--- title: Beta url: https://platform.claude.com/docs/en/api/http/beta --- # Beta ## Domain types ### Anthropic Beta - `AnthropicBeta = string or "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 48 more` - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` ### Beta API Error - `BetaAPIError object` - `type: "api_error"` default: api_error - `message: string` default: Internal server error ### Beta Authentication Error - `BetaAuthenticationError object` - `type: "authentication_error"` default: authentication_error - `message: string` default: Authentication error ### Beta Billing Error - `BetaBillingError object` - `type: "billing_error"` default: billing_error - `message: string` default: Billing error ### Beta Currency - `BetaCurrency = "USD"` ### Beta Error - `BetaError = BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 6 more` - `BetaInvalidRequestError object` - `type: "invalid_request_error"` default: invalid_request_error - `message: string` default: Invalid request - `BetaAuthenticationError object` - `type: "authentication_error"` default: authentication_error - `message: string` default: Authentication error - `BetaBillingError object` - `type: "billing_error"` default: billing_error - `message: string` default: Billing error - `BetaPermissionError object` - `type: "permission_error"` default: permission_error - `message: string` default: Permission denied - `BetaNotFoundError object` - `type: "not_found_error"` default: not_found_error - `message: string` default: Not found - `BetaRateLimitError object` - `type: "rate_limit_error"` default: rate_limit_error - `message: string` default: Rate limited - `BetaGatewayTimeoutError object` - `type: "timeout_error"` default: timeout_error - `message: string` default: Request timeout - `BetaAPIError object` - `type: "api_error"` default: api_error - `message: string` default: Internal server error - `BetaOverloadedError object` - `type: "overloaded_error"` default: overloaded_error - `message: string` default: Overloaded ### Beta Error Response - `BetaErrorResponse object` - `type: "error"` default: error - `error: BetaError` - `BetaInvalidRequestError object` - `type: "invalid_request_error"` default: invalid_request_error - `message: string` default: Invalid request - `BetaAuthenticationError object` - `type: "authentication_error"` default: authentication_error - `message: string` default: Authentication error - `BetaBillingError object` - `type: "billing_error"` default: billing_error - `message: string` default: Billing error - `BetaPermissionError object` - `type: "permission_error"` default: permission_error - `message: string` default: Permission denied - `BetaNotFoundError object` - `type: "not_found_error"` default: not_found_error - `message: string` default: Not found - `BetaRateLimitError object` - `type: "rate_limit_error"` default: rate_limit_error - `message: string` default: Rate limited - `BetaGatewayTimeoutError object` - `type: "timeout_error"` default: timeout_error - `message: string` default: Request timeout - `BetaAPIError object` - `type: "api_error"` default: api_error - `message: string` default: Internal server error - `BetaOverloadedError object` - `type: "overloaded_error"` default: overloaded_error - `message: string` default: Overloaded - `request_id: string or null` ### Beta Gateway Timeout Error - `BetaGatewayTimeoutError object` - `type: "timeout_error"` default: timeout_error - `message: string` default: Request timeout ### Beta Invalid Request Error - `BetaInvalidRequestError object` - `type: "invalid_request_error"` default: invalid_request_error - `message: string` default: Invalid request ### Beta Monetary Amount - `BetaMonetaryAmount object` A monetary amount in a specific currency. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. ### Beta Not Found Error - `BetaNotFoundError object` - `type: "not_found_error"` default: not_found_error - `message: string` default: Not found ### Beta Overloaded Error - `BetaOverloadedError object` - `type: "overloaded_error"` default: overloaded_error - `message: string` default: Overloaded ### Beta Permission Error - `BetaPermissionError object` - `type: "permission_error"` default: permission_error - `message: string` default: Permission denied ### Beta Rate Limit Error - `BetaRateLimitError object` - `type: "rate_limit_error"` default: rate_limit_error - `message: string` default: Rate limited ## Beta › Models ### List Models **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. #### Query parameters - `after_id: optional string` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `before_id: optional string` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `lifecycle: optional array of "active" or "deprecated" or "retired"` Filter the list to models in any of the given lifecycle stages (`active`, `deprecated`, or `retired`). Up to 3 values. When omitted, the list contains the `active` and `deprecated` models; `retired` models appear only when `retired` is requested explicitly. maxItems: 3 - `"active"` - `"deprecated"` - `"retired"` - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaModelInfo` - `type: "model"` Object type. For Models, this is always `"model"`. default: model - `id: string` Unique model identifier. - `allowed_fallback_models: array of string or null` Model IDs this model accepts as `fallbacks[i].model` on the Messages API. An empty list means the `fallbacks` parameter is not supported for this model as primary. - `capabilities: BetaModelCapabilities or null` Object mapping capability names to their support details. Keys are always present for all known capabilities. - `batch: BetaCapabilitySupport` Whether the model supports the Batch API. - `supported: boolean` Whether this capability is supported by the model. - `citations: BetaCapabilitySupport` Whether the model supports citation generation. - `code_execution: BetaCapabilitySupport` Whether code that the model runs in the code execution tool can call the request's other tools, as in programmatic tool calling and dynamic filtering for web search and web fetch. Support for the code execution tool itself is in `server_tools.code_execution`. - `compaction: BetaCompactionCapability or null` Server-side compaction support (the top-level `compaction` parameter) and the accepted `compaction.type` values. - `summarize: BetaCapabilitySupport` Whether the summarize compaction type is supported. - `supported: boolean` Whether this capability is supported by the model. - `context_management: BetaContextManagementCapability` Context management support and available strategies. - `clear_thinking_20251015: BetaCapabilitySupport or null` Whether the clear_thinking_20251015 strategy is supported. - `clear_tool_uses_20250919: BetaCapabilitySupport or null` Whether the clear_tool_uses_20250919 strategy is supported. - `compact_20260112: BetaCapabilitySupport or null` Whether the compact_20260112 strategy is supported. - `supported: boolean` 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: boolean` Whether this capability is supported by the model. - `xhigh: BetaCapabilitySupport or null` Whether the model supports xhigh effort level. - `image_input: BetaCapabilitySupport` Whether the model accepts image content blocks. - `pdf_input: BetaCapabilitySupport` Whether the model accepts PDF content blocks. - `server_tools: BetaServerToolsCapability` Whether this model supports the web search and code execution server tools. `supported` is true when the model supports at least one of the tools. A supported tool can still be rejected for your organization, for example when an admin has turned web search off. - `code_execution: BetaCapabilitySupport` Whether the model supports the code execution tool: true when the model supports at least one version of the tool, not necessarily every version. - `supported: boolean` Whether this capability is supported by the model. - `web_search: BetaCapabilitySupport` Whether the model supports the web search tool: true when the model supports at least one version of the tool, not necessarily every version. - `structured_outputs: BetaCapabilitySupport` Whether the model supports structured output / JSON mode / strict tool schemas. - `thinking: BetaThinkingCapability` Thinking capability and supported type configurations. - `supported: boolean` Whether this capability is supported by the model. - `types: BetaThinkingTypes` Supported thinking type configurations. - `adaptive: BetaCapabilitySupport` Whether the model accepts thinking with type 'adaptive' (the model decides whether and how much to think). - `disabled: BetaCapabilitySupport` Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking. - `enabled: BetaCapabilitySupport` Whether the model accepts thinking with type 'enabled' (extended thinking with a caller-set `budget_tokens`). - `created_at: string` 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. format: date-time - `deprecated_at: string or null` RFC 3339 datetime string representing the time of the model's most recent deprecation. Populated for `deprecated` and `retired` models; `null` while the model is `active`. format: date-time - `display_name: string` A human-readable name for the model. - `lifecycle: "active" or "deprecated" or "retired"` The model's current lifecycle stage. - `active`: The model is available for use, open to new adopters, and not scheduled for retirement. - `deprecated`: The model remains callable for organizations with existing access, but is headed for retirement and closed to new adopters. - `retired`: The model is no longer available for use; inference requests naming it fail. It remains in the catalogue as the historical record of its retirement. default: active - `"active"` - `"deprecated"` - `"retired"` - `line: BetaModelLine or null` The model line this model belongs to, such as `opus` for both Claude Opus 4.5 and Claude Opus 4.6. More lines may be added. `null` when the model belongs to no line; do not infer a line from the `id`. - `"haiku"` - `"sonnet"` - `"opus"` - `"fable"` - `"mythos"` - `max_input_tokens: number or null` Maximum input context window size in tokens for this model. - `max_tokens: number or null` Maximum value for the `max_tokens` parameter when using this model. - `retires_at: string or null` RFC 3339 datetime string representing the model's currently scheduled retirement date. The schedule can be revised until retirement occurs; `null` while the model is `active` or while no retirement is scheduled. A past date on a `deprecated` model means retirement is overdue, not that it has occurred: `lifecycle` is the retirement signal. format: date-time - `first_id: string or null` First ID in the `data` list. Can be used as the `before_id` for the previous page. - `has_more: boolean` Indicates if there are more results in the requested page direction. - `last_id: string or null` Last ID in the `data` list. Can be used as the `after_id` for the next page. #### Example ```bash curl https://api.anthropic.com/v1/models \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "claude-opus-5-5", "allowed_fallback_models": [ "string" ], "capabilities": { "batch": { "supported": true }, "citations": { "supported": true }, "code_execution": { "supported": true }, "compaction": { "summarize": { "supported": true }, "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 }, "server_tools": { "code_execution": { "supported": true }, "supported": true, "web_search": { "supported": true } }, "structured_outputs": { "supported": true }, "thinking": { "supported": true, "types": { "adaptive": { "supported": true }, "disabled": { "supported": true }, "enabled": { "supported": true } } } }, "created_at": "2026-09-21T00:00:00Z", "deprecated_at": "2019-12-27T18:11:19.117Z", "display_name": "Claude Opus 5.5", "lifecycle": "active", "line": "haiku", "max_input_tokens": 0, "max_tokens": 0, "retires_at": "2019-12-27T18:11:19.117Z", "type": "model" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ### Get a Model **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. #### Path parameters - `model_id: string` Model identifier or alias. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaModelInfo object` - `type: "model"` Object type. For Models, this is always `"model"`. default: model - `id: string` Unique model identifier. - `allowed_fallback_models: array of string or null` Model IDs this model accepts as `fallbacks[i].model` on the Messages API. An empty list means the `fallbacks` parameter is not supported for this model as primary. - `capabilities: BetaModelCapabilities or null` Object mapping capability names to their support details. Keys are always present for all known capabilities. - `batch: BetaCapabilitySupport` Whether the model supports the Batch API. - `supported: boolean` Whether this capability is supported by the model. - `citations: BetaCapabilitySupport` Whether the model supports citation generation. - `code_execution: BetaCapabilitySupport` Whether code that the model runs in the code execution tool can call the request's other tools, as in programmatic tool calling and dynamic filtering for web search and web fetch. Support for the code execution tool itself is in `server_tools.code_execution`. - `compaction: BetaCompactionCapability or null` Server-side compaction support (the top-level `compaction` parameter) and the accepted `compaction.type` values. - `summarize: BetaCapabilitySupport` Whether the summarize compaction type is supported. - `supported: boolean` Whether this capability is supported by the model. - `context_management: BetaContextManagementCapability` Context management support and available strategies. - `clear_thinking_20251015: BetaCapabilitySupport or null` Whether the clear_thinking_20251015 strategy is supported. - `clear_tool_uses_20250919: BetaCapabilitySupport or null` Whether the clear_tool_uses_20250919 strategy is supported. - `compact_20260112: BetaCapabilitySupport or null` Whether the compact_20260112 strategy is supported. - `supported: boolean` 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: boolean` Whether this capability is supported by the model. - `xhigh: BetaCapabilitySupport or null` Whether the model supports xhigh effort level. - `image_input: BetaCapabilitySupport` Whether the model accepts image content blocks. - `pdf_input: BetaCapabilitySupport` Whether the model accepts PDF content blocks. - `server_tools: BetaServerToolsCapability` Whether this model supports the web search and code execution server tools. `supported` is true when the model supports at least one of the tools. A supported tool can still be rejected for your organization, for example when an admin has turned web search off. - `code_execution: BetaCapabilitySupport` Whether the model supports the code execution tool: true when the model supports at least one version of the tool, not necessarily every version. - `supported: boolean` Whether this capability is supported by the model. - `web_search: BetaCapabilitySupport` Whether the model supports the web search tool: true when the model supports at least one version of the tool, not necessarily every version. - `structured_outputs: BetaCapabilitySupport` Whether the model supports structured output / JSON mode / strict tool schemas. - `thinking: BetaThinkingCapability` Thinking capability and supported type configurations. - `supported: boolean` Whether this capability is supported by the model. - `types: BetaThinkingTypes` Supported thinking type configurations. - `adaptive: BetaCapabilitySupport` Whether the model accepts thinking with type 'adaptive' (the model decides whether and how much to think). - `disabled: BetaCapabilitySupport` Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking. - `enabled: BetaCapabilitySupport` Whether the model accepts thinking with type 'enabled' (extended thinking with a caller-set `budget_tokens`). - `created_at: string` 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. format: date-time - `deprecated_at: string or null` RFC 3339 datetime string representing the time of the model's most recent deprecation. Populated for `deprecated` and `retired` models; `null` while the model is `active`. format: date-time - `display_name: string` A human-readable name for the model. - `lifecycle: "active" or "deprecated" or "retired"` The model's current lifecycle stage. - `active`: The model is available for use, open to new adopters, and not scheduled for retirement. - `deprecated`: The model remains callable for organizations with existing access, but is headed for retirement and closed to new adopters. - `retired`: The model is no longer available for use; inference requests naming it fail. It remains in the catalogue as the historical record of its retirement. default: active - `"active"` - `"deprecated"` - `"retired"` - `line: BetaModelLine or null` The model line this model belongs to, such as `opus` for both Claude Opus 4.5 and Claude Opus 4.6. More lines may be added. `null` when the model belongs to no line; do not infer a line from the `id`. - `"haiku"` - `"sonnet"` - `"opus"` - `"fable"` - `"mythos"` - `max_input_tokens: number or null` Maximum input context window size in tokens for this model. - `max_tokens: number or null` Maximum value for the `max_tokens` parameter when using this model. - `retires_at: string or null` RFC 3339 datetime string representing the model's currently scheduled retirement date. The schedule can be revised until retirement occurs; `null` while the model is `active` or while no retirement is scheduled. A past date on a `deprecated` model means retirement is overdue, not that it has occurred: `lifecycle` is the retirement signal. format: date-time #### Example ```bash curl https://api.anthropic.com/v1/models/$MODEL_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "claude-opus-5-5", "allowed_fallback_models": [ "string" ], "capabilities": { "batch": { "supported": true }, "citations": { "supported": true }, "code_execution": { "supported": true }, "compaction": { "summarize": { "supported": true }, "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 }, "server_tools": { "code_execution": { "supported": true }, "supported": true, "web_search": { "supported": true } }, "structured_outputs": { "supported": true }, "thinking": { "supported": true, "types": { "adaptive": { "supported": true }, "disabled": { "supported": true }, "enabled": { "supported": true } } } }, "created_at": "2026-09-21T00:00:00Z", "deprecated_at": "2019-12-27T18:11:19.117Z", "display_name": "Claude Opus 5.5", "lifecycle": "active", "line": "haiku", "max_input_tokens": 0, "max_tokens": 0, "retires_at": "2019-12-27T18:11:19.117Z", "type": "model" } ``` ## Beta › Messages ### Create a Message **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://platform.claude.com/docs/en/get-started?sdk_languages=http) #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-user-profile-id": optional string` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `max_tokens: number` 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://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=http) for details. minimum: 0 - `messages: array of BetaMessageParam` 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. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=http#prefill-not-supported). 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, for models that support prefill: ```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://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=http). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role), 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: string or array of BetaContentBlockParam` - `string` - `array of BetaContentBlockParam` - `BetaTextBlockParam object` - `type: "text"` - `text: string` minLength: 1 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl: optional "5m" or "1h"` 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`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http) for details. - `"5m"` - `"1h"` - `citations: optional array of BetaTextCitationParam or null` - `BetaCitationCharLocationParam object` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string or null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `BetaCitationPageLocationParam object` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string or null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `BetaCitationContentBlockLocationParam object` - `type: "content_block_location"` - `cited_text: 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. - `document_index: number` minimum: 0 - `document_title: string or null` minLength: 1, maxLength: 500 - `end_block_index: number` 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`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `BetaCitationWebSearchResultLocationParam object` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string or null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `BetaCitationSearchResultLocationParam object` - `type: "search_result_location"` - `cited_text: 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. - `end_block_index: number` 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`. - `search_result_index: number` 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. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string or null` - `BetaImageBlockParam object` - `type: "image"` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `BetaBase64ImageSource object` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `BetaURLImageSource object` - `type: "url"` - `url: string` - `BetaFileImageSource object` - `type: "file"` - `file_id: string` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `transformations: optional BetaImageTransformationsParam or null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image: optional "downsize" or "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` - `BetaRequestDocumentBlock object` - `type: "document"` - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` - `BetaBase64PDFSource object` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `BetaPlainTextSource object` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `BetaContentBlockSource object` - `type: "content"` - `content: string or array of BetaContentBlockSourceContent` - `string` - `BetaContentBlockSourceContent = array of BetaContentBlockSourceContent` - `BetaTextBlockParam object` - `BetaImageBlockParam object` - `BetaURLPDFSource object` - `type: "url"` - `url: string` - `BetaFileDocumentSource object` - `type: "file"` - `file_id: string` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` - `enabled: optional boolean` - `context: optional string or null` minLength: 1 - `title: optional string or null` minLength: 1, maxLength: 500 - `BetaSearchResultBlockParam object` - `type: "search_result"` - `content: array of BetaTextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam or null` - `source: string` - `title: string` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam` - `BetaThinkingBlockParam object` - `type: "thinking"` - `signature: string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `thinking: string` The `thinking` text of this block as returned by the API. - `BetaRedactedThinkingBlockParam object` - `type: "redacted_thinking"` - `data: string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `BetaToolUseBlockParam object` - `type: "tool_use"` - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: map[unknown]` - `name: string` minLength: 1, maxLength: 200 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `type: "direct"` - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaServerToolCaller20260120 object` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `toolset_name: optional string or null` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `BetaToolResultBlockParam object` - `type: "tool_result"` - `tool_use_id: string` pattern: ^[a-zA-Z0-9_-]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `content: optional string or array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 3 more` - `string` - `array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 3 more` - `BetaTextBlockParam object` - `BetaImageBlockParam object` - `BetaSearchResultBlockParam object` - `BetaRequestDocumentBlock object` - `BetaToolReferenceBlockParam object` Tool reference block that can be included in tool_result content. - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaBrowserStateBlockParam object` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `type: "browser_state"` - `tabs: array of BetaBrowserStateTabEntry` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `tab_id: string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `title: string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `active: optional boolean` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `state_changes: optional array of BetaBrowserStateChange or null` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `BetaBrowserStateChangeTabOpened object` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `type: "tab_opened"` - `tab_id: string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `BetaBrowserStateChangeDownloadStarted object` A file download that started during this call. - `type: "download_started"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `BetaBrowserStateChangeDownloadCompleted object` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `type: "download_completed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path: optional string or null` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `size_bytes: optional number or null` The completed download's size. minimum: 0 - `BetaBrowserStateChangeDownloadFailed object` A file download that failed — or was cancelled — during this call. - `type: "download_failed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `error: optional string or null` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `is_error: optional boolean` - `toolset_name: optional string or null` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `BetaServerToolUseBlockParam object` - `type: "server_tool_use"` - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: map[unknown]` - `name: "advisor" or "web_search" or "web_fetch" or 5 more` - `"advisor"` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaWebSearchToolResultBlockParam object` - `type: "web_search_tool_result"` - `content: BetaWebSearchToolResultBlockParamContent` - `ResultBlock = array of BetaWebSearchResultBlockParam` - `type: "web_search_result"` - `encrypted_content: string` - `title: string` - `url: string` - `page_age: optional string or null` - `BetaWebSearchToolRequestError object` - `type: "web_search_tool_result_error"` - `error_code: BetaWebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaWebFetchToolResultBlockParam object` - `type: "web_fetch_tool_result"` - `content: BetaWebFetchToolResultErrorBlockParam or BetaWebFetchBlockParam` - `BetaWebFetchToolResultErrorBlockParam object` - `type: "web_fetch_tool_result_error"` - `error_code: BetaWebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `BetaWebFetchBlockParam object` - `type: "web_fetch_result"` - `content: BetaRequestDocumentBlock` - `url: string` Fetched content URL - `retrieved_at: optional string or null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaAdvisorToolResultBlockParam object` - `type: "advisor_tool_result"` - `content: BetaAdvisorToolResultErrorParam or BetaAdvisorResultBlockParam or BetaAdvisorRedactedResultBlockParam` - `BetaAdvisorToolResultErrorParam object` - `type: "advisor_tool_result_error"` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 4 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `"model_not_found"` - `BetaAdvisorResultBlockParam object` - `type: "advisor_result"` - `text: string` - `stop_reason: optional string or null` - `BetaAdvisorRedactedResultBlockParam object` - `type: "advisor_redacted_result"` - `encrypted_content: string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `stop_reason: optional string or null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaCodeExecutionToolResultBlockParam object` - `type: "code_execution_tool_result"` - `content: BetaCodeExecutionToolResultBlockParamContent` - `BetaCodeExecutionToolResultErrorParam object` - `type: "code_execution_tool_result_error"` - `error_code: BetaCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `BetaCodeExecutionResultBlockParam object` - `type: "code_execution_result"` - `content: array of BetaCodeExecutionOutputBlockParam` - `type: "code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `BetaEncryptedCodeExecutionResultBlockParam object` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` - `content: array of BetaCodeExecutionOutputBlockParam` - `type: "code_execution_output"` - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaBashCodeExecutionToolResultBlockParam object` - `type: "bash_code_execution_tool_result"` - `content: BetaBashCodeExecutionToolResultErrorParam or BetaBashCodeExecutionResultBlockParam` - `BetaBashCodeExecutionToolResultErrorParam object` - `type: "bash_code_execution_tool_result_error"` - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `BetaBashCodeExecutionResultBlockParam object` - `type: "bash_code_execution_result"` - `content: array of BetaBashCodeExecutionOutputBlockParam` - `type: "bash_code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaTextEditorCodeExecutionToolResultBlockParam object` - `type: "text_editor_code_execution_tool_result"` - `content: BetaTextEditorCodeExecutionToolResultErrorParam or BetaTextEditorCodeExecutionViewResultBlockParam or BetaTextEditorCodeExecutionCreateResultBlockParam or BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `BetaTextEditorCodeExecutionToolResultErrorParam object` - `type: "text_editor_code_execution_tool_result_error"` - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message: optional string or null` - `BetaTextEditorCodeExecutionViewResultBlockParam object` - `type: "text_editor_code_execution_view_result"` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: optional number or null` - `start_line: optional number or null` - `total_lines: optional number or null` - `BetaTextEditorCodeExecutionCreateResultBlockParam object` - `type: "text_editor_code_execution_create_result"` - `is_file_update: boolean` - `BetaTextEditorCodeExecutionStrReplaceResultBlockParam object` - `type: "text_editor_code_execution_str_replace_result"` - `lines: optional array of string or null` - `new_lines: optional number or null` - `new_start: optional number or null` - `old_lines: optional number or null` - `old_start: optional number or null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaToolSearchToolResultBlockParam object` - `type: "tool_search_tool_result"` - `content: BetaToolSearchToolResultErrorParam or BetaToolSearchToolSearchResultBlockParam` - `BetaToolSearchToolResultErrorParam object` - `type: "tool_search_tool_result_error"` - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message: optional string or null` - `BetaToolSearchToolSearchResultBlockParam object` - `type: "tool_search_tool_search_result"` - `tool_references: array of BetaToolReferenceBlockParam` - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaMCPToolUseBlockParam object` - `type: "mcp_tool_use"` - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: map[unknown]` - `name: string` - `server_name: string` The name of the MCP server - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaRequestMCPToolResultBlockParam object` - `type: "mcp_tool_result"` - `tool_use_id: string` pattern: ^[a-zA-Z0-9_-]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `content: optional string or array of BetaTextBlockParam` - `string` - `BetaMCPToolResultBlockParamContent = array of BetaTextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam or null` - `is_error: optional boolean` - `BetaContainerUploadBlockParam object` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `type: "container_upload"` - `file_id: string` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaCompactionBlockParam object` 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"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `content: optional string or null` Summary of previously compacted content, or null if compaction failed - `encrypted_content: optional string or null` Opaque metadata from prior compaction, to be round-tripped verbatim - `signature: optional string or null` The block's signature as returned, to be sent back verbatim - `tool_changes: optional array of BetaRequestToolAdditionBlock or BetaRequestToolRemovalBlock or null` The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block. - `BetaRequestToolAdditionBlock object` Mid-conversation directive to make a tool available. `tool` is a reference to a tool (or MCP toolset) declared in the request's `tools`. Under the `inline-tools-2026-09-15` beta it may instead be a reference to a tool defined earlier in `messages`, or a `tool_definition` object that carries an inline tool definition in `definition` (the same object a `tools` entry holds). An `mcp_toolset` definition also requires the `mcp-client-2026-09-15` beta. The tool is offered to the model from this point in the conversation onward. - `type: "tool_addition"` - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference or BetaToolChangeToolDefinitionParam` - `BetaToolChangeToolReference object` Reference to a single tool, by the name the model uses to call it: a tool declared in `tools` or defined by an earlier `tool_addition` block. Does not accept the composed `{server}_{name}` form the server assigns to MCP-resolved tools; use `mcp_tool_reference` or `mcp_toolset_reference` for those. - `type: "tool_reference"` - `name: string` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `BetaToolChangeMCPToolReference object` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `type: "mcp_tool_reference"` - `name: string` - `server_name: string` - `BetaToolChangeMCPToolsetReference object` Reference to every tool in the named MCP server's toolset. - `type: "mcp_toolset_reference"` - `server_name: string` - `BetaToolChangeToolDefinitionParam object` A tool defined by value: `definition` is a `tools` entry (any kind `tools` accepts, an MCP toolset included). An `mcp_toolset` given here also requires the `mcp-client-2026-09-15` beta. - `type: "tool_definition"` - `definition: BetaToolUnion` - `BetaTool object` - `type: optional "custom" or null` - `input_schema: object` [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"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description: optional string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `eager_input_streaming: optional boolean or null` 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. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolBash20241022 object` - `type: "bash_20241022"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolBash20250124 object` - `type: "bash_20250124"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250522 object` - `type: "code_execution_20250522"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250825 object` - `type: "code_execution_20250825"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20260120 object` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type: "code_execution_20260120"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20260521 object` Code execution tool with REPL state persistence. - `type: "code_execution_20260521"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaBrowserToolset20260801 object` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `type: "browser_toolset_20260801"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional BetaBrowserToolsetConfigs or null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type: optional BetaBrowserTypeConfig or null` `type`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `close_tab: optional BetaBrowserCloseTabConfig or null` `close_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click: optional BetaBrowserDoubleClickConfig or null` `double_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `file_upload: optional BetaBrowserFileUploadConfig or null` `file_upload`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `find: optional BetaBrowserFindConfig or null` `find`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `form_input: optional BetaBrowserFormInputConfig or null` `form_input`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `get_page_text: optional BetaBrowserGetPageTextConfig or null` `get_page_text`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key: optional BetaBrowserHoldKeyConfig or null` `hold_key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hover: optional BetaBrowserHoverConfig or null` `hover`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `javascript_exec: optional BetaBrowserJavascriptExecConfig or null` `javascript_exec`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key: optional BetaBrowserKeyConfig or null` `key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click: optional BetaBrowserLeftClickConfig or null` `left_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag: optional BetaBrowserLeftClickDragConfig or null` `left_click_drag`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down: optional BetaBrowserLeftMouseDownConfig or null` `left_mouse_down`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up: optional BetaBrowserLeftMouseUpConfig or null` `left_mouse_up`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `list_tabs: optional BetaBrowserListTabsConfig or null` `list_tabs`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click: optional BetaBrowserMiddleClickConfig or null` `middle_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move: optional BetaBrowserMouseMoveConfig or null` `mouse_move`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `navigate: optional BetaBrowserNavigateConfig or null` `navigate`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `new_tab: optional BetaBrowserNewTabConfig or null` `new_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_console: optional BetaBrowserReadConsoleConfig or null` `read_console`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_network: optional BetaBrowserReadNetworkConfig or null` `read_network`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_page: optional BetaBrowserReadPageConfig or null` `read_page`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click: optional BetaBrowserRightClickConfig or null` `right_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot: optional BetaBrowserScreenshotConfig or null` `screenshot`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll: optional BetaBrowserScrollConfig or null` `scroll`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll_to: optional BetaBrowserScrollToConfig or null` `scroll_to`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `switch_tab: optional BetaBrowserSwitchTabConfig or null` `switch_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click: optional BetaBrowserTripleClickConfig or null` `triple_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait: optional BetaBrowserWaitConfig or null` `wait`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom: optional BetaBrowserZoomConfig or null` `zoom`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaToolComputerUse20241022 object` - `type: "computer_20241022"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaMemoryTool20250818 object` - `type: "memory_20250818"` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20250124 object` - `type: "computer_20250124"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20241022 object` - `type: "text_editor_20241022"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20251124 object` - `type: "computer_20251124"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `enable_zoom: optional boolean` Whether to enable an action to take a zoomed-in screenshot of the screen. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaComputerToolset20260801 object` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `type: "computer_toolset_20260801"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional BetaComputerToolsetConfigs or null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type: optional BetaComputerTypeConfig or null` `type`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `cursor_position: optional BetaComputerCursorPositionConfig or null` `cursor_position`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click: optional BetaComputerDoubleClickConfig or null` `double_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key: optional BetaComputerHoldKeyConfig or null` `hold_key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key: optional BetaComputerKeyConfig or null` `key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click: optional BetaComputerLeftClickConfig or null` `left_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag: optional BetaComputerLeftClickDragConfig or null` `left_click_drag`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down: optional BetaComputerLeftMouseDownConfig or null` `left_mouse_down`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up: optional BetaComputerLeftMouseUpConfig or null` `left_mouse_up`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click: optional BetaComputerMiddleClickConfig or null` `middle_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move: optional BetaComputerMouseMoveConfig or null` `mouse_move`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click: optional BetaComputerRightClickConfig or null` `right_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot: optional BetaComputerScreenshotConfig or null` `screenshot`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll: optional BetaComputerScrollConfig or null` `scroll`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click: optional BetaComputerTripleClickConfig or null` `triple_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait: optional BetaComputerWaitConfig or null` `wait`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom: optional BetaComputerZoomConfig or null` `zoom`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaToolTextEditor20250124 object` - `type: "text_editor_20250124"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250429 object` - `type: "text_editor_20250429"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250728 object` - `type: "text_editor_20250728"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `max_characters: optional number or null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebSearchTool20250305 object` - `type: "web_search_20250305"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city: optional string or null` The city of the user. minLength: 1, maxLength: 255 - `country: optional string or null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `region: optional string or null` The region of the user. minLength: 1, maxLength: 255 - `timezone: optional string or null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `BetaWebFetchTool20250910 object` - `type: "web_fetch_20250910"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `BetaWebFetchURLSourceOnly object` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: array of BetaWebFetchURLSourceToolReference` - `type: "tool_reference"` - `name: string` - `BetaWebFetchURLSourceExcept object` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: array of BetaWebFetchURLSourceToolReference` - `type: "tool_reference"` - `name: string` - `server_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `BetaWebFetchURLSourceOnly object` The tool filter variant under which only the named tools' results contribute. - `BetaWebFetchURLSourceExcept object` The tool filter variant under which every result but the named tools' contributes. - `user_input: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `BetaWebSearchTool20260209 object` - `type: "web_search_20260209"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `BetaWebFetchTool20260209 object` - `type: "web_fetch_20260209"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `BetaWebFetchTool20260309 object` Web fetch tool with use_cache parameter for bypassing cached content. - `type: "web_fetch_20260309"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache: optional boolean` 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. - `BetaWebSearchTool20260318 object` - `type: "web_search_20260318"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion: optional "full" or "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `BetaWebFetchTool20260318 object` - `type: "web_fetch_20260318"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion: optional "full" or "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache: optional boolean` 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. - `BetaAdvisorTool20260301 object` - `type: "advisor_20260301"` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-mythos-5"` Most capable model for cybersecurity and biology research - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `name: "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caching: optional BetaCacheControlEphemeral or null` 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. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_tokens: optional number or null` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolBm25_20251119 object` - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolRegex20251119 object` - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaMCPToolset object` 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. - `type: "mcp_toolset"` - `mcp_server_name: string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional map[BetaMCPToolConfig] or null` Configuration overrides for specific tools, keyed by tool name - `defer_loading: optional boolean` - `enabled: optional boolean` - `default_config: optional BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `defer_loading: optional boolean` - `enabled: optional boolean` - `tools: optional array of BetaMCPToolParam or null` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `input_schema: map[unknown]` The tool's input schema as the MCP server lists it, verbatim. - `name: string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `description: optional string or null` The tool's description as the MCP server lists it. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaRequestToolRemovalBlock object` Mid-conversation directive to withdraw a tool. `tool` references a tool (or MCP toolset) by name: one declared in the request's `tools` or defined earlier in `messages`. It is no longer offered to the model from this point in the conversation onward. - `type: "tool_removal"` - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference` - `BetaToolChangeToolReference object` Reference to a single tool, by the name the model uses to call it: a tool declared in `tools` or defined by an earlier `tool_addition` block. Does not accept the composed `{server}_{name}` form the server assigns to MCP-resolved tools; use `mcp_tool_reference` or `mcp_toolset_reference` for those. - `BetaToolChangeMCPToolReference object` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `BetaToolChangeMCPToolsetReference object` Reference to every tool in the named MCP server's toolset. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaRequestToolAdditionBlock object` Mid-conversation directive to make a tool available. `tool` is a reference to a tool (or MCP toolset) declared in the request's `tools`. Under the `inline-tools-2026-09-15` beta it may instead be a reference to a tool defined earlier in `messages`, or a `tool_definition` object that carries an inline tool definition in `definition` (the same object a `tools` entry holds). An `mcp_toolset` definition also requires the `mcp-client-2026-09-15` beta. The tool is offered to the model from this point in the conversation onward. - `BetaRequestToolRemovalBlock object` Mid-conversation directive to withdraw a tool. `tool` references a tool (or MCP toolset) by name: one declared in the request's `tools` or defined earlier in `messages`. It is no longer offered to the model from this point in the conversation onward. - `BetaMCPToolListingBlockParam object` The tool listing an MCP server returned while an earlier response was produced, as that response carried it. Send the assistant message back unchanged, this block included, and the server uses this listing for the matching `mcp_toolset` instead of asking the MCP server again. - `type: "mcp_tool_listing"` - `mcp_server_name: string` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `tools: array of BetaMCPToolParam` The server's tools, exactly as the response listed them. - `input_schema: map[unknown]` The tool's input schema as the MCP server lists it, verbatim. - `name: string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `description: optional string or null` The tool's description as the MCP server lists it. - `BetaFallbackBlockParam object` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `type: "fallback"` - `from: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `to: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `trigger: optional unknown` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. - `role: "user" or "assistant" or "system"` - `"user"` - `"assistant"` - `"system"` - `clear_at: optional "next_user_message" or "never" or null` How long this system message's text stays in front of the model. `"never"` (the default) renders it on every request that includes it. `"next_user_message"` renders it only for the user turn it follows: once a later `role: "user"` message exists in `messages` the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on `role: "system"` messages. - `"next_user_message"` - `"never"` - `output_config: optional BetaSystemMessageOutputConfig or null` Per-message output configuration on a role:"system" input message. Fields here apply per-turn; `format` remains top-level only. An empty `{}` is accepted on a message that carries content; a message with neither content nor output_config fields is rejected. - `effort: optional "low" or "medium" or "high" or 2 more or null` How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `cache_control: optional BetaCacheControlEphemeral or null` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `compaction: optional BetaCompactionConfig or null` Compaction configuration. When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`. - `type: "summarize"` - `instructions: optional string or null` Replaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent. maxLength: 16384 - `container: optional BetaContainerParams or string or null` Container identifier for reuse across requests. - `BetaContainerParams object` Container parameters with skills to be loaded. - `id: optional string or null` Container id - `skills: optional array of BetaSkillParams or null` List of skills to load in the container maxItems: 20 - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version: optional string` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 - `string` - `context_management: optional BetaContextManagementConfig or null` 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: optional array of BetaClearToolUses20250919Edit or BetaClearThinking20251015Edit or BetaCompact20260112Edit` List of context management edits to apply - `BetaClearToolUses20250919Edit object` - `type: "clear_tool_uses_20250919"` - `clear_at_least: optional BetaInputTokensClearAtLeast or null` 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: "input_tokens"` - `value: number` minimum: 0 - `clear_tool_inputs: optional boolean or array of string or null` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `boolean` - `array of string` - `exclude_tools: optional array of string or null` Tool names whose uses are preserved from clearing - `keep: optional BetaToolUsesKeep` Number of tool uses to retain in the conversation - `type: "tool_uses"` - `value: number` minimum: 0 - `trigger: optional BetaInputTokensTrigger or BetaToolUsesTrigger` Condition that triggers the context management strategy - `BetaInputTokensTrigger object` - `type: "input_tokens"` - `value: number` minimum: 1 - `BetaToolUsesTrigger object` - `type: "tool_uses"` - `value: number` minimum: 1 - `BetaClearThinking20251015Edit object` - `type: "clear_thinking_20251015"` - `keep: optional BetaThinkingTurns or BetaAllThinkingTurns or "all"` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `BetaThinkingTurns object` - `type: "thinking_turns"` - `value: number` minimum: 1 - `BetaAllThinkingTurns object` - `type: "all"` - `"all"` - `BetaCompact20260112Edit object` Automatically compact older context when reaching the configured trigger threshold. - `type: "compact_20260112"` - `instructions: optional string or null` Additional instructions for summarization. - `pause_after_compaction: optional boolean` Whether to pause after compaction and return the compaction block to the user. - `trigger: optional BetaInputTokensTrigger or null` When to trigger compaction. Defaults to 150000 input tokens. - `diagnostics: optional BetaDiagnosticsParam or null` Request-level diagnostics. Supply `previous_message_id` to have the response include `diagnostics.cache_miss_reason` explaining any prompt-cache divergence from that prior request. - `previous_message_id: optional string or null` 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. maxLength: 256 - `fallback_credit_token: optional string or BetaFallbackCreditTokenParam or null` The `fallback_credit_token` from a prior refusal's `stop_details`. When a preceding request was refused and returned a `fallback_credit_token`, pass that code here on the retry to have the retry's cache-creation tokens for the prefix that was warm on the refused model billed at the cache-read rate. Must be redeemed by the same organization and workspace, with the same request body (optionally extended by one appended `assistant` message whose content is the partial text — with any trailing whitespace stripped from the final text block — and paired server-tool blocks streamed before the refusal; the appended-assistant form is not available for requests with `output_format` set or forced `tool_choice`), on an eligible fallback model, on the same platform, and within 5 minutes of the refusal; a mismatch is a 400. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed with the appended-assistant form — if an exact-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry with the appended-assistant form instead. When the appended-assistant form is used on a model that otherwise disallows assistant-turn prefill, this token also authorizes that one prefill. - `string` - `BetaFallbackCreditTokenParam object` Object form of `fallback_credit_token`: the token plus a redemption mode. Requires `anthropic-beta: fallback-credit-2026-07-01`; without that header the field accepts the bare string only. The bare string and the mode-less object are equivalent (both select `strict`), so wrapping an existing token changes nothing by itself. - `token: string` The opaque `fallback_credit_token` from a prior refusal's `stop_details` — the same string the bare-string form carries. minLength: 1, maxLength: 2048 - `mode: optional "strict" or "best_effort"` How a failing token affects the retry. `strict` (the default, and the bare-string behavior): a failing redemption is a 400 and the retry is not served. `best_effort`: the retry is served either way — a token-layer failure no longer rejects the request; the retry proceeds at normal price and the outcome is reported on the response's `usage.fallback_credit`. Two failures stay hard in both modes: a malformed token, and combining `fallback_credit_token` with `fallbacks`. - `"strict"` - `"best_effort"` - `fallbacks: optional BetaFallbacksParam or null` Opt-in server-side retry on one or more substitute models when the requested model declines for policy reasons. Tried in order: if the first entry also declines, the second is tried, and so on. Some models don't support fallbacks; on those models, a list of fallback models returns a 400 error. See [Server-side fallback](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=http#server-side-fallback). The string "default" requests the requested model's server-defined default fallback configuration. On a model that doesn't support fallbacks, the request runs on the requested model alone, so a declined request stays declined. - `array of BetaFallbackParam` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `max_tokens: optional number or null` - `output_config: optional BetaOutputConfig or null` - `effort: optional "low" or "medium" or "high" or 2 more or null` How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `format: optional BetaJSONOutputFormat or null` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=http) - `type: "json_schema"` - `schema: map[unknown]` The JSON schema of the format - `task_budget: optional BetaTokenTaskBudget or null` Configuration for token budget tracking across contexts. - `type: "tokens"` The budget type. Currently only 'tokens' is supported. - `total: number` Total token budget across all contexts in the session. minimum: 1024 - `remaining: optional number or null` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. minimum: 0 - `speed: optional "standard" or "fast" or null` 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. - `"standard"` - `"fast"` - `thinking: optional BetaThinkingConfigEnabled or BetaThinkingConfigDisabled or BetaThinkingConfigBetweenTools or BetaThinkingConfigAdaptive or null` - `BetaThinkingConfigEnabled object` - `type: "enabled"` - `budget_tokens: number` 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://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details. minimum: 1024 - `block_binding: optional BetaThinkingBlockBinding or null` Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default. - `prefix_mismatch_behavior: optional BetaThinkingPrefixMismatchBehavior or null` "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`. - `"error"` - `"drop_block"` - `display: optional "summarized" or "omitted" or "updates" or null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display). - `"summarized"` - `"omitted"` - `"updates"` - `BetaThinkingConfigDisabled object` - `type: "disabled"` - `BetaThinkingConfigBetweenTools object` - `type: "between_tools"` - `BetaThinkingConfigAdaptive object` - `type: "adaptive"` - `block_binding: optional BetaThinkingBlockBinding or null` Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default. - `display: optional "summarized" or "omitted" or "updates" or null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display). - `"summarized"` - `"omitted"` - `"updates"` - `"default"` - `inference_geo: optional string or null` Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `mcp_servers: optional array of BetaRequestMCPServerURLDefinition` MCP servers to be utilized in this request maxItems: 20 - `type: "url"` - `name: string` - `url: string` - `authorization_token: optional string or null` - `tool_configuration: optional BetaRequestMCPServerToolConfiguration or null` - `allowed_tools: optional array of string or null` - `enabled: optional boolean or null` - `metadata: optional BetaMetadata` An object describing metadata about the request. - `user_id: optional string or null` 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. maxLength: 512 - `output_config: optional BetaOutputConfig` Configuration options for the model's output, such as the output format. - `service_tier: optional "auto" or "standard_only"` 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://platform.claude.com/docs/en/api/service-tiers?sdk_languages=http) for details. - `"auto"` - `"standard_only"` - `speed: optional "standard" or "fast" or null` The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. Some models require the `fast-mode-2026-02-01` beta header for any `speed` value. See [fast mode](https://platform.claude.com/docs/en/build-with-claude/fast-mode?sdk_languages=http) for which models. - `"standard"` - `"fast"` - `stop_sequences: optional array of 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: optional boolean` Whether to incrementally stream the response using server-sent events. When `true`, SDKs return a raw event stream. In the TypeScript, Python and Ruby SDKs, the recommended way to stream is `messages.stream()`. It sets `stream` for you and accumulates the events into the final message. See [Streaming with SDKs](https://platform.claude.com/docs/en/build-with-claude/streaming?sdk_languages=http#streaming-with-sdks) for an example in each language. - `system: optional string or array of BetaTextBlockParam` 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://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role). - `string` - `array of BetaTextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam or null` - `thinking: optional BetaThinkingConfigParam` Configuration for Claude's thinking. With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit. Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#configuring-thinking) for each model's behavior. - `BetaThinkingConfigEnabled object` - `BetaThinkingConfigDisabled object` - `BetaThinkingConfigBetweenTools object` - `BetaThinkingConfigAdaptive object` - `tool_choice: optional BetaToolChoice` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `BetaToolChoiceAuto object` The model will automatically decide whether to use tools. - `type: "auto"` - `disable_parallel_tool_use: optional boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `BetaToolChoiceAny object` The model will use any available tools. - `type: "any"` - `disable_parallel_tool_use: optional boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `BetaToolChoiceTool object` The model will use the specified tool with `tool_choice.name`. - `type: "tool"` - `name: string` The name of the tool to use. - `disable_parallel_tool_use: optional boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `BetaToolChoiceNone object` The model will not be allowed to use tools. - `type: "none"` - `tools: optional array of 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://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=http), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=http)). 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://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=http) for more details. - `BetaTool object` - `BetaToolBash20241022 object` - `BetaToolBash20250124 object` - `BetaCodeExecutionTool20250522 object` - `BetaCodeExecutionTool20250825 object` - `BetaCodeExecutionTool20260120 object` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `BetaCodeExecutionTool20260521 object` Code execution tool with REPL state persistence. - `BetaBrowserToolset20260801 object` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `BetaToolComputerUse20241022 object` - `BetaMemoryTool20250818 object` - `BetaToolComputerUse20250124 object` - `BetaToolTextEditor20241022 object` - `BetaToolComputerUse20251124 object` - `BetaComputerToolset20260801 object` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `BetaToolTextEditor20250124 object` - `BetaToolTextEditor20250429 object` - `BetaToolTextEditor20250728 object` - `BetaWebSearchTool20250305 object` - `BetaWebFetchTool20250910 object` - `BetaWebSearchTool20260209 object` - `BetaWebFetchTool20260209 object` - `BetaWebFetchTool20260309 object` Web fetch tool with use_cache parameter for bypassing cached content. - `BetaWebSearchTool20260318 object` - `BetaWebFetchTool20260318 object` - `BetaAdvisorTool20260301 object` - `BetaToolSearchToolBm25_20251119 object` - `BetaToolSearchToolRegex20251119 object` - `BetaMCPToolset object` 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. - `output_format: optional BetaJSONOutputFormat or null` **Deprecated** Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=http) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. - `temperature: optional number` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. 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. minimum: 0, maximum: 1 - `top_k: optional number` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error. 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. minimum: 0 - `top_p: optional number` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting top_p. A value >= 0.99 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. 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. minimum: 0, maximum: 1 #### Returns - `BetaMessage object` - `type: "message"` Object type. For Messages, this is always `"message"`. default: message - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: BetaContainer or null` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. format: date-time - `skills: array of BetaContainerSkill or null` Skills loaded in the container - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version: string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `content: array of BetaContentBlock` 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)"}] ``` - `BetaTextBlock object` - `type: "text"` default: text - `citations: array of BetaTextCitation or null` 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`. - `BetaCitationCharLocation object` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string or null` - `end_char_index: number` - `file_id: string or null` - `start_char_index: number` minimum: 0 - `BetaCitationPageLocation object` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string or null` - `end_page_number: number` - `file_id: string or null` - `start_page_number: number` minimum: 1 - `BetaCitationContentBlockLocation object` - `type: "content_block_location"` default: content_block_location - `cited_text: 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. - `document_index: number` minimum: 0 - `document_title: string or null` - `end_block_index: number` 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`. - `file_id: string or null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `BetaCitationsWebSearchResultLocation object` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string or null` maxLength: 512 - `url: string` - `BetaCitationSearchResultLocation object` - `type: "search_result_location"` default: search_result_location - `cited_text: 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. - `end_block_index: number` 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`. - `search_result_index: number` 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. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string or null` - `text: string` - `BetaThinkingBlock object` - `type: "thinking"` default: thinking - `signature: string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details. - `thinking: string` The text of Claude's thinking process for this block. - `BetaRedactedThinkingBlock object` - `type: "redacted_thinking"` default: redacted_thinking - `data: string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http#redacted-thinking-blocks) for details. - `BetaToolUseBlock object` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: map[unknown]` - `name: string` minLength: 1 - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `type: "direct"` - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaServerToolCaller20260120 object` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `toolset_name: optional string or null` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `BetaServerToolUseBlock object` - `type: "server_tool_use"` default: server_tool_use - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: map[unknown]` - `name: "advisor" or "web_search" or "web_fetch" or 5 more` - `"advisor"` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaWebSearchToolResultBlock object` - `type: "web_search_tool_result"` default: web_search_tool_result - `content: BetaWebSearchToolResultBlockContent` - `BetaWebSearchToolResultError object` - `type: "web_search_tool_result_error"` default: web_search_tool_result_error - `error_code: BetaWebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `array of BetaWebSearchResultBlock` - `type: "web_search_result"` default: web_search_result - `encrypted_content: string` - `page_age: string or null` - `title: string` - `url: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaWebFetchToolResultBlock object` - `type: "web_fetch_tool_result"` default: web_fetch_tool_result - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - `BetaWebFetchToolResultErrorBlock object` - `type: "web_fetch_tool_result_error"` default: web_fetch_tool_result_error - `error_code: BetaWebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `BetaWebFetchBlock object` - `type: "web_fetch_result"` default: web_fetch_result - `content: BetaDocumentBlock` - `type: "document"` default: document - `citations: BetaCitationConfig or null` Citation configuration for the document - `enabled: boolean` default: false - `source: BetaBase64PDFSource or BetaPlainTextSource` - `BetaBase64PDFSource object` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `BetaPlainTextSource object` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `title: string or null` The title of the document - `retrieved_at: string or null` ISO 8601 timestamp when the content was retrieved - `url: string` Fetched content URL - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaAdvisorToolResultBlock object` - `type: "advisor_tool_result"` default: advisor_tool_result - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - `BetaAdvisorToolResultError object` - `type: "advisor_tool_result_error"` default: advisor_tool_result_error - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 4 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `"model_not_found"` - `BetaAdvisorResultBlock object` - `type: "advisor_result"` default: advisor_result - `stop_reason: string or null` 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` - `BetaAdvisorRedactedResultBlock object` - `type: "advisor_redacted_result"` default: advisor_redacted_result - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string or null` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCodeExecutionToolResultBlock object` - `type: "code_execution_tool_result"` default: code_execution_tool_result - `content: BetaCodeExecutionToolResultBlockContent` - `BetaCodeExecutionToolResultError object` - `type: "code_execution_tool_result_error"` default: code_execution_tool_result_error - `error_code: BetaCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `BetaCodeExecutionResultBlock object` - `type: "code_execution_result"` default: code_execution_result - `content: array of BetaCodeExecutionOutputBlock` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `BetaEncryptedCodeExecutionResultBlock object` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` default: encrypted_code_execution_result - `content: array of BetaCodeExecutionOutputBlock` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaBashCodeExecutionToolResultBlock object` - `type: "bash_code_execution_tool_result"` default: bash_code_execution_tool_result - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - `BetaBashCodeExecutionToolResultError object` - `type: "bash_code_execution_tool_result_error"` default: bash_code_execution_tool_result_error - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `BetaBashCodeExecutionResultBlock object` - `type: "bash_code_execution_result"` default: bash_code_execution_result - `content: array of BetaBashCodeExecutionOutputBlock` - `type: "bash_code_execution_output"` default: bash_code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaTextEditorCodeExecutionToolResultBlock object` - `type: "text_editor_code_execution_tool_result"` default: text_editor_code_execution_tool_result - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - `BetaTextEditorCodeExecutionToolResultError object` - `type: "text_editor_code_execution_tool_result_error"` default: text_editor_code_execution_tool_result_error - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message: string or null` - `BetaTextEditorCodeExecutionViewResultBlock object` - `type: "text_editor_code_execution_view_result"` default: text_editor_code_execution_view_result - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number or null` - `start_line: number or null` - `total_lines: number or null` - `BetaTextEditorCodeExecutionCreateResultBlock object` - `type: "text_editor_code_execution_create_result"` default: text_editor_code_execution_create_result - `is_file_update: boolean` - `BetaTextEditorCodeExecutionStrReplaceResultBlock object` - `type: "text_editor_code_execution_str_replace_result"` default: text_editor_code_execution_str_replace_result - `lines: array of string or null` - `new_lines: number or null` - `new_start: number or null` - `old_lines: number or null` - `old_start: number or null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaToolSearchToolResultBlock object` - `type: "tool_search_tool_result"` default: tool_search_tool_result - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - `BetaToolSearchToolResultError object` - `type: "tool_search_tool_result_error"` default: tool_search_tool_result_error - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message: string or null` - `BetaToolSearchToolSearchResultBlock object` - `type: "tool_search_tool_search_result"` default: tool_search_tool_search_result - `tool_references: array of BetaToolReferenceBlock` - `type: "tool_reference"` default: tool_reference - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaMCPToolUseBlock object` - `type: "mcp_tool_use"` default: mcp_tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: map[unknown]` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `BetaMCPToolResultBlock object` - `type: "mcp_tool_result"` default: mcp_tool_result - `content: string or array of BetaTextBlock` - `string` - `BetaMCPToolResultBlockContent = array of BetaTextBlock` - `type: "text"` default: text - `citations: array of BetaTextCitation or null` 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` - `is_error: boolean` default: false - `tool_use_id: string` pattern: ^[a-zA-Z0-9_-]+$ - `BetaContainerUploadBlock object` Response model for a file uploaded to the container. - `type: "container_upload"` default: container_upload - `file_id: string` - `BetaCompactionBlock object` 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. - `type: "compaction"` default: compaction - `content: string or null` Summary of compacted content, or null if compaction failed - `encrypted_content: string or null` Opaque metadata from prior compaction, to be round-tripped verbatim - `signature: optional string or null` Signature over the summary, to be sent back with the block verbatim - `tool_changes: optional array of BetaResponseToolAdditionBlock or BetaResponseToolRemovalBlock or null` The tool changes of the compacted range: the `tool_addition` and `tool_removal` blocks that take the request's `tools` to the tool set in effect at the end of the range, or `[]` when the range changed no tool. Absent when the server did not compute them. Send the block back unchanged. - `BetaResponseToolAdditionBlock object` An entry of a `compaction` block's `tool_changes`: a tool the compacted range made available, as a reference to a `tools` entry or MCP toolset, or as the tool definition in effect at the end of the range, by value. Send it back unchanged. - `type: "tool_addition"` default: tool_addition - `tool: BetaResponseToolChangeToolReference or BetaResponseToolChangeMCPToolReference or BetaResponseToolChangeMCPToolsetReference or BetaToolChangeToolDefinition` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `BetaResponseToolChangeToolReference object` Reference to a single tool, by the name the model uses to call it, as a `compaction` block's `tool_changes` entry reports it: a tool declared in `tools` or defined by an earlier `tool_addition` block. Send it back unchanged with the block. - `type: "tool_reference"` default: tool_reference - `name: string` - `BetaResponseToolChangeMCPToolReference object` Reference to a single MCP tool, by its server and its name on that server, as a `compaction` block's `tool_changes` entry reports it. Send it back unchanged with the block. - `type: "mcp_tool_reference"` default: mcp_tool_reference - `name: string` - `server_name: string` - `BetaResponseToolChangeMCPToolsetReference object` Reference to every tool in the named MCP server's toolset, as a `compaction` block's `tool_changes` entry reports it. Send it back unchanged with the block. - `type: "mcp_toolset_reference"` default: mcp_toolset_reference - `server_name: string` - `BetaToolChangeToolDefinition object` A tool defined by value, as a `compaction` block's `tool_changes` entry reports it: `definition` is the tool's definition as it was sent, in the form of a `tools` entry, without `cache_control`. Send it back unchanged with the block. - `type: "tool_definition"` default: tool_definition - `definition: BetaResponseToolUnion` - `BetaResponseTool object` A custom tool definition, as sent. - `type: optional "custom" or null` - `input_schema: BetaResponseToolInputSchema` [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"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description: optional string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `eager_input_streaming: optional boolean or null` 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. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolBash20241022 object` - `type: "bash_20241022"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl: optional "5m" or "1h"` 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`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http) for details. - `"5m"` - `"1h"` - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolBash20250124 object` - `type: "bash_20250124"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250522 object` - `type: "code_execution_20250522"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250825 object` - `type: "code_execution_20250825"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20260120 object` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type: "code_execution_20260120"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20260521 object` Code execution tool with REPL state persistence. - `type: "code_execution_20260521"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaBrowserToolset20260801 object` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `type: "browser_toolset_20260801"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional BetaBrowserToolsetConfigs or null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type: optional BetaBrowserTypeConfig or null` `type`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `close_tab: optional BetaBrowserCloseTabConfig or null` `close_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click: optional BetaBrowserDoubleClickConfig or null` `double_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `file_upload: optional BetaBrowserFileUploadConfig or null` `file_upload`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `find: optional BetaBrowserFindConfig or null` `find`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `form_input: optional BetaBrowserFormInputConfig or null` `form_input`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `get_page_text: optional BetaBrowserGetPageTextConfig or null` `get_page_text`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key: optional BetaBrowserHoldKeyConfig or null` `hold_key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hover: optional BetaBrowserHoverConfig or null` `hover`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `javascript_exec: optional BetaBrowserJavascriptExecConfig or null` `javascript_exec`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key: optional BetaBrowserKeyConfig or null` `key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click: optional BetaBrowserLeftClickConfig or null` `left_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag: optional BetaBrowserLeftClickDragConfig or null` `left_click_drag`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down: optional BetaBrowserLeftMouseDownConfig or null` `left_mouse_down`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up: optional BetaBrowserLeftMouseUpConfig or null` `left_mouse_up`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `list_tabs: optional BetaBrowserListTabsConfig or null` `list_tabs`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click: optional BetaBrowserMiddleClickConfig or null` `middle_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move: optional BetaBrowserMouseMoveConfig or null` `mouse_move`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `navigate: optional BetaBrowserNavigateConfig or null` `navigate`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `new_tab: optional BetaBrowserNewTabConfig or null` `new_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_console: optional BetaBrowserReadConsoleConfig or null` `read_console`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_network: optional BetaBrowserReadNetworkConfig or null` `read_network`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_page: optional BetaBrowserReadPageConfig or null` `read_page`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click: optional BetaBrowserRightClickConfig or null` `right_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot: optional BetaBrowserScreenshotConfig or null` `screenshot`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll: optional BetaBrowserScrollConfig or null` `scroll`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll_to: optional BetaBrowserScrollToConfig or null` `scroll_to`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `switch_tab: optional BetaBrowserSwitchTabConfig or null` `switch_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click: optional BetaBrowserTripleClickConfig or null` `triple_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait: optional BetaBrowserWaitConfig or null` `wait`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom: optional BetaBrowserZoomConfig or null` `zoom`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaToolComputerUse20241022 object` - `type: "computer_20241022"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaMemoryTool20250818 object` - `type: "memory_20250818"` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20250124 object` - `type: "computer_20250124"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20241022 object` - `type: "text_editor_20241022"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20251124 object` - `type: "computer_20251124"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `enable_zoom: optional boolean` Whether to enable an action to take a zoomed-in screenshot of the screen. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaComputerToolset20260801 object` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `type: "computer_toolset_20260801"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional BetaComputerToolsetConfigs or null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type: optional BetaComputerTypeConfig or null` `type`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `cursor_position: optional BetaComputerCursorPositionConfig or null` `cursor_position`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click: optional BetaComputerDoubleClickConfig or null` `double_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key: optional BetaComputerHoldKeyConfig or null` `hold_key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key: optional BetaComputerKeyConfig or null` `key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click: optional BetaComputerLeftClickConfig or null` `left_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag: optional BetaComputerLeftClickDragConfig or null` `left_click_drag`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down: optional BetaComputerLeftMouseDownConfig or null` `left_mouse_down`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up: optional BetaComputerLeftMouseUpConfig or null` `left_mouse_up`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click: optional BetaComputerMiddleClickConfig or null` `middle_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move: optional BetaComputerMouseMoveConfig or null` `mouse_move`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click: optional BetaComputerRightClickConfig or null` `right_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot: optional BetaComputerScreenshotConfig or null` `screenshot`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll: optional BetaComputerScrollConfig or null` `scroll`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click: optional BetaComputerTripleClickConfig or null` `triple_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait: optional BetaComputerWaitConfig or null` `wait`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom: optional BetaComputerZoomConfig or null` `zoom`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaToolTextEditor20250124 object` - `type: "text_editor_20250124"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250429 object` - `type: "text_editor_20250429"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250728 object` - `type: "text_editor_20250728"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `max_characters: optional number or null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebSearchTool20250305 object` - `type: "web_search_20250305"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city: optional string or null` The city of the user. minLength: 1, maxLength: 255 - `country: optional string or null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `region: optional string or null` The region of the user. minLength: 1, maxLength: 255 - `timezone: optional string or null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `BetaWebFetchTool20250910 object` - `type: "web_fetch_20250910"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `enabled: optional boolean` - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `BetaWebFetchURLSourceOnly object` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: array of BetaWebFetchURLSourceToolReference` - `type: "tool_reference"` - `name: string` - `BetaWebFetchURLSourceExcept object` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: array of BetaWebFetchURLSourceToolReference` - `type: "tool_reference"` - `name: string` - `server_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `BetaWebFetchURLSourceOnly object` The tool filter variant under which only the named tools' results contribute. - `BetaWebFetchURLSourceExcept object` The tool filter variant under which every result but the named tools' contributes. - `user_input: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `BetaWebSearchTool20260209 object` - `type: "web_search_20260209"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `BetaWebFetchTool20260209 object` - `type: "web_fetch_20260209"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `BetaWebFetchTool20260309 object` Web fetch tool with use_cache parameter for bypassing cached content. - `type: "web_fetch_20260309"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache: optional boolean` 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. - `BetaWebSearchTool20260318 object` - `type: "web_search_20260318"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion: optional "full" or "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `BetaWebFetchTool20260318 object` - `type: "web_fetch_20260318"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion: optional "full" or "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache: optional boolean` 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. - `BetaAdvisorTool20260301 object` - `type: "advisor_20260301"` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-mythos-5"` Most capable model for cybersecurity and biology research - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `name: "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caching: optional BetaCacheControlEphemeral or null` 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. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_tokens: optional number or null` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolBm25_20251119 object` - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolRegex20251119 object` - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaMCPToolset object` 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. - `type: "mcp_toolset"` - `mcp_server_name: string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional map[BetaMCPToolConfig] or null` Configuration overrides for specific tools, keyed by tool name - `defer_loading: optional boolean` - `enabled: optional boolean` - `default_config: optional BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `defer_loading: optional boolean` - `enabled: optional boolean` - `tools: optional array of BetaMCPToolParam or null` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `input_schema: map[unknown]` The tool's input schema as the MCP server lists it, verbatim. - `name: string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `description: optional string or null` The tool's description as the MCP server lists it. - `BetaResponseToolRemovalBlock object` An entry of a `compaction` block's `tool_changes`: a tool of the request's `tools` (or an MCP tool or toolset) that the compacted range withdrew. Send it back unchanged. - `type: "tool_removal"` default: tool_removal - `tool: BetaResponseToolChangeToolReference or BetaResponseToolChangeMCPToolReference or BetaResponseToolChangeMCPToolsetReference` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `BetaResponseToolChangeToolReference object` Reference to a single tool, by the name the model uses to call it, as a `compaction` block's `tool_changes` entry reports it: a tool declared in `tools` or defined by an earlier `tool_addition` block. Send it back unchanged with the block. - `BetaResponseToolChangeMCPToolReference object` Reference to a single MCP tool, by its server and its name on that server, as a `compaction` block's `tool_changes` entry reports it. Send it back unchanged with the block. - `BetaResponseToolChangeMCPToolsetReference object` Reference to every tool in the named MCP server's toolset, as a `compaction` block's `tool_changes` entry reports it. Send it back unchanged with the block. - `BetaFallbackBlock object` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `type: "fallback"` default: fallback - `from: BetaFallbackInfo` The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id. - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `to: BetaFallbackInfo` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `trigger: BetaFallbackRefusalTrigger` What caused the `from` model to hand over at this hop. - `type: "refusal"` default: refusal - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null` The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.category`. - `"cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `"bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `"frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `"reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=http). - `"general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `BetaMCPToolListingBlock object` The tool listing the server fetched from an MCP server while producing this response. Send the assistant message back unchanged, this block included, so later requests use this listing instead of asking the MCP server again. - `type: "mcp_tool_listing"` default: mcp_tool_listing - `mcp_server_name: string` - `tools: array of BetaMCPTool` - `input_schema: map[unknown]` - `name: string` - `description: optional string` - `context_management: BetaContextManagementResponse or null` Context management response. Information about context management strategies applied during the request. - `applied_edits: array of BetaClearToolUses20250919EditResponse or BetaClearThinking20251015EditResponse` List of context management edits that were applied. - `BetaClearToolUses20250919EditResponse object` - `type: "clear_tool_uses_20250919"` The type of context management edit applied. default: clear_tool_uses_20250919 - `cleared_input_tokens: number` Number of input tokens cleared by this edit. minimum: 0 - `cleared_tool_uses: number` Number of tool uses that were cleared. minimum: 0 - `BetaClearThinking20251015EditResponse object` - `type: "clear_thinking_20251015"` The type of context management edit applied. default: clear_thinking_20251015 - `cleared_input_tokens: number` Number of input tokens cleared by this edit. minimum: 0 - `cleared_thinking_turns: number` Number of thinking turns that were cleared. minimum: 0 - `diagnostics: BetaDiagnostics or null` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `cache_miss_reason: BetaCacheMissReason or null` 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. - `BetaCacheMissModelChanged object` - `type: "model_changed"` default: model_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `BetaCacheMissSystemChanged object` - `type: "system_changed"` default: system_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `BetaCacheMissToolsChanged object` - `type: "tools_changed"` default: tools_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `BetaCacheMissMessagesChanged object` - `type: "messages_changed"` default: messages_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `BetaCacheMissPreviousMessageNotFound object` - `type: "previous_message_not_found"` default: previous_message_not_found - `BetaCacheMissUnavailable object` - `type: "unavailable"` default: 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. - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. default: assistant - `stop_details: BetaRefusalStopDetails or null` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `type: "refusal"` default: refusal - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `"bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `"frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `"reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=http). - `"general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `explanation: string or null` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `fallback_credit_token: string or null` Opaque code that refunds the cache-miss cost when retrying this refused request on the fallback model. Pass it as `fallback_credit_token` on the retry request. Expires 5 minutes after the refusal. The retry is sent either with the same request body (`system`, `messages`, `tools`, and other render-shaping fields), or with the same body plus one appended `assistant` message whose content is the partial text (with any trailing whitespace stripped from the final text block) and paired server-tool blocks from this refusal — which also authorizes that appended turn as an assistant-prefill continuation on models that otherwise disallow prefill. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed the second way — if a same-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry the second way instead. Either way: same workspace, same platform; a mismatch is a 400. Resending a token for an already-warm prefix is permitted but yields no additional credit. `null` when the refused model isn't eligible for a fallback credit. - `fallback_has_prefill_claim: boolean or null` Whether the accompanying `fallback_credit_token` may be redeemed with the appended-assistant retry form. Only set when `fallback_credit_token` is present. `true`: retry by resending the same request body plus one appended `assistant` message whose content is this response's `content` with any trailing whitespace stripped from the final text block and unpaired `tool_use` blocks omitted (the same appended-turn shape described on `fallback_credit_token`), with the token attached. `false`: retry by resending the original request body unchanged, with the token attached — the appended-assistant form is not available for this refusal (no continuable partial content, or the request uses `output_format` or a `tool_choice` that forces tool use). One exception: when the request used `output_format` or a forced `tool_choice` and the refusal arrived after server tools (including MCP connector tools) had already executed, the token may not be redeemable by either retry form; if the exact-body retry is then rejected with a 400 saying the token must be redeemed by continuing the partial response, discard the token and retry without it. Advisory: if an appended-assistant retry is rejected with a 400 despite `true`, fall back to resending the original request body with the token. - `recommended_model: string or null` The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise. - `stop_reason: BetaStopReason or null` 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 * `"model_context_window_exceeded"`: we exceeded the model's context window 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. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string or null` 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. - `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`. - `cache_creation: BetaCacheCreation or null` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `cache_creation_input_tokens: number or null` The number of input tokens used to create the cache entry. minimum: 0 - `cache_read_input_tokens: number or null` The number of input tokens read from the cache. minimum: 0 - `fallback_credit: BetaFallbackCreditUsage or null` Outcome of the `fallback_credit_token` presented on this request. Present on every response to a non-batch request that carried a `fallback_credit_token`, in either redemption mode; absent otherwise (batch items accept and ignore the token and carry no outcome object). - `status: BetaFallbackCreditRedeemed or BetaFallbackCreditNotApplied` Whether the fallback-credit reprice was applied to this response's billing. A union discriminated on `type`. `redeemed`: the retry is billed as if the conversation had been on the retry model all along — including when the resulting shift is zero because there was nothing to move. `not_applied`: no reprice was applied; the arm's `reason` says why. - `BetaFallbackCreditRedeemed object` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `type: "redeemed"` default: redeemed - `BetaFallbackCreditNotApplied object` No reprice was applied; `reason` says why. - `type: "not_applied"` default: not_applied - `reason: "body_mismatch" or "continuation_excluded" or "continuation_only" or 9 more` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `"body_mismatch"` - `"continuation_excluded"` - `"continuation_only"` - `"expired"` - `"invalid_target_model"` - `"not_enabled"` - `"reprice_unavailable"` - `"temporarily_unavailable"` - `"variant_fields_present"` - `"wrong_organization"` - `"wrong_platform"` - `"wrong_workspace"` - `remove_to_redeem: optional array of string or null` Request fields to remove before retrying, so the retry can redeem this token. Present exactly when `reason` is `variant_fields_present` — never null, never an empty array; absent otherwise. Fields are named only from your own request, and only after the sealed variant hash matched. A served best-effort retry has already been billed at normal price; nothing redeems retroactively, but a corrected re-send inside the token's five-minute window can still redeem. - `inference_geo: string or null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `iterations: BetaIterationsUsage or null` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. - `BetaMessageIterationUsage object` Token usage for a sampling iteration. - `type: "message"` Usage for a sampling iteration default: message - `cache_creation: BetaCacheCreation or null` Breakdown of cached tokens by TTL - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `cache_read_input_tokens: number` The number of input tokens read from the cache. default: 0, minimum: 0 - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `model: Model or null` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `BetaCompactionIterationUsage object` Token usage for a compaction iteration. - `type: "compaction"` Usage for a compaction iteration default: compaction - `cache_creation: BetaCacheCreation or null` Breakdown of cached tokens by TTL - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `cache_read_input_tokens: number` The number of input tokens read from the cache. default: 0, minimum: 0 - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `BetaAdvisorMessageIterationUsage object` Token usage for an advisor sub-inference iteration. - `type: "advisor_message"` Usage for an advisor sub-inference iteration default: advisor_message - `cache_creation: BetaCacheCreation or null` Breakdown of cached tokens by TTL - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `cache_read_input_tokens: number` The number of input tokens read from the cache. default: 0, minimum: 0 - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `BetaFallbackMessageIterationUsage object` Token usage for the fallback-model attempt of a server-side fallback request. The terminal entry of a fallback-served turn: when a fallback hop's output is the returned message, the entry for the iteration that completed it carries this type in place of `message`. A declined hop and the serving hop's earlier tool-loop iterations produce `message` entries. Whether a fallback model served the response is signalled by the presence of this entry in `usage.iterations`. - `type: "fallback_message"` Usage for the fallback-model attempt that served the response default: fallback_message - `cache_creation: BetaCacheCreation or null` Breakdown of cached tokens by TTL - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `cache_read_input_tokens: number` The number of input tokens read from the cache. default: 0, minimum: 0 - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `output_tokens_details: BetaOutputTokensDetails or null` 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. - `thinking_tokens: number` 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. default: 0, minimum: 0 - `server_tool_use: BetaServerToolUsage or null` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. default: 0, minimum: 0 - `web_search_requests: number` The number of web search tool requests. default: 0, minimum: 0 - `service_tier: "standard" or "priority" or "batch" or null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" or "fast" or null` The inference speed mode used for this request. - `"standard"` - `"fast"` - `input_transformations: optional array of BetaInputTransformation or null` Changes the API made to the request's input before showing it to the model, and blocks that failed a binding check but were left unchanged: one entry per block, in request order. Two entry types today. `thinking_dropped` — a `thinking`, `redacted_thinking` or `connector_text` block from the request's `messages` that was removed from the prompt instead of being shown to the model because it failed a binding check. `thinking_mismatch_allowed` — a `thinking` or `redacted_thinking` block that failed the conversation check (the conversation before it differs from the one it was created in, or it carries no record of one on a model that requires it) and was shown to the model all the same, because that check is not enforced for this request. More entry types may be added over time; ignore types you do not recognize. Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on every such response from a model that supports extended thinking, as `[]` when there is no entry to report; without the beta, blocks are removed or left in place all the same but nothing is reported. Removed blocks contribute nothing to `usage.input_tokens`; blocks left in place count as sent. When streaming, the array is final in `message_start`; the final `message_delta` event carries it only when a server-side model fallback happened mid-stream, in which case it holds the serving model's entries and replaces the one in `message_start`. - `BetaThinkingDroppedInputTransformation object` - `type: "thinking_dropped"` Always `thinking_dropped` for this entry type. default: thinking_dropped - `path: string` Where the removed block was in your request, as `messages.{i}.content.{j}`: `i` indexes the `messages` array you sent and `j` that message's `content` array — the same form error messages use. - `reason: "model_binding_mismatch" or "prefix_binding_mismatch" or "organization_binding_mismatch" or "end_user_binding_mismatch"` Which binding check removed the block: `model_binding_mismatch` — it was created by a model whose reasoning the requested model may not read; `prefix_binding_mismatch` — the conversation before it differs from the conversation it was created in (the rest of that turn's consecutive thinking blocks are removed with it, each with this reason); `organization_binding_mismatch` — it was created under a different organization (an Anthropic organization, AWS account or Google Cloud project) and this organization is not one of its additional organizations; `end_user_binding_mismatch` — it was created for a different end user, or was removed by the consumer-organization binding. A block that would fail several checks reports one reason, in this order of precedence: `organization_binding_mismatch`, `end_user_binding_mismatch`, `model_binding_mismatch`, `prefix_binding_mismatch`. - `"model_binding_mismatch"` - `"prefix_binding_mismatch"` - `"organization_binding_mismatch"` - `"end_user_binding_mismatch"` - `BetaThinkingMismatchAllowedInputTransformation object` - `type: "thinking_mismatch_allowed"` Always `thinking_mismatch_allowed` for this entry type. default: thinking_mismatch_allowed - `path: string` Where the block is in your request, as `messages.{i}.content.{j}`: `i` indexes the `messages` array you sent and `j` that message's `content` array — the same form error messages use. - `reason: "model_binding_mismatch" or "prefix_binding_mismatch" or "organization_binding_mismatch" or "end_user_binding_mismatch"` Which binding check the block failed; the block was shown to the model all the same. Always `prefix_binding_mismatch` today — the conversation before the block differs from the conversation it was created in, or the block carries no record of one on a model that requires it. Were the check enforced for this request, the block would have been removed or the request rejected (`thinking.block_binding.prefix_mismatch_behavior`). A removal also takes the rest of that turn's consecutive thinking blocks, whereas here each block is checked on its own, so `thinking_mismatch_allowed` entries are a lower bound on what enforcement would remove. - `"model_binding_mismatch"` - `"prefix_binding_mismatch"` - `"organization_binding_mismatch"` - `"end_user_binding_mismatch"` - `BetaRawMessageStreamEvent = BetaRawMessageStartEvent or BetaRawMessageDeltaEvent or BetaRawMessageStopEvent or 3 more` - `BetaRawMessageStartEvent object` - `type: "message_start"` default: message_start - `message: BetaMessage` - `BetaRawMessageDeltaEvent object` - `type: "message_delta"` default: message_delta - `context_management: BetaContextManagementResponse or null` Information about context management strategies applied during the request - `delta: object` - `container: BetaContainer or null` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `stop_details: BetaRefusalStopDetails or null` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `stop_reason: BetaStopReason or null` - `stop_sequence: string or null` - `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`. - `cache_creation_input_tokens: number or null` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `cache_read_input_tokens: number or null` The cumulative number of input tokens read from the cache. minimum: 0 - `fallback_credit: BetaFallbackCreditUsage or null` Outcome of the `fallback_credit_token` presented on this request. Present on every response to a non-batch request that carried a `fallback_credit_token`, in either redemption mode; absent otherwise (batch items accept and ignore the token and carry no outcome object). - `input_tokens: number or null` The cumulative number of input tokens which were used. minimum: 0 - `iterations: BetaIterationsUsage or null` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. - `output_tokens: number` The cumulative number of output tokens which were used. - `output_tokens_details: BetaOutputTokensDetails or null` 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. - `server_tool_use: BetaServerToolUsage or null` The number of server tool requests. - `input_transformations: optional array of BetaInputTransformation or null` Changes the API made to the request's input before showing it to the model, and blocks that failed a binding check but were left unchanged: one entry per block, in request order. Two entry types today. `thinking_dropped` — a `thinking`, `redacted_thinking` or `connector_text` block from the request's `messages` that was removed from the prompt instead of being shown to the model because it failed a binding check. `thinking_mismatch_allowed` — a `thinking` or `redacted_thinking` block that failed the conversation check (the conversation before it differs from the one it was created in, or it carries no record of one on a model that requires it) and was shown to the model all the same, because that check is not enforced for this request. More entry types may be added over time; ignore types you do not recognize. Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on every such response from a model that supports extended thinking, as `[]` when there is no entry to report; without the beta, blocks are removed or left in place all the same but nothing is reported. Removed blocks contribute nothing to `usage.input_tokens`; blocks left in place count as sent. When streaming, the array is final in `message_start`; the final `message_delta` event carries it only when a server-side model fallback happened mid-stream, in which case it holds the serving model's entries and replaces the one in `message_start`. - `BetaThinkingDroppedInputTransformation object` - `BetaThinkingMismatchAllowedInputTransformation object` - `BetaRawMessageStopEvent object` - `type: "message_stop"` default: message_stop - `BetaRawContentBlockStartEvent object` - `type: "content_block_start"` default: content_block_start - `content_block: BetaTextBlock or BetaThinkingBlock or BetaRedactedThinkingBlock or 15 more` - `BetaTextBlock object` - `BetaThinkingBlock object` - `BetaRedactedThinkingBlock object` - `BetaToolUseBlock object` - `BetaServerToolUseBlock object` - `BetaWebSearchToolResultBlock object` - `BetaWebFetchToolResultBlock object` - `BetaAdvisorToolResultBlock object` - `BetaCodeExecutionToolResultBlock object` - `BetaBashCodeExecutionToolResultBlock object` - `BetaTextEditorCodeExecutionToolResultBlock object` - `BetaToolSearchToolResultBlock object` - `BetaMCPToolUseBlock object` - `BetaMCPToolResultBlock object` - `BetaContainerUploadBlock object` Response model for a file uploaded to the container. - `BetaCompactionBlock object` 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. - `BetaFallbackBlock object` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `BetaMCPToolListingBlock object` The tool listing the server fetched from an MCP server while producing this response. Send the assistant message back unchanged, this block included, so later requests use this listing instead of asking the MCP server again. - `index: number` - `BetaRawContentBlockDeltaEvent object` - `type: "content_block_delta"` default: content_block_delta - `delta: BetaRawContentBlockDelta` - `BetaTextDelta object` - `type: "text_delta"` default: text_delta - `text: string` - `BetaInputJSONDelta object` - `type: "input_json_delta"` default: input_json_delta - `partial_json: string` - `BetaCitationsDelta object` - `type: "citations_delta"` default: citations_delta - `citation: BetaCitationCharLocation or BetaCitationPageLocation or BetaCitationContentBlockLocation or 2 more` - `BetaCitationCharLocation object` - `BetaCitationPageLocation object` - `BetaCitationContentBlockLocation object` - `BetaCitationsWebSearchResultLocation object` - `BetaCitationSearchResultLocation object` - `BetaThinkingDelta object` - `type: "thinking_delta"` default: thinking_delta - `estimated_tokens: number or null` 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` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. - `BetaSignatureDelta object` - `type: "signature_delta"` default: signature_delta - `signature: string` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. - `BetaCompactionContentBlockDelta object` - `type: "compaction_delta"` default: compaction_delta - `content: string or null` - `encrypted_content: string or null` Opaque metadata from prior compaction, to be round-tripped verbatim - `index: number` - `BetaRawContentBlockStopEvent object` - `type: "content_block_stop"` default: content_block_stop - `index: number` #### Example ```bash curl https://api.anthropic.com/v1/messages \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ --max-time 600 \ -d '{ "max_tokens": 1024, "messages": [ { "content": "Hello, world", "role": "user" } ], "model": "claude-opus-5-5", "stream": false, "system": [ { "text": "Today'\''s date is 2024-06-01.", "type": "text" } ], "temperature": 1, "thinking": { "type": "adaptive" }, "tools": [ { "input_schema": { "type": "object", "properties": { "location": "bar", "unit": "bar" }, "required": [ "location" ] }, "name": "name" } ], "top_k": 5, "top_p": 0.7 }' ``` ##### Response (200) ```json { "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF", "container": { "id": "container_011CpZohnwH4vuy7gazohgSP", "expires_at": "2019-12-27T18:11:19.117Z", "skills": [ { "skill_id": "pdf", "type": "anthropic", "version": "latest" } ] }, "content": [ { "citations": [ { "cited_text": "The grass is green. The sky is blue.", "document_index": 0, "document_title": "My Document", "end_char_index": 0, "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "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-5-5", "role": "assistant", "stop_details": { "category": "cyber", "explanation": "This request was declined because it conflicts with Anthropic's Usage Policy.", "fallback_credit_token": "QW50aHJvcGljL0NsYXVkZQ==", "fallback_has_prefill_claim": true, "recommended_model": "claude-opus-4-8", "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, "fallback_credit": { "status": { "type": "redeemed" } }, "inference_geo": "global", "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, "model": "claude-haiku-5-5", "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" }, "input_transformations": [ { "path": "path", "reason": "model_binding_mismatch", "type": "thinking_dropped" } ] } ``` ### Count tokens in a Message **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://platform.claude.com/docs/en/build-with-claude/token-counting?sdk_languages=http) #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-user-profile-id": optional string` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `messages: array of BetaMessageParam` 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. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=http#prefill-not-supported). 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, for models that support prefill: ```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://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=http). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role), 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: string or array of BetaContentBlockParam` - `string` - `array of BetaContentBlockParam` - `BetaTextBlockParam object` - `type: "text"` - `text: string` minLength: 1 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl: optional "5m" or "1h"` 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`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http) for details. - `"5m"` - `"1h"` - `citations: optional array of BetaTextCitationParam or null` - `BetaCitationCharLocationParam object` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string or null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `BetaCitationPageLocationParam object` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string or null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `BetaCitationContentBlockLocationParam object` - `type: "content_block_location"` - `cited_text: 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. - `document_index: number` minimum: 0 - `document_title: string or null` minLength: 1, maxLength: 500 - `end_block_index: number` 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`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `BetaCitationWebSearchResultLocationParam object` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string or null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `BetaCitationSearchResultLocationParam object` - `type: "search_result_location"` - `cited_text: 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. - `end_block_index: number` 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`. - `search_result_index: number` 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. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string or null` - `BetaImageBlockParam object` - `type: "image"` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `BetaBase64ImageSource object` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `BetaURLImageSource object` - `type: "url"` - `url: string` - `BetaFileImageSource object` - `type: "file"` - `file_id: string` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `transformations: optional BetaImageTransformationsParam or null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image: optional "downsize" or "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` - `BetaRequestDocumentBlock object` - `type: "document"` - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` - `BetaBase64PDFSource object` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `BetaPlainTextSource object` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `BetaContentBlockSource object` - `type: "content"` - `content: string or array of BetaContentBlockSourceContent` - `string` - `BetaContentBlockSourceContent = array of BetaContentBlockSourceContent` - `BetaTextBlockParam object` - `BetaImageBlockParam object` - `BetaURLPDFSource object` - `type: "url"` - `url: string` - `BetaFileDocumentSource object` - `type: "file"` - `file_id: string` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` - `enabled: optional boolean` - `context: optional string or null` minLength: 1 - `title: optional string or null` minLength: 1, maxLength: 500 - `BetaSearchResultBlockParam object` - `type: "search_result"` - `content: array of BetaTextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam or null` - `source: string` - `title: string` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam` - `BetaThinkingBlockParam object` - `type: "thinking"` - `signature: string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `thinking: string` The `thinking` text of this block as returned by the API. - `BetaRedactedThinkingBlockParam object` - `type: "redacted_thinking"` - `data: string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `BetaToolUseBlockParam object` - `type: "tool_use"` - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: map[unknown]` - `name: string` minLength: 1, maxLength: 200 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `type: "direct"` - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaServerToolCaller20260120 object` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `toolset_name: optional string or null` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `BetaToolResultBlockParam object` - `type: "tool_result"` - `tool_use_id: string` pattern: ^[a-zA-Z0-9_-]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `content: optional string or array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 3 more` - `string` - `array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 3 more` - `BetaTextBlockParam object` - `BetaImageBlockParam object` - `BetaSearchResultBlockParam object` - `BetaRequestDocumentBlock object` - `BetaToolReferenceBlockParam object` Tool reference block that can be included in tool_result content. - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaBrowserStateBlockParam object` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `type: "browser_state"` - `tabs: array of BetaBrowserStateTabEntry` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `tab_id: string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `title: string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `active: optional boolean` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `state_changes: optional array of BetaBrowserStateChange or null` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `BetaBrowserStateChangeTabOpened object` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `type: "tab_opened"` - `tab_id: string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `BetaBrowserStateChangeDownloadStarted object` A file download that started during this call. - `type: "download_started"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `BetaBrowserStateChangeDownloadCompleted object` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `type: "download_completed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path: optional string or null` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `size_bytes: optional number or null` The completed download's size. minimum: 0 - `BetaBrowserStateChangeDownloadFailed object` A file download that failed — or was cancelled — during this call. - `type: "download_failed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `error: optional string or null` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `is_error: optional boolean` - `toolset_name: optional string or null` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `BetaServerToolUseBlockParam object` - `type: "server_tool_use"` - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: map[unknown]` - `name: "advisor" or "web_search" or "web_fetch" or 5 more` - `"advisor"` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaWebSearchToolResultBlockParam object` - `type: "web_search_tool_result"` - `content: BetaWebSearchToolResultBlockParamContent` - `ResultBlock = array of BetaWebSearchResultBlockParam` - `type: "web_search_result"` - `encrypted_content: string` - `title: string` - `url: string` - `page_age: optional string or null` - `BetaWebSearchToolRequestError object` - `type: "web_search_tool_result_error"` - `error_code: BetaWebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaWebFetchToolResultBlockParam object` - `type: "web_fetch_tool_result"` - `content: BetaWebFetchToolResultErrorBlockParam or BetaWebFetchBlockParam` - `BetaWebFetchToolResultErrorBlockParam object` - `type: "web_fetch_tool_result_error"` - `error_code: BetaWebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `BetaWebFetchBlockParam object` - `type: "web_fetch_result"` - `content: BetaRequestDocumentBlock` - `url: string` Fetched content URL - `retrieved_at: optional string or null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaAdvisorToolResultBlockParam object` - `type: "advisor_tool_result"` - `content: BetaAdvisorToolResultErrorParam or BetaAdvisorResultBlockParam or BetaAdvisorRedactedResultBlockParam` - `BetaAdvisorToolResultErrorParam object` - `type: "advisor_tool_result_error"` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 4 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `"model_not_found"` - `BetaAdvisorResultBlockParam object` - `type: "advisor_result"` - `text: string` - `stop_reason: optional string or null` - `BetaAdvisorRedactedResultBlockParam object` - `type: "advisor_redacted_result"` - `encrypted_content: string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `stop_reason: optional string or null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaCodeExecutionToolResultBlockParam object` - `type: "code_execution_tool_result"` - `content: BetaCodeExecutionToolResultBlockParamContent` - `BetaCodeExecutionToolResultErrorParam object` - `type: "code_execution_tool_result_error"` - `error_code: BetaCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `BetaCodeExecutionResultBlockParam object` - `type: "code_execution_result"` - `content: array of BetaCodeExecutionOutputBlockParam` - `type: "code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `BetaEncryptedCodeExecutionResultBlockParam object` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` - `content: array of BetaCodeExecutionOutputBlockParam` - `type: "code_execution_output"` - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaBashCodeExecutionToolResultBlockParam object` - `type: "bash_code_execution_tool_result"` - `content: BetaBashCodeExecutionToolResultErrorParam or BetaBashCodeExecutionResultBlockParam` - `BetaBashCodeExecutionToolResultErrorParam object` - `type: "bash_code_execution_tool_result_error"` - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `BetaBashCodeExecutionResultBlockParam object` - `type: "bash_code_execution_result"` - `content: array of BetaBashCodeExecutionOutputBlockParam` - `type: "bash_code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaTextEditorCodeExecutionToolResultBlockParam object` - `type: "text_editor_code_execution_tool_result"` - `content: BetaTextEditorCodeExecutionToolResultErrorParam or BetaTextEditorCodeExecutionViewResultBlockParam or BetaTextEditorCodeExecutionCreateResultBlockParam or BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `BetaTextEditorCodeExecutionToolResultErrorParam object` - `type: "text_editor_code_execution_tool_result_error"` - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message: optional string or null` - `BetaTextEditorCodeExecutionViewResultBlockParam object` - `type: "text_editor_code_execution_view_result"` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: optional number or null` - `start_line: optional number or null` - `total_lines: optional number or null` - `BetaTextEditorCodeExecutionCreateResultBlockParam object` - `type: "text_editor_code_execution_create_result"` - `is_file_update: boolean` - `BetaTextEditorCodeExecutionStrReplaceResultBlockParam object` - `type: "text_editor_code_execution_str_replace_result"` - `lines: optional array of string or null` - `new_lines: optional number or null` - `new_start: optional number or null` - `old_lines: optional number or null` - `old_start: optional number or null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaToolSearchToolResultBlockParam object` - `type: "tool_search_tool_result"` - `content: BetaToolSearchToolResultErrorParam or BetaToolSearchToolSearchResultBlockParam` - `BetaToolSearchToolResultErrorParam object` - `type: "tool_search_tool_result_error"` - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message: optional string or null` - `BetaToolSearchToolSearchResultBlockParam object` - `type: "tool_search_tool_search_result"` - `tool_references: array of BetaToolReferenceBlockParam` - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaMCPToolUseBlockParam object` - `type: "mcp_tool_use"` - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: map[unknown]` - `name: string` - `server_name: string` The name of the MCP server - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaRequestMCPToolResultBlockParam object` - `type: "mcp_tool_result"` - `tool_use_id: string` pattern: ^[a-zA-Z0-9_-]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `content: optional string or array of BetaTextBlockParam` - `string` - `BetaMCPToolResultBlockParamContent = array of BetaTextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam or null` - `is_error: optional boolean` - `BetaContainerUploadBlockParam object` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `type: "container_upload"` - `file_id: string` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaCompactionBlockParam object` 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"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `content: optional string or null` Summary of previously compacted content, or null if compaction failed - `encrypted_content: optional string or null` Opaque metadata from prior compaction, to be round-tripped verbatim - `signature: optional string or null` The block's signature as returned, to be sent back verbatim - `tool_changes: optional array of BetaRequestToolAdditionBlock or BetaRequestToolRemovalBlock or null` The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block. - `BetaRequestToolAdditionBlock object` Mid-conversation directive to make a tool available. `tool` is a reference to a tool (or MCP toolset) declared in the request's `tools`. Under the `inline-tools-2026-09-15` beta it may instead be a reference to a tool defined earlier in `messages`, or a `tool_definition` object that carries an inline tool definition in `definition` (the same object a `tools` entry holds). An `mcp_toolset` definition also requires the `mcp-client-2026-09-15` beta. The tool is offered to the model from this point in the conversation onward. - `type: "tool_addition"` - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference or BetaToolChangeToolDefinitionParam` - `BetaToolChangeToolReference object` Reference to a single tool, by the name the model uses to call it: a tool declared in `tools` or defined by an earlier `tool_addition` block. Does not accept the composed `{server}_{name}` form the server assigns to MCP-resolved tools; use `mcp_tool_reference` or `mcp_toolset_reference` for those. - `type: "tool_reference"` - `name: string` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `BetaToolChangeMCPToolReference object` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `type: "mcp_tool_reference"` - `name: string` - `server_name: string` - `BetaToolChangeMCPToolsetReference object` Reference to every tool in the named MCP server's toolset. - `type: "mcp_toolset_reference"` - `server_name: string` - `BetaToolChangeToolDefinitionParam object` A tool defined by value: `definition` is a `tools` entry (any kind `tools` accepts, an MCP toolset included). An `mcp_toolset` given here also requires the `mcp-client-2026-09-15` beta. - `type: "tool_definition"` - `definition: BetaToolUnion` - `BetaTool object` - `type: optional "custom" or null` - `input_schema: object` [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"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description: optional string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `eager_input_streaming: optional boolean or null` 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. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolBash20241022 object` - `type: "bash_20241022"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolBash20250124 object` - `type: "bash_20250124"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250522 object` - `type: "code_execution_20250522"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250825 object` - `type: "code_execution_20250825"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20260120 object` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type: "code_execution_20260120"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20260521 object` Code execution tool with REPL state persistence. - `type: "code_execution_20260521"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaBrowserToolset20260801 object` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `type: "browser_toolset_20260801"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional BetaBrowserToolsetConfigs or null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type: optional BetaBrowserTypeConfig or null` `type`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `close_tab: optional BetaBrowserCloseTabConfig or null` `close_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click: optional BetaBrowserDoubleClickConfig or null` `double_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `file_upload: optional BetaBrowserFileUploadConfig or null` `file_upload`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `find: optional BetaBrowserFindConfig or null` `find`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `form_input: optional BetaBrowserFormInputConfig or null` `form_input`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `get_page_text: optional BetaBrowserGetPageTextConfig or null` `get_page_text`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key: optional BetaBrowserHoldKeyConfig or null` `hold_key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hover: optional BetaBrowserHoverConfig or null` `hover`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `javascript_exec: optional BetaBrowserJavascriptExecConfig or null` `javascript_exec`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key: optional BetaBrowserKeyConfig or null` `key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click: optional BetaBrowserLeftClickConfig or null` `left_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag: optional BetaBrowserLeftClickDragConfig or null` `left_click_drag`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down: optional BetaBrowserLeftMouseDownConfig or null` `left_mouse_down`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up: optional BetaBrowserLeftMouseUpConfig or null` `left_mouse_up`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `list_tabs: optional BetaBrowserListTabsConfig or null` `list_tabs`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click: optional BetaBrowserMiddleClickConfig or null` `middle_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move: optional BetaBrowserMouseMoveConfig or null` `mouse_move`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `navigate: optional BetaBrowserNavigateConfig or null` `navigate`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `new_tab: optional BetaBrowserNewTabConfig or null` `new_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_console: optional BetaBrowserReadConsoleConfig or null` `read_console`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_network: optional BetaBrowserReadNetworkConfig or null` `read_network`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_page: optional BetaBrowserReadPageConfig or null` `read_page`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click: optional BetaBrowserRightClickConfig or null` `right_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot: optional BetaBrowserScreenshotConfig or null` `screenshot`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll: optional BetaBrowserScrollConfig or null` `scroll`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll_to: optional BetaBrowserScrollToConfig or null` `scroll_to`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `switch_tab: optional BetaBrowserSwitchTabConfig or null` `switch_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click: optional BetaBrowserTripleClickConfig or null` `triple_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait: optional BetaBrowserWaitConfig or null` `wait`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom: optional BetaBrowserZoomConfig or null` `zoom`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaToolComputerUse20241022 object` - `type: "computer_20241022"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaMemoryTool20250818 object` - `type: "memory_20250818"` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20250124 object` - `type: "computer_20250124"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20241022 object` - `type: "text_editor_20241022"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20251124 object` - `type: "computer_20251124"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `enable_zoom: optional boolean` Whether to enable an action to take a zoomed-in screenshot of the screen. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaComputerToolset20260801 object` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `type: "computer_toolset_20260801"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional BetaComputerToolsetConfigs or null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type: optional BetaComputerTypeConfig or null` `type`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `cursor_position: optional BetaComputerCursorPositionConfig or null` `cursor_position`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click: optional BetaComputerDoubleClickConfig or null` `double_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key: optional BetaComputerHoldKeyConfig or null` `hold_key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key: optional BetaComputerKeyConfig or null` `key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click: optional BetaComputerLeftClickConfig or null` `left_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag: optional BetaComputerLeftClickDragConfig or null` `left_click_drag`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down: optional BetaComputerLeftMouseDownConfig or null` `left_mouse_down`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up: optional BetaComputerLeftMouseUpConfig or null` `left_mouse_up`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click: optional BetaComputerMiddleClickConfig or null` `middle_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move: optional BetaComputerMouseMoveConfig or null` `mouse_move`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click: optional BetaComputerRightClickConfig or null` `right_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot: optional BetaComputerScreenshotConfig or null` `screenshot`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll: optional BetaComputerScrollConfig or null` `scroll`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click: optional BetaComputerTripleClickConfig or null` `triple_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait: optional BetaComputerWaitConfig or null` `wait`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom: optional BetaComputerZoomConfig or null` `zoom`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaToolTextEditor20250124 object` - `type: "text_editor_20250124"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250429 object` - `type: "text_editor_20250429"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250728 object` - `type: "text_editor_20250728"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `max_characters: optional number or null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebSearchTool20250305 object` - `type: "web_search_20250305"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city: optional string or null` The city of the user. minLength: 1, maxLength: 255 - `country: optional string or null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `region: optional string or null` The region of the user. minLength: 1, maxLength: 255 - `timezone: optional string or null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `BetaWebFetchTool20250910 object` - `type: "web_fetch_20250910"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `BetaWebFetchURLSourceOnly object` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: array of BetaWebFetchURLSourceToolReference` - `type: "tool_reference"` - `name: string` - `BetaWebFetchURLSourceExcept object` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: array of BetaWebFetchURLSourceToolReference` - `type: "tool_reference"` - `name: string` - `server_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `BetaWebFetchURLSourceOnly object` The tool filter variant under which only the named tools' results contribute. - `BetaWebFetchURLSourceExcept object` The tool filter variant under which every result but the named tools' contributes. - `user_input: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `BetaWebSearchTool20260209 object` - `type: "web_search_20260209"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `BetaWebFetchTool20260209 object` - `type: "web_fetch_20260209"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `BetaWebFetchTool20260309 object` Web fetch tool with use_cache parameter for bypassing cached content. - `type: "web_fetch_20260309"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache: optional boolean` 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. - `BetaWebSearchTool20260318 object` - `type: "web_search_20260318"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion: optional "full" or "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `BetaWebFetchTool20260318 object` - `type: "web_fetch_20260318"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion: optional "full" or "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache: optional boolean` 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. - `BetaAdvisorTool20260301 object` - `type: "advisor_20260301"` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-mythos-5"` Most capable model for cybersecurity and biology research - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `name: "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caching: optional BetaCacheControlEphemeral or null` 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. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_tokens: optional number or null` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolBm25_20251119 object` - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolRegex20251119 object` - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaMCPToolset object` 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. - `type: "mcp_toolset"` - `mcp_server_name: string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional map[BetaMCPToolConfig] or null` Configuration overrides for specific tools, keyed by tool name - `defer_loading: optional boolean` - `enabled: optional boolean` - `default_config: optional BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `defer_loading: optional boolean` - `enabled: optional boolean` - `tools: optional array of BetaMCPToolParam or null` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `input_schema: map[unknown]` The tool's input schema as the MCP server lists it, verbatim. - `name: string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `description: optional string or null` The tool's description as the MCP server lists it. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaRequestToolRemovalBlock object` Mid-conversation directive to withdraw a tool. `tool` references a tool (or MCP toolset) by name: one declared in the request's `tools` or defined earlier in `messages`. It is no longer offered to the model from this point in the conversation onward. - `type: "tool_removal"` - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference` - `BetaToolChangeToolReference object` Reference to a single tool, by the name the model uses to call it: a tool declared in `tools` or defined by an earlier `tool_addition` block. Does not accept the composed `{server}_{name}` form the server assigns to MCP-resolved tools; use `mcp_tool_reference` or `mcp_toolset_reference` for those. - `BetaToolChangeMCPToolReference object` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `BetaToolChangeMCPToolsetReference object` Reference to every tool in the named MCP server's toolset. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaRequestToolAdditionBlock object` Mid-conversation directive to make a tool available. `tool` is a reference to a tool (or MCP toolset) declared in the request's `tools`. Under the `inline-tools-2026-09-15` beta it may instead be a reference to a tool defined earlier in `messages`, or a `tool_definition` object that carries an inline tool definition in `definition` (the same object a `tools` entry holds). An `mcp_toolset` definition also requires the `mcp-client-2026-09-15` beta. The tool is offered to the model from this point in the conversation onward. - `BetaRequestToolRemovalBlock object` Mid-conversation directive to withdraw a tool. `tool` references a tool (or MCP toolset) by name: one declared in the request's `tools` or defined earlier in `messages`. It is no longer offered to the model from this point in the conversation onward. - `BetaMCPToolListingBlockParam object` The tool listing an MCP server returned while an earlier response was produced, as that response carried it. Send the assistant message back unchanged, this block included, and the server uses this listing for the matching `mcp_toolset` instead of asking the MCP server again. - `type: "mcp_tool_listing"` - `mcp_server_name: string` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `tools: array of BetaMCPToolParam` The server's tools, exactly as the response listed them. - `input_schema: map[unknown]` The tool's input schema as the MCP server lists it, verbatim. - `name: string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `description: optional string or null` The tool's description as the MCP server lists it. - `BetaFallbackBlockParam object` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `type: "fallback"` - `from: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `to: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `trigger: optional unknown` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. - `role: "user" or "assistant" or "system"` - `"user"` - `"assistant"` - `"system"` - `clear_at: optional "next_user_message" or "never" or null` How long this system message's text stays in front of the model. `"never"` (the default) renders it on every request that includes it. `"next_user_message"` renders it only for the user turn it follows: once a later `role: "user"` message exists in `messages` the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on `role: "system"` messages. - `"next_user_message"` - `"never"` - `output_config: optional BetaSystemMessageOutputConfig or null` Per-message output configuration on a role:"system" input message. Fields here apply per-turn; `format` remains top-level only. An empty `{}` is accepted on a message that carries content; a message with neither content nor output_config fields is rejected. - `effort: optional "low" or "medium" or "high" or 2 more or null` How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `cache_control: optional BetaCacheControlEphemeral or null` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `compaction: optional BetaCompactionConfig or null` Compaction configuration. When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`. - `type: "summarize"` - `instructions: optional string or null` Replaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent. maxLength: 16384 - `context_management: optional BetaContextManagementConfig or null` 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: optional array of BetaClearToolUses20250919Edit or BetaClearThinking20251015Edit or BetaCompact20260112Edit` List of context management edits to apply - `BetaClearToolUses20250919Edit object` - `type: "clear_tool_uses_20250919"` - `clear_at_least: optional BetaInputTokensClearAtLeast or null` 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: "input_tokens"` - `value: number` minimum: 0 - `clear_tool_inputs: optional boolean or array of string or null` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `boolean` - `array of string` - `exclude_tools: optional array of string or null` Tool names whose uses are preserved from clearing - `keep: optional BetaToolUsesKeep` Number of tool uses to retain in the conversation - `type: "tool_uses"` - `value: number` minimum: 0 - `trigger: optional BetaInputTokensTrigger or BetaToolUsesTrigger` Condition that triggers the context management strategy - `BetaInputTokensTrigger object` - `type: "input_tokens"` - `value: number` minimum: 1 - `BetaToolUsesTrigger object` - `type: "tool_uses"` - `value: number` minimum: 1 - `BetaClearThinking20251015Edit object` - `type: "clear_thinking_20251015"` - `keep: optional BetaThinkingTurns or BetaAllThinkingTurns or "all"` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `BetaThinkingTurns object` - `type: "thinking_turns"` - `value: number` minimum: 1 - `BetaAllThinkingTurns object` - `type: "all"` - `"all"` - `BetaCompact20260112Edit object` Automatically compact older context when reaching the configured trigger threshold. - `type: "compact_20260112"` - `instructions: optional string or null` Additional instructions for summarization. - `pause_after_compaction: optional boolean` Whether to pause after compaction and return the compaction block to the user. - `trigger: optional BetaInputTokensTrigger or null` When to trigger compaction. Defaults to 150000 input tokens. - `mcp_servers: optional array of BetaRequestMCPServerURLDefinition` MCP servers to be utilized in this request maxItems: 20 - `type: "url"` - `name: string` - `url: string` - `authorization_token: optional string or null` - `tool_configuration: optional BetaRequestMCPServerToolConfiguration or null` - `allowed_tools: optional array of string or null` - `enabled: optional boolean or null` - `output_config: optional BetaOutputConfig` Configuration options for the model's output, such as the output format. - `effort: optional "low" or "medium" or "high" or 2 more or null` How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `format: optional BetaJSONOutputFormat or null` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=http) - `type: "json_schema"` - `schema: map[unknown]` The JSON schema of the format - `task_budget: optional BetaTokenTaskBudget or null` Configuration for token budget tracking across contexts. - `type: "tokens"` The budget type. Currently only 'tokens' is supported. - `total: number` Total token budget across all contexts in the session. minimum: 1024 - `remaining: optional number or null` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. minimum: 0 - `speed: optional "standard" or "fast" or null` The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. Some models require the `fast-mode-2026-02-01` beta header for any `speed` value. See [fast mode](https://platform.claude.com/docs/en/build-with-claude/fast-mode?sdk_languages=http) for which models. - `"standard"` - `"fast"` - `system: optional string or array of BetaTextBlockParam` 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://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role). - `string` - `array of BetaTextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam or null` - `thinking: optional BetaThinkingConfigParam` Configuration for Claude's thinking. With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit. Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#configuring-thinking) for each model's behavior. - `BetaThinkingConfigEnabled object` - `type: "enabled"` - `budget_tokens: number` 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://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details. minimum: 1024 - `block_binding: optional BetaThinkingBlockBinding or null` Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default. - `prefix_mismatch_behavior: optional BetaThinkingPrefixMismatchBehavior or null` "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`. - `"error"` - `"drop_block"` - `display: optional "summarized" or "omitted" or "updates" or null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display). - `"summarized"` - `"omitted"` - `"updates"` - `BetaThinkingConfigDisabled object` - `type: "disabled"` - `BetaThinkingConfigBetweenTools object` - `type: "between_tools"` - `BetaThinkingConfigAdaptive object` - `type: "adaptive"` - `block_binding: optional BetaThinkingBlockBinding or null` Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default. - `display: optional "summarized" or "omitted" or "updates" or null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display). - `"summarized"` - `"omitted"` - `"updates"` - `tool_choice: optional BetaToolChoice` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `BetaToolChoiceAuto object` The model will automatically decide whether to use tools. - `type: "auto"` - `disable_parallel_tool_use: optional boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `BetaToolChoiceAny object` The model will use any available tools. - `type: "any"` - `disable_parallel_tool_use: optional boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `BetaToolChoiceTool object` The model will use the specified tool with `tool_choice.name`. - `type: "tool"` - `name: string` The name of the tool to use. - `disable_parallel_tool_use: optional boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `BetaToolChoiceNone object` The model will not be allowed to use tools. - `type: "none"` - `tools: optional array of BetaTool or BetaToolBash20241022 or BetaToolBash20250124 or 25 more` 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://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=http), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=http)). 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://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=http) for more details. - `BetaTool object` - `BetaToolBash20241022 object` - `BetaToolBash20250124 object` - `BetaCodeExecutionTool20250522 object` - `BetaCodeExecutionTool20250825 object` - `BetaCodeExecutionTool20260120 object` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `BetaCodeExecutionTool20260521 object` Code execution tool with REPL state persistence. - `BetaBrowserToolset20260801 object` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `BetaToolComputerUse20241022 object` - `BetaMemoryTool20250818 object` - `BetaToolComputerUse20250124 object` - `BetaToolTextEditor20241022 object` - `BetaToolComputerUse20251124 object` - `BetaComputerToolset20260801 object` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `BetaToolTextEditor20250124 object` - `BetaToolTextEditor20250429 object` - `BetaToolTextEditor20250728 object` - `BetaWebSearchTool20250305 object` - `BetaWebFetchTool20250910 object` - `BetaWebSearchTool20260209 object` - `BetaWebFetchTool20260209 object` - `BetaWebFetchTool20260309 object` Web fetch tool with use_cache parameter for bypassing cached content. - `BetaWebSearchTool20260318 object` - `BetaWebFetchTool20260318 object` - `BetaAdvisorTool20260301 object` - `BetaToolSearchToolBm25_20251119 object` - `BetaToolSearchToolRegex20251119 object` - `BetaMCPToolset object` 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. - `output_format: optional BetaJSONOutputFormat or null` **Deprecated** Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=http) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. #### Returns - `BetaMessageTokensCount object` - `context_management: BetaCountTokensContextManagementResponse or null` Information about context management applied to the message. - `original_input_tokens: number` The original token count before context management was applied - `input_tokens: number` The total number of tokens across the provided list of messages, system prompt, and tools. #### Example ```bash curl https://api.anthropic.com/v1/messages/count_tokens \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "messages": [ { "content": "Hello, world", "role": "user" } ], "model": "claude-opus-5-5", "system": [ { "text": "Today'\''s date is 2024-06-01.", "type": "text" } ], "thinking": { "type": "adaptive" }, "tools": [ { "input_schema": { "type": "object", "properties": { "location": "bar", "unit": "bar" }, "required": [ "location" ] }, "name": "name" } ] }' ``` ##### Response (200) ```json { "context_management": { "original_input_tokens": 0 }, "input_tokens": 2095 } ``` ## Beta › Messages › Batches ### Create a Message Batch **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://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=http) #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-user-profile-id": optional string` The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `requests: array of object` List of requests for prompt completion. Each is an individual request to create a Message. minItems: 1, maxItems: 100000 - `custom_id: 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. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]{1,64}$ - `params: object` Messages API creation parameters for the individual request. See the [Messages API reference](https://platform.claude.com/docs/en/api/messages?sdk_languages=http) for full documentation on available parameters. - `max_tokens: number` 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://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=http) for details. minimum: 0 - `messages: array of BetaMessageParam` 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. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=http#prefill-not-supported). 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, for models that support prefill: ```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://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=http). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role), 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: string or array of BetaContentBlockParam` - `string` - `array of BetaContentBlockParam` - `BetaTextBlockParam object` - `type: "text"` - `text: string` minLength: 1 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl: optional "5m" or "1h"` 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`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http) for details. - `"5m"` - `"1h"` - `citations: optional array of BetaTextCitationParam or null` - `BetaCitationCharLocationParam object` - `type: "char_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string or null` minLength: 1, maxLength: 500 - `end_char_index: number` - `start_char_index: number` minimum: 0 - `BetaCitationPageLocationParam object` - `type: "page_location"` - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string or null` minLength: 1, maxLength: 500 - `end_page_number: number` - `start_page_number: number` minimum: 1 - `BetaCitationContentBlockLocationParam object` - `type: "content_block_location"` - `cited_text: 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. - `document_index: number` minimum: 0 - `document_title: string or null` minLength: 1, maxLength: 500 - `end_block_index: number` 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`. - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `BetaCitationWebSearchResultLocationParam object` - `type: "web_search_result_location"` - `cited_text: string` - `encrypted_index: string` - `title: string or null` minLength: 1, maxLength: 512 - `url: string` minLength: 1 - `BetaCitationSearchResultLocationParam object` - `type: "search_result_location"` - `cited_text: 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. - `end_block_index: number` 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`. - `search_result_index: number` 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. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string or null` - `BetaImageBlockParam object` - `type: "image"` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `BetaBase64ImageSource object` - `type: "base64"` - `data: string` format: byte - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `BetaURLImageSource object` - `type: "url"` - `url: string` - `BetaFileImageSource object` - `type: "file"` - `file_id: string` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `transformations: optional BetaImageTransformationsParam or null` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `oversized_image: optional "downsize" or "error"` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `"downsize"` - `"error"` - `BetaRequestDocumentBlock object` - `type: "document"` - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` - `BetaBase64PDFSource object` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `BetaPlainTextSource object` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `BetaContentBlockSource object` - `type: "content"` - `content: string or array of BetaContentBlockSourceContent` - `string` - `BetaContentBlockSourceContent = array of BetaContentBlockSourceContent` - `BetaTextBlockParam object` - `BetaImageBlockParam object` - `BetaURLPDFSource object` - `type: "url"` - `url: string` - `BetaFileDocumentSource object` - `type: "file"` - `file_id: string` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` - `enabled: optional boolean` - `context: optional string or null` minLength: 1 - `title: optional string or null` minLength: 1, maxLength: 500 - `BetaSearchResultBlockParam object` - `type: "search_result"` - `content: array of BetaTextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam or null` - `source: string` - `title: string` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam` - `BetaThinkingBlockParam object` - `type: "thinking"` - `signature: string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `thinking: string` The `thinking` text of this block as returned by the API. - `BetaRedactedThinkingBlockParam object` - `type: "redacted_thinking"` - `data: string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `BetaToolUseBlockParam object` - `type: "tool_use"` - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: map[unknown]` - `name: string` minLength: 1, maxLength: 200 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `type: "direct"` - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaServerToolCaller20260120 object` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `toolset_name: optional string or null` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `BetaToolResultBlockParam object` - `type: "tool_result"` - `tool_use_id: string` pattern: ^[a-zA-Z0-9_-]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `content: optional string or array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 3 more` - `string` - `array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 3 more` - `BetaTextBlockParam object` - `BetaImageBlockParam object` - `BetaSearchResultBlockParam object` - `BetaRequestDocumentBlock object` - `BetaToolReferenceBlockParam object` Tool reference block that can be included in tool_result content. - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaBrowserStateBlockParam object` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `type: "browser_state"` - `tabs: array of BetaBrowserStateTabEntry` All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. maxItems: 100 - `tab_id: string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `title: string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `active: optional boolean` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `state_changes: optional array of BetaBrowserStateChange or null` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `BetaBrowserStateChangeTabOpened object` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `type: "tab_opened"` - `tab_id: string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `BetaBrowserStateChangeDownloadStarted object` A file download that started during this call. - `type: "download_started"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `BetaBrowserStateChangeDownloadCompleted object` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `type: "download_completed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `path: optional string or null` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `size_bytes: optional number or null` The completed download's size. minimum: 0 - `BetaBrowserStateChangeDownloadFailed object` A file download that failed — or was cancelled — during this call. - `type: "download_failed"` - `download_id: string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `url: string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `error: optional string or null` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `is_error: optional boolean` - `toolset_name: optional string or null` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `BetaServerToolUseBlockParam object` - `type: "server_tool_use"` - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: map[unknown]` - `name: "advisor" or "web_search" or "web_fetch" or 5 more` - `"advisor"` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaWebSearchToolResultBlockParam object` - `type: "web_search_tool_result"` - `content: BetaWebSearchToolResultBlockParamContent` - `ResultBlock = array of BetaWebSearchResultBlockParam` - `type: "web_search_result"` - `encrypted_content: string` - `title: string` - `url: string` - `page_age: optional string or null` - `BetaWebSearchToolRequestError object` - `type: "web_search_tool_result_error"` - `error_code: BetaWebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaWebFetchToolResultBlockParam object` - `type: "web_fetch_tool_result"` - `content: BetaWebFetchToolResultErrorBlockParam or BetaWebFetchBlockParam` - `BetaWebFetchToolResultErrorBlockParam object` - `type: "web_fetch_tool_result_error"` - `error_code: BetaWebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `BetaWebFetchBlockParam object` - `type: "web_fetch_result"` - `content: BetaRequestDocumentBlock` - `url: string` Fetched content URL - `retrieved_at: optional string or null` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaAdvisorToolResultBlockParam object` - `type: "advisor_tool_result"` - `content: BetaAdvisorToolResultErrorParam or BetaAdvisorResultBlockParam or BetaAdvisorRedactedResultBlockParam` - `BetaAdvisorToolResultErrorParam object` - `type: "advisor_tool_result_error"` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 4 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `"model_not_found"` - `BetaAdvisorResultBlockParam object` - `type: "advisor_result"` - `text: string` - `stop_reason: optional string or null` - `BetaAdvisorRedactedResultBlockParam object` - `type: "advisor_redacted_result"` - `encrypted_content: string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `stop_reason: optional string or null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaCodeExecutionToolResultBlockParam object` - `type: "code_execution_tool_result"` - `content: BetaCodeExecutionToolResultBlockParamContent` - `BetaCodeExecutionToolResultErrorParam object` - `type: "code_execution_tool_result_error"` - `error_code: BetaCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `BetaCodeExecutionResultBlockParam object` - `type: "code_execution_result"` - `content: array of BetaCodeExecutionOutputBlockParam` - `type: "code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `BetaEncryptedCodeExecutionResultBlockParam object` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` - `content: array of BetaCodeExecutionOutputBlockParam` - `type: "code_execution_output"` - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaBashCodeExecutionToolResultBlockParam object` - `type: "bash_code_execution_tool_result"` - `content: BetaBashCodeExecutionToolResultErrorParam or BetaBashCodeExecutionResultBlockParam` - `BetaBashCodeExecutionToolResultErrorParam object` - `type: "bash_code_execution_tool_result_error"` - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `BetaBashCodeExecutionResultBlockParam object` - `type: "bash_code_execution_result"` - `content: array of BetaBashCodeExecutionOutputBlockParam` - `type: "bash_code_execution_output"` - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaTextEditorCodeExecutionToolResultBlockParam object` - `type: "text_editor_code_execution_tool_result"` - `content: BetaTextEditorCodeExecutionToolResultErrorParam or BetaTextEditorCodeExecutionViewResultBlockParam or BetaTextEditorCodeExecutionCreateResultBlockParam or BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `BetaTextEditorCodeExecutionToolResultErrorParam object` - `type: "text_editor_code_execution_tool_result_error"` - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message: optional string or null` - `BetaTextEditorCodeExecutionViewResultBlockParam object` - `type: "text_editor_code_execution_view_result"` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: optional number or null` - `start_line: optional number or null` - `total_lines: optional number or null` - `BetaTextEditorCodeExecutionCreateResultBlockParam object` - `type: "text_editor_code_execution_create_result"` - `is_file_update: boolean` - `BetaTextEditorCodeExecutionStrReplaceResultBlockParam object` - `type: "text_editor_code_execution_str_replace_result"` - `lines: optional array of string or null` - `new_lines: optional number or null` - `new_start: optional number or null` - `old_lines: optional number or null` - `old_start: optional number or null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaToolSearchToolResultBlockParam object` - `type: "tool_search_tool_result"` - `content: BetaToolSearchToolResultErrorParam or BetaToolSearchToolSearchResultBlockParam` - `BetaToolSearchToolResultErrorParam object` - `type: "tool_search_tool_result_error"` - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message: optional string or null` - `BetaToolSearchToolSearchResultBlockParam object` - `type: "tool_search_tool_search_result"` - `tool_references: array of BetaToolReferenceBlockParam` - `type: "tool_reference"` - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaMCPToolUseBlockParam object` - `type: "mcp_tool_use"` - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: map[unknown]` - `name: string` - `server_name: string` The name of the MCP server - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaRequestMCPToolResultBlockParam object` - `type: "mcp_tool_result"` - `tool_use_id: string` pattern: ^[a-zA-Z0-9_-]+$ - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `content: optional string or array of BetaTextBlockParam` - `string` - `BetaMCPToolResultBlockParamContent = array of BetaTextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam or null` - `is_error: optional boolean` - `BetaContainerUploadBlockParam object` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `type: "container_upload"` - `file_id: string` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaCompactionBlockParam object` 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"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `content: optional string or null` Summary of previously compacted content, or null if compaction failed - `encrypted_content: optional string or null` Opaque metadata from prior compaction, to be round-tripped verbatim - `signature: optional string or null` The block's signature as returned, to be sent back verbatim - `tool_changes: optional array of BetaRequestToolAdditionBlock or BetaRequestToolRemovalBlock or null` The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block. - `BetaRequestToolAdditionBlock object` Mid-conversation directive to make a tool available. `tool` is a reference to a tool (or MCP toolset) declared in the request's `tools`. Under the `inline-tools-2026-09-15` beta it may instead be a reference to a tool defined earlier in `messages`, or a `tool_definition` object that carries an inline tool definition in `definition` (the same object a `tools` entry holds). An `mcp_toolset` definition also requires the `mcp-client-2026-09-15` beta. The tool is offered to the model from this point in the conversation onward. - `type: "tool_addition"` - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference or BetaToolChangeToolDefinitionParam` - `BetaToolChangeToolReference object` Reference to a single tool, by the name the model uses to call it: a tool declared in `tools` or defined by an earlier `tool_addition` block. Does not accept the composed `{server}_{name}` form the server assigns to MCP-resolved tools; use `mcp_tool_reference` or `mcp_toolset_reference` for those. - `type: "tool_reference"` - `name: string` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `BetaToolChangeMCPToolReference object` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `type: "mcp_tool_reference"` - `name: string` - `server_name: string` - `BetaToolChangeMCPToolsetReference object` Reference to every tool in the named MCP server's toolset. - `type: "mcp_toolset_reference"` - `server_name: string` - `BetaToolChangeToolDefinitionParam object` A tool defined by value: `definition` is a `tools` entry (any kind `tools` accepts, an MCP toolset included). An `mcp_toolset` given here also requires the `mcp-client-2026-09-15` beta. - `type: "tool_definition"` - `definition: BetaToolUnion` - `BetaTool object` - `type: optional "custom" or null` - `input_schema: object` [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"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description: optional string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `eager_input_streaming: optional boolean or null` 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. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolBash20241022 object` - `type: "bash_20241022"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolBash20250124 object` - `type: "bash_20250124"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250522 object` - `type: "code_execution_20250522"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250825 object` - `type: "code_execution_20250825"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20260120 object` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type: "code_execution_20260120"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20260521 object` Code execution tool with REPL state persistence. - `type: "code_execution_20260521"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaBrowserToolset20260801 object` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `type: "browser_toolset_20260801"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional BetaBrowserToolsetConfigs or null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type: optional BetaBrowserTypeConfig or null` `type`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `close_tab: optional BetaBrowserCloseTabConfig or null` `close_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click: optional BetaBrowserDoubleClickConfig or null` `double_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `file_upload: optional BetaBrowserFileUploadConfig or null` `file_upload`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `find: optional BetaBrowserFindConfig or null` `find`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `form_input: optional BetaBrowserFormInputConfig or null` `form_input`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `get_page_text: optional BetaBrowserGetPageTextConfig or null` `get_page_text`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key: optional BetaBrowserHoldKeyConfig or null` `hold_key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hover: optional BetaBrowserHoverConfig or null` `hover`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `javascript_exec: optional BetaBrowserJavascriptExecConfig or null` `javascript_exec`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key: optional BetaBrowserKeyConfig or null` `key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click: optional BetaBrowserLeftClickConfig or null` `left_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag: optional BetaBrowserLeftClickDragConfig or null` `left_click_drag`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down: optional BetaBrowserLeftMouseDownConfig or null` `left_mouse_down`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up: optional BetaBrowserLeftMouseUpConfig or null` `left_mouse_up`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `list_tabs: optional BetaBrowserListTabsConfig or null` `list_tabs`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click: optional BetaBrowserMiddleClickConfig or null` `middle_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move: optional BetaBrowserMouseMoveConfig or null` `mouse_move`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `navigate: optional BetaBrowserNavigateConfig or null` `navigate`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `new_tab: optional BetaBrowserNewTabConfig or null` `new_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_console: optional BetaBrowserReadConsoleConfig or null` `read_console`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_network: optional BetaBrowserReadNetworkConfig or null` `read_network`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_page: optional BetaBrowserReadPageConfig or null` `read_page`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click: optional BetaBrowserRightClickConfig or null` `right_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot: optional BetaBrowserScreenshotConfig or null` `screenshot`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll: optional BetaBrowserScrollConfig or null` `scroll`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll_to: optional BetaBrowserScrollToConfig or null` `scroll_to`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `switch_tab: optional BetaBrowserSwitchTabConfig or null` `switch_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click: optional BetaBrowserTripleClickConfig or null` `triple_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait: optional BetaBrowserWaitConfig or null` `wait`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom: optional BetaBrowserZoomConfig or null` `zoom`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaToolComputerUse20241022 object` - `type: "computer_20241022"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaMemoryTool20250818 object` - `type: "memory_20250818"` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20250124 object` - `type: "computer_20250124"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20241022 object` - `type: "text_editor_20241022"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20251124 object` - `type: "computer_20251124"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `enable_zoom: optional boolean` Whether to enable an action to take a zoomed-in screenshot of the screen. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaComputerToolset20260801 object` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `type: "computer_toolset_20260801"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional BetaComputerToolsetConfigs or null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type: optional BetaComputerTypeConfig or null` `type`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `cursor_position: optional BetaComputerCursorPositionConfig or null` `cursor_position`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click: optional BetaComputerDoubleClickConfig or null` `double_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key: optional BetaComputerHoldKeyConfig or null` `hold_key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key: optional BetaComputerKeyConfig or null` `key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click: optional BetaComputerLeftClickConfig or null` `left_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag: optional BetaComputerLeftClickDragConfig or null` `left_click_drag`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down: optional BetaComputerLeftMouseDownConfig or null` `left_mouse_down`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up: optional BetaComputerLeftMouseUpConfig or null` `left_mouse_up`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click: optional BetaComputerMiddleClickConfig or null` `middle_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move: optional BetaComputerMouseMoveConfig or null` `mouse_move`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click: optional BetaComputerRightClickConfig or null` `right_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot: optional BetaComputerScreenshotConfig or null` `screenshot`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll: optional BetaComputerScrollConfig or null` `scroll`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click: optional BetaComputerTripleClickConfig or null` `triple_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait: optional BetaComputerWaitConfig or null` `wait`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom: optional BetaComputerZoomConfig or null` `zoom`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaToolTextEditor20250124 object` - `type: "text_editor_20250124"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250429 object` - `type: "text_editor_20250429"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250728 object` - `type: "text_editor_20250728"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `max_characters: optional number or null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebSearchTool20250305 object` - `type: "web_search_20250305"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city: optional string or null` The city of the user. minLength: 1, maxLength: 255 - `country: optional string or null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `region: optional string or null` The region of the user. minLength: 1, maxLength: 255 - `timezone: optional string or null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `BetaWebFetchTool20250910 object` - `type: "web_fetch_20250910"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `BetaWebFetchURLSourceOnly object` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: array of BetaWebFetchURLSourceToolReference` - `type: "tool_reference"` - `name: string` - `BetaWebFetchURLSourceExcept object` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: array of BetaWebFetchURLSourceToolReference` - `type: "tool_reference"` - `name: string` - `server_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `BetaWebFetchURLSourceOnly object` The tool filter variant under which only the named tools' results contribute. - `BetaWebFetchURLSourceExcept object` The tool filter variant under which every result but the named tools' contributes. - `user_input: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `BetaWebSearchTool20260209 object` - `type: "web_search_20260209"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `BetaWebFetchTool20260209 object` - `type: "web_fetch_20260209"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `BetaWebFetchTool20260309 object` Web fetch tool with use_cache parameter for bypassing cached content. - `type: "web_fetch_20260309"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache: optional boolean` 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. - `BetaWebSearchTool20260318 object` - `type: "web_search_20260318"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion: optional "full" or "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `BetaWebFetchTool20260318 object` - `type: "web_fetch_20260318"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion: optional "full" or "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache: optional boolean` 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. - `BetaAdvisorTool20260301 object` - `type: "advisor_20260301"` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-mythos-5"` Most capable model for cybersecurity and biology research - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `name: "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caching: optional BetaCacheControlEphemeral or null` 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. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_tokens: optional number or null` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolBm25_20251119 object` - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolRegex20251119 object` - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaMCPToolset object` 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. - `type: "mcp_toolset"` - `mcp_server_name: string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional map[BetaMCPToolConfig] or null` Configuration overrides for specific tools, keyed by tool name - `defer_loading: optional boolean` - `enabled: optional boolean` - `default_config: optional BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `defer_loading: optional boolean` - `enabled: optional boolean` - `tools: optional array of BetaMCPToolParam or null` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `input_schema: map[unknown]` The tool's input schema as the MCP server lists it, verbatim. - `name: string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `description: optional string or null` The tool's description as the MCP server lists it. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaRequestToolRemovalBlock object` Mid-conversation directive to withdraw a tool. `tool` references a tool (or MCP toolset) by name: one declared in the request's `tools` or defined earlier in `messages`. It is no longer offered to the model from this point in the conversation onward. - `type: "tool_removal"` - `tool: BetaToolChangeToolReference or BetaToolChangeMCPToolReference or BetaToolChangeMCPToolsetReference` - `BetaToolChangeToolReference object` Reference to a single tool, by the name the model uses to call it: a tool declared in `tools` or defined by an earlier `tool_addition` block. Does not accept the composed `{server}_{name}` form the server assigns to MCP-resolved tools; use `mcp_tool_reference` or `mcp_toolset_reference` for those. - `BetaToolChangeMCPToolReference object` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `BetaToolChangeMCPToolsetReference object` Reference to every tool in the named MCP server's toolset. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `BetaRequestToolAdditionBlock object` Mid-conversation directive to make a tool available. `tool` is a reference to a tool (or MCP toolset) declared in the request's `tools`. Under the `inline-tools-2026-09-15` beta it may instead be a reference to a tool defined earlier in `messages`, or a `tool_definition` object that carries an inline tool definition in `definition` (the same object a `tools` entry holds). An `mcp_toolset` definition also requires the `mcp-client-2026-09-15` beta. The tool is offered to the model from this point in the conversation onward. - `BetaRequestToolRemovalBlock object` Mid-conversation directive to withdraw a tool. `tool` references a tool (or MCP toolset) by name: one declared in the request's `tools` or defined earlier in `messages`. It is no longer offered to the model from this point in the conversation onward. - `BetaMCPToolListingBlockParam object` The tool listing an MCP server returned while an earlier response was produced, as that response carried it. Send the assistant message back unchanged, this block included, and the server uses this listing for the matching `mcp_toolset` instead of asking the MCP server again. - `type: "mcp_tool_listing"` - `mcp_server_name: string` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `tools: array of BetaMCPToolParam` The server's tools, exactly as the response listed them. - `input_schema: map[unknown]` The tool's input schema as the MCP server lists it, verbatim. - `name: string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `description: optional string or null` The tool's description as the MCP server lists it. - `BetaFallbackBlockParam object` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `type: "fallback"` - `from: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `to: BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `trigger: optional unknown` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. - `role: "user" or "assistant" or "system"` - `"user"` - `"assistant"` - `"system"` - `clear_at: optional "next_user_message" or "never" or null` How long this system message's text stays in front of the model. `"never"` (the default) renders it on every request that includes it. `"next_user_message"` renders it only for the user turn it follows: once a later `role: "user"` message exists in `messages` the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on `role: "system"` messages. - `"next_user_message"` - `"never"` - `output_config: optional BetaSystemMessageOutputConfig or null` Per-message output configuration on a role:"system" input message. Fields here apply per-turn; `format` remains top-level only. An empty `{}` is accepted on a message that carries content; a message with neither content nor output_config fields is rejected. - `effort: optional "low" or "medium" or "high" or 2 more or null` How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `cache_control: optional BetaCacheControlEphemeral or null` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `compaction: optional BetaCompactionConfig or null` Compaction configuration. When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`. - `type: "summarize"` - `instructions: optional string or null` Replaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent. maxLength: 16384 - `container: optional BetaContainerParams or string or null` Container identifier for reuse across requests. - `BetaContainerParams object` Container parameters with skills to be loaded. - `id: optional string or null` Container id - `skills: optional array of BetaSkillParams or null` List of skills to load in the container maxItems: 20 - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version: optional string` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 - `string` - `context_management: optional BetaContextManagementConfig or null` 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: optional array of BetaClearToolUses20250919Edit or BetaClearThinking20251015Edit or BetaCompact20260112Edit` List of context management edits to apply - `BetaClearToolUses20250919Edit object` - `type: "clear_tool_uses_20250919"` - `clear_at_least: optional BetaInputTokensClearAtLeast or null` 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: "input_tokens"` - `value: number` minimum: 0 - `clear_tool_inputs: optional boolean or array of string or null` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `boolean` - `array of string` - `exclude_tools: optional array of string or null` Tool names whose uses are preserved from clearing - `keep: optional BetaToolUsesKeep` Number of tool uses to retain in the conversation - `type: "tool_uses"` - `value: number` minimum: 0 - `trigger: optional BetaInputTokensTrigger or BetaToolUsesTrigger` Condition that triggers the context management strategy - `BetaInputTokensTrigger object` - `type: "input_tokens"` - `value: number` minimum: 1 - `BetaToolUsesTrigger object` - `type: "tool_uses"` - `value: number` minimum: 1 - `BetaClearThinking20251015Edit object` - `type: "clear_thinking_20251015"` - `keep: optional BetaThinkingTurns or BetaAllThinkingTurns or "all"` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `BetaThinkingTurns object` - `type: "thinking_turns"` - `value: number` minimum: 1 - `BetaAllThinkingTurns object` - `type: "all"` - `"all"` - `BetaCompact20260112Edit object` Automatically compact older context when reaching the configured trigger threshold. - `type: "compact_20260112"` - `instructions: optional string or null` Additional instructions for summarization. - `pause_after_compaction: optional boolean` Whether to pause after compaction and return the compaction block to the user. - `trigger: optional BetaInputTokensTrigger or null` When to trigger compaction. Defaults to 150000 input tokens. - `diagnostics: optional BetaDiagnosticsParam or null` Request-level diagnostics. Supply `previous_message_id` to have the response include `diagnostics.cache_miss_reason` explaining any prompt-cache divergence from that prior request. - `previous_message_id: optional string or null` 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. maxLength: 256 - `fallback_credit_token: optional string or BetaFallbackCreditTokenParam or null` The `fallback_credit_token` from a prior refusal's `stop_details`. When a preceding request was refused and returned a `fallback_credit_token`, pass that code here on the retry to have the retry's cache-creation tokens for the prefix that was warm on the refused model billed at the cache-read rate. Must be redeemed by the same organization and workspace, with the same request body (optionally extended by one appended `assistant` message whose content is the partial text — with any trailing whitespace stripped from the final text block — and paired server-tool blocks streamed before the refusal; the appended-assistant form is not available for requests with `output_format` set or forced `tool_choice`), on an eligible fallback model, on the same platform, and within 5 minutes of the refusal; a mismatch is a 400. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed with the appended-assistant form — if an exact-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry with the appended-assistant form instead. When the appended-assistant form is used on a model that otherwise disallows assistant-turn prefill, this token also authorizes that one prefill. - `string` - `BetaFallbackCreditTokenParam object` Object form of `fallback_credit_token`: the token plus a redemption mode. Requires `anthropic-beta: fallback-credit-2026-07-01`; without that header the field accepts the bare string only. The bare string and the mode-less object are equivalent (both select `strict`), so wrapping an existing token changes nothing by itself. - `token: string` The opaque `fallback_credit_token` from a prior refusal's `stop_details` — the same string the bare-string form carries. minLength: 1, maxLength: 2048 - `mode: optional "strict" or "best_effort"` How a failing token affects the retry. `strict` (the default, and the bare-string behavior): a failing redemption is a 400 and the retry is not served. `best_effort`: the retry is served either way — a token-layer failure no longer rejects the request; the retry proceeds at normal price and the outcome is reported on the response's `usage.fallback_credit`. Two failures stay hard in both modes: a malformed token, and combining `fallback_credit_token` with `fallbacks`. - `"strict"` - `"best_effort"` - `fallbacks: optional BetaFallbacksParam or null` Opt-in server-side retry on one or more substitute models when the requested model declines for policy reasons. Tried in order: if the first entry also declines, the second is tried, and so on. Some models don't support fallbacks; on those models, a list of fallback models returns a 400 error. See [Server-side fallback](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=http#server-side-fallback). The string "default" requests the requested model's server-defined default fallback configuration. On a model that doesn't support fallbacks, the request runs on the requested model alone, so a declined request stays declined. - `array of BetaFallbackParam` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `max_tokens: optional number or null` - `output_config: optional BetaOutputConfig or null` - `effort: optional "low" or "medium" or "high" or 2 more or null` How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `format: optional BetaJSONOutputFormat or null` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=http) - `type: "json_schema"` - `schema: map[unknown]` The JSON schema of the format - `task_budget: optional BetaTokenTaskBudget or null` Configuration for token budget tracking across contexts. - `type: "tokens"` The budget type. Currently only 'tokens' is supported. - `total: number` Total token budget across all contexts in the session. minimum: 1024 - `remaining: optional number or null` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. minimum: 0 - `speed: optional "standard" or "fast" or null` 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. - `"standard"` - `"fast"` - `thinking: optional BetaThinkingConfigEnabled or BetaThinkingConfigDisabled or BetaThinkingConfigBetweenTools or BetaThinkingConfigAdaptive or null` - `BetaThinkingConfigEnabled object` - `type: "enabled"` - `budget_tokens: number` 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://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details. minimum: 1024 - `block_binding: optional BetaThinkingBlockBinding or null` Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default. - `prefix_mismatch_behavior: optional BetaThinkingPrefixMismatchBehavior or null` "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`. - `"error"` - `"drop_block"` - `display: optional "summarized" or "omitted" or "updates" or null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display). - `"summarized"` - `"omitted"` - `"updates"` - `BetaThinkingConfigDisabled object` - `type: "disabled"` - `BetaThinkingConfigBetweenTools object` - `type: "between_tools"` - `BetaThinkingConfigAdaptive object` - `type: "adaptive"` - `block_binding: optional BetaThinkingBlockBinding or null` Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. `null`, absent or an empty object means every default. - `display: optional "summarized" or "omitted" or "updates" or null` 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. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#controlling-thinking-display). - `"summarized"` - `"omitted"` - `"updates"` - `"default"` - `inference_geo: optional string or null` Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `mcp_servers: optional array of BetaRequestMCPServerURLDefinition` MCP servers to be utilized in this request maxItems: 20 - `type: "url"` - `name: string` - `url: string` - `authorization_token: optional string or null` - `tool_configuration: optional BetaRequestMCPServerToolConfiguration or null` - `allowed_tools: optional array of string or null` - `enabled: optional boolean or null` - `metadata: optional BetaMetadata` An object describing metadata about the request. - `user_id: optional string or null` 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. maxLength: 512 - `output_config: optional BetaOutputConfig` Configuration options for the model's output, such as the output format. - `service_tier: optional "auto" or "standard_only"` 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://platform.claude.com/docs/en/api/service-tiers?sdk_languages=http) for details. - `"auto"` - `"standard_only"` - `speed: optional "standard" or "fast" or null` The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. Some models require the `fast-mode-2026-02-01` beta header for any `speed` value. See [fast mode](https://platform.claude.com/docs/en/build-with-claude/fast-mode?sdk_languages=http) for which models. - `"standard"` - `"fast"` - `stop_sequences: optional array of 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: optional boolean` Whether to incrementally stream the response using server-sent events. When `true`, SDKs return a raw event stream. In the TypeScript, Python and Ruby SDKs, the recommended way to stream is `messages.stream()`. It sets `stream` for you and accumulates the events into the final message. See [Streaming with SDKs](https://platform.claude.com/docs/en/build-with-claude/streaming?sdk_languages=http#streaming-with-sdks) for an example in each language. - `system: optional string or array of BetaTextBlockParam` 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://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=http#give-claude-a-role). - `string` - `array of BetaTextBlockParam` - `type: "text"` - `text: string` minLength: 1 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam or null` - `thinking: optional BetaThinkingConfigParam` Configuration for Claude's thinking. With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit. Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=http#configuring-thinking) for each model's behavior. - `BetaThinkingConfigEnabled object` - `BetaThinkingConfigDisabled object` - `BetaThinkingConfigBetweenTools object` - `BetaThinkingConfigAdaptive object` - `tool_choice: optional BetaToolChoice` How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `BetaToolChoiceAuto object` The model will automatically decide whether to use tools. - `type: "auto"` - `disable_parallel_tool_use: optional boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `BetaToolChoiceAny object` The model will use any available tools. - `type: "any"` - `disable_parallel_tool_use: optional boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `BetaToolChoiceTool object` The model will use the specified tool with `tool_choice.name`. - `type: "tool"` - `name: string` The name of the tool to use. - `disable_parallel_tool_use: optional boolean` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `BetaToolChoiceNone object` The model will not be allowed to use tools. - `type: "none"` - `tools: optional array of 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://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=http), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=http)). 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://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=http) for more details. - `BetaTool object` - `BetaToolBash20241022 object` - `BetaToolBash20250124 object` - `BetaCodeExecutionTool20250522 object` - `BetaCodeExecutionTool20250825 object` - `BetaCodeExecutionTool20260120 object` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `BetaCodeExecutionTool20260521 object` Code execution tool with REPL state persistence. - `BetaBrowserToolset20260801 object` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `BetaToolComputerUse20241022 object` - `BetaMemoryTool20250818 object` - `BetaToolComputerUse20250124 object` - `BetaToolTextEditor20241022 object` - `BetaToolComputerUse20251124 object` - `BetaComputerToolset20260801 object` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `BetaToolTextEditor20250124 object` - `BetaToolTextEditor20250429 object` - `BetaToolTextEditor20250728 object` - `BetaWebSearchTool20250305 object` - `BetaWebFetchTool20250910 object` - `BetaWebSearchTool20260209 object` - `BetaWebFetchTool20260209 object` - `BetaWebFetchTool20260309 object` Web fetch tool with use_cache parameter for bypassing cached content. - `BetaWebSearchTool20260318 object` - `BetaWebFetchTool20260318 object` - `BetaAdvisorTool20260301 object` - `BetaToolSearchToolBm25_20251119 object` - `BetaToolSearchToolRegex20251119 object` - `BetaMCPToolset object` 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. - `output_format: optional BetaJSONOutputFormat or null` **Deprecated** Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=http) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. - `temperature: optional number` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. 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. minimum: 0, maximum: 1 - `top_k: optional number` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error. 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. minimum: 0 - `top_p: optional number` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting top_p. A value >= 0.99 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. 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. minimum: 0, maximum: 1 #### Returns - `BetaMessageBatch object` - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string or null` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `cancel_initiated_at: string or null` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `ended_at: string or null` 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. format: date-time - `expires_at: string` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `processing_status: "in_progress" or "canceling" or "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: 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: number` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. default: 0 - `errored: number` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. default: 0 - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. default: 0 - `processing: number` Number of requests in the Message Batch that are processing. default: 0 - `succeeded: number` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. default: 0 - `results_url: string or null` 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. #### Example ```bash curl https://api.anthropic.com/v1/messages/batches \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: message-batches-2024-09-24' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "requests": [ { "custom_id": "my-custom-id-1", "params": { "max_tokens": 1024, "messages": [ { "content": "Hello, world", "role": "user" } ], "model": "claude-opus-5-5" } } ] }' ``` ##### Response (200) ```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 **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://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=http) #### Path parameters - `message_batch_id: string` ID of the Message Batch. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaMessageBatch object` - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string or null` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `cancel_initiated_at: string or null` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `ended_at: string or null` 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. format: date-time - `expires_at: string` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `processing_status: "in_progress" or "canceling" or "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: 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: number` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. default: 0 - `errored: number` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. default: 0 - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. default: 0 - `processing: number` Number of requests in the Message Batch that are processing. default: 0 - `succeeded: number` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. default: 0 - `results_url: string or null` 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. #### Example ```bash curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: message-batches-2024-09-24' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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 **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://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=http) #### Query parameters - `after_id: optional string` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `before_id: optional string` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaMessageBatch` - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string or null` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `cancel_initiated_at: string or null` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `ended_at: string or null` 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. format: date-time - `expires_at: string` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `processing_status: "in_progress" or "canceling" or "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: 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: number` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. default: 0 - `errored: number` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. default: 0 - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. default: 0 - `processing: number` Number of requests in the Message Batch that are processing. default: 0 - `succeeded: number` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. default: 0 - `results_url: string or null` 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. - `first_id: string or null` First ID in the `data` list. Can be used as the `before_id` for the previous page. - `has_more: boolean` Indicates if there are more results in the requested page direction. - `last_id: string or null` Last ID in the `data` list. Can be used as the `after_id` for the next page. #### Example ```bash curl https://api.anthropic.com/v1/messages/batches \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: message-batches-2024-09-24' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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 **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://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=http) #### Path parameters - `message_batch_id: string` ID of the Message Batch. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaMessageBatch object` - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string or null` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `cancel_initiated_at: string or null` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `ended_at: string or null` 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. format: date-time - `expires_at: string` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `processing_status: "in_progress" or "canceling" or "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: 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: number` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. default: 0 - `errored: number` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. default: 0 - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. default: 0 - `processing: number` Number of requests in the Message Batch that are processing. default: 0 - `succeeded: number` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. default: 0 - `results_url: string or null` 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. #### Example ```bash curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID/cancel \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: message-batches-2024-09-24' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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 **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://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=http) #### Path parameters - `message_batch_id: string` ID of the Message Batch. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaDeletedMessageBatch object` - `type: "message_batch_deleted"` Deleted object type. For Message Batches, this is always `"message_batch_deleted"`. default: message_batch_deleted - `id: string` ID of the Message Batch. #### Example ```bash curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: message-batches-2024-09-24' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "type": "message_batch_deleted" } ``` ### Retrieve Message Batch results **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://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=http) #### Path parameters - `message_batch_id: string` ID of the Message Batch. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaMessageBatchIndividualResponse object` This is a single line in the response `.jsonl` file and does not represent the response as a whole. - `custom_id: string` Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch. - `result: BetaMessageBatchResult` Processing result for this request. Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration. - `BetaMessageBatchSucceededResult object` - `type: "succeeded"` default: succeeded - `message: BetaMessage` - `type: "message"` Object type. For Messages, this is always `"message"`. default: message - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: BetaContainer or null` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. format: date-time - `skills: array of BetaContainerSkill or null` Skills loaded in the container - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `skill_id: string` Skill ID minLength: 1, maxLength: 64 - `version: string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `content: array of BetaContentBlock` 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)"}] ``` - `BetaTextBlock object` - `type: "text"` default: text - `citations: array of BetaTextCitation or null` 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`. - `BetaCitationCharLocation object` - `type: "char_location"` default: char_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string or null` - `end_char_index: number` - `file_id: string or null` - `start_char_index: number` minimum: 0 - `BetaCitationPageLocation object` - `type: "page_location"` default: page_location - `cited_text: string` - `document_index: number` minimum: 0 - `document_title: string or null` - `end_page_number: number` - `file_id: string or null` - `start_page_number: number` minimum: 1 - `BetaCitationContentBlockLocation object` - `type: "content_block_location"` default: content_block_location - `cited_text: 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. - `document_index: number` minimum: 0 - `document_title: string or null` - `end_block_index: number` 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`. - `file_id: string or null` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `BetaCitationsWebSearchResultLocation object` - `type: "web_search_result_location"` default: web_search_result_location - `cited_text: string` - `encrypted_index: string` - `title: string or null` maxLength: 512 - `url: string` - `BetaCitationSearchResultLocation object` - `type: "search_result_location"` default: search_result_location - `cited_text: 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. - `end_block_index: number` 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`. - `search_result_index: number` 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. minimum: 0 - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `title: string or null` - `text: string` - `BetaThinkingBlock object` - `type: "thinking"` default: thinking - `signature: string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http) for details. - `thinking: string` The text of Claude's thinking process for this block. - `BetaRedactedThinkingBlock object` - `type: "redacted_thinking"` default: redacted_thinking - `data: string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=http#redacted-thinking-blocks) for details. - `BetaToolUseBlock object` - `type: "tool_use"` default: tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: map[unknown]` - `name: string` minLength: 1 - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `type: "direct"` - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `type: "code_execution_20250825"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaServerToolCaller20260120 object` - `type: "code_execution_20260120"` - `tool_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `toolset_name: optional string or null` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `BetaServerToolUseBlock object` - `type: "server_tool_use"` default: server_tool_use - `id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `input: map[unknown]` - `name: "advisor" or "web_search" or "web_fetch" or 5 more` - `"advisor"` - `"web_search"` - `"web_fetch"` - `"code_execution"` - `"bash_code_execution"` - `"text_editor_code_execution"` - `"tool_search_tool_regex"` - `"tool_search_tool_bm25"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaWebSearchToolResultBlock object` - `type: "web_search_tool_result"` default: web_search_tool_result - `content: BetaWebSearchToolResultBlockContent` - `BetaWebSearchToolResultError object` - `type: "web_search_tool_result_error"` default: web_search_tool_result_error - `error_code: BetaWebSearchToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `array of BetaWebSearchResultBlock` - `type: "web_search_result"` default: web_search_result - `encrypted_content: string` - `page_age: string or null` - `title: string` - `url: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaWebFetchToolResultBlock object` - `type: "web_fetch_tool_result"` default: web_fetch_tool_result - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - `BetaWebFetchToolResultErrorBlock object` - `type: "web_fetch_tool_result_error"` default: web_fetch_tool_result_error - `error_code: BetaWebFetchToolResultErrorCode` - `"invalid_tool_input"` - `"url_too_long"` - `"url_not_allowed"` - `"url_not_in_prior_context"` - `"url_not_accessible"` - `"unsupported_content_type"` - `"too_many_requests"` - `"max_uses_exceeded"` - `"unavailable"` - `"content_too_large"` - `BetaWebFetchBlock object` - `type: "web_fetch_result"` default: web_fetch_result - `content: BetaDocumentBlock` - `type: "document"` default: document - `citations: BetaCitationConfig or null` Citation configuration for the document - `enabled: boolean` default: false - `source: BetaBase64PDFSource or BetaPlainTextSource` - `BetaBase64PDFSource object` - `type: "base64"` - `data: string` format: byte - `media_type: "application/pdf"` - `BetaPlainTextSource object` - `type: "text"` - `data: string` - `media_type: "text/plain"` - `title: string or null` The title of the document - `retrieved_at: string or null` ISO 8601 timestamp when the content was retrieved - `url: string` Fetched content URL - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` - `BetaDirectCaller object` Tool invocation directly from the model. - `BetaServerToolCaller object` Tool invocation generated by a server-side tool. - `BetaServerToolCaller20260120 object` - `BetaAdvisorToolResultBlock object` - `type: "advisor_tool_result"` default: advisor_tool_result - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - `BetaAdvisorToolResultError object` - `type: "advisor_tool_result_error"` default: advisor_tool_result_error - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 4 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `"model_not_found"` - `BetaAdvisorResultBlock object` - `type: "advisor_result"` default: advisor_result - `stop_reason: string or null` 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` - `BetaAdvisorRedactedResultBlock object` - `type: "advisor_redacted_result"` default: advisor_redacted_result - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string or null` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCodeExecutionToolResultBlock object` - `type: "code_execution_tool_result"` default: code_execution_tool_result - `content: BetaCodeExecutionToolResultBlockContent` - `BetaCodeExecutionToolResultError object` - `type: "code_execution_tool_result_error"` default: code_execution_tool_result_error - `error_code: BetaCodeExecutionToolResultErrorCode` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `BetaCodeExecutionResultBlock object` - `type: "code_execution_result"` default: code_execution_result - `content: array of BetaCodeExecutionOutputBlock` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `BetaEncryptedCodeExecutionResultBlock object` Code execution result with encrypted stdout for PFC + web_search results. - `type: "encrypted_code_execution_result"` default: encrypted_code_execution_result - `content: array of BetaCodeExecutionOutputBlock` - `type: "code_execution_output"` default: code_execution_output - `file_id: string` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaBashCodeExecutionToolResultBlock object` - `type: "bash_code_execution_tool_result"` default: bash_code_execution_tool_result - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - `BetaBashCodeExecutionToolResultError object` - `type: "bash_code_execution_tool_result_error"` default: bash_code_execution_tool_result_error - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"output_file_too_large"` - `BetaBashCodeExecutionResultBlock object` - `type: "bash_code_execution_result"` default: bash_code_execution_result - `content: array of BetaBashCodeExecutionOutputBlock` - `type: "bash_code_execution_output"` default: bash_code_execution_output - `file_id: string` - `return_code: number` - `stderr: string` - `stdout: string` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaTextEditorCodeExecutionToolResultBlock object` - `type: "text_editor_code_execution_tool_result"` default: text_editor_code_execution_tool_result - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - `BetaTextEditorCodeExecutionToolResultError object` - `type: "text_editor_code_execution_tool_result_error"` default: text_editor_code_execution_tool_result_error - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `"file_not_found"` - `error_message: string or null` - `BetaTextEditorCodeExecutionViewResultBlock object` - `type: "text_editor_code_execution_view_result"` default: text_editor_code_execution_view_result - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number or null` - `start_line: number or null` - `total_lines: number or null` - `BetaTextEditorCodeExecutionCreateResultBlock object` - `type: "text_editor_code_execution_create_result"` default: text_editor_code_execution_create_result - `is_file_update: boolean` - `BetaTextEditorCodeExecutionStrReplaceResultBlock object` - `type: "text_editor_code_execution_str_replace_result"` default: text_editor_code_execution_str_replace_result - `lines: array of string or null` - `new_lines: number or null` - `new_start: number or null` - `old_lines: number or null` - `old_start: number or null` - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaToolSearchToolResultBlock object` - `type: "tool_search_tool_result"` default: tool_search_tool_result - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - `BetaToolSearchToolResultError object` - `type: "tool_search_tool_result_error"` default: tool_search_tool_result_error - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"` - `"invalid_tool_input"` - `"unavailable"` - `"too_many_requests"` - `"execution_time_exceeded"` - `error_message: string or null` - `BetaToolSearchToolSearchResultBlock object` - `type: "tool_search_tool_search_result"` default: tool_search_tool_search_result - `tool_references: array of BetaToolReferenceBlock` - `type: "tool_reference"` default: tool_reference - `tool_name: string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `tool_use_id: string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaMCPToolUseBlock object` - `type: "mcp_tool_use"` default: mcp_tool_use - `id: string` pattern: ^[a-zA-Z0-9_-]+$ - `input: map[unknown]` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `BetaMCPToolResultBlock object` - `type: "mcp_tool_result"` default: mcp_tool_result - `content: string or array of BetaTextBlock` - `string` - `BetaMCPToolResultBlockContent = array of BetaTextBlock` - `type: "text"` default: text - `citations: array of BetaTextCitation or null` 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` - `is_error: boolean` default: false - `tool_use_id: string` pattern: ^[a-zA-Z0-9_-]+$ - `BetaContainerUploadBlock object` Response model for a file uploaded to the container. - `type: "container_upload"` default: container_upload - `file_id: string` - `BetaCompactionBlock object` 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. - `type: "compaction"` default: compaction - `content: string or null` Summary of compacted content, or null if compaction failed - `encrypted_content: string or null` Opaque metadata from prior compaction, to be round-tripped verbatim - `signature: optional string or null` Signature over the summary, to be sent back with the block verbatim - `tool_changes: optional array of BetaResponseToolAdditionBlock or BetaResponseToolRemovalBlock or null` The tool changes of the compacted range: the `tool_addition` and `tool_removal` blocks that take the request's `tools` to the tool set in effect at the end of the range, or `[]` when the range changed no tool. Absent when the server did not compute them. Send the block back unchanged. - `BetaResponseToolAdditionBlock object` An entry of a `compaction` block's `tool_changes`: a tool the compacted range made available, as a reference to a `tools` entry or MCP toolset, or as the tool definition in effect at the end of the range, by value. Send it back unchanged. - `type: "tool_addition"` default: tool_addition - `tool: BetaResponseToolChangeToolReference or BetaResponseToolChangeMCPToolReference or BetaResponseToolChangeMCPToolsetReference or BetaToolChangeToolDefinition` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `BetaResponseToolChangeToolReference object` Reference to a single tool, by the name the model uses to call it, as a `compaction` block's `tool_changes` entry reports it: a tool declared in `tools` or defined by an earlier `tool_addition` block. Send it back unchanged with the block. - `type: "tool_reference"` default: tool_reference - `name: string` - `BetaResponseToolChangeMCPToolReference object` Reference to a single MCP tool, by its server and its name on that server, as a `compaction` block's `tool_changes` entry reports it. Send it back unchanged with the block. - `type: "mcp_tool_reference"` default: mcp_tool_reference - `name: string` - `server_name: string` - `BetaResponseToolChangeMCPToolsetReference object` Reference to every tool in the named MCP server's toolset, as a `compaction` block's `tool_changes` entry reports it. Send it back unchanged with the block. - `type: "mcp_toolset_reference"` default: mcp_toolset_reference - `server_name: string` - `BetaToolChangeToolDefinition object` A tool defined by value, as a `compaction` block's `tool_changes` entry reports it: `definition` is the tool's definition as it was sent, in the form of a `tools` entry, without `cache_control`. Send it back unchanged with the block. - `type: "tool_definition"` default: tool_definition - `definition: BetaResponseToolUnion` - `BetaResponseTool object` A custom tool definition, as sent. - `type: optional "custom" or null` - `input_schema: BetaResponseToolInputSchema` [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"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `description: optional string` Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `eager_input_streaming: optional boolean or null` 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. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolBash20241022 object` - `type: "bash_20241022"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - `ttl: optional "5m" or "1h"` 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`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=http) for details. - `"5m"` - `"1h"` - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolBash20250124 object` - `type: "bash_20250124"` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250522 object` - `type: "code_execution_20250522"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20250825 object` - `type: "code_execution_20250825"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20260120 object` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type: "code_execution_20260120"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaCodeExecutionTool20260521 object` Code execution tool with REPL state persistence. - `type: "code_execution_20260521"` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaBrowserToolset20260801 object` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `type: "browser_toolset_20260801"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional BetaBrowserToolsetConfigs or null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type: optional BetaBrowserTypeConfig or null` `type`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `close_tab: optional BetaBrowserCloseTabConfig or null` `close_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click: optional BetaBrowserDoubleClickConfig or null` `double_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `file_upload: optional BetaBrowserFileUploadConfig or null` `file_upload`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `find: optional BetaBrowserFindConfig or null` `find`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `form_input: optional BetaBrowserFormInputConfig or null` `form_input`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `get_page_text: optional BetaBrowserGetPageTextConfig or null` `get_page_text`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key: optional BetaBrowserHoldKeyConfig or null` `hold_key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hover: optional BetaBrowserHoverConfig or null` `hover`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `javascript_exec: optional BetaBrowserJavascriptExecConfig or null` `javascript_exec`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key: optional BetaBrowserKeyConfig or null` `key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click: optional BetaBrowserLeftClickConfig or null` `left_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag: optional BetaBrowserLeftClickDragConfig or null` `left_click_drag`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down: optional BetaBrowserLeftMouseDownConfig or null` `left_mouse_down`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up: optional BetaBrowserLeftMouseUpConfig or null` `left_mouse_up`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `list_tabs: optional BetaBrowserListTabsConfig or null` `list_tabs`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click: optional BetaBrowserMiddleClickConfig or null` `middle_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move: optional BetaBrowserMouseMoveConfig or null` `mouse_move`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `navigate: optional BetaBrowserNavigateConfig or null` `navigate`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `new_tab: optional BetaBrowserNewTabConfig or null` `new_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_console: optional BetaBrowserReadConsoleConfig or null` `read_console`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_network: optional BetaBrowserReadNetworkConfig or null` `read_network`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `read_page: optional BetaBrowserReadPageConfig or null` `read_page`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click: optional BetaBrowserRightClickConfig or null` `right_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot: optional BetaBrowserScreenshotConfig or null` `screenshot`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll: optional BetaBrowserScrollConfig or null` `scroll`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll_to: optional BetaBrowserScrollToConfig or null` `scroll_to`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `switch_tab: optional BetaBrowserSwitchTabConfig or null` `switch_tab`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click: optional BetaBrowserTripleClickConfig or null` `triple_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait: optional BetaBrowserWaitConfig or null` `wait`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom: optional BetaBrowserZoomConfig or null` `zoom`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaToolComputerUse20241022 object` - `type: "computer_20241022"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaMemoryTool20250818 object` - `type: "memory_20250818"` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20250124 object` - `type: "computer_20250124"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20241022 object` - `type: "text_editor_20241022"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolComputerUse20251124 object` - `type: "computer_20251124"` - `display_height_px: number` The height of the display in pixels. minimum: 1 - `display_width_px: number` The width of the display in pixels. minimum: 1 - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `display_number: optional number or null` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `enable_zoom: optional boolean` Whether to enable an action to take a zoomed-in screenshot of the screen. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaComputerToolset20260801 object` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `type: "computer_toolset_20260801"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional BetaComputerToolsetConfigs or null` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `type: optional BetaComputerTypeConfig or null` `type`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `cursor_position: optional BetaComputerCursorPositionConfig or null` `cursor_position`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `double_click: optional BetaComputerDoubleClickConfig or null` `double_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `hold_key: optional BetaComputerHoldKeyConfig or null` `hold_key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `key: optional BetaComputerKeyConfig or null` `key`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click: optional BetaComputerLeftClickConfig or null` `left_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_click_drag: optional BetaComputerLeftClickDragConfig or null` `left_click_drag`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_down: optional BetaComputerLeftMouseDownConfig or null` `left_mouse_down`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `left_mouse_up: optional BetaComputerLeftMouseUpConfig or null` `left_mouse_up`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `middle_click: optional BetaComputerMiddleClickConfig or null` `middle_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `mouse_move: optional BetaComputerMouseMoveConfig or null` `mouse_move`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `right_click: optional BetaComputerRightClickConfig or null` `right_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `screenshot: optional BetaComputerScreenshotConfig or null` `screenshot`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `scroll: optional BetaComputerScrollConfig or null` `scroll`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `triple_click: optional BetaComputerTripleClickConfig or null` `triple_click`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `wait: optional BetaComputerWaitConfig or null` `wait`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `zoom: optional BetaComputerZoomConfig or null` `zoom`'s config overrides. - `defer_loading: optional boolean or null` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `enabled: optional boolean or null` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaToolTextEditor20250124 object` - `type: "text_editor_20250124"` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250429 object` - `type: "text_editor_20250429"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolTextEditor20250728 object` - `type: "text_editor_20250728"` - `name: "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples: optional array of map[unknown]` - `max_characters: optional number or null` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaWebSearchTool20250305 object` - `type: "web_search_20250305"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city: optional string or null` The city of the user. minLength: 1, maxLength: 255 - `country: optional string or null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `region: optional string or null` The region of the user. minLength: 1, maxLength: 255 - `timezone: optional string or null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `BetaWebFetchTool20250910 object` - `type: "web_fetch_20250910"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `enabled: optional boolean` - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `client_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type: "all"` - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type: "none"` - `BetaWebFetchURLSourceOnly object` The tool filter variant under which only the named tools' results contribute. - `type: "only"` - `tools: array of BetaWebFetchURLSourceToolReference` - `type: "tool_reference"` - `name: string` - `BetaWebFetchURLSourceExcept object` The tool filter variant under which every result but the named tools' contributes. - `type: "except"` - `tools: array of BetaWebFetchURLSourceToolReference` - `type: "tool_reference"` - `name: string` - `server_tool_results: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone or BetaWebFetchURLSourceOnly or BetaWebFetchURLSourceExcept` Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute. - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `BetaWebFetchURLSourceOnly object` The tool filter variant under which only the named tools' results contribute. - `BetaWebFetchURLSourceExcept object` The tool filter variant under which every result but the named tools' contributes. - `user_input: optional BetaWebFetchURLSourceAll or BetaWebFetchURLSourceNone` Whether URLs in user messages are fetchable: "all" or "none". - `BetaWebFetchURLSourceAll object` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `BetaWebFetchURLSourceNone object` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `BetaWebSearchTool20260209 object` - `type: "web_search_20260209"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `BetaWebFetchTool20260209 object` - `type: "web_fetch_20260209"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `BetaWebFetchTool20260309 object` Web fetch tool with use_cache parameter for bypassing cached content. - `type: "web_fetch_20260309"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache: optional boolean` 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. - `BetaWebSearchTool20260318 object` - `type: "web_search_20260318"` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string or null` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion: optional "full" or "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional BetaUserLocation or null` Parameters for the user's location. Used to provide more relevant search results. - `BetaWebFetchTool20260318 object` - `type: "web_fetch_20260318"` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `allowed_domains: optional array of string or null` List of domains to allow fetching from - `blocked_domains: optional array of string or null` List of domains to block fetching from - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional BetaCitationsConfigParam or null` Citations configuration for fetched documents. Citations are disabled by default. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens: optional number or null` 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. minimum: 1 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `response_inclusion: optional "full" or "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `"full"` - `"excluded"` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `url_sources: optional BetaWebFetchURLSources or null` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `use_cache: optional boolean` 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. - `BetaAdvisorTool20260301 object` - `type: "advisor_20260301"` - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-mythos-5"` Most capable model for cybersecurity and biology research - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `name: "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `caching: optional BetaCacheControlEphemeral or null` 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. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_tokens: optional number or null` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. minimum: 1 - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolBm25_20251119 object` - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `name: "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaToolSearchToolRegex20251119 object` - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `name: "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `"code_execution_20260521"` - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `defer_loading: optional boolean` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `BetaMCPToolset object` 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. - `type: "mcp_toolset"` - `mcp_server_name: string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `cache_control: optional BetaCacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `configs: optional map[BetaMCPToolConfig] or null` Configuration overrides for specific tools, keyed by tool name - `defer_loading: optional boolean` - `enabled: optional boolean` - `default_config: optional BetaMCPToolDefaultConfig` Default configuration applied to all tools from this server - `defer_loading: optional boolean` - `enabled: optional boolean` - `tools: optional array of BetaMCPToolParam or null` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `input_schema: map[unknown]` The tool's input schema as the MCP server lists it, verbatim. - `name: string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `description: optional string or null` The tool's description as the MCP server lists it. - `BetaResponseToolRemovalBlock object` An entry of a `compaction` block's `tool_changes`: a tool of the request's `tools` (or an MCP tool or toolset) that the compacted range withdrew. Send it back unchanged. - `type: "tool_removal"` default: tool_removal - `tool: BetaResponseToolChangeToolReference or BetaResponseToolChangeMCPToolReference or BetaResponseToolChangeMCPToolsetReference` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `BetaResponseToolChangeToolReference object` Reference to a single tool, by the name the model uses to call it, as a `compaction` block's `tool_changes` entry reports it: a tool declared in `tools` or defined by an earlier `tool_addition` block. Send it back unchanged with the block. - `BetaResponseToolChangeMCPToolReference object` Reference to a single MCP tool, by its server and its name on that server, as a `compaction` block's `tool_changes` entry reports it. Send it back unchanged with the block. - `BetaResponseToolChangeMCPToolsetReference object` Reference to every tool in the named MCP server's toolset, as a `compaction` block's `tool_changes` entry reports it. Send it back unchanged with the block. - `BetaFallbackBlock object` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `type: "fallback"` default: fallback - `from: BetaFallbackInfo` The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id. - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `to: BetaFallbackInfo` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `trigger: BetaFallbackRefusalTrigger` What caused the `from` model to hand over at this hop. - `type: "refusal"` default: refusal - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null` The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.category`. - `"cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `"bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `"frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `"reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=http). - `"general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `BetaMCPToolListingBlock object` The tool listing the server fetched from an MCP server while producing this response. Send the assistant message back unchanged, this block included, so later requests use this listing instead of asking the MCP server again. - `type: "mcp_tool_listing"` default: mcp_tool_listing - `mcp_server_name: string` - `tools: array of BetaMCPTool` - `input_schema: map[unknown]` - `name: string` - `description: optional string` - `context_management: BetaContextManagementResponse or null` Context management response. Information about context management strategies applied during the request. - `applied_edits: array of BetaClearToolUses20250919EditResponse or BetaClearThinking20251015EditResponse` List of context management edits that were applied. - `BetaClearToolUses20250919EditResponse object` - `type: "clear_tool_uses_20250919"` The type of context management edit applied. default: clear_tool_uses_20250919 - `cleared_input_tokens: number` Number of input tokens cleared by this edit. minimum: 0 - `cleared_tool_uses: number` Number of tool uses that were cleared. minimum: 0 - `BetaClearThinking20251015EditResponse object` - `type: "clear_thinking_20251015"` The type of context management edit applied. default: clear_thinking_20251015 - `cleared_input_tokens: number` Number of input tokens cleared by this edit. minimum: 0 - `cleared_thinking_turns: number` Number of thinking turns that were cleared. minimum: 0 - `diagnostics: BetaDiagnostics or null` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `cache_miss_reason: BetaCacheMissReason or null` 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. - `BetaCacheMissModelChanged object` - `type: "model_changed"` default: model_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `BetaCacheMissSystemChanged object` - `type: "system_changed"` default: system_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `BetaCacheMissToolsChanged object` - `type: "tools_changed"` default: tools_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `BetaCacheMissMessagesChanged object` - `type: "messages_changed"` default: messages_changed - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `BetaCacheMissPreviousMessageNotFound object` - `type: "previous_message_not_found"` default: previous_message_not_found - `BetaCacheMissUnavailable object` - `type: "unavailable"` default: 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. - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. default: assistant - `stop_details: BetaRefusalStopDetails or null` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `type: "refusal"` default: refusal - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `"bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `"frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `"reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=http). - `"general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `explanation: string or null` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `fallback_credit_token: string or null` Opaque code that refunds the cache-miss cost when retrying this refused request on the fallback model. Pass it as `fallback_credit_token` on the retry request. Expires 5 minutes after the refusal. The retry is sent either with the same request body (`system`, `messages`, `tools`, and other render-shaping fields), or with the same body plus one appended `assistant` message whose content is the partial text (with any trailing whitespace stripped from the final text block) and paired server-tool blocks from this refusal — which also authorizes that appended turn as an assistant-prefill continuation on models that otherwise disallow prefill. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed the second way — if a same-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry the second way instead. Either way: same workspace, same platform; a mismatch is a 400. Resending a token for an already-warm prefix is permitted but yields no additional credit. `null` when the refused model isn't eligible for a fallback credit. - `fallback_has_prefill_claim: boolean or null` Whether the accompanying `fallback_credit_token` may be redeemed with the appended-assistant retry form. Only set when `fallback_credit_token` is present. `true`: retry by resending the same request body plus one appended `assistant` message whose content is this response's `content` with any trailing whitespace stripped from the final text block and unpaired `tool_use` blocks omitted (the same appended-turn shape described on `fallback_credit_token`), with the token attached. `false`: retry by resending the original request body unchanged, with the token attached — the appended-assistant form is not available for this refusal (no continuable partial content, or the request uses `output_format` or a `tool_choice` that forces tool use). One exception: when the request used `output_format` or a forced `tool_choice` and the refusal arrived after server tools (including MCP connector tools) had already executed, the token may not be redeemable by either retry form; if the exact-body retry is then rejected with a 400 saying the token must be redeemed by continuing the partial response, discard the token and retry without it. Advisory: if an appended-assistant retry is rejected with a 400 despite `true`, fall back to resending the original request body with the token. - `recommended_model: string or null` The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise. - `stop_reason: BetaStopReason or null` 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 * `"model_context_window_exceeded"`: we exceeded the model's context window 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. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string or null` 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. - `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`. - `cache_creation: BetaCacheCreation or null` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `cache_creation_input_tokens: number or null` The number of input tokens used to create the cache entry. minimum: 0 - `cache_read_input_tokens: number or null` The number of input tokens read from the cache. minimum: 0 - `fallback_credit: BetaFallbackCreditUsage or null` Outcome of the `fallback_credit_token` presented on this request. Present on every response to a non-batch request that carried a `fallback_credit_token`, in either redemption mode; absent otherwise (batch items accept and ignore the token and carry no outcome object). - `status: BetaFallbackCreditRedeemed or BetaFallbackCreditNotApplied` Whether the fallback-credit reprice was applied to this response's billing. A union discriminated on `type`. `redeemed`: the retry is billed as if the conversation had been on the retry model all along — including when the resulting shift is zero because there was nothing to move. `not_applied`: no reprice was applied; the arm's `reason` says why. - `BetaFallbackCreditRedeemed object` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `type: "redeemed"` default: redeemed - `BetaFallbackCreditNotApplied object` No reprice was applied; `reason` says why. - `type: "not_applied"` default: not_applied - `reason: "body_mismatch" or "continuation_excluded" or "continuation_only" or 9 more` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `"body_mismatch"` - `"continuation_excluded"` - `"continuation_only"` - `"expired"` - `"invalid_target_model"` - `"not_enabled"` - `"reprice_unavailable"` - `"temporarily_unavailable"` - `"variant_fields_present"` - `"wrong_organization"` - `"wrong_platform"` - `"wrong_workspace"` - `remove_to_redeem: optional array of string or null` Request fields to remove before retrying, so the retry can redeem this token. Present exactly when `reason` is `variant_fields_present` — never null, never an empty array; absent otherwise. Fields are named only from your own request, and only after the sealed variant hash matched. A served best-effort retry has already been billed at normal price; nothing redeems retroactively, but a corrected re-send inside the token's five-minute window can still redeem. - `inference_geo: string or null` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `iterations: BetaIterationsUsage or null` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by `type`. For `message` entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to: - Calculate the context window size from the last `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. - `BetaMessageIterationUsage object` Token usage for a sampling iteration. - `type: "message"` Usage for a sampling iteration default: message - `cache_creation: BetaCacheCreation or null` Breakdown of cached tokens by TTL - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `cache_read_input_tokens: number` The number of input tokens read from the cache. default: 0, minimum: 0 - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `model: Model or null` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `BetaCompactionIterationUsage object` Token usage for a compaction iteration. - `type: "compaction"` Usage for a compaction iteration default: compaction - `cache_creation: BetaCacheCreation or null` Breakdown of cached tokens by TTL - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `cache_read_input_tokens: number` The number of input tokens read from the cache. default: 0, minimum: 0 - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `BetaAdvisorMessageIterationUsage object` Token usage for an advisor sub-inference iteration. - `type: "advisor_message"` Usage for an advisor sub-inference iteration default: advisor_message - `cache_creation: BetaCacheCreation or null` Breakdown of cached tokens by TTL - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `cache_read_input_tokens: number` The number of input tokens read from the cache. default: 0, minimum: 0 - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `BetaFallbackMessageIterationUsage object` Token usage for the fallback-model attempt of a server-side fallback request. The terminal entry of a fallback-served turn: when a fallback hop's output is the returned message, the entry for the iteration that completed it carries this type in place of `message`. A declined hop and the serving hop's earlier tool-loop iterations produce `message` entries. Whether a fallback model served the response is signalled by the presence of this entry in `usage.iterations`. - `type: "fallback_message"` Usage for the fallback-model attempt that served the response default: fallback_message - `cache_creation: BetaCacheCreation or null` Breakdown of cached tokens by TTL - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `cache_read_input_tokens: number` The number of input tokens read from the cache. default: 0, minimum: 0 - `input_tokens: number` The number of input tokens which were used. minimum: 0 - `model: Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `output_tokens: number` The number of output tokens which were used. minimum: 0 - `output_tokens_details: BetaOutputTokensDetails or null` 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. - `thinking_tokens: number` 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. default: 0, minimum: 0 - `server_tool_use: BetaServerToolUsage or null` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. default: 0, minimum: 0 - `web_search_requests: number` The number of web search tool requests. default: 0, minimum: 0 - `service_tier: "standard" or "priority" or "batch" or null` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" or "fast" or null` The inference speed mode used for this request. - `"standard"` - `"fast"` - `input_transformations: optional array of BetaInputTransformation or null` Changes the API made to the request's input before showing it to the model, and blocks that failed a binding check but were left unchanged: one entry per block, in request order. Two entry types today. `thinking_dropped` — a `thinking`, `redacted_thinking` or `connector_text` block from the request's `messages` that was removed from the prompt instead of being shown to the model because it failed a binding check. `thinking_mismatch_allowed` — a `thinking` or `redacted_thinking` block that failed the conversation check (the conversation before it differs from the one it was created in, or it carries no record of one on a model that requires it) and was shown to the model all the same, because that check is not enforced for this request. More entry types may be added over time; ignore types you do not recognize. Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on every such response from a model that supports extended thinking, as `[]` when there is no entry to report; without the beta, blocks are removed or left in place all the same but nothing is reported. Removed blocks contribute nothing to `usage.input_tokens`; blocks left in place count as sent. When streaming, the array is final in `message_start`; the final `message_delta` event carries it only when a server-side model fallback happened mid-stream, in which case it holds the serving model's entries and replaces the one in `message_start`. - `BetaThinkingDroppedInputTransformation object` - `type: "thinking_dropped"` Always `thinking_dropped` for this entry type. default: thinking_dropped - `path: string` Where the removed block was in your request, as `messages.{i}.content.{j}`: `i` indexes the `messages` array you sent and `j` that message's `content` array — the same form error messages use. - `reason: "model_binding_mismatch" or "prefix_binding_mismatch" or "organization_binding_mismatch" or "end_user_binding_mismatch"` Which binding check removed the block: `model_binding_mismatch` — it was created by a model whose reasoning the requested model may not read; `prefix_binding_mismatch` — the conversation before it differs from the conversation it was created in (the rest of that turn's consecutive thinking blocks are removed with it, each with this reason); `organization_binding_mismatch` — it was created under a different organization (an Anthropic organization, AWS account or Google Cloud project) and this organization is not one of its additional organizations; `end_user_binding_mismatch` — it was created for a different end user, or was removed by the consumer-organization binding. A block that would fail several checks reports one reason, in this order of precedence: `organization_binding_mismatch`, `end_user_binding_mismatch`, `model_binding_mismatch`, `prefix_binding_mismatch`. - `"model_binding_mismatch"` - `"prefix_binding_mismatch"` - `"organization_binding_mismatch"` - `"end_user_binding_mismatch"` - `BetaThinkingMismatchAllowedInputTransformation object` - `type: "thinking_mismatch_allowed"` Always `thinking_mismatch_allowed` for this entry type. default: thinking_mismatch_allowed - `path: string` Where the block is in your request, as `messages.{i}.content.{j}`: `i` indexes the `messages` array you sent and `j` that message's `content` array — the same form error messages use. - `reason: "model_binding_mismatch" or "prefix_binding_mismatch" or "organization_binding_mismatch" or "end_user_binding_mismatch"` Which binding check the block failed; the block was shown to the model all the same. Always `prefix_binding_mismatch` today — the conversation before the block differs from the conversation it was created in, or the block carries no record of one on a model that requires it. Were the check enforced for this request, the block would have been removed or the request rejected (`thinking.block_binding.prefix_mismatch_behavior`). A removal also takes the rest of that turn's consecutive thinking blocks, whereas here each block is checked on its own, so `thinking_mismatch_allowed` entries are a lower bound on what enforcement would remove. - `"model_binding_mismatch"` - `"prefix_binding_mismatch"` - `"organization_binding_mismatch"` - `"end_user_binding_mismatch"` - `BetaMessageBatchErroredResult object` - `type: "errored"` default: errored - `error: BetaErrorResponse` - `type: "error"` default: error - `error: BetaError` - `BetaInvalidRequestError object` - `type: "invalid_request_error"` default: invalid_request_error - `message: string` default: Invalid request - `BetaAuthenticationError object` - `type: "authentication_error"` default: authentication_error - `message: string` default: Authentication error - `BetaBillingError object` - `type: "billing_error"` default: billing_error - `message: string` default: Billing error - `BetaPermissionError object` - `type: "permission_error"` default: permission_error - `message: string` default: Permission denied - `BetaNotFoundError object` - `type: "not_found_error"` default: not_found_error - `message: string` default: Not found - `BetaRateLimitError object` - `type: "rate_limit_error"` default: rate_limit_error - `message: string` default: Rate limited - `BetaGatewayTimeoutError object` - `type: "timeout_error"` default: timeout_error - `message: string` default: Request timeout - `BetaAPIError object` - `type: "api_error"` default: api_error - `message: string` default: Internal server error - `BetaOverloadedError object` - `type: "overloaded_error"` default: overloaded_error - `message: string` default: Overloaded - `request_id: string or null` - `BetaMessageBatchCanceledResult object` - `type: "canceled"` default: canceled - `BetaMessageBatchExpiredResult object` - `type: "expired"` default: expired #### Example ```bash curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID/results \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: message-batches-2024-09-24' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ## Beta › Agents ### Create Agent **POST** `/v1/agents` Create Agent #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `model: BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams` Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=http#latest-models-comparison), e.g. `claude-opus-5-5`, or a `model_config` object for additional configuration control - `BetaManagedAgentsModel = "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-opus-5-5" or 14 more or string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `BetaManagedAgentsModelConfigParams object` 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. - `effort: optional "low" or "medium" or "high" or 2 more or BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or 3 more or null` How hard Claude works on each inference call. Accepts a bare level string (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged. - `"low"` Low effort. Favors latency over reasoning depth. - `"medium"` Medium effort. Balances latency and reasoning depth. - `"high"` High effort. Favors reasoning depth. - `"xhigh"` Extra-high effort. Not all models accept this level. - `"max"` Maximum effort. Favors reasoning depth over latency. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string or null` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it. - `speed: optional "standard" or "fast" or null` Inference speed mode. Defaults to `standard`. - `"standard"` - `"fast"` - `name: string` Human-readable name for the agent. minLength: 1, maxLength: 256 - `description: optional string or null` Description of what the agent does. maxLength: 2048 - `execution_identity: optional BetaManagedAgentsExecutionIdentityParams or null` Execution principal for runs of this agent. Omitting it, sending null, or sending `{"type": "service_account"}` stores the default. - `BetaManagedAgentsAWSRoleExecutionIdentityParams object` An AWS IAM role principal. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN, e.g. "arn:aws:iam::123456789012:role/my-agent-runner". Maximum 2048 characters. maxLength: 2048 - `BetaManagedAgentsServiceAccountExecutionIdentityParams object` The Anthropic-managed service account — the default execution principal. Carries no identifier. - `type: "service_account"` - `mcp_servers: optional array of BetaManagedAgentsURLMCPServerParams` MCP servers this agent connects to. Maximum 20. Names must be unique within the array. Every server must be referenced by an `mcp_toolset` in `tools`; unreferenced servers are rejected. See the [MCP connector guide](https://platform.claude.com/docs/en/managed-agents/mcp-connector?sdk_languages=http). - `type: "url"` - `name: string` Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters. minLength: 1, maxLength: 255 - `url: string` Endpoint URL for the MCP server. maxLength: 2048 - `metadata: optional map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `multiagent: optional BetaManagedAgentsMultiagentParams or null` Multiagent orchestration configuration. - `BetaManagedAgentsMultiagentCoordinatorParams object` A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster. - `type: "coordinator"` - `agents: array of BetaManagedAgentsMultiagentRosterEntryParams` 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` - `BetaManagedAgentsAgentParams object` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `type: "agent"` - `id: string` The `agent` ID. minLength: 1, maxLength: 128 - `version: optional number` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. format: int32 - `BetaManagedAgentsMultiagentSelfParams object` Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. - `type: "self"` - `BetaManagedAgentsAdvisorParams object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. At most one per roster; the entry occupies the roster name `anthropic.advisor`. - `type: "advisor"` - `model: string` A Claude model id. The model must be permitted as an advisor for this agent's model. minLength: 1, maxLength: 256 - `BetaManagedAgentsMultiagent20261001Params object` Multiagent configuration with three members, each enabled or disabled on its own. On an update, if the agent's stored `multiagent` also has type `multiagent_20261001`, this configuration is merged into the stored one, level by level, instead of replacing it. A key that the update omits keeps its stored value. A key sent as null takes its default, on create as well, so `"workflows": null` enables workflows. An object sent with a `type` other than the stored one replaces the stored object, and the keys that it omits take their defaults. A `predefined_agents` list that is sent replaces the stored list. Every object that is sent needs its `type`, and an enabled `advisor` needs its `model`. Other validation applies to the merged result. - `type: "multiagent_20261001"` - `advisor: optional BetaManagedAgentsMultiagentAdvisorParams or null` Whether the session's primary thread can consult an advisor model. Defaults to disabled. - `BetaManagedAgentsMultiagentAdvisorEnabledParams object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` A Claude model id. The model must be permitted as an advisor for this agent's model. minLength: 1, maxLength: 256 - `BetaManagedAgentsMultiagentAdvisorDisabledParams object` The agent has no advisor. - `type: "disabled"` - `subagents: optional BetaManagedAgentsMultiagentSubagentsParams or null` Whether the agent can spawn session threads. Defaults to enabled. - `BetaManagedAgentsMultiagentSubagentsEnabledParams object` The agent can spawn session threads. Each thread runs a predefined agent, which is a saved agent in `predefined_agents`, or an inline agent, which the agent defines when it spawns the thread and which is not saved. If `inline_agents` is disabled, `predefined_agents` must name at least one agent. - `type: "enabled"` - `inline_agents: optional BetaManagedAgentsMultiagentInlineAgentsParams or null` Whether the agent can define inline agents when it spawns session threads. Defaults to enabled. - `BetaManagedAgentsMultiagentInlineAgentsEnabledParams object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabledParams object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: optional array of BetaManagedAgentsMultiagentPredefinedAgentParams or null` Predefined agents that this agent can spawn as session threads. At most 20. Defaults to null. Null and an empty list both mean no predefined agents. This list is separate from `workflows.predefined_agents`, and an agent in one list is not added to the other. - `string` - `BetaManagedAgentsAgentParams object` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `BetaManagedAgentsMultiagentSelfParams object` Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. - `BetaManagedAgentsMultiagentSubagentsDisabledParams object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: optional BetaManagedAgentsMultiagentWorkflowsParams or null` Whether the agent can start workflow runs. Defaults to enabled. - `BetaManagedAgentsMultiagentWorkflowsEnabledParams object` The agent can start workflow runs. Each run follows a plan, a program that the agent writes. A plan can use predefined agents, which are the saved agents in `predefined_agents`, and inline agents, which it defines itself and which are not saved. If `inline_agents` is disabled, `predefined_agents` must name at least one agent. - `type: "enabled"` - `inline_agents: optional BetaManagedAgentsMultiagentInlineAgentsParams or null` Whether a run's plan can define inline agents. Defaults to enabled. - `predefined_agents: optional array of BetaManagedAgentsMultiagentPredefinedAgentParams or null` Predefined agents that a run's plan can use. At most 20. Defaults to null. Null and an empty list both mean no predefined agents. This list is separate from `subagents.predefined_agents`, and an agent in one list is not added to the other. - `string` - `BetaManagedAgentsAgentParams object` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `BetaManagedAgentsMultiagentSelfParams object` Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. - `BetaManagedAgentsMultiagentWorkflowsDisabledParams object` The agent cannot start workflow runs. - `type: "disabled"` - `skills: optional array of BetaManagedAgentsSkillParams` Skills available to the agent. - `BetaManagedAgentsAnthropicSkillParams object` An Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` Identifier of the Anthropic skill (e.g., "xlsx"). minLength: 1, maxLength: 64 - `version: optional string or null` Version to pin. Defaults to latest if omitted. minLength: 1, maxLength: 64 - `BetaManagedAgentsCustomSkillParams object` A user-created custom skill. - `type: "custom"` - `skill_id: string` Tagged ID of the custom skill (e.g., "skill_01XJ5..."). minLength: 1, maxLength: 64 - `version: optional string or null` Version to pin. Defaults to latest if omitted. minLength: 1, maxLength: 64 - `system: optional string or null` System prompt for the agent. maxLength: 100000 - `tools: optional array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams` Tool configurations available to the agent. Maximum of 256 tools across all toolsets allowed. - `BetaManagedAgentsAgentToolset20260401Params object` Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent. - `type: "agent_toolset_20260401"` - `configs: optional array of BetaManagedAgentsAgentToolConfigParams` Per-tool configuration overrides. - `BetaManagedAgentsBashToolConfigParams object` Configuration override for the bash tool. - `type: optional "bash"` - `name: "bash"` Must be "bash". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfigParams object` Configuration override for the edit tool. - `type: optional "edit"` - `name: "edit"` Must be "edit". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfigParams object` Configuration override for the read tool. - `type: optional "read"` - `name: "read"` Must be "read". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfigParams object` Configuration override for the write tool. - `type: optional "write"` - `name: "write"` Must be "write". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfigParams object` Configuration override for the glob tool. - `type: optional "glob"` - `name: "glob"` Must be "glob". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfigParams object` Configuration override for the grep tool. - `type: optional "grep"` - `name: "grep"` Must be "grep". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfigParams object` Configuration override for the web_fetch tool. - `type: optional "web_fetch"` - `name: "web_fetch"` Must be "web_fetch". - `allowed_domains: optional array of string` Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. - `blocked_domains: optional array of string` Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `max_content_tokens: optional number or null` Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. format: int32 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: optional BetaManagedAgentsWebFetchURLSourcesParams or null` Which sources contribute URLs the tool may fetch. Omit to allow every source. - `client_tool_results: optional BetaManagedAgentsWebFetchURLSourceToolFilterParams or null` Which custom tools' results contribute URLs that may be fetched: "all" (the default), "none", or an only or except list. Each name in a list must be a custom tool in the same tools array. - `BetaManagedAgentsWebFetchURLSourceShorthand = "all" or "none"` String form of a url_sources value that has no field other than its type: "all" means {"type": "all"} and "none" means {"type": "none"}. - `"all"` - `"none"` - `BetaManagedAgentsWebFetchURLSourceToolFilter = BetaManagedAgentsWebFetchURLSourceAll or BetaManagedAgentsWebFetchURLSourceNone or BetaManagedAgentsWebFetchURLSourceOnly or BetaManagedAgentsWebFetchURLSourceExcept` Which tools' results contribute URLs that may be fetched. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: optional BetaManagedAgentsWebFetchURLSourceToolFilterParams or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched: "all" (the default), "none", or an only or except list. Each name in a list must be "web_search" or "web_fetch". - `user_input: optional BetaManagedAgentsWebFetchURLSourceUserInputParams or null` Whether URLs in the text of user messages may be fetched: "all" (the default) or "none". - `BetaManagedAgentsWebFetchURLSourceShorthand = "all" or "none"` String form of a url_sources value that has no field other than its type: "all" means {"type": "all"} and "none" means {"type": "none"}. - `BetaManagedAgentsWebFetchURLSourceUserInput = BetaManagedAgentsWebFetchURLSourceAll or BetaManagedAgentsWebFetchURLSourceNone` Whether URLs in the text of user messages may be fetched. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `BetaManagedAgentsWebSearchToolConfigParams object` Configuration override for the web_search tool. - `type: optional "web_search"` - `name: "web_search"` Must be "web_search". - `allowed_domains: optional array of string` Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. - `blocked_domains: optional array of string` Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` Default configuration applied to all tools in this set. - `enabled: optional boolean or null` Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolsetParams object` Configuration for tools from an MCP server defined in `mcp_servers`. - `type: "mcp_toolset"` - `mcp_server_name: string` Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters. minLength: 1, maxLength: 255 - `configs: optional array of BetaManagedAgentsMCPToolConfigParams` Per-tool configuration overrides. - `name: string` Name of the MCP tool to configure. 1-128 characters. minLength: 1, maxLength: 128 - `enabled: optional boolean or null` Whether this tool is enabled. Overrides the `default_config` setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Overrides the `default_config` setting. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` Default configuration for all tools from this server. - `enabled: optional boolean or null` Whether tools are enabled by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Default permission policy for tools from this server. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsCustomToolParams object` 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. - `type: "custom"` - `description: string` Description of what the tool does, shown to the agent to help it decide when to use the tool. minLength: 1 - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema defining the expected input parameters for the tool. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens. minLength: 1, maxLength: 128 #### Returns - `BetaManagedAgentsAgent object` A Managed Agents `agent`. - `type: "agent"` - `id: string` - `archived_at: string or null` When the agent was archived. Null if not archived. format: date-time - `created_at: string` A timestamp in RFC 3339 format format: date-time - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal for runs of this agent. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `metadata: map[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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsMultiagent or null` Multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsMultiagentCoordinator object` Resolved coordinator topology with a concrete agent roster. - `type: "coordinator"` - `agents: array of BetaManagedAgentsAgentReference or BetaManagedAgentsAdvisor` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `BetaManagedAgentsAgentReference object` A resolved agent reference with a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagent20261001 object` Resolved multiagent configuration with three members, each enabled or disabled on its own. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsAgentReference` Predefined agents, which are saved agents that this agent can spawn as session threads, each resolved to a specific version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsAgentReference` Predefined agents, which are saved agents that a run's plan can use, each resolved to a specific version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. format: int32 #### Example ```bash curl https://api.anthropic.com/v1/agents \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "model": "claude-opus-5-5", "name": "My First Agent", "description": "A general-purpose starter agent.", "metadata": { "foo": "bar" }, "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": [ { "type": "agent_toolset_20260401" } ] }' ``` ##### Response (200) ```json { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "advisor": { "type": "disabled" }, "subagents": { "inline_agents": { "type": "enabled" }, "predefined_agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "enabled" }, "type": "multiagent_20261001", "workflows": { "inline_agents": { "type": "enabled" }, "predefined_agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "enabled" } }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTmx", "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" }, "type": "bash" } ], "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 **GET** `/v1/agents` List Agents #### Query parameters - `"created_at[gte]": optional string` Return agents created at or after this time (inclusive). format: date-time - `"created_at[lte]": optional string` Return agents created at or before this time (inclusive). format: date-time - `include_archived: optional boolean` Include archived agents in results. Defaults to false. - `limit: optional number` Maximum results per page. Default 20, maximum 100. format: int32 - `page: optional string` Opaque pagination cursor from a previous response. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaManagedAgentsAgent` List of agents. - `type: "agent"` - `id: string` - `archived_at: string or null` When the agent was archived. Null if not archived. format: date-time - `created_at: string` A timestamp in RFC 3339 format format: date-time - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal for runs of this agent. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `metadata: map[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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsMultiagent or null` Multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsMultiagentCoordinator object` Resolved coordinator topology with a concrete agent roster. - `type: "coordinator"` - `agents: array of BetaManagedAgentsAgentReference or BetaManagedAgentsAdvisor` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `BetaManagedAgentsAgentReference object` A resolved agent reference with a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagent20261001 object` Resolved multiagent configuration with three members, each enabled or disabled on its own. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsAgentReference` Predefined agents, which are saved agents that this agent can spawn as session threads, each resolved to a specific version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsAgentReference` Predefined agents, which are saved agents that a run's plan can use, each resolved to a specific version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. format: int32 - `next_page: optional string or null` Opaque cursor for the next page. Null when no more results. #### Example ```bash curl https://api.anthropic.com/v1/agents \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "advisor": { "type": "disabled" }, "subagents": { "inline_agents": { "type": "enabled" }, "predefined_agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "enabled" }, "type": "multiagent_20261001", "workflows": { "inline_agents": { "type": "enabled" }, "predefined_agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "enabled" } }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTmx", "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" }, "type": "bash" } ], "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 **GET** `/v1/agents/{agent_id}` Get Agent #### Path parameters - `agent_id: string` Unique identifier of the agent to retrieve. #### Query parameters - `version: optional number` Agent version. Omit for the most recent version. Must be at least 1 if specified. format: int32 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsAgent object` A Managed Agents `agent`. - `type: "agent"` - `id: string` - `archived_at: string or null` When the agent was archived. Null if not archived. format: date-time - `created_at: string` A timestamp in RFC 3339 format format: date-time - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal for runs of this agent. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `metadata: map[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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsMultiagent or null` Multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsMultiagentCoordinator object` Resolved coordinator topology with a concrete agent roster. - `type: "coordinator"` - `agents: array of BetaManagedAgentsAgentReference or BetaManagedAgentsAdvisor` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `BetaManagedAgentsAgentReference object` A resolved agent reference with a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagent20261001 object` Resolved multiagent configuration with three members, each enabled or disabled on its own. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsAgentReference` Predefined agents, which are saved agents that this agent can spawn as session threads, each resolved to a specific version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsAgentReference` Predefined agents, which are saved agents that a run's plan can use, each resolved to a specific version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. format: int32 #### Example ```bash curl https://api.anthropic.com/v1/agents/$AGENT_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "advisor": { "type": "disabled" }, "subagents": { "inline_agents": { "type": "enabled" }, "predefined_agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "enabled" }, "type": "multiagent_20261001", "workflows": { "inline_agents": { "type": "enabled" }, "predefined_agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "enabled" } }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTmx", "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" }, "type": "bash" } ], "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 **POST** `/v1/agents/{agent_id}` Update Agent #### Path parameters - `agent_id: string` Unique identifier of the agent to update. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `description: optional string or null` Description. Omit to preserve; send empty string or null to clear. maxLength: 2048 - `execution_identity: optional BetaManagedAgentsExecutionIdentityParams or null` Execution principal for runs of this agent. Full replacement. Omit to preserve; send null or `{"type": "service_account"}` to restore the default. - `BetaManagedAgentsAWSRoleExecutionIdentityParams object` An AWS IAM role principal. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN, e.g. "arn:aws:iam::123456789012:role/my-agent-runner". Maximum 2048 characters. maxLength: 2048 - `BetaManagedAgentsServiceAccountExecutionIdentityParams object` The Anthropic-managed service account — the default execution principal. Carries no identifier. - `type: "service_account"` - `mcp_servers: optional array of BetaManagedAgentsURLMCPServerParams or null` MCP servers. Full replacement. Omit to preserve; send empty array or `null` to clear. Names must be unique. Maximum 20. Every server must be referenced by an `mcp_toolset` in the agent's resulting `tools`; unreferenced servers are rejected. See the [MCP connector guide](https://platform.claude.com/docs/en/managed-agents/mcp-connector?sdk_languages=http). - `type: "url"` - `name: string` Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters. minLength: 1, maxLength: 255 - `url: string` Endpoint URL for the MCP server. maxLength: 2048 - `metadata: optional map[string] or null` 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: optional BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams` Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=http#latest-models-comparison), e.g. `claude-opus-5-5`, or a `model_config` object for additional configuration control. Omit to preserve. Cannot be cleared. - `BetaManagedAgentsModel = "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-opus-5-5" or 14 more or string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `BetaManagedAgentsModelConfigParams object` 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. - `effort: optional "low" or "medium" or "high" or 2 more or BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or 3 more or null` How hard Claude works on each inference call. Accepts a bare level string (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged. - `"low"` Low effort. Favors latency over reasoning depth. - `"medium"` Medium effort. Balances latency and reasoning depth. - `"high"` High effort. Favors reasoning depth. - `"xhigh"` Extra-high effort. Not all models accept this level. - `"max"` Maximum effort. Favors reasoning depth over latency. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string or null` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it. - `speed: optional "standard" or "fast" or null` Inference speed mode. Defaults to `standard`. - `"standard"` - `"fast"` - `multiagent: optional BetaManagedAgentsMultiagentParams or null` Multiagent orchestration configuration. Full replacement. Omit to preserve; send null to clear. - `BetaManagedAgentsMultiagentCoordinatorParams object` A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster. - `type: "coordinator"` - `agents: array of BetaManagedAgentsMultiagentRosterEntryParams` 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` - `BetaManagedAgentsAgentParams object` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `type: "agent"` - `id: string` The `agent` ID. minLength: 1, maxLength: 128 - `version: optional number` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. format: int32 - `BetaManagedAgentsMultiagentSelfParams object` Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. - `type: "self"` - `BetaManagedAgentsAdvisorParams object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. At most one per roster; the entry occupies the roster name `anthropic.advisor`. - `type: "advisor"` - `model: string` A Claude model id. The model must be permitted as an advisor for this agent's model. minLength: 1, maxLength: 256 - `BetaManagedAgentsMultiagent20261001Params object` Multiagent configuration with three members, each enabled or disabled on its own. On an update, if the agent's stored `multiagent` also has type `multiagent_20261001`, this configuration is merged into the stored one, level by level, instead of replacing it. A key that the update omits keeps its stored value. A key sent as null takes its default, on create as well, so `"workflows": null` enables workflows. An object sent with a `type` other than the stored one replaces the stored object, and the keys that it omits take their defaults. A `predefined_agents` list that is sent replaces the stored list. Every object that is sent needs its `type`, and an enabled `advisor` needs its `model`. Other validation applies to the merged result. - `type: "multiagent_20261001"` - `advisor: optional BetaManagedAgentsMultiagentAdvisorParams or null` Whether the session's primary thread can consult an advisor model. Defaults to disabled. - `BetaManagedAgentsMultiagentAdvisorEnabledParams object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` A Claude model id. The model must be permitted as an advisor for this agent's model. minLength: 1, maxLength: 256 - `BetaManagedAgentsMultiagentAdvisorDisabledParams object` The agent has no advisor. - `type: "disabled"` - `subagents: optional BetaManagedAgentsMultiagentSubagentsParams or null` Whether the agent can spawn session threads. Defaults to enabled. - `BetaManagedAgentsMultiagentSubagentsEnabledParams object` The agent can spawn session threads. Each thread runs a predefined agent, which is a saved agent in `predefined_agents`, or an inline agent, which the agent defines when it spawns the thread and which is not saved. If `inline_agents` is disabled, `predefined_agents` must name at least one agent. - `type: "enabled"` - `inline_agents: optional BetaManagedAgentsMultiagentInlineAgentsParams or null` Whether the agent can define inline agents when it spawns session threads. Defaults to enabled. - `BetaManagedAgentsMultiagentInlineAgentsEnabledParams object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabledParams object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: optional array of BetaManagedAgentsMultiagentPredefinedAgentParams or null` Predefined agents that this agent can spawn as session threads. At most 20. Defaults to null. Null and an empty list both mean no predefined agents. This list is separate from `workflows.predefined_agents`, and an agent in one list is not added to the other. - `string` - `BetaManagedAgentsAgentParams object` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `BetaManagedAgentsMultiagentSelfParams object` Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. - `BetaManagedAgentsMultiagentSubagentsDisabledParams object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: optional BetaManagedAgentsMultiagentWorkflowsParams or null` Whether the agent can start workflow runs. Defaults to enabled. - `BetaManagedAgentsMultiagentWorkflowsEnabledParams object` The agent can start workflow runs. Each run follows a plan, a program that the agent writes. A plan can use predefined agents, which are the saved agents in `predefined_agents`, and inline agents, which it defines itself and which are not saved. If `inline_agents` is disabled, `predefined_agents` must name at least one agent. - `type: "enabled"` - `inline_agents: optional BetaManagedAgentsMultiagentInlineAgentsParams or null` Whether a run's plan can define inline agents. Defaults to enabled. - `predefined_agents: optional array of BetaManagedAgentsMultiagentPredefinedAgentParams or null` Predefined agents that a run's plan can use. At most 20. Defaults to null. Null and an empty list both mean no predefined agents. This list is separate from `subagents.predefined_agents`, and an agent in one list is not added to the other. - `string` - `BetaManagedAgentsAgentParams object` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `BetaManagedAgentsMultiagentSelfParams object` Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. - `BetaManagedAgentsMultiagentWorkflowsDisabledParams object` The agent cannot start workflow runs. - `type: "disabled"` - `name: optional string` Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared. maxLength: 256 - `skills: optional array of BetaManagedAgentsSkillParams or null` Skills. Full replacement. Omit to preserve; send empty array or null to clear. - `BetaManagedAgentsAnthropicSkillParams object` An Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` Identifier of the Anthropic skill (e.g., "xlsx"). minLength: 1, maxLength: 64 - `version: optional string or null` Version to pin. Defaults to latest if omitted. minLength: 1, maxLength: 64 - `BetaManagedAgentsCustomSkillParams object` A user-created custom skill. - `type: "custom"` - `skill_id: string` Tagged ID of the custom skill (e.g., "skill_01XJ5..."). minLength: 1, maxLength: 64 - `version: optional string or null` Version to pin. Defaults to latest if omitted. minLength: 1, maxLength: 64 - `system: optional string or null` System prompt. Omit to preserve; send empty string or null to clear. maxLength: 100000 - `tools: optional array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams or null` Tool configurations available to the agent. Full replacement. Omit to preserve; send empty array or null to clear. Maximum of 256 tools across all toolsets allowed. - `BetaManagedAgentsAgentToolset20260401Params object` Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent. - `type: "agent_toolset_20260401"` - `configs: optional array of BetaManagedAgentsAgentToolConfigParams` Per-tool configuration overrides. - `BetaManagedAgentsBashToolConfigParams object` Configuration override for the bash tool. - `type: optional "bash"` - `name: "bash"` Must be "bash". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfigParams object` Configuration override for the edit tool. - `type: optional "edit"` - `name: "edit"` Must be "edit". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfigParams object` Configuration override for the read tool. - `type: optional "read"` - `name: "read"` Must be "read". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfigParams object` Configuration override for the write tool. - `type: optional "write"` - `name: "write"` Must be "write". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfigParams object` Configuration override for the glob tool. - `type: optional "glob"` - `name: "glob"` Must be "glob". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfigParams object` Configuration override for the grep tool. - `type: optional "grep"` - `name: "grep"` Must be "grep". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfigParams object` Configuration override for the web_fetch tool. - `type: optional "web_fetch"` - `name: "web_fetch"` Must be "web_fetch". - `allowed_domains: optional array of string` Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. - `blocked_domains: optional array of string` Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `max_content_tokens: optional number or null` Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. format: int32 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: optional BetaManagedAgentsWebFetchURLSourcesParams or null` Which sources contribute URLs the tool may fetch. Omit to allow every source. - `client_tool_results: optional BetaManagedAgentsWebFetchURLSourceToolFilterParams or null` Which custom tools' results contribute URLs that may be fetched: "all" (the default), "none", or an only or except list. Each name in a list must be a custom tool in the same tools array. - `BetaManagedAgentsWebFetchURLSourceShorthand = "all" or "none"` String form of a url_sources value that has no field other than its type: "all" means {"type": "all"} and "none" means {"type": "none"}. - `"all"` - `"none"` - `BetaManagedAgentsWebFetchURLSourceToolFilter = BetaManagedAgentsWebFetchURLSourceAll or BetaManagedAgentsWebFetchURLSourceNone or BetaManagedAgentsWebFetchURLSourceOnly or BetaManagedAgentsWebFetchURLSourceExcept` Which tools' results contribute URLs that may be fetched. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: optional BetaManagedAgentsWebFetchURLSourceToolFilterParams or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched: "all" (the default), "none", or an only or except list. Each name in a list must be "web_search" or "web_fetch". - `user_input: optional BetaManagedAgentsWebFetchURLSourceUserInputParams or null` Whether URLs in the text of user messages may be fetched: "all" (the default) or "none". - `BetaManagedAgentsWebFetchURLSourceShorthand = "all" or "none"` String form of a url_sources value that has no field other than its type: "all" means {"type": "all"} and "none" means {"type": "none"}. - `BetaManagedAgentsWebFetchURLSourceUserInput = BetaManagedAgentsWebFetchURLSourceAll or BetaManagedAgentsWebFetchURLSourceNone` Whether URLs in the text of user messages may be fetched. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `BetaManagedAgentsWebSearchToolConfigParams object` Configuration override for the web_search tool. - `type: optional "web_search"` - `name: "web_search"` Must be "web_search". - `allowed_domains: optional array of string` Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. - `blocked_domains: optional array of string` Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` Default configuration applied to all tools in this set. - `enabled: optional boolean or null` Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolsetParams object` Configuration for tools from an MCP server defined in `mcp_servers`. - `type: "mcp_toolset"` - `mcp_server_name: string` Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters. minLength: 1, maxLength: 255 - `configs: optional array of BetaManagedAgentsMCPToolConfigParams` Per-tool configuration overrides. - `name: string` Name of the MCP tool to configure. 1-128 characters. minLength: 1, maxLength: 128 - `enabled: optional boolean or null` Whether this tool is enabled. Overrides the `default_config` setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Overrides the `default_config` setting. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` Default configuration for all tools from this server. - `enabled: optional boolean or null` Whether tools are enabled by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Default permission policy for tools from this server. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsCustomToolParams object` 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. - `type: "custom"` - `description: string` Description of what the tool does, shown to the agent to help it decide when to use the tool. minLength: 1 - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema defining the expected input parameters for the tool. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens. minLength: 1, maxLength: 128 - `version: optional number` The agent's current version, used to prevent concurrent overwrites. Obtain this value from a create or retrieve response. Must be at least 1 if specified. When supplied, the request fails if it does not match the server's current version; omit to apply the update unconditionally. format: int32 #### Returns - `BetaManagedAgentsAgent object` A Managed Agents `agent`. - `type: "agent"` - `id: string` - `archived_at: string or null` When the agent was archived. Null if not archived. format: date-time - `created_at: string` A timestamp in RFC 3339 format format: date-time - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal for runs of this agent. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `metadata: map[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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsMultiagent or null` Multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsMultiagentCoordinator object` Resolved coordinator topology with a concrete agent roster. - `type: "coordinator"` - `agents: array of BetaManagedAgentsAgentReference or BetaManagedAgentsAdvisor` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `BetaManagedAgentsAgentReference object` A resolved agent reference with a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagent20261001 object` Resolved multiagent configuration with three members, each enabled or disabled on its own. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsAgentReference` Predefined agents, which are saved agents that this agent can spawn as session threads, each resolved to a specific version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsAgentReference` Predefined agents, which are saved agents that a run's plan can use, each resolved to a specific version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. format: int32 #### Example ```bash curl https://api.anthropic.com/v1/agents/$AGENT_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "description": "updated", "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.", "version": 1 }' ``` ##### Response (200) ```json { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "advisor": { "type": "disabled" }, "subagents": { "inline_agents": { "type": "enabled" }, "predefined_agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "enabled" }, "type": "multiagent_20261001", "workflows": { "inline_agents": { "type": "enabled" }, "predefined_agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "enabled" } }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTmx", "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" }, "type": "bash" } ], "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 **POST** `/v1/agents/{agent_id}/archive` Archive Agent #### Path parameters - `agent_id: string` Unique identifier of the agent to archive. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsAgent object` A Managed Agents `agent`. - `type: "agent"` - `id: string` - `archived_at: string or null` When the agent was archived. Null if not archived. format: date-time - `created_at: string` A timestamp in RFC 3339 format format: date-time - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal for runs of this agent. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `metadata: map[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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsMultiagent or null` Multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsMultiagentCoordinator object` Resolved coordinator topology with a concrete agent roster. - `type: "coordinator"` - `agents: array of BetaManagedAgentsAgentReference or BetaManagedAgentsAdvisor` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `BetaManagedAgentsAgentReference object` A resolved agent reference with a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagent20261001 object` Resolved multiagent configuration with three members, each enabled or disabled on its own. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsAgentReference` Predefined agents, which are saved agents that this agent can spawn as session threads, each resolved to a specific version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsAgentReference` Predefined agents, which are saved agents that a run's plan can use, each resolved to a specific version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. format: int32 #### Example ```bash curl https://api.anthropic.com/v1/agents/$AGENT_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "advisor": { "type": "disabled" }, "subagents": { "inline_agents": { "type": "enabled" }, "predefined_agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "enabled" }, "type": "multiagent_20261001", "workflows": { "inline_agents": { "type": "enabled" }, "predefined_agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "enabled" } }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTmx", "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" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ``` ## Beta › Agents › Versions ### List Agent Versions **GET** `/v1/agents/{agent_id}/versions` List Agent Versions #### Path parameters - `agent_id: string` Agent ID to list versions for. #### Query parameters - `limit: optional number` Maximum results per page. Default 20, maximum 100. format: int32 - `page: optional string` Opaque pagination cursor. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaManagedAgentsAgent` Agent versions. - `type: "agent"` - `id: string` - `archived_at: string or null` When the agent was archived. Null if not archived. format: date-time - `created_at: string` A timestamp in RFC 3339 format format: date-time - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal for runs of this agent. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `metadata: map[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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsMultiagent or null` Multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsMultiagentCoordinator object` Resolved coordinator topology with a concrete agent roster. - `type: "coordinator"` - `agents: array of BetaManagedAgentsAgentReference or BetaManagedAgentsAdvisor` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `BetaManagedAgentsAgentReference object` A resolved agent reference with a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagent20261001 object` Resolved multiagent configuration with three members, each enabled or disabled on its own. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsAgentReference` Predefined agents, which are saved agents that this agent can spawn as session threads, each resolved to a specific version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsAgentReference` Predefined agents, which are saved agents that a run's plan can use, each resolved to a specific version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. format: int32 - `next_page: optional string or null` Opaque cursor for the next page. Null when no more results. #### Example ```bash curl https://api.anthropic.com/v1/agents/$AGENT_ID/versions \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "advisor": { "type": "disabled" }, "subagents": { "inline_agents": { "type": "enabled" }, "predefined_agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "enabled" }, "type": "multiagent_20261001", "workflows": { "inline_agents": { "type": "enabled" }, "predefined_agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "enabled" } }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTmx", "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" }, "type": "bash" } ], "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" } ``` ## Beta › Environments ### Create Environment **POST** `/v1/environments` Create a new environment with the specified configuration. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `name: string` Human-readable name for the environment minLength: 1, maxLength: 256 - `config: optional BetaCloudConfigParams or BetaSelfHostedConfigParams or null` Environment configuration - `BetaCloudConfigParams object` Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value. - `type: "cloud"` Environment type - `networking: optional BetaUnrestrictedNetwork or BetaLimitedNetworkParams or null` Network configuration policy. Omit on update to preserve the existing value. - `BetaUnrestrictedNetwork object` Unrestricted network access. - `type: "unrestricted"` Network policy type - `BetaLimitedNetworkParams object` Limited network request params. Fields default to null; on update, omitted fields preserve the existing value. - `type: "limited"` Network policy type - `allow_mcp_servers: optional boolean or null` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `allow_package_managers: optional boolean or null` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: optional array of string or null` Specifies domains the container can reach. - `packages: optional BetaPackagesParams or null` Package manager configuration. Under `limited` networking, requires `networking.allow_package_managers` to be `true`. Omit on update to preserve the existing value. - `type: optional "packages"` Package configuration type default: packages - `apt: optional array of string or null` Ubuntu/Debian packages to install - `cargo: optional array of string or null` Rust packages to install - `gem: optional array of string or null` Ruby packages to install - `go: optional array of string or null` Go packages to install - `npm: optional array of string or null` Node.js packages to install - `pip: optional array of string or null` Python packages to install - `BetaSelfHostedConfigParams object` Request params for `self_hosted` environment configuration. - `type: "self_hosted"` Environment type - `description: optional string or null` Optional description of the environment maxLength: 1024 - `metadata: optional map[string]` User-provided metadata key-value pairs - `scope: optional "organization" or "account" or null` The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. API organizations support only 'organization'; 'account' is rejected. If not specified, defaults based on organization type. - `"organization"` - `"account"` #### Returns - `BetaEnvironment object` Unified Environment resource for both cloud and self-hosted environments. - `type: "environment"` The type of object (always 'environment') default: environment - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string or null` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig or BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `BetaCloudConfig object` `cloud` environment configuration. - `type: "cloud"` Environment type - `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork` Network configuration policy. - `BetaUnrestrictedNetwork object` Unrestricted network access. - `type: "unrestricted"` Network policy type - `BetaLimitedNetwork object` Limited network access. - `type: "limited"` Network policy type - `allow_mcp_servers: boolean` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `allow_package_managers: boolean` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `allowed_hosts: array of string` Specifies domains the container can reach. - `packages: BetaPackages` Package manager configuration. - `type: optional "packages"` Package configuration type default: packages - `apt: array of string` Ubuntu/Debian packages to install - `cargo: array of string` Rust packages to install - `gem: array of string` Ruby packages to install - `go: array of string` Go packages to install - `npm: array of string` Node.js packages to install - `pip: array of string` Python packages to install - `BetaSelfHostedConfig object` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `created_at: string` RFC 3339 timestamp when environment was created - `description: string or null` User-provided description for the environment; null when unset - `metadata: map[string]` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `updated_at: string` RFC 3339 timestamp when environment was last updated - `scope: optional "organization" or "account"` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `"organization"` - `"account"` #### Example ```bash curl https://api.anthropic.com/v1/environments \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "name": "python-data-analysis", "config": { "type": "cloud", "networking": { "type": "limited", "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ] }, "packages": { "pip": [ "pandas", "numpy" ] } }, "description": "Python environment with data-analysis packages." }' ``` ##### Response (200) ```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 **GET** `/v1/environments` List environments with pagination support. #### Query parameters - `include_archived: optional boolean` Include archived environments in the response default: false - `limit: optional number` Maximum number of environments to return default: 20, minimum: 1, maximum: 1000 - `page: optional string` Opaque cursor from previous response for pagination. Pass the `next_page` value from the previous response. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaEnvironment` List of environments. - `type: "environment"` The type of object (always 'environment') default: environment - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string or null` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig or BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `BetaCloudConfig object` `cloud` environment configuration. - `type: "cloud"` Environment type - `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork` Network configuration policy. - `BetaUnrestrictedNetwork object` Unrestricted network access. - `type: "unrestricted"` Network policy type - `BetaLimitedNetwork object` Limited network access. - `type: "limited"` Network policy type - `allow_mcp_servers: boolean` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `allow_package_managers: boolean` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `allowed_hosts: array of string` Specifies domains the container can reach. - `packages: BetaPackages` Package manager configuration. - `type: optional "packages"` Package configuration type default: packages - `apt: array of string` Ubuntu/Debian packages to install - `cargo: array of string` Rust packages to install - `gem: array of string` Ruby packages to install - `go: array of string` Go packages to install - `npm: array of string` Node.js packages to install - `pip: array of string` Python packages to install - `BetaSelfHostedConfig object` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `created_at: string` RFC 3339 timestamp when environment was created - `description: string or null` User-provided description for the environment; null when unset - `metadata: map[string]` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `updated_at: string` RFC 3339 timestamp when environment was last updated - `scope: optional "organization" or "account"` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `"organization"` - `"account"` - `next_page: string or null` Token for fetching the next page of results. If `null`, there are no more results available. Pass this value to the `page` parameter in the next request. #### Example ```bash curl https://api.anthropic.com/v1/environments \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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 **GET** `/v1/environments/{environment_id}` Retrieve a specific environment by ID. #### Path parameters - `environment_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaEnvironment object` Unified Environment resource for both cloud and self-hosted environments. - `type: "environment"` The type of object (always 'environment') default: environment - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string or null` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig or BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `BetaCloudConfig object` `cloud` environment configuration. - `type: "cloud"` Environment type - `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork` Network configuration policy. - `BetaUnrestrictedNetwork object` Unrestricted network access. - `type: "unrestricted"` Network policy type - `BetaLimitedNetwork object` Limited network access. - `type: "limited"` Network policy type - `allow_mcp_servers: boolean` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `allow_package_managers: boolean` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `allowed_hosts: array of string` Specifies domains the container can reach. - `packages: BetaPackages` Package manager configuration. - `type: optional "packages"` Package configuration type default: packages - `apt: array of string` Ubuntu/Debian packages to install - `cargo: array of string` Rust packages to install - `gem: array of string` Ruby packages to install - `go: array of string` Go packages to install - `npm: array of string` Node.js packages to install - `pip: array of string` Python packages to install - `BetaSelfHostedConfig object` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `created_at: string` RFC 3339 timestamp when environment was created - `description: string or null` User-provided description for the environment; null when unset - `metadata: map[string]` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `updated_at: string` RFC 3339 timestamp when environment was last updated - `scope: optional "organization" or "account"` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `"organization"` - `"account"` #### Example ```bash curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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 **POST** `/v1/environments/{environment_id}` Update an existing environment's configuration. #### Path parameters - `environment_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `config: optional BetaCloudConfigParams or BetaSelfHostedConfigParams or null` Updated environment configuration - `BetaCloudConfigParams object` Request params for `cloud` environment configuration. Fields default to null; on update, omitted fields preserve the existing value. - `type: "cloud"` Environment type - `networking: optional BetaUnrestrictedNetwork or BetaLimitedNetworkParams or null` Network configuration policy. Omit on update to preserve the existing value. - `BetaUnrestrictedNetwork object` Unrestricted network access. - `type: "unrestricted"` Network policy type - `BetaLimitedNetworkParams object` Limited network request params. Fields default to null; on update, omitted fields preserve the existing value. - `type: "limited"` Network policy type - `allow_mcp_servers: optional boolean or null` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `allow_package_managers: optional boolean or null` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. - `allowed_hosts: optional array of string or null` Specifies domains the container can reach. - `packages: optional BetaPackagesParams or null` Package manager configuration. Under `limited` networking, requires `networking.allow_package_managers` to be `true`. Omit on update to preserve the existing value. - `type: optional "packages"` Package configuration type default: packages - `apt: optional array of string or null` Ubuntu/Debian packages to install - `cargo: optional array of string or null` Rust packages to install - `gem: optional array of string or null` Ruby packages to install - `go: optional array of string or null` Go packages to install - `npm: optional array of string or null` Node.js packages to install - `pip: optional array of string or null` Python packages to install - `BetaSelfHostedConfigParams object` Request params for `self_hosted` environment configuration. - `type: "self_hosted"` Environment type - `description: optional string or null` Updated description of the environment. Omit to preserve; null clears to null; an empty string is stored as an empty string. maxLength: 1024 - `metadata: optional map[string]` User-provided metadata key-value pairs. Set a value to null or empty string to delete the key. - `name: optional string or null` Updated name for the environment minLength: 1, maxLength: 256 - `scope: optional "organization" or "account" or null` The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. - `"organization"` - `"account"` #### Returns - `BetaEnvironment object` Unified Environment resource for both cloud and self-hosted environments. - `type: "environment"` The type of object (always 'environment') default: environment - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string or null` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig or BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `BetaCloudConfig object` `cloud` environment configuration. - `type: "cloud"` Environment type - `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork` Network configuration policy. - `BetaUnrestrictedNetwork object` Unrestricted network access. - `type: "unrestricted"` Network policy type - `BetaLimitedNetwork object` Limited network access. - `type: "limited"` Network policy type - `allow_mcp_servers: boolean` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `allow_package_managers: boolean` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `allowed_hosts: array of string` Specifies domains the container can reach. - `packages: BetaPackages` Package manager configuration. - `type: optional "packages"` Package configuration type default: packages - `apt: array of string` Ubuntu/Debian packages to install - `cargo: array of string` Rust packages to install - `gem: array of string` Ruby packages to install - `go: array of string` Go packages to install - `npm: array of string` Node.js packages to install - `pip: array of string` Python packages to install - `BetaSelfHostedConfig object` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `created_at: string` RFC 3339 timestamp when environment was created - `description: string or null` User-provided description for the environment; null when unset - `metadata: map[string]` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `updated_at: string` RFC 3339 timestamp when environment was last updated - `scope: optional "organization" or "account"` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `"organization"` - `"account"` #### Example ```bash curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "description": "Python environment with data-analysis packages." }' ``` ##### Response (200) ```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 **DELETE** `/v1/environments/{environment_id}` Delete an environment by ID. Returns a confirmation of the deletion. #### Path parameters - `environment_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaEnvironmentDeleteResponse object` Response after deleting an environment. - `type: "environment_deleted"` The type of response default: environment_deleted - `id: string` Environment identifier #### Example ```bash curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "type": "environment_deleted" } ``` ### Archive Environment **POST** `/v1/environments/{environment_id}/archive` Archive an environment by ID. Archived environments cannot be used to create new sessions. #### Path parameters - `environment_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaEnvironment object` Unified Environment resource for both cloud and self-hosted environments. - `type: "environment"` The type of object (always 'environment') default: environment - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string or null` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig or BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `BetaCloudConfig object` `cloud` environment configuration. - `type: "cloud"` Environment type - `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork` Network configuration policy. - `BetaUnrestrictedNetwork object` Unrestricted network access. - `type: "unrestricted"` Network policy type - `BetaLimitedNetwork object` Limited network access. - `type: "limited"` Network policy type - `allow_mcp_servers: boolean` Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. - `allow_package_managers: boolean` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. - `allowed_hosts: array of string` Specifies domains the container can reach. - `packages: BetaPackages` Package manager configuration. - `type: optional "packages"` Package configuration type default: packages - `apt: array of string` Ubuntu/Debian packages to install - `cargo: array of string` Rust packages to install - `gem: array of string` Ruby packages to install - `go: array of string` Go packages to install - `npm: array of string` Node.js packages to install - `pip: array of string` Python packages to install - `BetaSelfHostedConfig object` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `created_at: string` RFC 3339 timestamp when environment was created - `description: string or null` User-provided description for the environment; null when unset - `metadata: map[string]` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `updated_at: string` RFC 3339 timestamp when environment was last updated - `scope: optional "organization" or "account"` The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. - `"organization"` - `"account"` #### Example ```bash curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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" } ``` ## Beta › Environments › Work ### Get Work Item **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. #### Path parameters - `environment_id: string` - `work_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaSelfHostedWork object` 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. - `type: "work"` The type of object (always 'work') default: work - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string or null` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `created_at: string` RFC 3339 timestamp when work was created - `data: BetaSessionWorkData` The actual work to be performed - `type: "session"` Type of work data - `id: string` Session identifier (e.g., 'session_...') - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string or null` RFC 3339 timestamp of the most recent heartbeat - `metadata: map[string]` User-provided metadata key-value pairs associated with this work item - `secret: string or null` Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths. - `started_at: string or null` RFC 3339 timestamp when work execution started - `state: "queued" or "starting" or "active" or 2 more` Current state of the work item - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `stop_requested_at: string or null` RFC 3339 timestamp when stop was requested - `stopped_at: string or null` RFC 3339 timestamp when work execution stopped #### Example ```bash curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/work/$WORK_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ### Poll for Work **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. #### Path parameters - `environment_id: string` #### Query parameters - `block_ms: optional number` 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). minimum: 1 - `reclaim_older_than_ms: optional number` Reclaim unacknowledged work items older than this many milliseconds. If omitted, uses the default (5000ms). minimum: 1 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"Anthropic-Worker-ID": optional string` Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console #### Returns - `BetaSelfHostedWork object` 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. - `type: "work"` The type of object (always 'work') default: work - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string or null` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `created_at: string` RFC 3339 timestamp when work was created - `data: BetaSessionWorkData` The actual work to be performed - `type: "session"` Type of work data - `id: string` Session identifier (e.g., 'session_...') - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string or null` RFC 3339 timestamp of the most recent heartbeat - `metadata: map[string]` User-provided metadata key-value pairs associated with this work item - `secret: string or null` Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths. - `started_at: string or null` RFC 3339 timestamp when work execution started - `state: "queued" or "starting" or "active" or 2 more` Current state of the work item - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `stop_requested_at: string or null` RFC 3339 timestamp when stop was requested - `stopped_at: string or null` RFC 3339 timestamp when work execution stopped #### Example ```bash curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/work/poll \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ### Acknowledge Work **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. #### Path parameters - `environment_id: string` - `work_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaSelfHostedWork object` 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. - `type: "work"` The type of object (always 'work') default: work - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string or null` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `created_at: string` RFC 3339 timestamp when work was created - `data: BetaSessionWorkData` The actual work to be performed - `type: "session"` Type of work data - `id: string` Session identifier (e.g., 'session_...') - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string or null` RFC 3339 timestamp of the most recent heartbeat - `metadata: map[string]` User-provided metadata key-value pairs associated with this work item - `secret: string or null` Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths. - `started_at: string or null` RFC 3339 timestamp when work execution started - `state: "queued" or "starting" or "active" or 2 more` Current state of the work item - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `stop_requested_at: string or null` RFC 3339 timestamp when stop was requested - `stopped_at: string or null` RFC 3339 timestamp when work execution stopped #### Example ```bash curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/work/$WORK_ID/ack \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ### Record Heartbeat **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. #### Path parameters - `environment_id: string` - `work_id: string` #### Query parameters - `desired_ttl_seconds: optional number` Desired TTL in seconds - `expected_last_heartbeat: optional string` 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. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaSelfHostedWorkHeartbeatResponse object` Response after recording a heartbeat for a work item. - `type: "work_heartbeat"` The type of response default: work_heartbeat - `last_heartbeat: string` RFC 3339 timestamp of the actual heartbeat from DB - `lease_extended: boolean` Whether the heartbeat succeeded in extending the lease - `state: "queued" or "starting" or "active" or 2 more` Current state of the work item (active/stopping/stopped) - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `ttl_seconds: number` Effective TTL applied to the lease #### Example ```bash curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/work/$WORK_ID/heartbeat \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "last_heartbeat": "last_heartbeat", "lease_extended": true, "state": "queued", "ttl_seconds": 0, "type": "work_heartbeat" } ``` ### Stop Work **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. #### Path parameters - `environment_id: string` - `work_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `force: optional boolean` If true, immediately stop work without graceful shutdown default: false #### Returns - `BetaSelfHostedWork object` 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. - `type: "work"` The type of object (always 'work') default: work - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string or null` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `created_at: string` RFC 3339 timestamp when work was created - `data: BetaSessionWorkData` The actual work to be performed - `type: "session"` Type of work data - `id: string` Session identifier (e.g., 'session_...') - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string or null` RFC 3339 timestamp of the most recent heartbeat - `metadata: map[string]` User-provided metadata key-value pairs associated with this work item - `secret: string or null` Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths. - `started_at: string or null` RFC 3339 timestamp when work execution started - `state: "queued" or "starting" or "active" or 2 more` Current state of the work item - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `stop_requested_at: string or null` RFC 3339 timestamp when stop was requested - `stopped_at: string or null` RFC 3339 timestamp when work execution stopped #### Example ```bash curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/work/$WORK_ID/stop \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{}' ``` ##### Response (200) ```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" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ### List Work Items **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. #### Path parameters - `environment_id: string` #### Query parameters - `limit: optional number` Maximum number of work items to return default: 20, minimum: 1, maximum: 1000 - `page: optional string` Opaque cursor from previous response for pagination #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaSelfHostedWorkListResponse object` Response when listing work items with cursor-based pagination. - `data: array of BetaSelfHostedWork` List of work items - `type: "work"` The type of object (always 'work') default: work - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string or null` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `created_at: string` RFC 3339 timestamp when work was created - `data: BetaSessionWorkData` The actual work to be performed - `type: "session"` Type of work data - `id: string` Session identifier (e.g., 'session_...') - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string or null` RFC 3339 timestamp of the most recent heartbeat - `metadata: map[string]` User-provided metadata key-value pairs associated with this work item - `secret: string or null` Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths. - `started_at: string or null` RFC 3339 timestamp when work execution started - `state: "queued" or "starting" or "active" or 2 more` Current state of the work item - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `stop_requested_at: string or null` RFC 3339 timestamp when stop was requested - `stopped_at: string or null` RFC 3339 timestamp when work execution stopped - `next_page: string or null` Opaque cursor for fetching the next page of results #### Example ```bash curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/work \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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" }, "secret": "secret", "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 **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. #### Path parameters - `environment_id: string` - `work_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `metadata: map[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. #### Returns - `BetaSelfHostedWork object` 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. - `type: "work"` The type of object (always 'work') default: work - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string or null` RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox - `created_at: string` RFC 3339 timestamp when work was created - `data: BetaSessionWorkData` The actual work to be performed - `type: "session"` Type of work data - `id: string` Session identifier (e.g., 'session_...') - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string or null` RFC 3339 timestamp of the most recent heartbeat - `metadata: map[string]` User-provided metadata key-value pairs associated with this work item - `secret: string or null` Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths. - `started_at: string or null` RFC 3339 timestamp when work execution started - `state: "queued" or "starting" or "active" or 2 more` Current state of the work item - `"queued"` - `"starting"` - `"active"` - `"stopping"` - `"stopped"` - `stop_requested_at: string or null` RFC 3339 timestamp when stop was requested - `stopped_at: string or null` RFC 3339 timestamp when work execution stopped #### Example ```bash curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/work/$WORK_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "metadata": { "foo": "string" } }' ``` ##### Response (200) ```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" }, "secret": "secret", "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ### Get Queue Statistics **GET** `/v1/environments/{environment_id}/work/stats` Get statistics about the work queue for an environment. #### Path parameters - `environment_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaSelfHostedWorkQueueStats object` Statistics about the work queue for an environment. Uses Redis Stream consumer group metrics for O(1) queries. - `type: "work_queue_stats"` The type of object default: work_queue_stats - `depth: number` Number of work items waiting to be picked up (lag from consumer group) - `oldest_queued_at: string or null` RFC 3339 timestamp of oldest item in the work stream (includes both queued and pending items), null if stream empty - `pending: number` Number of work items being processed (polled but not acknowledged) default: 0 - `workers_polling: number or null` Number of workers that have polled for work in the last 30 seconds. Requires worker_id to be sent with poll requests. #### Example ```bash curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/work/stats \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "depth": 0, "oldest_queued_at": "oldest_queued_at", "pending": 0, "type": "work_queue_stats", "workers_polling": 0 } ``` ## Beta › Sessions ### Create Session **POST** `/v1/sessions` Create Session #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `agent: string or BetaManagedAgentsAgentParams or BetaManagedAgentsAgentWithOverridesParams` 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` - `BetaManagedAgentsAgentParams object` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `type: "agent"` - `id: string` The `agent` ID. minLength: 1, maxLength: 128 - `version: optional number` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. format: int32 - `BetaManagedAgentsAgentWithOverridesParams object` Reference to an `agent` plus optional configuration overrides. Each provided field replaces the agent's value for the caller's use; the agent resource is unchanged. - `type: "agent_with_overrides"` - `id: string` The `agent` ID. minLength: 1, maxLength: 128 - `mcp_servers: optional array of BetaManagedAgentsURLMCPServerParams` Replacement MCP server list. Full replacement: the provided array becomes the MCP servers. Send an empty array to clear; omit to preserve the agent's servers. - `type: "url"` - `name: string` Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters. minLength: 1, maxLength: 255 - `url: string` Endpoint URL for the MCP server. maxLength: 2048 - `model: optional BetaManagedAgentsModel or BetaManagedAgentsModelConfigParams` Replacement model. Accepts the model string, e.g. `claude-opus-5-5`, or a `model_config` object. Omit to use the agent's model. - `BetaManagedAgentsModel = "claude-haiku-5-5" or "claude-sonnet-5-5" or "claude-opus-5-5" or 14 more or string` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `BetaManagedAgentsModelConfigParams object` 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. - `effort: optional "low" or "medium" or "high" or 2 more or BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or 3 more or null` How hard Claude works on each inference call. Accepts a bare level string (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged. - `"low"` Low effort. Favors latency over reasoning depth. - `"medium"` Medium effort. Balances latency and reasoning depth. - `"high"` High effort. Favors reasoning depth. - `"xhigh"` Extra-high effort. Not all models accept this level. - `"max"` Maximum effort. Favors reasoning depth over latency. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string or null` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it. - `speed: optional "standard" or "fast" or null` Inference speed mode. Defaults to `standard`. - `"standard"` - `"fast"` - `skills: optional array of BetaManagedAgentsSkillParams` Replacement skill list. Full replacement: the provided array becomes the skills. Send an empty array to clear; omit to preserve the agent's skills. - `BetaManagedAgentsAnthropicSkillParams object` An Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` Identifier of the Anthropic skill (e.g., "xlsx"). minLength: 1, maxLength: 64 - `version: optional string or null` Version to pin. Defaults to latest if omitted. minLength: 1, maxLength: 64 - `BetaManagedAgentsCustomSkillParams object` A user-created custom skill. - `type: "custom"` - `skill_id: string` Tagged ID of the custom skill (e.g., "skill_01XJ5..."). minLength: 1, maxLength: 64 - `version: optional string or null` Version to pin. Defaults to latest if omitted. minLength: 1, maxLength: 64 - `system: optional string or null` Replacement system prompt. Up to 100,000 characters. Set to null to clear the agent's system prompt; omit to preserve it. maxLength: 100000 - `tools: optional array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams` Replacement tool list. Full replacement: the provided array becomes the tool configuration. Send an empty array to clear; omit to preserve the agent's tools. - `BetaManagedAgentsAgentToolset20260401Params object` Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent. - `type: "agent_toolset_20260401"` - `configs: optional array of BetaManagedAgentsAgentToolConfigParams` Per-tool configuration overrides. - `BetaManagedAgentsBashToolConfigParams object` Configuration override for the bash tool. - `type: optional "bash"` - `name: "bash"` Must be "bash". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfigParams object` Configuration override for the edit tool. - `type: optional "edit"` - `name: "edit"` Must be "edit". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfigParams object` Configuration override for the read tool. - `type: optional "read"` - `name: "read"` Must be "read". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfigParams object` Configuration override for the write tool. - `type: optional "write"` - `name: "write"` Must be "write". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfigParams object` Configuration override for the glob tool. - `type: optional "glob"` - `name: "glob"` Must be "glob". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfigParams object` Configuration override for the grep tool. - `type: optional "grep"` - `name: "grep"` Must be "grep". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfigParams object` Configuration override for the web_fetch tool. - `type: optional "web_fetch"` - `name: "web_fetch"` Must be "web_fetch". - `allowed_domains: optional array of string` Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. - `blocked_domains: optional array of string` Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `max_content_tokens: optional number or null` Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. format: int32 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: optional BetaManagedAgentsWebFetchURLSourcesParams or null` Which sources contribute URLs the tool may fetch. Omit to allow every source. - `client_tool_results: optional BetaManagedAgentsWebFetchURLSourceToolFilterParams or null` Which custom tools' results contribute URLs that may be fetched: "all" (the default), "none", or an only or except list. Each name in a list must be a custom tool in the same tools array. - `BetaManagedAgentsWebFetchURLSourceShorthand = "all" or "none"` String form of a url_sources value that has no field other than its type: "all" means {"type": "all"} and "none" means {"type": "none"}. - `"all"` - `"none"` - `BetaManagedAgentsWebFetchURLSourceToolFilter = BetaManagedAgentsWebFetchURLSourceAll or BetaManagedAgentsWebFetchURLSourceNone or BetaManagedAgentsWebFetchURLSourceOnly or BetaManagedAgentsWebFetchURLSourceExcept` Which tools' results contribute URLs that may be fetched. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: optional BetaManagedAgentsWebFetchURLSourceToolFilterParams or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched: "all" (the default), "none", or an only or except list. Each name in a list must be "web_search" or "web_fetch". - `user_input: optional BetaManagedAgentsWebFetchURLSourceUserInputParams or null` Whether URLs in the text of user messages may be fetched: "all" (the default) or "none". - `BetaManagedAgentsWebFetchURLSourceShorthand = "all" or "none"` String form of a url_sources value that has no field other than its type: "all" means {"type": "all"} and "none" means {"type": "none"}. - `BetaManagedAgentsWebFetchURLSourceUserInput = BetaManagedAgentsWebFetchURLSourceAll or BetaManagedAgentsWebFetchURLSourceNone` Whether URLs in the text of user messages may be fetched. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `BetaManagedAgentsWebSearchToolConfigParams object` Configuration override for the web_search tool. - `type: optional "web_search"` - `name: "web_search"` Must be "web_search". - `allowed_domains: optional array of string` Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. - `blocked_domains: optional array of string` Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` Default configuration applied to all tools in this set. - `enabled: optional boolean or null` Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolsetParams object` Configuration for tools from an MCP server defined in `mcp_servers`. - `type: "mcp_toolset"` - `mcp_server_name: string` Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters. minLength: 1, maxLength: 255 - `configs: optional array of BetaManagedAgentsMCPToolConfigParams` Per-tool configuration overrides. - `name: string` Name of the MCP tool to configure. 1-128 characters. minLength: 1, maxLength: 128 - `enabled: optional boolean or null` Whether this tool is enabled. Overrides the `default_config` setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Overrides the `default_config` setting. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` Default configuration for all tools from this server. - `enabled: optional boolean or null` Whether tools are enabled by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Default permission policy for tools from this server. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsCustomToolParams object` 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. - `type: "custom"` - `description: string` Description of what the tool does, shown to the agent to help it decide when to use the tool. minLength: 1 - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema defining the expected input parameters for the tool. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens. minLength: 1, maxLength: 128 - `version: optional number` The specific `agent` version to use. Omit to use the latest version. format: int32 - `environment_id: string` ID of the `environment` defining the container configuration for this session. minLength: 1, maxLength: 128 - `budget: optional BetaManagedAgentsBudgetLimit` Enforced spend ceiling for the session. Omit to create an uncapped session. Every model the session can run — the agent's model and each callable agent's model — must have a public list price, or the request is rejected with reason `model_not_budgetable`. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `initial_events: optional array of BetaManagedAgentsUserMessageEventParams or BetaManagedAgentsUserDefineOutcomeEventParams` Initial events to send to the `session` at creation, processed in order. Supports `user.message` and `user.define_outcome` events. Maximum 50 events. - `BetaManagedAgentsUserMessageEventParams object` Parameters for sending a user message to the session. - `type: "user.message"` - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks for the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `BetaManagedAgentsUserDefineOutcomeEventParams object` Parameters for defining an outcome the agent should work toward. The agent begins work on receipt. - `type: "user.define_outcome"` - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams` How to grade the outcome. Text or file reference. - `BetaManagedAgentsFileRubricParams object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubricParams object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. maxLength: 262144 - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `metadata: optional map[string]` Arbitrary key-value metadata attached to the session. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `resources: optional array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam` Resources (e.g. repositories, files) to mount into the session's container. - `BetaManagedAgentsGitHubRepositoryResourceParams object` Mount a GitHub repository into the session's container. - `type: "github_repository"` - `url: string` Github URL of the repository minLength: 1, maxLength: 2048 - `authorization_token: optional string` GitHub authorization token used to clone the repository. Required for private repositories; optional for public ones. minLength: 1, maxLength: 4096 - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` Branch or commit to check out. Defaults to the repository's default branch. - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/`. minLength: 1, maxLength: 4096 - `BetaManagedAgentsFileResourceParams object` Mount a file uploaded via the Files API into the session. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1, maxLength: 128 - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/`. minLength: 1, maxLength: 4096 - `BetaManagedAgentsMemoryStoreResourceParam object` Parameters for attaching a memory store to an agent session. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `instructions: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. maxLength: 4096 - `title: optional string or null` Human-readable session title. maxLength: 500 - `vault_ids: optional array of string` Vault IDs for stored credentials the agent can use during the session. #### Returns - `BetaManagedAgentsSession object` A Managed Agents `session`. - `type: "session"` - `id: string` - `agent: BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsSessionMultiagent or null` Resolved multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsSessionMultiagentCoordinator object` Resolved coordinator topology with full agent definitions for each roster member. - `type: "coordinator"` - `agents: array of BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` Full `agent` definitions the coordinator may spawn as session threads. - `BetaManagedAgentsSessionThreadAgent object` 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`. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsSessionMultiagent20261001 object` Resolved multiagent configuration with three members, as copied to the `session` at creation. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsSessionMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsSessionMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that this agent can spawn as session threads. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsSessionMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsSessionMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that a run's plan can use. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `BetaManagedAgentsMCPToolset object` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `version: number` format: int32 - `archived_at: string or null` When the session was archived. Null if not archived. format: date-time - `budget: BetaManagedAgentsBudgetLimit or null` The session's enforced spend ceiling, or null when no budget is set. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `created_at: string` A timestamp in RFC 3339 format format: date-time - `environment_id: string` - `metadata: map[string]` - `outcome_evaluations: array of BetaManagedAgentsOutcomeEvaluationResource` Per-outcome evaluation state. One entry per `define_outcome` event sent to the session. - `type: "outcome_evaluation"` - `completed_at: string or null` When the outcome reached a terminal result. Null while `pending`/`running`/`evaluating`. format: date-time - `description: string` What the agent should produce. - `explanation: string or null` 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: number` 0-indexed revision cycle the outcome is currently on. format: int32 - `outcome_id: 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. - `resources: array of BetaManagedAgentsSessionResource` - `BetaManagedAgentsGitHubRepositoryResource object` - `type: "github_repository"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `BetaManagedAgentsFileResource object` - `type: "file"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `file_id: string` - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `BetaManagedAgentsMemoryStoreResource object` A memory store attached to an agent session. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `description: optional 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: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. maxLength: 4096 - `mount_path: optional string or null` 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: optional string or null` 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 the session. - `active_seconds: optional number` Cumulative time in seconds the session spent in `running` status. Excludes idle time. format: double - `duration_seconds: optional number` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. format: double - `status: "rescheduling" or "running" or "idle" or "terminated"` - `"rescheduling"` Transient error occurred, retrying automatically. - `"running"` Agent is actively executing. - `"idle"` Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle. - `"terminated"` Session has ended, either due to an error or completion. - `title: string or null` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `usage: BetaManagedAgentsSessionUsage` Cumulative token usage for the session. - `active_seconds: optional number` Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once, unlike `stats.active_seconds`, which sums each thread's own active time. This is the duration the session's runtime cost is priced on. format: double - `cache_creation: optional BetaManagedAgentsCacheCreationUsage` Tokens used to create prompt cache entries, broken down by cache TTL. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. format: int32 - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. format: int32 - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. format: int32 - `input_tokens: optional number` Total input tokens consumed across all turns. format: int32 - `list_cost: optional BetaMonetaryAmount or null` Cumulative list cost of the session across all turns, priced at public list rates. Absent until cost tracking is available for the session. - `output_tokens: optional number` Total output tokens generated across all turns. format: int32 - `server_tool_use: optional BetaManagedAgentsServerToolUsage or null` Cumulative server-executed tool usage across all turns. Absent until server-tool tracking is available for the session. - `web_fetch_requests: optional number` Number of server-executed web fetch requests. format: int32 - `web_search_requests: optional number` Number of server-executed web search requests. format: int32 - `vault_ids: array of string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. - `deployment_id: optional string or null` Deployment ID when the session was created from a deployment reference. Null otherwise. #### Example ```bash curl https://api.anthropic.com/v1/sessions \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "agent": "agent_011CZkYpogX7uDKUyvBTophP", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message" } ], "title": "Order #1234 inquiry" }' ``` ##### Response (200) ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "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" }, "type": "bash" } ], "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_011CZkZFNu9hAbo3jZPRgTmx", "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" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" }, "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_011CZkZRSw2kEfs6ncTVmjxP", "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_011CZkZCKr6eXym1gWMPdQiu", "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": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "deployment_id": "deployment_id" } ``` ### List Sessions **GET** `/v1/sessions` List Sessions #### Query parameters - `agent_id: optional string` Filter sessions created with this agent ID. - `agent_version: optional number` Filter by agent version. Only applies when `agent_id` is also set. format: int32 - `"created_at[gt]": optional string` Return sessions created after this time (exclusive). format: date-time - `"created_at[gte]": optional string` Return sessions created at or after this time (inclusive). format: date-time - `"created_at[lt]": optional string` Return sessions created before this time (exclusive). format: date-time - `"created_at[lte]": optional string` Return sessions created at or before this time (inclusive). format: date-time - `deployment_id: optional string` Filter sessions created by this deployment ID. - `include_archived: optional boolean` When true, includes archived sessions. Default: false (exclude archived). - `limit: optional number` Maximum number of results to return. format: int32 - `memory_store_id: optional string` Filter sessions whose resources contain a `memory_store` with this memory store ID. - `order: optional "asc" or "desc"` Sort direction for results, ordered by `created_at`. Defaults to `desc` (newest first). - `"asc"` - `"desc"` - `page: optional string` Opaque pagination cursor from a previous response. - `statuses: optional array of "rescheduling" or "running" or "idle" or "terminated"` Filter by session status. Repeat the parameter to match any of multiple statuses. - `"rescheduling"` Transient error occurred, retrying automatically. - `"running"` Agent is actively executing. - `"idle"` Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle. - `"terminated"` Session has ended, either due to an error or completion. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: optional array of BetaManagedAgentsSession` List of sessions. - `type: "session"` - `id: string` - `agent: BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsSessionMultiagent or null` Resolved multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsSessionMultiagentCoordinator object` Resolved coordinator topology with full agent definitions for each roster member. - `type: "coordinator"` - `agents: array of BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` Full `agent` definitions the coordinator may spawn as session threads. - `BetaManagedAgentsSessionThreadAgent object` 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`. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsSessionMultiagent20261001 object` Resolved multiagent configuration with three members, as copied to the `session` at creation. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsSessionMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsSessionMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that this agent can spawn as session threads. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsSessionMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsSessionMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that a run's plan can use. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `BetaManagedAgentsMCPToolset object` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `version: number` format: int32 - `archived_at: string or null` When the session was archived. Null if not archived. format: date-time - `budget: BetaManagedAgentsBudgetLimit or null` The session's enforced spend ceiling, or null when no budget is set. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `created_at: string` A timestamp in RFC 3339 format format: date-time - `environment_id: string` - `metadata: map[string]` - `outcome_evaluations: array of BetaManagedAgentsOutcomeEvaluationResource` Per-outcome evaluation state. One entry per `define_outcome` event sent to the session. - `type: "outcome_evaluation"` - `completed_at: string or null` When the outcome reached a terminal result. Null while `pending`/`running`/`evaluating`. format: date-time - `description: string` What the agent should produce. - `explanation: string or null` 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: number` 0-indexed revision cycle the outcome is currently on. format: int32 - `outcome_id: 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. - `resources: array of BetaManagedAgentsSessionResource` - `BetaManagedAgentsGitHubRepositoryResource object` - `type: "github_repository"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `BetaManagedAgentsFileResource object` - `type: "file"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `file_id: string` - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `BetaManagedAgentsMemoryStoreResource object` A memory store attached to an agent session. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `description: optional 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: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. maxLength: 4096 - `mount_path: optional string or null` 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: optional string or null` 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 the session. - `active_seconds: optional number` Cumulative time in seconds the session spent in `running` status. Excludes idle time. format: double - `duration_seconds: optional number` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. format: double - `status: "rescheduling" or "running" or "idle" or "terminated"` - `"rescheduling"` Transient error occurred, retrying automatically. - `"running"` Agent is actively executing. - `"idle"` Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle. - `"terminated"` Session has ended, either due to an error or completion. - `title: string or null` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `usage: BetaManagedAgentsSessionUsage` Cumulative token usage for the session. - `active_seconds: optional number` Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once, unlike `stats.active_seconds`, which sums each thread's own active time. This is the duration the session's runtime cost is priced on. format: double - `cache_creation: optional BetaManagedAgentsCacheCreationUsage` Tokens used to create prompt cache entries, broken down by cache TTL. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. format: int32 - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. format: int32 - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. format: int32 - `input_tokens: optional number` Total input tokens consumed across all turns. format: int32 - `list_cost: optional BetaMonetaryAmount or null` Cumulative list cost of the session across all turns, priced at public list rates. Absent until cost tracking is available for the session. - `output_tokens: optional number` Total output tokens generated across all turns. format: int32 - `server_tool_use: optional BetaManagedAgentsServerToolUsage or null` Cumulative server-executed tool usage across all turns. Absent until server-tool tracking is available for the session. - `web_fetch_requests: optional number` Number of server-executed web fetch requests. format: int32 - `web_search_requests: optional number` Number of server-executed web search requests. format: int32 - `vault_ids: array of string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. - `deployment_id: optional string or null` Deployment ID when the session was created from a deployment reference. Null otherwise. - `next_page: optional string or null` Opaque cursor for the next page. Null when no more results. - `prev_page: optional string or null` Opaque cursor for the previous page. Null when on the first page. Pass as the `page` parameter to navigate backward. #### Example ```bash curl https://api.anthropic.com/v1/sessions \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "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" }, "type": "bash" } ], "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_011CZkZFNu9hAbo3jZPRgTmx", "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" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" }, "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_011CZkZRSw2kEfs6ncTVmjxP", "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_011CZkZCKr6eXym1gWMPdQiu", "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": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "deployment_id": "deployment_id" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=", "prev_page": "page_MjAyNS0wNS0xM1QwMDowMDowMFo=" } ``` ### Get Session **GET** `/v1/sessions/{session_id}` Get Session #### Path parameters - `session_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsSession object` A Managed Agents `session`. - `type: "session"` - `id: string` - `agent: BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsSessionMultiagent or null` Resolved multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsSessionMultiagentCoordinator object` Resolved coordinator topology with full agent definitions for each roster member. - `type: "coordinator"` - `agents: array of BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` Full `agent` definitions the coordinator may spawn as session threads. - `BetaManagedAgentsSessionThreadAgent object` 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`. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsSessionMultiagent20261001 object` Resolved multiagent configuration with three members, as copied to the `session` at creation. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsSessionMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsSessionMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that this agent can spawn as session threads. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsSessionMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsSessionMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that a run's plan can use. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `BetaManagedAgentsMCPToolset object` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `version: number` format: int32 - `archived_at: string or null` When the session was archived. Null if not archived. format: date-time - `budget: BetaManagedAgentsBudgetLimit or null` The session's enforced spend ceiling, or null when no budget is set. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `created_at: string` A timestamp in RFC 3339 format format: date-time - `environment_id: string` - `metadata: map[string]` - `outcome_evaluations: array of BetaManagedAgentsOutcomeEvaluationResource` Per-outcome evaluation state. One entry per `define_outcome` event sent to the session. - `type: "outcome_evaluation"` - `completed_at: string or null` When the outcome reached a terminal result. Null while `pending`/`running`/`evaluating`. format: date-time - `description: string` What the agent should produce. - `explanation: string or null` 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: number` 0-indexed revision cycle the outcome is currently on. format: int32 - `outcome_id: 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. - `resources: array of BetaManagedAgentsSessionResource` - `BetaManagedAgentsGitHubRepositoryResource object` - `type: "github_repository"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `BetaManagedAgentsFileResource object` - `type: "file"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `file_id: string` - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `BetaManagedAgentsMemoryStoreResource object` A memory store attached to an agent session. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `description: optional 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: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. maxLength: 4096 - `mount_path: optional string or null` 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: optional string or null` 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 the session. - `active_seconds: optional number` Cumulative time in seconds the session spent in `running` status. Excludes idle time. format: double - `duration_seconds: optional number` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. format: double - `status: "rescheduling" or "running" or "idle" or "terminated"` - `"rescheduling"` Transient error occurred, retrying automatically. - `"running"` Agent is actively executing. - `"idle"` Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle. - `"terminated"` Session has ended, either due to an error or completion. - `title: string or null` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `usage: BetaManagedAgentsSessionUsage` Cumulative token usage for the session. - `active_seconds: optional number` Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once, unlike `stats.active_seconds`, which sums each thread's own active time. This is the duration the session's runtime cost is priced on. format: double - `cache_creation: optional BetaManagedAgentsCacheCreationUsage` Tokens used to create prompt cache entries, broken down by cache TTL. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. format: int32 - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. format: int32 - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. format: int32 - `input_tokens: optional number` Total input tokens consumed across all turns. format: int32 - `list_cost: optional BetaMonetaryAmount or null` Cumulative list cost of the session across all turns, priced at public list rates. Absent until cost tracking is available for the session. - `output_tokens: optional number` Total output tokens generated across all turns. format: int32 - `server_tool_use: optional BetaManagedAgentsServerToolUsage or null` Cumulative server-executed tool usage across all turns. Absent until server-tool tracking is available for the session. - `web_fetch_requests: optional number` Number of server-executed web fetch requests. format: int32 - `web_search_requests: optional number` Number of server-executed web search requests. format: int32 - `vault_ids: array of string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. - `deployment_id: optional string or null` Deployment ID when the session was created from a deployment reference. Null otherwise. #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "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" }, "type": "bash" } ], "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_011CZkZFNu9hAbo3jZPRgTmx", "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" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" }, "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_011CZkZRSw2kEfs6ncTVmjxP", "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_011CZkZCKr6eXym1gWMPdQiu", "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": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "deployment_id": "deployment_id" } ``` ### Update Session **POST** `/v1/sessions/{session_id}` Update Session #### Path parameters - `session_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `agent: optional BetaManagedAgentsSessionAgentUpdate` Agent configuration update. Only `tools` and `mcp_servers` are updatable mid-session. Only valid for sessions created from an agent or deployment reference. The session must not be running. - `mcp_servers: optional array of BetaManagedAgentsURLMCPServerParams` Replacement MCP server list. Full replacement: the provided array becomes the new value. Send an empty array to clear; omit to preserve. - `type: "url"` - `name: string` Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters. minLength: 1, maxLength: 255 - `url: string` Endpoint URL for the MCP server. maxLength: 2048 - `tools: optional array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams` Replacement tool list. Full replacement: the provided array becomes the new value. Send an empty array to clear; omit to preserve. - `BetaManagedAgentsAgentToolset20260401Params object` Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent. - `type: "agent_toolset_20260401"` - `configs: optional array of BetaManagedAgentsAgentToolConfigParams` Per-tool configuration overrides. - `BetaManagedAgentsBashToolConfigParams object` Configuration override for the bash tool. - `type: optional "bash"` - `name: "bash"` Must be "bash". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfigParams object` Configuration override for the edit tool. - `type: optional "edit"` - `name: "edit"` Must be "edit". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfigParams object` Configuration override for the read tool. - `type: optional "read"` - `name: "read"` Must be "read". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfigParams object` Configuration override for the write tool. - `type: optional "write"` - `name: "write"` Must be "write". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfigParams object` Configuration override for the glob tool. - `type: optional "glob"` - `name: "glob"` Must be "glob". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfigParams object` Configuration override for the grep tool. - `type: optional "grep"` - `name: "grep"` Must be "grep". - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfigParams object` Configuration override for the web_fetch tool. - `type: optional "web_fetch"` - `name: "web_fetch"` Must be "web_fetch". - `allowed_domains: optional array of string` Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. - `blocked_domains: optional array of string` Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `max_content_tokens: optional number or null` Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. format: int32 - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: optional BetaManagedAgentsWebFetchURLSourcesParams or null` Which sources contribute URLs the tool may fetch. Omit to allow every source. - `client_tool_results: optional BetaManagedAgentsWebFetchURLSourceToolFilterParams or null` Which custom tools' results contribute URLs that may be fetched: "all" (the default), "none", or an only or except list. Each name in a list must be a custom tool in the same tools array. - `BetaManagedAgentsWebFetchURLSourceShorthand = "all" or "none"` String form of a url_sources value that has no field other than its type: "all" means {"type": "all"} and "none" means {"type": "none"}. - `"all"` - `"none"` - `BetaManagedAgentsWebFetchURLSourceToolFilter = BetaManagedAgentsWebFetchURLSourceAll or BetaManagedAgentsWebFetchURLSourceNone or BetaManagedAgentsWebFetchURLSourceOnly or BetaManagedAgentsWebFetchURLSourceExcept` Which tools' results contribute URLs that may be fetched. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: optional BetaManagedAgentsWebFetchURLSourceToolFilterParams or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched: "all" (the default), "none", or an only or except list. Each name in a list must be "web_search" or "web_fetch". - `user_input: optional BetaManagedAgentsWebFetchURLSourceUserInputParams or null` Whether URLs in the text of user messages may be fetched: "all" (the default) or "none". - `BetaManagedAgentsWebFetchURLSourceShorthand = "all" or "none"` String form of a url_sources value that has no field other than its type: "all" means {"type": "all"} and "none" means {"type": "none"}. - `BetaManagedAgentsWebFetchURLSourceUserInput = BetaManagedAgentsWebFetchURLSourceAll or BetaManagedAgentsWebFetchURLSourceNone` Whether URLs in the text of user messages may be fetched. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `BetaManagedAgentsWebSearchToolConfigParams object` Configuration override for the web_search tool. - `type: optional "web_search"` - `name: "web_search"` Must be "web_search". - `allowed_domains: optional array of string` Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. - `blocked_domains: optional array of string` Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. - `enabled: optional boolean or null` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` Default configuration applied to all tools in this set. - `enabled: optional boolean or null` Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolsetParams object` Configuration for tools from an MCP server defined in `mcp_servers`. - `type: "mcp_toolset"` - `mcp_server_name: string` Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters. minLength: 1, maxLength: 255 - `configs: optional array of BetaManagedAgentsMCPToolConfigParams` Per-tool configuration overrides. - `name: string` Name of the MCP tool to configure. 1-128 characters. minLength: 1, maxLength: 128 - `enabled: optional boolean or null` Whether this tool is enabled. Overrides the `default_config` setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Permission policy for this tool. Overrides the `default_config` setting. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` Default configuration for all tools from this server. - `enabled: optional boolean or null` Whether tools are enabled by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy or null` Default permission policy for tools from this server. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsCustomToolParams object` 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. - `type: "custom"` - `description: string` Description of what the tool does, shown to the agent to help it decide when to use the tool. minLength: 1 - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema defining the expected input parameters for the tool. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens. minLength: 1, maxLength: 128 - `budget: optional BetaManagedAgentsBudgetLimit or null` Enforced spend ceiling for the session. Set an object to replace the budget of a session that was created with one, or `null` to remove it; omit to preserve. A budget cannot be added to a session created without one (rejected with reason `budget_create_only`), and a removed budget cannot be re-added. Allowed in any non-terminated status. Lowering `max_list_cost` to at or below the session's consumed list cost is rejected with reason `budget_not_raised`, and every model the session can run must have a public list price or the request is rejected with reason `model_not_budgetable`. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `metadata: optional map[string] or null` Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. - `title: optional string or null` Human-readable session title. minLength: 1, maxLength: 500 - `vault_ids: optional array of string` Vault IDs (`vlt_*`) to attach to the session. Not yet supported; requests setting this field are rejected. Reserved for future use. #### Returns - `BetaManagedAgentsSession object` A Managed Agents `session`. - `type: "session"` - `id: string` - `agent: BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsSessionMultiagent or null` Resolved multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsSessionMultiagentCoordinator object` Resolved coordinator topology with full agent definitions for each roster member. - `type: "coordinator"` - `agents: array of BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` Full `agent` definitions the coordinator may spawn as session threads. - `BetaManagedAgentsSessionThreadAgent object` 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`. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsSessionMultiagent20261001 object` Resolved multiagent configuration with three members, as copied to the `session` at creation. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsSessionMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsSessionMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that this agent can spawn as session threads. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsSessionMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsSessionMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that a run's plan can use. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `BetaManagedAgentsMCPToolset object` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `version: number` format: int32 - `archived_at: string or null` When the session was archived. Null if not archived. format: date-time - `budget: BetaManagedAgentsBudgetLimit or null` The session's enforced spend ceiling, or null when no budget is set. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `created_at: string` A timestamp in RFC 3339 format format: date-time - `environment_id: string` - `metadata: map[string]` - `outcome_evaluations: array of BetaManagedAgentsOutcomeEvaluationResource` Per-outcome evaluation state. One entry per `define_outcome` event sent to the session. - `type: "outcome_evaluation"` - `completed_at: string or null` When the outcome reached a terminal result. Null while `pending`/`running`/`evaluating`. format: date-time - `description: string` What the agent should produce. - `explanation: string or null` 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: number` 0-indexed revision cycle the outcome is currently on. format: int32 - `outcome_id: 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. - `resources: array of BetaManagedAgentsSessionResource` - `BetaManagedAgentsGitHubRepositoryResource object` - `type: "github_repository"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `BetaManagedAgentsFileResource object` - `type: "file"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `file_id: string` - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `BetaManagedAgentsMemoryStoreResource object` A memory store attached to an agent session. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `description: optional 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: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. maxLength: 4096 - `mount_path: optional string or null` 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: optional string or null` 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 the session. - `active_seconds: optional number` Cumulative time in seconds the session spent in `running` status. Excludes idle time. format: double - `duration_seconds: optional number` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. format: double - `status: "rescheduling" or "running" or "idle" or "terminated"` - `"rescheduling"` Transient error occurred, retrying automatically. - `"running"` Agent is actively executing. - `"idle"` Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle. - `"terminated"` Session has ended, either due to an error or completion. - `title: string or null` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `usage: BetaManagedAgentsSessionUsage` Cumulative token usage for the session. - `active_seconds: optional number` Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once, unlike `stats.active_seconds`, which sums each thread's own active time. This is the duration the session's runtime cost is priced on. format: double - `cache_creation: optional BetaManagedAgentsCacheCreationUsage` Tokens used to create prompt cache entries, broken down by cache TTL. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. format: int32 - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. format: int32 - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. format: int32 - `input_tokens: optional number` Total input tokens consumed across all turns. format: int32 - `list_cost: optional BetaMonetaryAmount or null` Cumulative list cost of the session across all turns, priced at public list rates. Absent until cost tracking is available for the session. - `output_tokens: optional number` Total output tokens generated across all turns. format: int32 - `server_tool_use: optional BetaManagedAgentsServerToolUsage or null` Cumulative server-executed tool usage across all turns. Absent until server-tool tracking is available for the session. - `web_fetch_requests: optional number` Number of server-executed web fetch requests. format: int32 - `web_search_requests: optional number` Number of server-executed web search requests. format: int32 - `vault_ids: array of string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. - `deployment_id: optional string or null` Deployment ID when the session was created from a deployment reference. Null otherwise. #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "title": "Order #1234 inquiry" }' ``` ##### Response (200) ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "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" }, "type": "bash" } ], "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_011CZkZFNu9hAbo3jZPRgTmx", "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" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" }, "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_011CZkZRSw2kEfs6ncTVmjxP", "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_011CZkZCKr6eXym1gWMPdQiu", "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": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "deployment_id": "deployment_id" } ``` ### Delete Session **DELETE** `/v1/sessions/{session_id}` Delete Session #### Path parameters - `session_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsDeletedSession object` Confirmation that a `session` has been permanently deleted. - `type: "session_deleted"` - `id: string` #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "type": "session_deleted" } ``` ### Archive Session **POST** `/v1/sessions/{session_id}/archive` Archive Session #### Path parameters - `session_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsSession object` A Managed Agents `session`. - `type: "session"` - `id: string` - `agent: BetaManagedAgentsSessionAgent` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsSessionMultiagent or null` Resolved multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsSessionMultiagentCoordinator object` Resolved coordinator topology with full agent definitions for each roster member. - `type: "coordinator"` - `agents: array of BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` Full `agent` definitions the coordinator may spawn as session threads. - `BetaManagedAgentsSessionThreadAgent object` 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`. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsSessionMultiagent20261001 object` Resolved multiagent configuration with three members, as copied to the `session` at creation. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsSessionMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsSessionMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that this agent can spawn as session threads. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsSessionMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsSessionMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that a run's plan can use. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `BetaManagedAgentsMCPToolset object` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `version: number` format: int32 - `archived_at: string or null` When the session was archived. Null if not archived. format: date-time - `budget: BetaManagedAgentsBudgetLimit or null` The session's enforced spend ceiling, or null when no budget is set. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `created_at: string` A timestamp in RFC 3339 format format: date-time - `environment_id: string` - `metadata: map[string]` - `outcome_evaluations: array of BetaManagedAgentsOutcomeEvaluationResource` Per-outcome evaluation state. One entry per `define_outcome` event sent to the session. - `type: "outcome_evaluation"` - `completed_at: string or null` When the outcome reached a terminal result. Null while `pending`/`running`/`evaluating`. format: date-time - `description: string` What the agent should produce. - `explanation: string or null` 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: number` 0-indexed revision cycle the outcome is currently on. format: int32 - `outcome_id: 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. - `resources: array of BetaManagedAgentsSessionResource` - `BetaManagedAgentsGitHubRepositoryResource object` - `type: "github_repository"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `BetaManagedAgentsFileResource object` - `type: "file"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `file_id: string` - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `BetaManagedAgentsMemoryStoreResource object` A memory store attached to an agent session. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `description: optional 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: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. maxLength: 4096 - `mount_path: optional string or null` 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: optional string or null` 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 the session. - `active_seconds: optional number` Cumulative time in seconds the session spent in `running` status. Excludes idle time. format: double - `duration_seconds: optional number` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. format: double - `status: "rescheduling" or "running" or "idle" or "terminated"` - `"rescheduling"` Transient error occurred, retrying automatically. - `"running"` Agent is actively executing. - `"idle"` Agent is waiting for input, including user messages or tool confirmations. Sessions start in idle. - `"terminated"` Session has ended, either due to an error or completion. - `title: string or null` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `usage: BetaManagedAgentsSessionUsage` Cumulative token usage for the session. - `active_seconds: optional number` Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once, unlike `stats.active_seconds`, which sums each thread's own active time. This is the duration the session's runtime cost is priced on. format: double - `cache_creation: optional BetaManagedAgentsCacheCreationUsage` Tokens used to create prompt cache entries, broken down by cache TTL. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. format: int32 - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. format: int32 - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. format: int32 - `input_tokens: optional number` Total input tokens consumed across all turns. format: int32 - `list_cost: optional BetaMonetaryAmount or null` Cumulative list cost of the session across all turns, priced at public list rates. Absent until cost tracking is available for the session. - `output_tokens: optional number` Total output tokens generated across all turns. format: int32 - `server_tool_use: optional BetaManagedAgentsServerToolUsage or null` Cumulative server-executed tool usage across all turns. Absent until server-tool tracking is available for the session. - `web_fetch_requests: optional number` Number of server-executed web fetch requests. format: int32 - `web_search_requests: optional number` Number of server-executed web search requests. format: int32 - `vault_ids: array of string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. - `deployment_id: optional string or null` Deployment ID when the session was created from a deployment reference. Null otherwise. #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "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" }, "type": "bash" } ], "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_011CZkZFNu9hAbo3jZPRgTmx", "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" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" }, "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_011CZkZRSw2kEfs6ncTVmjxP", "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_011CZkZCKr6eXym1gWMPdQiu", "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": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "deployment_id": "deployment_id" } ``` ## Beta › Sessions › Events ### List Events **GET** `/v1/sessions/{session_id}/events` List Events #### Path parameters - `session_id: string` #### Query parameters - `"created_at[gt]": optional string` Return events created after this time (exclusive). Compared against the event's `processed_at` value. format: date-time - `"created_at[gte]": optional string` Return events created at or after this time (inclusive). Compared against the event's `processed_at` value. format: date-time - `"created_at[lt]": optional string` Return events created before this time (exclusive). Compared against the event's `processed_at` value. format: date-time - `"created_at[lte]": optional string` Return events created at or before this time (inclusive). Compared against the event's `processed_at` value. format: date-time - `limit: optional number` format: int32 - `order: optional "asc" or "desc"` Sort direction for results, ordered by the event's `processed_at`. Defaults to `asc` (chronological). - `"asc"` - `"desc"` - `page: optional string` Opaque pagination cursor from a previous response's `next_page`. - `types: optional array of BetaManagedAgentsSessionEventType` 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. - `"user.message"` - `"user.interrupt"` - `"user.tool_confirmation"` - `"user.custom_tool_result"` - `"agent.custom_tool_use"` - `"agent.message"` - `"agent.thinking"` - `"agent.mcp_tool_use"` - `"agent.mcp_tool_result"` - `"agent.tool_use"` - `"agent.tool_result"` - `"agent.thread_message_received"` - `"agent.thread_message_sent"` - `"agent.thread_context_compacted"` - `"session.error"` - `"session.status_rescheduled"` - `"session.status_running"` - `"session.status_idle"` - `"session.status_terminated"` - `"session.thread_created"` - `"span.outcome_evaluation_start"` - `"span.outcome_evaluation_end"` - `"span.model_request_start"` - `"span.model_request_end"` - `"span.outcome_evaluation_ongoing"` - `"user.define_outcome"` - `"session.thread_status_running"` - `"session.thread_status_idle"` - `"session.thread_status_terminated"` - `"user.tool_result"` - `"session.thread_status_rescheduled"` - `"session.updated"` - `"system.message"` - `"session.usage"` - `"workflow_run.created"` - `"workflow_run.status_running"` - `"workflow_run.status_idle"` - `"workflow_run.status_ended"` - `"workflow_run.error"` - `"workflow_run.phase_started"` - `"workflow_run.phase_ended"` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: optional array of BetaManagedAgentsSessionEvent` Events for the session, ordered by `processed_at`. - `BetaManagedAgentsUserMessageEvent object` A user message event in the session conversation. - `type: "user.message"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks comprising the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `processed_at: optional string or null` Timestamp when the agent finished processing this message. format: date-time - `BetaManagedAgentsUserInterruptEvent object` An interrupt event that pauses agent execution and returns control to the user. - `type: "user.interrupt"` - `id: string` Unique identifier for this event. - `processed_at: optional string or null` Timestamp when the interrupt was processed. format: date-time - `session_thread_id: optional string or null` 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. - `BetaManagedAgentsUserToolConfirmationEvent object` A tool confirmation event that approves or denies a pending tool execution. - `type: "user.tool_confirmation"` - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` The confirmation result: 'allow' or 'deny'. - `"allow"` - `"deny"` - `tool_use_id: 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?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `deny_message: optional string or null` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. maxLength: 10000 - `processed_at: optional string or null` Timestamp when the confirmation was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this confirmation was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsUserCustomToolResultEvent object` Event sent by the client providing the result of a custom tool execution. - `type: "user.custom_tool_result"` - `id: string` Unique identifier for this event. - `custom_tool_use_id: string` The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `type: "search_result"` - `citations: BetaManagedAgentsSearchResultCitations` Citation settings for this search result. - `enabled: boolean` Whether citations are enabled for this search result. - `content: array of BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `type: "text"` - `text: string` The text content. minLength: 1 - `source: string` The URL source of the search result. minLength: 1 - `title: string` The title of the search result. minLength: 1 - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `processed_at: optional string or null` Timestamp when this result was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this result was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsAgentCustomToolUseEvent object` 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. The client can send it as soon as this event arrives, without waiting for `session.status_idle`. - `type: "agent.custom_tool_use"` - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the custom tool being called. - `processed_at: string` Timestamp when this tool use was processed. format: date-time - `session_thread_id: optional string or null` 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. Informational only: the server routes the matching `user.custom_tool_result` by `custom_tool_use_id`, so clients do not send it back. - `BetaManagedAgentsAgentMessageEvent object` An agent response event in the session conversation. - `type: "agent.message"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsRedactedBlock` Array of text blocks comprising the agent response. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `processed_at: string` Timestamp when this response was generated. format: date-time - `BetaManagedAgentsAgentThinkingEvent object` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `type: "agent.thinking"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this thinking was produced. format: date-time - `BetaManagedAgentsAgentMCPToolUseEvent object` Event emitted when the agent invokes a tool provided by an MCP server. - `type: "agent.mcp_tool_use"` - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `mcp_server_name: string` Name of the MCP server providing the tool. - `name: string` Name of the MCP tool being used. - `processed_at: string` Timestamp when this event was processed. format: date-time - `evaluated_permission: optional BetaManagedAgentsAgentEvaluatedPermission` The evaluated permission policy for this tool invocation. - `"allow"` - `"ask"` - `"deny"` - `evaluation: optional BetaManagedAgentsAgentToolEvaluation` Which resolved permission_policy produced evaluated_permission: always_allow, always_ask, or auto (with the server's per-invocation judgement). Absent only when the server refused the call before any policy applied (for example, the named tool is not enabled in the session); such a refusal has evaluated_permission deny. An event recorded before this field existed reads as the arm its evaluated_permission implies (always_allow for allow, always_ask for ask). - `BetaManagedAgentsAgentToolEvaluationAlwaysAllow object` The resolved permission_policy was always_allow; accompanies evaluated_permission "allow". - `type: "always_allow"` - `BetaManagedAgentsAgentToolEvaluationAlwaysAsk object` The resolved permission_policy was always_ask; accompanies evaluated_permission "ask". - `type: "always_ask"` - `BetaManagedAgentsAgentToolEvaluationAuto object` The resolved permission_policy was auto: the server judged this invocation individually. - `type: "auto"` - `evaluated_permission: BetaManagedAgentsAgentAutoEvaluatedPermission` The server's judgement for this invocation. - `BetaManagedAgentsAgentAutoEvaluatedPermissionAllow object` The server judged the invocation safe to execute without client approval. - `type: "allow"` - `BetaManagedAgentsAgentAutoEvaluatedPermissionAsk object` The server reached no judgement; the invocation is held for client approval. - `type: "ask"` - `reason_code: string` The judgement's grounds in registry-bound terms, for client branching and audit rather than end-user display. Open registry; currently "indeterminate" (no judgement was reached). Clients must tolerate values outside this set. maxLength: 64 - `BetaManagedAgentsAgentAutoEvaluatedPermissionDeny object` The server judged the invocation high-risk; it does not execute and a synthetic error tool result is appended. - `type: "deny"` - `reason_code: string` The judgement's grounds in registry-bound terms. Open registry; currently "high_risk" (judged high-risk; the call does not run). Clients must tolerate values outside this set. maxLength: 64 - `session_thread_id: optional string or null` 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. Informational only: the server routes the matching `user.tool_confirmation` by `tool_use_id`, so clients do not send it back. - `BetaManagedAgentsAgentMCPToolResultEvent object` Event representing the result of an MCP tool execution. - `type: "agent.mcp_tool_result"` - `id: string` Unique identifier for this event. - `mcp_tool_use_id: string` The id of the `agent.mcp_tool_use` event this result corresponds to. - `processed_at: string` Timestamp when this event was processed. format: date-time - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `BetaManagedAgentsAgentToolUseEvent object` Event emitted when the agent invokes a built-in agent tool. - `type: "agent.tool_use"` - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the agent tool being used. - `processed_at: string` Timestamp when this event was processed. format: date-time - `evaluated_permission: optional BetaManagedAgentsAgentEvaluatedPermission` The evaluated permission policy for this tool invocation. - `evaluation: optional BetaManagedAgentsAgentToolEvaluation` Which resolved permission_policy produced evaluated_permission: always_allow, always_ask, or auto (with the server's per-invocation judgement). Absent only when the server refused the call before any policy applied (for example, the named tool is not enabled in the session); such a refusal has evaluated_permission deny. An event recorded before this field existed reads as the arm its evaluated_permission implies (always_allow for allow, always_ask for ask). - `session_thread_id: optional string or null` 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. Informational only: the server routes the matching `user.tool_confirmation` or `user.tool_result` by `tool_use_id`, so clients do not send it back. - `BetaManagedAgentsAgentToolResultEvent object` Event representing the result of an agent tool execution. - `type: "agent.tool_result"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `tool_use_id: string` The id of the `agent.tool_use` event this result corresponds to. - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `BetaManagedAgentsAgentThreadMessageReceivedEvent object` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `type: "agent.thread_message_received"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Message content blocks. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `from_session_thread_id: string` Public `sthr_` ID of the thread that sent the message. - `processed_at: string` Timestamp when the message was received. format: date-time - `from_agent_name: optional string or null` Name of the callable agent this message came from. Absent when received from the primary agent. - `BetaManagedAgentsAgentThreadMessageSentEvent object` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `type: "agent.thread_message_sent"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Message content blocks. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `processed_at: string` Timestamp when the message was sent. format: date-time - `to_session_thread_id: string` Public `sthr_` ID of the thread the message was sent to. - `to_agent_name: optional string or null` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `BetaManagedAgentsAgentThreadContextCompactedEvent object` Indicates that context compaction (summarization) occurred during the session. - `type: "agent.thread_context_compacted"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when compaction was processed. format: date-time - `BetaManagedAgentsSessionErrorEvent object` An error event indicating a problem occurred during session execution. - `type: "session.error"` - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 10 more` - `BetaManagedAgentsUnknownError object` 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: "unknown_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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: "retrying"` - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `BetaManagedAgentsModelOverloadedError object` The model is currently overloaded. Emitted after automatic retries are exhausted. - `type: "model_overloaded_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsModelRateLimitedError object` The model request was rate-limited. - `type: "model_rate_limited_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsModelRequestFailedError object` A model request failed for a reason other than overload or rate-limiting. - `type: "model_request_failed_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsMCPConnectionFailedError object` Failed to connect to an MCP server. - `type: "mcp_connection_failed_error"` - `mcp_server_name: string` Name of the MCP server that failed to connect. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsMCPAuthenticationFailedError object` Authentication to an MCP server failed. - `type: "mcp_authentication_failed_error"` - `mcp_server_name: string` Name of the MCP server that failed authentication. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsBillingError object` 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. - `type: "billing_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsCredentialHostUnreachableError object` An `environment_variable` credential's `auth.networking.allowed_hosts` includes a host the environment's network policy does not permit. - `type: "credential_host_unreachable_error"` - `credential_id: string` ID of the affected credential. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `vault_id: string` ID of the vault containing the affected credential. - `BetaManagedAgentsRepositoryAuthenticationError object` The repository host rejected the credentials, or required credentials and received none. - `type: "repository_authentication_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryForbiddenError object` The repository host refused access to the repository. - `type: "repository_forbidden_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryNotFoundError object` The repository host reported the repository as not found. - `type: "repository_not_found_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryCheckoutError object` The requested branch or commit does not exist in the repository. - `type: "repository_checkout_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryCloneError object` The repository could not be cloned. - `type: "repository_clone_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `processed_at: string` Timestamp when the error occurred. format: date-time - `BetaManagedAgentsSessionStatusRescheduledEvent object` Indicates the session is recovering from an error state and is rescheduled for execution. - `type: "session.status_rescheduled"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `BetaManagedAgentsSessionStatusRunningEvent object` Indicates the session is actively running and the agent is working. - `type: "session.status_running"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `BetaManagedAgentsSessionStatusIdleEvent object` Indicates the agent has paused and is awaiting user input. - `type: "session.status_idle"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `stop_details: BetaManagedAgentsSessionRefusalStopDetails or null` Structured information about why the session stopped. `null` when there is nothing more to report. - `type: "refusal"` - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null` The policy category that triggered the refusal, or `null` when there is no named category. New values can be added over time. - `"cyber"` - `"bio"` - `"frontier_llm"` - `"reasoning_extraction"` - `"general_harms"` - `explanation: string or null` Human-readable explanation of the refusal, or `null` when none is available. The wording can change, so do not parse it. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted or 2 more` - `BetaManagedAgentsSessionEndTurn object` The agent completed its turn naturally and is ready for the next user message. - `type: "end_turn"` - `BetaManagedAgentsSessionRequiresAction object` 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: "requires_action"` - `event_ids: array of string` The ids of events the agent is blocked on. Resolving fewer than all re-emits `session.status_idle` with the remainder. - `BetaManagedAgentsSessionRetriesExhausted object` The turn ended because repeated errors exhausted the retry budget or an error escalated to `retry_status: 'exhausted'`. - `type: "retries_exhausted"` - `BetaManagedAgentsSessionBudgetReached object` The agent stopped because the session's tracked list cost reached its budget, or because its usage includes a model with no list price (which the budget cannot measure). Raise the budget to continue — or, if raising is rejected because a model has no list price, remove the budget. - `type: "budget_reached"` - `BetaManagedAgentsSessionRefusal object` The turn ended because the model's response was refused, for example by a safety classifier. - `type: "refusal"` - `BetaManagedAgentsSessionStatusTerminatedEvent object` Indicates the session has terminated, either due to an error or completion. - `type: "session.status_terminated"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `BetaManagedAgentsSessionThreadCreatedEvent object` Emitted when a child thread is created. Written to the parent thread's output stream so clients observing the session see child creation. - `type: "session.thread_created"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the callable agent the thread runs. - `processed_at: string` Timestamp when the thread was created. format: date-time - `session_thread_id: string` Public `sthr_` ID of the newly created thread. - `workflow_run_id: string or null` Identifier of the workflow run that created the thread, or `null` for any other thread. - `BetaManagedAgentsSpanOutcomeEvaluationStartEvent object` Emitted when an outcome evaluation cycle begins. - `type: "span.outcome_evaluation_start"` - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc. format: int32 - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` Timestamp when outcome evaluation started. format: date-time - `BetaManagedAgentsSpanOutcomeEvaluationEndEvent object` 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. - `type: "span.outcome_evaluation_end"` - `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: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. format: int32 - `outcome_evaluation_start_id: string` The id of the corresponding `span.outcome_evaluation_start` event. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` Timestamp when outcome evaluation ended. format: date-time - `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. - `usage: BetaManagedAgentsSpanModelUsage` Aggregate token usage for this evaluation cycle. Sums across all grader model requests within the cycle. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. format: int32 - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. format: int32 - `input_tokens: number` Input tokens consumed by this request. format: int32 - `output_tokens: number` Output tokens generated by this request. format: int32 - `speed: optional "standard" or "fast" or null` Inference speed tier this request actually ran at. Mirrors `usage.speed` on /v1/messages. Only present when the fast-mode beta is active. - `"standard"` - `"fast"` - `BetaManagedAgentsSpanModelRequestStartEvent object` Emitted when a model request is initiated by the agent. - `type: "span.model_request_start"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the model request started. format: date-time - `BetaManagedAgentsSpanModelRequestEndEvent object` Emitted when a model request completes. - `type: "span.model_request_end"` - `id: string` Unique identifier for this event. - `is_error: boolean or null` Whether the model request resulted in an error. - `model_request_start_id: string` The id of the corresponding `span.model_request_start` event. - `model_usage: BetaManagedAgentsSpanModelUsage` Token usage for this model request. - `processed_at: string` Timestamp when the model request completed. format: date-time - `BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent object` 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. - `type: "span.outcome_evaluation_ongoing"` - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. format: int32 - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` Timestamp when this heartbeat was emitted. format: date-time - `BetaManagedAgentsUserDefineOutcomeEvent object` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `type: "user.define_outcome"` - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number or null` Evaluate-then-revise cycles before giving up. Default 3, max 20. format: int32 - `outcome_id: string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `processed_at: string` Timestamp when the outcome was accepted. format: date-time - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` How to grade the outcome. File rubrics are currently resolved to their text content; clients should handle both variants. - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `BetaManagedAgentsSessionDeletedEvent object` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `type: "session.deleted"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the session was deleted. format: date-time - `BetaManagedAgentsSessionThreadStatusRunningEvent object` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `type: "session.thread_status_running"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that started running. - `BetaManagedAgentsSessionThreadStatusIdleEvent object` 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. - `type: "session.thread_status_idle"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that went idle. - `stop_details: BetaManagedAgentsSessionRefusalStopDetails or null` Structured information about why the thread stopped. `null` when there is nothing more to report. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted or 2 more` - `BetaManagedAgentsSessionEndTurn object` The agent completed its turn naturally and is ready for the next user message. - `BetaManagedAgentsSessionRequiresAction object` 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. - `BetaManagedAgentsSessionRetriesExhausted object` The turn ended because repeated errors exhausted the retry budget or an error escalated to `retry_status: 'exhausted'`. - `BetaManagedAgentsSessionBudgetReached object` The agent stopped because the session's tracked list cost reached its budget, or because its usage includes a model with no list price (which the budget cannot measure). Raise the budget to continue — or, if raising is rejected because a model has no list price, remove the budget. - `BetaManagedAgentsSessionRefusal object` The turn ended because the model's response was refused, for example by a safety classifier. - `BetaManagedAgentsSessionThreadStatusTerminatedEvent object` 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. - `type: "session.thread_status_terminated"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that terminated. - `BetaManagedAgentsUserToolResultEvent object` 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. - `type: "user.tool_result"` - `id: string` Unique identifier for this event. - `tool_use_id: 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?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `processed_at: optional string or null` Timestamp when this result was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this result was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsSessionThreadStatusRescheduledEvent object` 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. - `type: "session.thread_status_rescheduled"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that is retrying. - `BetaManagedAgentsSessionUpdatedEvent object` 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. - `type: "session.updated"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the update was applied. format: date-time - `agent: optional BetaManagedAgentsSessionAgent or null` The session's effective agent configuration after the update. Present only when the update changed `agent` (tools or mcp_servers); when present it is the full materialised snapshot, not a diff. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsSessionMultiagent or null` Resolved multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsSessionMultiagentCoordinator object` Resolved coordinator topology with full agent definitions for each roster member. - `type: "coordinator"` - `agents: array of BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` Full `agent` definitions the coordinator may spawn as session threads. - `BetaManagedAgentsSessionThreadAgent object` 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`. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsSessionMultiagent20261001 object` Resolved multiagent configuration with three members, as copied to the `session` at creation. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsSessionMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsSessionMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that this agent can spawn as session threads. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsSessionMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsSessionMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that a run's plan can use. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `BetaManagedAgentsMCPToolset object` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `version: number` format: int32 - `budget: optional BetaManagedAgentsBudgetLimit or null` The session's budget after the update: the new budget when set or replaced, or null when the update removed it. Present only when the update changed the budget. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `metadata: optional map[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: optional string or null` The session's new title. Present only when the update changed it. - `BetaManagedAgentsSystemMessageEvent object` A mid-conversation system message event. Carries system-role content that is appended to the session as a `role: "system"` turn. - `type: "system.message"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `processed_at: optional string or null` Timestamp when this system message was processed. format: date-time - `BetaManagedAgentsSessionUsageEvent object` Periodic snapshot of the session's cumulative usage and tracked list cost. - `type: "session.usage"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the snapshot was taken. format: date-time - `usage: BetaManagedAgentsSessionUsageSnapshot` The session's cumulative usage at the snapshot time. - `active_seconds: optional number` Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once. This is the duration the session's runtime cost is priced on. format: double - `cache_creation: optional BetaManagedAgentsCacheCreationUsage` Tokens used to create prompt cache entries, broken down by cache TTL. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. format: int32 - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. format: int32 - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. format: int32 - `input_tokens: optional number` Total input tokens consumed across all turns. format: int32 - `list_cost: optional BetaMonetaryAmount` Cumulative list cost of the session across all turns, priced at public list rates. - `output_tokens: optional number` Total output tokens generated across all turns. format: int32 - `server_tool_use: optional BetaManagedAgentsServerToolUsage` Cumulative server-executed tool usage across all turns. - `web_fetch_requests: optional number` Number of server-executed web fetch requests. format: int32 - `web_search_requests: optional number` Number of server-executed web search requests. format: int32 - `budget: optional BetaManagedAgentsBudgetLimit or null` The session's configured budget at the snapshot time, or null when the session has no budget. - `BetaManagedAgentsWorkflowRunCreatedEvent object` A workflow run was created. A workflow run is background work that the session's agent starts. Emitted once per run, before the run's other `workflow_run.*` events. - `type: "workflow_run.created"` - `id: string` Unique identifier for this event. - `description: string or null` Description that the agent gave the run, passed on as written, or `null` if it gave none. - `name: string` Name that the agent gave the run, passed on as written, or a name that the server assigned. - `phases: array of BetaManagedAgentsWorkflowRunPhase` The phases that the run's plan declares, in the plan's order. Can be empty. - `id: string` Unique identifier for the phase. - `description: string or null` Description that the agent gave the phase, passed on as written, or `null` if it gave none. - `name: string` Name that the agent gave the phase, passed on as written. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunStatusEndedEvent object` A workflow run ended. Emitted once per run, as the last of the run's `workflow_run.*` events. - `type: "workflow_run.status_ended"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `result: BetaManagedAgentsWorkflowRunResult` How the run ended. - `BetaManagedAgentsWorkflowRunResultCompleted object` The run's plan, a program that the agent wrote, finished. This does not say whether the work succeeded. - `type: "completed"` - `BetaManagedAgentsWorkflowRunResultError object` The run failed or reached its time limit. - `type: "error"` - `error: BetaManagedAgentsWorkflowRunError` Why the run did not finish. - `BetaManagedAgentsTimeoutWorkflowRunError object` The run reached its time limit. - `type: "timeout_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsProgramWorkflowRunError object` The plan, a program that the agent wrote, failed, or the server refused it. - `type: "program_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsUnknownWorkflowRunError object` A failure that has no type of its own. - `type: "unknown_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsThreadLimitWorkflowRunError object` The run exceeded the limit on the number of threads that a run can create. - `type: "thread_limit_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsMaxWorkflowRunsWorkflowRunError object` No run was created, because the session was at its limit of open workflow runs, which are runs that have not ended. Only `workflow_run.error` carries this type. - `type: "max_workflow_runs_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsWorkflowRunResultStopped object` The agent stopped the run. - `type: "stopped"` - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunPhaseStartedEvent object` A workflow run's plan entered a phase. - `type: "workflow_run.phase_started"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `workflow_run_phase_id: string` Identifier of the phase, as in `phases` on the run's `workflow_run.created` event. - `BetaManagedAgentsWorkflowRunPhaseEndedEvent object` A workflow run's plan left a phase, or the run's end closed it. Emitted once for every `workflow_run.phase_started` event, before the run's `workflow_run.status_ended` event. The event does not say whether the plan finished the phase's work, or why it left. - `type: "workflow_run.phase_ended"` - `id: string` Unique identifier for this event. - `phase_started_id: string` Identifier of the `workflow_run.phase_started` event that opened the phase. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `workflow_run_phase_id: string` Identifier of the phase, as in `phases` on the run's `workflow_run.created` event. - `BetaManagedAgentsWorkflowRunStatusRunningEvent object` A workflow run is running. Emitted when the run starts to execute, and each time it resumes after being idle. A run that starts idle emits `workflow_run.status_idle` first. - `type: "workflow_run.status_running"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunStatusIdleEvent object` A workflow run is idle. Emitted each time the run goes idle, whatever the cause. If the run ends while idle, no `workflow_run.status_running` comes between this event and its `workflow_run.status_ended`. - `type: "workflow_run.status_idle"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunErrorEvent object` A workflow run met an error, or an error kept a run from being created. A run that ends with a `result.type` of `error` emits this event before its `workflow_run.status_ended`, with the same `error`. - `type: "workflow_run.error"` - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsWorkflowRunError` Why the run did not finish, or was not created. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string or null` Identifier of the run that met the error, or `null` when the error kept a run from being created. - `next_page: optional string or null` Opaque cursor for the next page. Null when no more results. #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID/events \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "sevt_011CZkZGPp1iBcp4kaQSihUm", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" }, { "id": "sevt_011CZkZHPq1jCdq5mbRTjiVn", "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 **POST** `/v1/sessions/{session_id}/events` Send Events #### Path parameters - `session_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `events: array of BetaManagedAgentsEventParams` Events to send to the `session`. - `BetaManagedAgentsUserMessageEventParams object` Parameters for sending a user message to the session. - `type: "user.message"` - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks for the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `BetaManagedAgentsUserInterruptEventParams object` Parameters for sending an interrupt to pause the agent. - `type: "user.interrupt"` - `session_thread_id: optional string or null` 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. - `BetaManagedAgentsUserToolConfirmationEventParams object` Parameters for confirming or denying a tool execution request. - `type: "user.tool_confirmation"` - `result: "allow" or "deny"` The confirmation result: 'allow' or 'deny'. - `"allow"` - `"deny"` - `tool_use_id: 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?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. minLength: 1, maxLength: 128 - `deny_message: optional string or null` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. maxLength: 10000 - `BetaManagedAgentsUserCustomToolResultEventParams object` Parameters for providing the result of a custom tool execution. - `type: "user.custom_tool_result"` - `custom_tool_use_id: string` The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. minLength: 1, maxLength: 128 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `type: "search_result"` - `citations: BetaManagedAgentsSearchResultCitations` Citation settings for this search result. - `enabled: boolean` Whether citations are enabled for this search result. - `content: array of BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `type: "text"` - `text: string` The text content. minLength: 1 - `source: string` The URL source of the search result. minLength: 1 - `title: string` The title of the search result. minLength: 1 - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `BetaManagedAgentsUserDefineOutcomeEventParams object` Parameters for defining an outcome the agent should work toward. The agent begins work on receipt. - `type: "user.define_outcome"` - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams` How to grade the outcome. Text or file reference. - `BetaManagedAgentsFileRubricParams object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubricParams object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. maxLength: 262144 - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsUserToolResultEventParams object` 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. - `type: "user.tool_result"` - `tool_use_id: 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?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. minLength: 1, maxLength: 128 - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `BetaManagedAgentsSystemMessageEventParams object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt. At most one per request: it must be the final event and immediately follow the `user.message`, `user.tool_result`, or `user.custom_tool_result` it accompanies. Only supported on models that accept mid-conversation system messages. - `type: "system.message"` - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks to append. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 #### Returns - `BetaManagedAgentsSendSessionEvents object` Events that were successfully sent to the session. - `data: optional array of BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 4 more` Sent events - `BetaManagedAgentsUserMessageEvent object` A user message event in the session conversation. - `type: "user.message"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks comprising the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `processed_at: optional string or null` Timestamp when the agent finished processing this message. format: date-time - `BetaManagedAgentsUserInterruptEvent object` An interrupt event that pauses agent execution and returns control to the user. - `type: "user.interrupt"` - `id: string` Unique identifier for this event. - `processed_at: optional string or null` Timestamp when the interrupt was processed. format: date-time - `session_thread_id: optional string or null` 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. - `BetaManagedAgentsUserToolConfirmationEvent object` A tool confirmation event that approves or denies a pending tool execution. - `type: "user.tool_confirmation"` - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` The confirmation result: 'allow' or 'deny'. - `"allow"` - `"deny"` - `tool_use_id: 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?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `deny_message: optional string or null` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. maxLength: 10000 - `processed_at: optional string or null` Timestamp when the confirmation was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this confirmation was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsUserCustomToolResultEvent object` Event sent by the client providing the result of a custom tool execution. - `type: "user.custom_tool_result"` - `id: string` Unique identifier for this event. - `custom_tool_use_id: string` The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `type: "search_result"` - `citations: BetaManagedAgentsSearchResultCitations` Citation settings for this search result. - `enabled: boolean` Whether citations are enabled for this search result. - `content: array of BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `type: "text"` - `text: string` The text content. minLength: 1 - `source: string` The URL source of the search result. minLength: 1 - `title: string` The title of the search result. minLength: 1 - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `processed_at: optional string or null` Timestamp when this result was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this result was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsUserDefineOutcomeEvent object` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `type: "user.define_outcome"` - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number or null` Evaluate-then-revise cycles before giving up. Default 3, max 20. format: int32 - `outcome_id: string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `processed_at: string` Timestamp when the outcome was accepted. format: date-time - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` How to grade the outcome. File rubrics are currently resolved to their text content; clients should handle both variants. - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `BetaManagedAgentsUserToolResultEvent object` 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. - `type: "user.tool_result"` - `id: string` Unique identifier for this event. - `tool_use_id: 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?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `processed_at: optional string or null` Timestamp when this result was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this result was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsSystemMessageEvent object` A mid-conversation system message event. Carries system-role content that is appended to the session as a `role: "system"` turn. - `type: "system.message"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `processed_at: optional string or null` Timestamp when this system message was processed. format: date-time #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID/events \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "events": [ { "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message" } ] }' ``` ##### Response (200) ```json { "data": [ { "id": "sevt_011CZkZGPp1iBcp4kaQSihUm", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } ] } ``` ### Stream Events **GET** `/v1/sessions/{session_id}/events/stream` Stream Events #### Path parameters - `session_id: string` #### Query parameters - `event_deltas: optional array of BetaManagedAgentsDeltaType` When set, this connection also receives streaming deltas (`event_start`, `event_delta`) while an event is being produced, before the event itself arrives. Deltas are best-effort; when the final event is produced it carries the complete content. A model request that ends early (an error or interrupt) produces no final event — its terminal `span.model_request_end` closes the preview. Accepts one or more event types to preview and may be repeated: `agent.message` streams `content_delta` fragments; `agent.thinking` is start-only — a signal that the agent has begun extended thinking, concluded by the `agent.thinking` event itself. Only previews of the requested event types are sent. - `"agent.message"` - `"agent.thinking"` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsStreamSessionEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 41 more` Server-sent event in the session stream. - `BetaManagedAgentsUserMessageEvent object` A user message event in the session conversation. - `type: "user.message"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks comprising the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `processed_at: optional string or null` Timestamp when the agent finished processing this message. format: date-time - `BetaManagedAgentsUserInterruptEvent object` An interrupt event that pauses agent execution and returns control to the user. - `type: "user.interrupt"` - `id: string` Unique identifier for this event. - `processed_at: optional string or null` Timestamp when the interrupt was processed. format: date-time - `session_thread_id: optional string or null` 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. - `BetaManagedAgentsUserToolConfirmationEvent object` A tool confirmation event that approves or denies a pending tool execution. - `type: "user.tool_confirmation"` - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` The confirmation result: 'allow' or 'deny'. - `"allow"` - `"deny"` - `tool_use_id: 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?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `deny_message: optional string or null` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. maxLength: 10000 - `processed_at: optional string or null` Timestamp when the confirmation was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this confirmation was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsUserCustomToolResultEvent object` Event sent by the client providing the result of a custom tool execution. - `type: "user.custom_tool_result"` - `id: string` Unique identifier for this event. - `custom_tool_use_id: string` The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `type: "search_result"` - `citations: BetaManagedAgentsSearchResultCitations` Citation settings for this search result. - `enabled: boolean` Whether citations are enabled for this search result. - `content: array of BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `type: "text"` - `text: string` The text content. minLength: 1 - `source: string` The URL source of the search result. minLength: 1 - `title: string` The title of the search result. minLength: 1 - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `processed_at: optional string or null` Timestamp when this result was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this result was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsAgentCustomToolUseEvent object` 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. The client can send it as soon as this event arrives, without waiting for `session.status_idle`. - `type: "agent.custom_tool_use"` - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the custom tool being called. - `processed_at: string` Timestamp when this tool use was processed. format: date-time - `session_thread_id: optional string or null` 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. Informational only: the server routes the matching `user.custom_tool_result` by `custom_tool_use_id`, so clients do not send it back. - `BetaManagedAgentsAgentMessageEvent object` An agent response event in the session conversation. - `type: "agent.message"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsRedactedBlock` Array of text blocks comprising the agent response. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `processed_at: string` Timestamp when this response was generated. format: date-time - `BetaManagedAgentsAgentThinkingEvent object` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `type: "agent.thinking"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this thinking was produced. format: date-time - `BetaManagedAgentsAgentMCPToolUseEvent object` Event emitted when the agent invokes a tool provided by an MCP server. - `type: "agent.mcp_tool_use"` - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `mcp_server_name: string` Name of the MCP server providing the tool. - `name: string` Name of the MCP tool being used. - `processed_at: string` Timestamp when this event was processed. format: date-time - `evaluated_permission: optional BetaManagedAgentsAgentEvaluatedPermission` The evaluated permission policy for this tool invocation. - `"allow"` - `"ask"` - `"deny"` - `evaluation: optional BetaManagedAgentsAgentToolEvaluation` Which resolved permission_policy produced evaluated_permission: always_allow, always_ask, or auto (with the server's per-invocation judgement). Absent only when the server refused the call before any policy applied (for example, the named tool is not enabled in the session); such a refusal has evaluated_permission deny. An event recorded before this field existed reads as the arm its evaluated_permission implies (always_allow for allow, always_ask for ask). - `BetaManagedAgentsAgentToolEvaluationAlwaysAllow object` The resolved permission_policy was always_allow; accompanies evaluated_permission "allow". - `type: "always_allow"` - `BetaManagedAgentsAgentToolEvaluationAlwaysAsk object` The resolved permission_policy was always_ask; accompanies evaluated_permission "ask". - `type: "always_ask"` - `BetaManagedAgentsAgentToolEvaluationAuto object` The resolved permission_policy was auto: the server judged this invocation individually. - `type: "auto"` - `evaluated_permission: BetaManagedAgentsAgentAutoEvaluatedPermission` The server's judgement for this invocation. - `BetaManagedAgentsAgentAutoEvaluatedPermissionAllow object` The server judged the invocation safe to execute without client approval. - `type: "allow"` - `BetaManagedAgentsAgentAutoEvaluatedPermissionAsk object` The server reached no judgement; the invocation is held for client approval. - `type: "ask"` - `reason_code: string` The judgement's grounds in registry-bound terms, for client branching and audit rather than end-user display. Open registry; currently "indeterminate" (no judgement was reached). Clients must tolerate values outside this set. maxLength: 64 - `BetaManagedAgentsAgentAutoEvaluatedPermissionDeny object` The server judged the invocation high-risk; it does not execute and a synthetic error tool result is appended. - `type: "deny"` - `reason_code: string` The judgement's grounds in registry-bound terms. Open registry; currently "high_risk" (judged high-risk; the call does not run). Clients must tolerate values outside this set. maxLength: 64 - `session_thread_id: optional string or null` 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. Informational only: the server routes the matching `user.tool_confirmation` by `tool_use_id`, so clients do not send it back. - `BetaManagedAgentsAgentMCPToolResultEvent object` Event representing the result of an MCP tool execution. - `type: "agent.mcp_tool_result"` - `id: string` Unique identifier for this event. - `mcp_tool_use_id: string` The id of the `agent.mcp_tool_use` event this result corresponds to. - `processed_at: string` Timestamp when this event was processed. format: date-time - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `BetaManagedAgentsAgentToolUseEvent object` Event emitted when the agent invokes a built-in agent tool. - `type: "agent.tool_use"` - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the agent tool being used. - `processed_at: string` Timestamp when this event was processed. format: date-time - `evaluated_permission: optional BetaManagedAgentsAgentEvaluatedPermission` The evaluated permission policy for this tool invocation. - `evaluation: optional BetaManagedAgentsAgentToolEvaluation` Which resolved permission_policy produced evaluated_permission: always_allow, always_ask, or auto (with the server's per-invocation judgement). Absent only when the server refused the call before any policy applied (for example, the named tool is not enabled in the session); such a refusal has evaluated_permission deny. An event recorded before this field existed reads as the arm its evaluated_permission implies (always_allow for allow, always_ask for ask). - `session_thread_id: optional string or null` 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. Informational only: the server routes the matching `user.tool_confirmation` or `user.tool_result` by `tool_use_id`, so clients do not send it back. - `BetaManagedAgentsAgentToolResultEvent object` Event representing the result of an agent tool execution. - `type: "agent.tool_result"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `tool_use_id: string` The id of the `agent.tool_use` event this result corresponds to. - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `BetaManagedAgentsAgentThreadMessageReceivedEvent object` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `type: "agent.thread_message_received"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Message content blocks. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `from_session_thread_id: string` Public `sthr_` ID of the thread that sent the message. - `processed_at: string` Timestamp when the message was received. format: date-time - `from_agent_name: optional string or null` Name of the callable agent this message came from. Absent when received from the primary agent. - `BetaManagedAgentsAgentThreadMessageSentEvent object` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `type: "agent.thread_message_sent"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Message content blocks. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `processed_at: string` Timestamp when the message was sent. format: date-time - `to_session_thread_id: string` Public `sthr_` ID of the thread the message was sent to. - `to_agent_name: optional string or null` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `BetaManagedAgentsAgentThreadContextCompactedEvent object` Indicates that context compaction (summarization) occurred during the session. - `type: "agent.thread_context_compacted"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when compaction was processed. format: date-time - `BetaManagedAgentsSessionErrorEvent object` An error event indicating a problem occurred during session execution. - `type: "session.error"` - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 10 more` - `BetaManagedAgentsUnknownError object` 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: "unknown_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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: "retrying"` - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `BetaManagedAgentsModelOverloadedError object` The model is currently overloaded. Emitted after automatic retries are exhausted. - `type: "model_overloaded_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsModelRateLimitedError object` The model request was rate-limited. - `type: "model_rate_limited_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsModelRequestFailedError object` A model request failed for a reason other than overload or rate-limiting. - `type: "model_request_failed_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsMCPConnectionFailedError object` Failed to connect to an MCP server. - `type: "mcp_connection_failed_error"` - `mcp_server_name: string` Name of the MCP server that failed to connect. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsMCPAuthenticationFailedError object` Authentication to an MCP server failed. - `type: "mcp_authentication_failed_error"` - `mcp_server_name: string` Name of the MCP server that failed authentication. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsBillingError object` 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. - `type: "billing_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsCredentialHostUnreachableError object` An `environment_variable` credential's `auth.networking.allowed_hosts` includes a host the environment's network policy does not permit. - `type: "credential_host_unreachable_error"` - `credential_id: string` ID of the affected credential. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `vault_id: string` ID of the vault containing the affected credential. - `BetaManagedAgentsRepositoryAuthenticationError object` The repository host rejected the credentials, or required credentials and received none. - `type: "repository_authentication_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryForbiddenError object` The repository host refused access to the repository. - `type: "repository_forbidden_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryNotFoundError object` The repository host reported the repository as not found. - `type: "repository_not_found_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryCheckoutError object` The requested branch or commit does not exist in the repository. - `type: "repository_checkout_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryCloneError object` The repository could not be cloned. - `type: "repository_clone_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `processed_at: string` Timestamp when the error occurred. format: date-time - `BetaManagedAgentsSessionStatusRescheduledEvent object` Indicates the session is recovering from an error state and is rescheduled for execution. - `type: "session.status_rescheduled"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `BetaManagedAgentsSessionStatusRunningEvent object` Indicates the session is actively running and the agent is working. - `type: "session.status_running"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `BetaManagedAgentsSessionStatusIdleEvent object` Indicates the agent has paused and is awaiting user input. - `type: "session.status_idle"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `stop_details: BetaManagedAgentsSessionRefusalStopDetails or null` Structured information about why the session stopped. `null` when there is nothing more to report. - `type: "refusal"` - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null` The policy category that triggered the refusal, or `null` when there is no named category. New values can be added over time. - `"cyber"` - `"bio"` - `"frontier_llm"` - `"reasoning_extraction"` - `"general_harms"` - `explanation: string or null` Human-readable explanation of the refusal, or `null` when none is available. The wording can change, so do not parse it. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted or 2 more` - `BetaManagedAgentsSessionEndTurn object` The agent completed its turn naturally and is ready for the next user message. - `type: "end_turn"` - `BetaManagedAgentsSessionRequiresAction object` 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: "requires_action"` - `event_ids: array of string` The ids of events the agent is blocked on. Resolving fewer than all re-emits `session.status_idle` with the remainder. - `BetaManagedAgentsSessionRetriesExhausted object` The turn ended because repeated errors exhausted the retry budget or an error escalated to `retry_status: 'exhausted'`. - `type: "retries_exhausted"` - `BetaManagedAgentsSessionBudgetReached object` The agent stopped because the session's tracked list cost reached its budget, or because its usage includes a model with no list price (which the budget cannot measure). Raise the budget to continue — or, if raising is rejected because a model has no list price, remove the budget. - `type: "budget_reached"` - `BetaManagedAgentsSessionRefusal object` The turn ended because the model's response was refused, for example by a safety classifier. - `type: "refusal"` - `BetaManagedAgentsSessionStatusTerminatedEvent object` Indicates the session has terminated, either due to an error or completion. - `type: "session.status_terminated"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `BetaManagedAgentsSessionThreadCreatedEvent object` Emitted when a child thread is created. Written to the parent thread's output stream so clients observing the session see child creation. - `type: "session.thread_created"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the callable agent the thread runs. - `processed_at: string` Timestamp when the thread was created. format: date-time - `session_thread_id: string` Public `sthr_` ID of the newly created thread. - `workflow_run_id: string or null` Identifier of the workflow run that created the thread, or `null` for any other thread. - `BetaManagedAgentsSpanOutcomeEvaluationStartEvent object` Emitted when an outcome evaluation cycle begins. - `type: "span.outcome_evaluation_start"` - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc. format: int32 - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` Timestamp when outcome evaluation started. format: date-time - `BetaManagedAgentsSpanOutcomeEvaluationEndEvent object` 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. - `type: "span.outcome_evaluation_end"` - `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: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. format: int32 - `outcome_evaluation_start_id: string` The id of the corresponding `span.outcome_evaluation_start` event. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` Timestamp when outcome evaluation ended. format: date-time - `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. - `usage: BetaManagedAgentsSpanModelUsage` Aggregate token usage for this evaluation cycle. Sums across all grader model requests within the cycle. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. format: int32 - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. format: int32 - `input_tokens: number` Input tokens consumed by this request. format: int32 - `output_tokens: number` Output tokens generated by this request. format: int32 - `speed: optional "standard" or "fast" or null` Inference speed tier this request actually ran at. Mirrors `usage.speed` on /v1/messages. Only present when the fast-mode beta is active. - `"standard"` - `"fast"` - `BetaManagedAgentsSpanModelRequestStartEvent object` Emitted when a model request is initiated by the agent. - `type: "span.model_request_start"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the model request started. format: date-time - `BetaManagedAgentsSpanModelRequestEndEvent object` Emitted when a model request completes. - `type: "span.model_request_end"` - `id: string` Unique identifier for this event. - `is_error: boolean or null` Whether the model request resulted in an error. - `model_request_start_id: string` The id of the corresponding `span.model_request_start` event. - `model_usage: BetaManagedAgentsSpanModelUsage` Token usage for this model request. - `processed_at: string` Timestamp when the model request completed. format: date-time - `BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent object` 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. - `type: "span.outcome_evaluation_ongoing"` - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. format: int32 - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` Timestamp when this heartbeat was emitted. format: date-time - `BetaManagedAgentsUserDefineOutcomeEvent object` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `type: "user.define_outcome"` - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number or null` Evaluate-then-revise cycles before giving up. Default 3, max 20. format: int32 - `outcome_id: string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `processed_at: string` Timestamp when the outcome was accepted. format: date-time - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` How to grade the outcome. File rubrics are currently resolved to their text content; clients should handle both variants. - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `BetaManagedAgentsSessionDeletedEvent object` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `type: "session.deleted"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the session was deleted. format: date-time - `BetaManagedAgentsSessionThreadStatusRunningEvent object` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `type: "session.thread_status_running"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that started running. - `BetaManagedAgentsSessionThreadStatusIdleEvent object` 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. - `type: "session.thread_status_idle"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that went idle. - `stop_details: BetaManagedAgentsSessionRefusalStopDetails or null` Structured information about why the thread stopped. `null` when there is nothing more to report. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted or 2 more` - `BetaManagedAgentsSessionEndTurn object` The agent completed its turn naturally and is ready for the next user message. - `BetaManagedAgentsSessionRequiresAction object` 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. - `BetaManagedAgentsSessionRetriesExhausted object` The turn ended because repeated errors exhausted the retry budget or an error escalated to `retry_status: 'exhausted'`. - `BetaManagedAgentsSessionBudgetReached object` The agent stopped because the session's tracked list cost reached its budget, or because its usage includes a model with no list price (which the budget cannot measure). Raise the budget to continue — or, if raising is rejected because a model has no list price, remove the budget. - `BetaManagedAgentsSessionRefusal object` The turn ended because the model's response was refused, for example by a safety classifier. - `BetaManagedAgentsSessionThreadStatusTerminatedEvent object` 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. - `type: "session.thread_status_terminated"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that terminated. - `BetaManagedAgentsUserToolResultEvent object` 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. - `type: "user.tool_result"` - `id: string` Unique identifier for this event. - `tool_use_id: 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?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `processed_at: optional string or null` Timestamp when this result was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this result was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsSessionThreadStatusRescheduledEvent object` 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. - `type: "session.thread_status_rescheduled"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that is retrying. - `BetaManagedAgentsSessionUpdatedEvent object` 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. - `type: "session.updated"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the update was applied. format: date-time - `agent: optional BetaManagedAgentsSessionAgent or null` The session's effective agent configuration after the update. Present only when the update changed `agent` (tools or mcp_servers); when present it is the full materialised snapshot, not a diff. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsSessionMultiagent or null` Resolved multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsSessionMultiagentCoordinator object` Resolved coordinator topology with full agent definitions for each roster member. - `type: "coordinator"` - `agents: array of BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` Full `agent` definitions the coordinator may spawn as session threads. - `BetaManagedAgentsSessionThreadAgent object` 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`. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsSessionMultiagent20261001 object` Resolved multiagent configuration with three members, as copied to the `session` at creation. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsSessionMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsSessionMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that this agent can spawn as session threads. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsSessionMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsSessionMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that a run's plan can use. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `BetaManagedAgentsMCPToolset object` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `version: number` format: int32 - `budget: optional BetaManagedAgentsBudgetLimit or null` The session's budget after the update: the new budget when set or replaced, or null when the update removed it. Present only when the update changed the budget. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `metadata: optional map[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: optional string or null` The session's new title. Present only when the update changed it. - `BetaManagedAgentsStartEvent object` Opens a preview of a buffered event. Carries the previewed event's type and id only. Followed by zero or more event_delta events with the same event id, normally concluded by the buffered event carrying that id. If the producing model request ends without that event (an error or interrupt mid-stream), its terminal span.model_request_end closes the preview. Only sent on stream connections that opt in via event_deltas; never appears in event history. - `type: "event_start"` - `event: BetaManagedAgentsStartEventPreview` The previewed event's type and id. The event type determines which delta types the preview's event_delta events carry: agent.message events stream content_delta fragments; agent.thinking previews are start-only — no deltas follow, and the buffered agent.thinking with the same id concludes them. - `BetaManagedAgentsAgentMessagePreview object` - `type: "agent.message"` - `id: string` The id the buffered agent.message will carry if it is emitted. Matches the event_id on this preview's event_delta events. - `BetaManagedAgentsAgentThinkingPreview object` - `type: "agent.thinking"` - `id: string` The id the buffered agent.thinking will carry if it is emitted. Start-only — no event_delta events follow. - `BetaManagedAgentsDeltaEvent object` An incremental update to an event that is still being streamed. Deltas are best-effort and may stop early; when the buffered event with id == event_id is produced it carries the complete content. A model request that ends early (an error or interrupt) produces no buffered event — its terminal span.model_request_end closes the preview. Only sent on stream connections that opt in via event_deltas; never appears in event history. - `type: "event_delta"` - `delta: BetaManagedAgentsDeltaContent` One fragment of the previewed event. The delta type is named for the previewed event's field it streams into: agent.message events stream content_delta fragments, each a partial element of the content array. - `type: "content_delta"` - `content: BetaManagedAgentsTextBlock` A partial element of the content array at index, typed like the element itself — the same shape the buffered agent.message carries in content. - `index: optional number` Which entry in the previewed event's content array this fragment lands in. Insert content as that entry when the index is new; append to the existing entry otherwise. - `event_id: string` The id of the event being previewed. Matches event.id on the corresponding event_start and the buffered event that reconciles the preview. - `BetaManagedAgentsSystemMessageEvent object` A mid-conversation system message event. Carries system-role content that is appended to the session as a `role: "system"` turn. - `type: "system.message"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `processed_at: optional string or null` Timestamp when this system message was processed. format: date-time - `BetaManagedAgentsSessionUsageEvent object` Periodic snapshot of the session's cumulative usage and tracked list cost. - `type: "session.usage"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the snapshot was taken. format: date-time - `usage: BetaManagedAgentsSessionUsageSnapshot` The session's cumulative usage at the snapshot time. - `active_seconds: optional number` Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once. This is the duration the session's runtime cost is priced on. format: double - `cache_creation: optional BetaManagedAgentsCacheCreationUsage` Tokens used to create prompt cache entries, broken down by cache TTL. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. format: int32 - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. format: int32 - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. format: int32 - `input_tokens: optional number` Total input tokens consumed across all turns. format: int32 - `list_cost: optional BetaMonetaryAmount` Cumulative list cost of the session across all turns, priced at public list rates. - `output_tokens: optional number` Total output tokens generated across all turns. format: int32 - `server_tool_use: optional BetaManagedAgentsServerToolUsage` Cumulative server-executed tool usage across all turns. - `web_fetch_requests: optional number` Number of server-executed web fetch requests. format: int32 - `web_search_requests: optional number` Number of server-executed web search requests. format: int32 - `budget: optional BetaManagedAgentsBudgetLimit or null` The session's configured budget at the snapshot time, or null when the session has no budget. - `BetaManagedAgentsWorkflowRunCreatedEvent object` A workflow run was created. A workflow run is background work that the session's agent starts. Emitted once per run, before the run's other `workflow_run.*` events. - `type: "workflow_run.created"` - `id: string` Unique identifier for this event. - `description: string or null` Description that the agent gave the run, passed on as written, or `null` if it gave none. - `name: string` Name that the agent gave the run, passed on as written, or a name that the server assigned. - `phases: array of BetaManagedAgentsWorkflowRunPhase` The phases that the run's plan declares, in the plan's order. Can be empty. - `id: string` Unique identifier for the phase. - `description: string or null` Description that the agent gave the phase, passed on as written, or `null` if it gave none. - `name: string` Name that the agent gave the phase, passed on as written. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunStatusEndedEvent object` A workflow run ended. Emitted once per run, as the last of the run's `workflow_run.*` events. - `type: "workflow_run.status_ended"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `result: BetaManagedAgentsWorkflowRunResult` How the run ended. - `BetaManagedAgentsWorkflowRunResultCompleted object` The run's plan, a program that the agent wrote, finished. This does not say whether the work succeeded. - `type: "completed"` - `BetaManagedAgentsWorkflowRunResultError object` The run failed or reached its time limit. - `type: "error"` - `error: BetaManagedAgentsWorkflowRunError` Why the run did not finish. - `BetaManagedAgentsTimeoutWorkflowRunError object` The run reached its time limit. - `type: "timeout_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsProgramWorkflowRunError object` The plan, a program that the agent wrote, failed, or the server refused it. - `type: "program_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsUnknownWorkflowRunError object` A failure that has no type of its own. - `type: "unknown_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsThreadLimitWorkflowRunError object` The run exceeded the limit on the number of threads that a run can create. - `type: "thread_limit_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsMaxWorkflowRunsWorkflowRunError object` No run was created, because the session was at its limit of open workflow runs, which are runs that have not ended. Only `workflow_run.error` carries this type. - `type: "max_workflow_runs_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsWorkflowRunResultStopped object` The agent stopped the run. - `type: "stopped"` - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunPhaseStartedEvent object` A workflow run's plan entered a phase. - `type: "workflow_run.phase_started"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `workflow_run_phase_id: string` Identifier of the phase, as in `phases` on the run's `workflow_run.created` event. - `BetaManagedAgentsWorkflowRunPhaseEndedEvent object` A workflow run's plan left a phase, or the run's end closed it. Emitted once for every `workflow_run.phase_started` event, before the run's `workflow_run.status_ended` event. The event does not say whether the plan finished the phase's work, or why it left. - `type: "workflow_run.phase_ended"` - `id: string` Unique identifier for this event. - `phase_started_id: string` Identifier of the `workflow_run.phase_started` event that opened the phase. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `workflow_run_phase_id: string` Identifier of the phase, as in `phases` on the run's `workflow_run.created` event. - `BetaManagedAgentsWorkflowRunStatusRunningEvent object` A workflow run is running. Emitted when the run starts to execute, and each time it resumes after being idle. A run that starts idle emits `workflow_run.status_idle` first. - `type: "workflow_run.status_running"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunStatusIdleEvent object` A workflow run is idle. Emitted each time the run goes idle, whatever the cause. If the run ends while idle, no `workflow_run.status_running` comes between this event and its `workflow_run.status_ended`. - `type: "workflow_run.status_idle"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunErrorEvent object` A workflow run met an error, or an error kept a run from being created. A run that ends with a `result.type` of `error` emits this event before its `workflow_run.status_ended`, with the same `error`. - `type: "workflow_run.error"` - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsWorkflowRunError` Why the run did not finish, or was not created. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string or null` Identifier of the run that met the error, or `null` when the error kept a run from being created. #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID/events/stream \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "sevt_011CZkZGPp1iBcp4kaQSihUm", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } ``` ## Beta › Sessions › Resources ### Add Session Resource **POST** `/v1/sessions/{session_id}/resources` Add Session Resource #### Path parameters - `session_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `file_id: string` ID of a previously uploaded file. minLength: 1, maxLength: 128 - `type: "file"` - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/`. minLength: 1, maxLength: 4096 #### Returns - `BetaManagedAgentsFileResource object` - `type: "file"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `file_id: string` - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID/resources \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "type": "file", "mount_path": "/uploads/receipt.pdf" }' ``` ##### Response (200) ```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 **GET** `/v1/sessions/{session_id}/resources` List Session Resources #### Path parameters - `session_id: string` #### Query parameters - `limit: optional number` Maximum number of resources to return per page (max 1000). If omitted, returns all resources. format: int32 - `page: optional string` Opaque cursor from a previous response's `next_page` field. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaManagedAgentsSessionResource` Resources for the session, ordered by `created_at`. - `BetaManagedAgentsGitHubRepositoryResource object` - `type: "github_repository"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `BetaManagedAgentsFileResource object` - `type: "file"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `file_id: string` - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `BetaManagedAgentsMemoryStoreResource object` A memory store attached to an agent session. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `description: optional 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: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. maxLength: 4096 - `mount_path: optional string or null` 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: optional string or null` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - `next_page: optional string or null` Opaque cursor for the next page. Null when no more results. #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID/resources \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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_011CZkZCKr6eXym1gWMPdQiu", "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 **GET** `/v1/sessions/{session_id}/resources/{resource_id}` Get Session Resource #### Path parameters - `session_id: string` - `resource_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsGitHubRepositoryResource object` - `type: "github_repository"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `BetaManagedAgentsFileResource object` - `type: "file"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `file_id: string` - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `BetaManagedAgentsMemoryStoreResource object` A memory store attached to an agent session. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `description: optional 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: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. maxLength: 4096 - `mount_path: optional string or null` 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: optional string or null` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID/resources/$RESOURCE_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "sesrsc_011CZkZCKr6eXym1gWMPdQiu", "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 **POST** `/v1/sessions/{session_id}/resources/{resource_id}` Update Session Resource #### Path parameters - `session_id: string` - `resource_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `authorization_token: string` New authorization token for the resource. Currently only `github_repository` resources support token rotation. minLength: 1, maxLength: 4096 #### Returns - `BetaManagedAgentsGitHubRepositoryResource object` - `type: "github_repository"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `BetaManagedAgentsFileResource object` - `type: "file"` - `id: string` - `created_at: string` A timestamp in RFC 3339 format format: date-time - `file_id: string` - `mount_path: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `BetaManagedAgentsMemoryStoreResource object` A memory store attached to an agent session. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `description: optional 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: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. maxLength: 4096 - `mount_path: optional string or null` 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: optional string or null` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID/resources/$RESOURCE_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "authorization_token": "ghp_exampletoken" }' ``` ##### Response (200) ```json { "id": "sesrsc_011CZkZCKr6eXym1gWMPdQiu", "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 **DELETE** `/v1/sessions/{session_id}/resources/{resource_id}` Delete Session Resource #### Path parameters - `session_id: string` - `resource_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsDeleteSessionResource object` Confirmation of resource deletion. - `type: "session_resource_deleted"` - `id: string` #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID/resources/$RESOURCE_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "type": "session_resource_deleted" } ``` ## Beta › Sessions › Threads ### List Session Threads **GET** `/v1/sessions/{session_id}/threads` List Session Threads #### Path parameters - `session_id: string` #### Query parameters - `limit: optional number` Maximum results per page. Defaults to 1000. format: int32 - `page: optional string` Opaque pagination cursor from a previous response's `next_page`. Forward-only. - `statuses: optional array of BetaManagedAgentsSessionThreadStatus` Return only threads that have one of these statuses. Repeat the parameter to give more than one status. Leave it out to return threads of every status. - `"running"` - `"idle"` - `"rescheduling"` - `"terminated"` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: optional array of BetaManagedAgentsSessionThread` Threads in the session, primary first then children in spawn order. - `type: "session_thread"` - `id: string` Unique identifier for this thread. - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor or BetaManagedAgentsInlineAgent` Resolved agent definition for this thread. Snapshot of the agent at thread creation time. - `BetaManagedAgentsSessionThreadAgent object` 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`. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsInlineAgent object` An agent that has no Agent resource, and so no `id` or `version`. It is defined inline, in a workflow run's plan or when a session thread is spawned, and is not saved. - `type: "inline"` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` The session's execution principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` The name that the agent's definition gave, or one that the server assigned. - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `BetaManagedAgentsMCPToolset object` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `archived_at: string or null` When the thread was archived. Null if not archived. format: date-time - `created_at: string` When the thread was created. format: date-time - `parent_thread_id: string or null` Parent thread that spawned this thread. Null for the primary thread. - `session_id: string` The session this thread belongs to. - `stats: BetaManagedAgentsSessionThreadStats or null` Timing statistics for this thread. Null until the thread's first status transition. - `active_seconds: optional number` Cumulative time in seconds the thread spent actively running. Excludes idle time. format: double - `duration_seconds: optional number` Elapsed time since thread creation in seconds. For archived threads, frozen at the final update. format: double - `startup_seconds: optional number` Time in seconds for the thread to begin running. Zero for child threads, which start immediately. format: double - `status: BetaManagedAgentsSessionThreadStatus` Current execution status of the thread. - `"running"` - `"idle"` - `"rescheduling"` - `"terminated"` - `updated_at: string` When the thread was last updated. format: date-time - `usage: BetaManagedAgentsSessionThreadUsage or null` Cumulative token usage for this thread. Null until the thread's first idle transition. - `active_seconds: optional number` Cumulative time in seconds this thread spent in running status. Equal to `stats.active_seconds`; surfaced here so a thread's usage carries every quantity its cost is priced on. format: double - `cache_creation: optional BetaManagedAgentsCacheCreationUsage` Tokens used to create prompt cache entries, broken down by cache TTL. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. format: int32 - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. format: int32 - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. format: int32 - `input_tokens: optional number` Total input tokens consumed across all turns. format: int32 - `list_cost: optional BetaMonetaryAmount or null` Cumulative list cost of this thread across all turns, priced at public list rates. Absent until cost tracking is available for the thread. Each figure is rounded to the nearest cent independently and the session's aggregate `usage.list_cost` additionally includes session runtime, so per-thread costs do not sum exactly to the session figure; the session figure is authoritative and is what a budget is enforced against. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `output_tokens: optional number` Total output tokens generated across all turns. format: int32 - `server_tool_use: optional BetaManagedAgentsServerToolUsage or null` Cumulative server-executed tool usage across all turns of this thread. Absent until server-tool tracking is available for the thread. - `web_fetch_requests: optional number` Number of server-executed web fetch requests. format: int32 - `web_search_requests: optional number` Number of server-executed web search requests. format: int32 - `workflow_run_id: string or null` Identifier of the workflow run that created the thread, or `null` for any other thread. - `next_page: optional string or null` Opaque cursor for the next page. Null when no more results. #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID/threads \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "sthr_011CZkZVWa6oJjw1rgXZpnBt", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "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" }, "type": "bash" } ], "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": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } }, "workflow_run_id": null } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ### Get Session Thread **GET** `/v1/sessions/{session_id}/threads/{thread_id}` Get Session Thread #### Path parameters - `session_id: string` - `thread_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsSessionThread object` An execution thread within a `session`. Each session has one primary thread plus zero or more child threads. - `type: "session_thread"` - `id: string` Unique identifier for this thread. - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor or BetaManagedAgentsInlineAgent` Resolved agent definition for this thread. Snapshot of the agent at thread creation time. - `BetaManagedAgentsSessionThreadAgent object` 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`. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsInlineAgent object` An agent that has no Agent resource, and so no `id` or `version`. It is defined inline, in a workflow run's plan or when a session thread is spawned, and is not saved. - `type: "inline"` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` The session's execution principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` The name that the agent's definition gave, or one that the server assigned. - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `BetaManagedAgentsMCPToolset object` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `archived_at: string or null` When the thread was archived. Null if not archived. format: date-time - `created_at: string` When the thread was created. format: date-time - `parent_thread_id: string or null` Parent thread that spawned this thread. Null for the primary thread. - `session_id: string` The session this thread belongs to. - `stats: BetaManagedAgentsSessionThreadStats or null` Timing statistics for this thread. Null until the thread's first status transition. - `active_seconds: optional number` Cumulative time in seconds the thread spent actively running. Excludes idle time. format: double - `duration_seconds: optional number` Elapsed time since thread creation in seconds. For archived threads, frozen at the final update. format: double - `startup_seconds: optional number` Time in seconds for the thread to begin running. Zero for child threads, which start immediately. format: double - `status: BetaManagedAgentsSessionThreadStatus` Current execution status of the thread. - `"running"` - `"idle"` - `"rescheduling"` - `"terminated"` - `updated_at: string` When the thread was last updated. format: date-time - `usage: BetaManagedAgentsSessionThreadUsage or null` Cumulative token usage for this thread. Null until the thread's first idle transition. - `active_seconds: optional number` Cumulative time in seconds this thread spent in running status. Equal to `stats.active_seconds`; surfaced here so a thread's usage carries every quantity its cost is priced on. format: double - `cache_creation: optional BetaManagedAgentsCacheCreationUsage` Tokens used to create prompt cache entries, broken down by cache TTL. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. format: int32 - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. format: int32 - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. format: int32 - `input_tokens: optional number` Total input tokens consumed across all turns. format: int32 - `list_cost: optional BetaMonetaryAmount or null` Cumulative list cost of this thread across all turns, priced at public list rates. Absent until cost tracking is available for the thread. Each figure is rounded to the nearest cent independently and the session's aggregate `usage.list_cost` additionally includes session runtime, so per-thread costs do not sum exactly to the session figure; the session figure is authoritative and is what a budget is enforced against. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `output_tokens: optional number` Total output tokens generated across all turns. format: int32 - `server_tool_use: optional BetaManagedAgentsServerToolUsage or null` Cumulative server-executed tool usage across all turns of this thread. Absent until server-tool tracking is available for the thread. - `web_fetch_requests: optional number` Number of server-executed web fetch requests. format: int32 - `web_search_requests: optional number` Number of server-executed web search requests. format: int32 - `workflow_run_id: string or null` Identifier of the workflow run that created the thread, or `null` for any other thread. #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID/threads/$THREAD_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "sthr_011CZkZVWa6oJjw1rgXZpnBt", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "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" }, "type": "bash" } ], "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": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } }, "workflow_run_id": null } ``` ### Archive Session Thread **POST** `/v1/sessions/{session_id}/threads/{thread_id}/archive` Archive Session Thread #### Path parameters - `session_id: string` - `thread_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsSessionThread object` An execution thread within a `session`. Each session has one primary thread plus zero or more child threads. - `type: "session_thread"` - `id: string` Unique identifier for this thread. - `agent: BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor or BetaManagedAgentsInlineAgent` Resolved agent definition for this thread. Snapshot of the agent at thread creation time. - `BetaManagedAgentsSessionThreadAgent object` 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`. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsInlineAgent object` An agent that has no Agent resource, and so no `id` or `version`. It is defined inline, in a workflow run's plan or when a session thread is spawned, and is not saved. - `type: "inline"` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` The session's execution principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` The name that the agent's definition gave, or one that the server assigned. - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `BetaManagedAgentsMCPToolset object` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `archived_at: string or null` When the thread was archived. Null if not archived. format: date-time - `created_at: string` When the thread was created. format: date-time - `parent_thread_id: string or null` Parent thread that spawned this thread. Null for the primary thread. - `session_id: string` The session this thread belongs to. - `stats: BetaManagedAgentsSessionThreadStats or null` Timing statistics for this thread. Null until the thread's first status transition. - `active_seconds: optional number` Cumulative time in seconds the thread spent actively running. Excludes idle time. format: double - `duration_seconds: optional number` Elapsed time since thread creation in seconds. For archived threads, frozen at the final update. format: double - `startup_seconds: optional number` Time in seconds for the thread to begin running. Zero for child threads, which start immediately. format: double - `status: BetaManagedAgentsSessionThreadStatus` Current execution status of the thread. - `"running"` - `"idle"` - `"rescheduling"` - `"terminated"` - `updated_at: string` When the thread was last updated. format: date-time - `usage: BetaManagedAgentsSessionThreadUsage or null` Cumulative token usage for this thread. Null until the thread's first idle transition. - `active_seconds: optional number` Cumulative time in seconds this thread spent in running status. Equal to `stats.active_seconds`; surfaced here so a thread's usage carries every quantity its cost is priced on. format: double - `cache_creation: optional BetaManagedAgentsCacheCreationUsage` Tokens used to create prompt cache entries, broken down by cache TTL. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. format: int32 - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. format: int32 - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. format: int32 - `input_tokens: optional number` Total input tokens consumed across all turns. format: int32 - `list_cost: optional BetaMonetaryAmount or null` Cumulative list cost of this thread across all turns, priced at public list rates. Absent until cost tracking is available for the thread. Each figure is rounded to the nearest cent independently and the session's aggregate `usage.list_cost` additionally includes session runtime, so per-thread costs do not sum exactly to the session figure; the session figure is authoritative and is what a budget is enforced against. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `output_tokens: optional number` Total output tokens generated across all turns. format: int32 - `server_tool_use: optional BetaManagedAgentsServerToolUsage or null` Cumulative server-executed tool usage across all turns of this thread. Absent until server-tool tracking is available for the thread. - `web_fetch_requests: optional number` Number of server-executed web fetch requests. format: int32 - `web_search_requests: optional number` Number of server-executed web search requests. format: int32 - `workflow_run_id: string or null` Identifier of the workflow run that created the thread, or `null` for any other thread. #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID/threads/$THREAD_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "sthr_011CZkZVWa6oJjw1rgXZpnBt", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "execution_identity": { "type": "service_account" }, "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-opus-5-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "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" }, "type": "bash" } ], "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": { "active_seconds": 0, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "list_cost": { "amount": "2500", "currency": "USD" }, "output_tokens": 0, "server_tool_use": { "web_fetch_requests": 0, "web_search_requests": 3 } }, "workflow_run_id": null } ``` ## Beta › Sessions › Threads › Events ### List Session Thread Events **GET** `/v1/sessions/{session_id}/threads/{thread_id}/events` List Session Thread Events #### Path parameters - `session_id: string` - `thread_id: string` #### Query parameters - `limit: optional number` format: int32 - `page: optional string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: optional array of BetaManagedAgentsSessionEvent` Events for the thread, ordered by `processed_at`. - `BetaManagedAgentsUserMessageEvent object` A user message event in the session conversation. - `type: "user.message"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks comprising the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `processed_at: optional string or null` Timestamp when the agent finished processing this message. format: date-time - `BetaManagedAgentsUserInterruptEvent object` An interrupt event that pauses agent execution and returns control to the user. - `type: "user.interrupt"` - `id: string` Unique identifier for this event. - `processed_at: optional string or null` Timestamp when the interrupt was processed. format: date-time - `session_thread_id: optional string or null` 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. - `BetaManagedAgentsUserToolConfirmationEvent object` A tool confirmation event that approves or denies a pending tool execution. - `type: "user.tool_confirmation"` - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` The confirmation result: 'allow' or 'deny'. - `"allow"` - `"deny"` - `tool_use_id: 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?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `deny_message: optional string or null` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. maxLength: 10000 - `processed_at: optional string or null` Timestamp when the confirmation was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this confirmation was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsUserCustomToolResultEvent object` Event sent by the client providing the result of a custom tool execution. - `type: "user.custom_tool_result"` - `id: string` Unique identifier for this event. - `custom_tool_use_id: string` The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `type: "search_result"` - `citations: BetaManagedAgentsSearchResultCitations` Citation settings for this search result. - `enabled: boolean` Whether citations are enabled for this search result. - `content: array of BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `type: "text"` - `text: string` The text content. minLength: 1 - `source: string` The URL source of the search result. minLength: 1 - `title: string` The title of the search result. minLength: 1 - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `processed_at: optional string or null` Timestamp when this result was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this result was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsAgentCustomToolUseEvent object` 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. The client can send it as soon as this event arrives, without waiting for `session.status_idle`. - `type: "agent.custom_tool_use"` - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the custom tool being called. - `processed_at: string` Timestamp when this tool use was processed. format: date-time - `session_thread_id: optional string or null` 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. Informational only: the server routes the matching `user.custom_tool_result` by `custom_tool_use_id`, so clients do not send it back. - `BetaManagedAgentsAgentMessageEvent object` An agent response event in the session conversation. - `type: "agent.message"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsRedactedBlock` Array of text blocks comprising the agent response. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `processed_at: string` Timestamp when this response was generated. format: date-time - `BetaManagedAgentsAgentThinkingEvent object` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `type: "agent.thinking"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this thinking was produced. format: date-time - `BetaManagedAgentsAgentMCPToolUseEvent object` Event emitted when the agent invokes a tool provided by an MCP server. - `type: "agent.mcp_tool_use"` - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `mcp_server_name: string` Name of the MCP server providing the tool. - `name: string` Name of the MCP tool being used. - `processed_at: string` Timestamp when this event was processed. format: date-time - `evaluated_permission: optional BetaManagedAgentsAgentEvaluatedPermission` The evaluated permission policy for this tool invocation. - `"allow"` - `"ask"` - `"deny"` - `evaluation: optional BetaManagedAgentsAgentToolEvaluation` Which resolved permission_policy produced evaluated_permission: always_allow, always_ask, or auto (with the server's per-invocation judgement). Absent only when the server refused the call before any policy applied (for example, the named tool is not enabled in the session); such a refusal has evaluated_permission deny. An event recorded before this field existed reads as the arm its evaluated_permission implies (always_allow for allow, always_ask for ask). - `BetaManagedAgentsAgentToolEvaluationAlwaysAllow object` The resolved permission_policy was always_allow; accompanies evaluated_permission "allow". - `type: "always_allow"` - `BetaManagedAgentsAgentToolEvaluationAlwaysAsk object` The resolved permission_policy was always_ask; accompanies evaluated_permission "ask". - `type: "always_ask"` - `BetaManagedAgentsAgentToolEvaluationAuto object` The resolved permission_policy was auto: the server judged this invocation individually. - `type: "auto"` - `evaluated_permission: BetaManagedAgentsAgentAutoEvaluatedPermission` The server's judgement for this invocation. - `BetaManagedAgentsAgentAutoEvaluatedPermissionAllow object` The server judged the invocation safe to execute without client approval. - `type: "allow"` - `BetaManagedAgentsAgentAutoEvaluatedPermissionAsk object` The server reached no judgement; the invocation is held for client approval. - `type: "ask"` - `reason_code: string` The judgement's grounds in registry-bound terms, for client branching and audit rather than end-user display. Open registry; currently "indeterminate" (no judgement was reached). Clients must tolerate values outside this set. maxLength: 64 - `BetaManagedAgentsAgentAutoEvaluatedPermissionDeny object` The server judged the invocation high-risk; it does not execute and a synthetic error tool result is appended. - `type: "deny"` - `reason_code: string` The judgement's grounds in registry-bound terms. Open registry; currently "high_risk" (judged high-risk; the call does not run). Clients must tolerate values outside this set. maxLength: 64 - `session_thread_id: optional string or null` 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. Informational only: the server routes the matching `user.tool_confirmation` by `tool_use_id`, so clients do not send it back. - `BetaManagedAgentsAgentMCPToolResultEvent object` Event representing the result of an MCP tool execution. - `type: "agent.mcp_tool_result"` - `id: string` Unique identifier for this event. - `mcp_tool_use_id: string` The id of the `agent.mcp_tool_use` event this result corresponds to. - `processed_at: string` Timestamp when this event was processed. format: date-time - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `BetaManagedAgentsAgentToolUseEvent object` Event emitted when the agent invokes a built-in agent tool. - `type: "agent.tool_use"` - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the agent tool being used. - `processed_at: string` Timestamp when this event was processed. format: date-time - `evaluated_permission: optional BetaManagedAgentsAgentEvaluatedPermission` The evaluated permission policy for this tool invocation. - `evaluation: optional BetaManagedAgentsAgentToolEvaluation` Which resolved permission_policy produced evaluated_permission: always_allow, always_ask, or auto (with the server's per-invocation judgement). Absent only when the server refused the call before any policy applied (for example, the named tool is not enabled in the session); such a refusal has evaluated_permission deny. An event recorded before this field existed reads as the arm its evaluated_permission implies (always_allow for allow, always_ask for ask). - `session_thread_id: optional string or null` 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. Informational only: the server routes the matching `user.tool_confirmation` or `user.tool_result` by `tool_use_id`, so clients do not send it back. - `BetaManagedAgentsAgentToolResultEvent object` Event representing the result of an agent tool execution. - `type: "agent.tool_result"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `tool_use_id: string` The id of the `agent.tool_use` event this result corresponds to. - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `BetaManagedAgentsAgentThreadMessageReceivedEvent object` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `type: "agent.thread_message_received"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Message content blocks. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `from_session_thread_id: string` Public `sthr_` ID of the thread that sent the message. - `processed_at: string` Timestamp when the message was received. format: date-time - `from_agent_name: optional string or null` Name of the callable agent this message came from. Absent when received from the primary agent. - `BetaManagedAgentsAgentThreadMessageSentEvent object` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `type: "agent.thread_message_sent"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Message content blocks. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `processed_at: string` Timestamp when the message was sent. format: date-time - `to_session_thread_id: string` Public `sthr_` ID of the thread the message was sent to. - `to_agent_name: optional string or null` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `BetaManagedAgentsAgentThreadContextCompactedEvent object` Indicates that context compaction (summarization) occurred during the session. - `type: "agent.thread_context_compacted"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when compaction was processed. format: date-time - `BetaManagedAgentsSessionErrorEvent object` An error event indicating a problem occurred during session execution. - `type: "session.error"` - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 10 more` - `BetaManagedAgentsUnknownError object` 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: "unknown_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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: "retrying"` - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `BetaManagedAgentsModelOverloadedError object` The model is currently overloaded. Emitted after automatic retries are exhausted. - `type: "model_overloaded_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsModelRateLimitedError object` The model request was rate-limited. - `type: "model_rate_limited_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsModelRequestFailedError object` A model request failed for a reason other than overload or rate-limiting. - `type: "model_request_failed_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsMCPConnectionFailedError object` Failed to connect to an MCP server. - `type: "mcp_connection_failed_error"` - `mcp_server_name: string` Name of the MCP server that failed to connect. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsMCPAuthenticationFailedError object` Authentication to an MCP server failed. - `type: "mcp_authentication_failed_error"` - `mcp_server_name: string` Name of the MCP server that failed authentication. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsBillingError object` 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. - `type: "billing_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsCredentialHostUnreachableError object` An `environment_variable` credential's `auth.networking.allowed_hosts` includes a host the environment's network policy does not permit. - `type: "credential_host_unreachable_error"` - `credential_id: string` ID of the affected credential. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `vault_id: string` ID of the vault containing the affected credential. - `BetaManagedAgentsRepositoryAuthenticationError object` The repository host rejected the credentials, or required credentials and received none. - `type: "repository_authentication_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryForbiddenError object` The repository host refused access to the repository. - `type: "repository_forbidden_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryNotFoundError object` The repository host reported the repository as not found. - `type: "repository_not_found_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryCheckoutError object` The requested branch or commit does not exist in the repository. - `type: "repository_checkout_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryCloneError object` The repository could not be cloned. - `type: "repository_clone_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `processed_at: string` Timestamp when the error occurred. format: date-time - `BetaManagedAgentsSessionStatusRescheduledEvent object` Indicates the session is recovering from an error state and is rescheduled for execution. - `type: "session.status_rescheduled"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `BetaManagedAgentsSessionStatusRunningEvent object` Indicates the session is actively running and the agent is working. - `type: "session.status_running"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `BetaManagedAgentsSessionStatusIdleEvent object` Indicates the agent has paused and is awaiting user input. - `type: "session.status_idle"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `stop_details: BetaManagedAgentsSessionRefusalStopDetails or null` Structured information about why the session stopped. `null` when there is nothing more to report. - `type: "refusal"` - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null` The policy category that triggered the refusal, or `null` when there is no named category. New values can be added over time. - `"cyber"` - `"bio"` - `"frontier_llm"` - `"reasoning_extraction"` - `"general_harms"` - `explanation: string or null` Human-readable explanation of the refusal, or `null` when none is available. The wording can change, so do not parse it. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted or 2 more` - `BetaManagedAgentsSessionEndTurn object` The agent completed its turn naturally and is ready for the next user message. - `type: "end_turn"` - `BetaManagedAgentsSessionRequiresAction object` 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: "requires_action"` - `event_ids: array of string` The ids of events the agent is blocked on. Resolving fewer than all re-emits `session.status_idle` with the remainder. - `BetaManagedAgentsSessionRetriesExhausted object` The turn ended because repeated errors exhausted the retry budget or an error escalated to `retry_status: 'exhausted'`. - `type: "retries_exhausted"` - `BetaManagedAgentsSessionBudgetReached object` The agent stopped because the session's tracked list cost reached its budget, or because its usage includes a model with no list price (which the budget cannot measure). Raise the budget to continue — or, if raising is rejected because a model has no list price, remove the budget. - `type: "budget_reached"` - `BetaManagedAgentsSessionRefusal object` The turn ended because the model's response was refused, for example by a safety classifier. - `type: "refusal"` - `BetaManagedAgentsSessionStatusTerminatedEvent object` Indicates the session has terminated, either due to an error or completion. - `type: "session.status_terminated"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `BetaManagedAgentsSessionThreadCreatedEvent object` Emitted when a child thread is created. Written to the parent thread's output stream so clients observing the session see child creation. - `type: "session.thread_created"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the callable agent the thread runs. - `processed_at: string` Timestamp when the thread was created. format: date-time - `session_thread_id: string` Public `sthr_` ID of the newly created thread. - `workflow_run_id: string or null` Identifier of the workflow run that created the thread, or `null` for any other thread. - `BetaManagedAgentsSpanOutcomeEvaluationStartEvent object` Emitted when an outcome evaluation cycle begins. - `type: "span.outcome_evaluation_start"` - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc. format: int32 - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` Timestamp when outcome evaluation started. format: date-time - `BetaManagedAgentsSpanOutcomeEvaluationEndEvent object` 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. - `type: "span.outcome_evaluation_end"` - `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: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. format: int32 - `outcome_evaluation_start_id: string` The id of the corresponding `span.outcome_evaluation_start` event. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` Timestamp when outcome evaluation ended. format: date-time - `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. - `usage: BetaManagedAgentsSpanModelUsage` Aggregate token usage for this evaluation cycle. Sums across all grader model requests within the cycle. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. format: int32 - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. format: int32 - `input_tokens: number` Input tokens consumed by this request. format: int32 - `output_tokens: number` Output tokens generated by this request. format: int32 - `speed: optional "standard" or "fast" or null` Inference speed tier this request actually ran at. Mirrors `usage.speed` on /v1/messages. Only present when the fast-mode beta is active. - `"standard"` - `"fast"` - `BetaManagedAgentsSpanModelRequestStartEvent object` Emitted when a model request is initiated by the agent. - `type: "span.model_request_start"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the model request started. format: date-time - `BetaManagedAgentsSpanModelRequestEndEvent object` Emitted when a model request completes. - `type: "span.model_request_end"` - `id: string` Unique identifier for this event. - `is_error: boolean or null` Whether the model request resulted in an error. - `model_request_start_id: string` The id of the corresponding `span.model_request_start` event. - `model_usage: BetaManagedAgentsSpanModelUsage` Token usage for this model request. - `processed_at: string` Timestamp when the model request completed. format: date-time - `BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent object` 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. - `type: "span.outcome_evaluation_ongoing"` - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. format: int32 - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` Timestamp when this heartbeat was emitted. format: date-time - `BetaManagedAgentsUserDefineOutcomeEvent object` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `type: "user.define_outcome"` - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number or null` Evaluate-then-revise cycles before giving up. Default 3, max 20. format: int32 - `outcome_id: string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `processed_at: string` Timestamp when the outcome was accepted. format: date-time - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` How to grade the outcome. File rubrics are currently resolved to their text content; clients should handle both variants. - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `BetaManagedAgentsSessionDeletedEvent object` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `type: "session.deleted"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the session was deleted. format: date-time - `BetaManagedAgentsSessionThreadStatusRunningEvent object` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `type: "session.thread_status_running"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that started running. - `BetaManagedAgentsSessionThreadStatusIdleEvent object` 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. - `type: "session.thread_status_idle"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that went idle. - `stop_details: BetaManagedAgentsSessionRefusalStopDetails or null` Structured information about why the thread stopped. `null` when there is nothing more to report. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted or 2 more` - `BetaManagedAgentsSessionEndTurn object` The agent completed its turn naturally and is ready for the next user message. - `BetaManagedAgentsSessionRequiresAction object` 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. - `BetaManagedAgentsSessionRetriesExhausted object` The turn ended because repeated errors exhausted the retry budget or an error escalated to `retry_status: 'exhausted'`. - `BetaManagedAgentsSessionBudgetReached object` The agent stopped because the session's tracked list cost reached its budget, or because its usage includes a model with no list price (which the budget cannot measure). Raise the budget to continue — or, if raising is rejected because a model has no list price, remove the budget. - `BetaManagedAgentsSessionRefusal object` The turn ended because the model's response was refused, for example by a safety classifier. - `BetaManagedAgentsSessionThreadStatusTerminatedEvent object` 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. - `type: "session.thread_status_terminated"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that terminated. - `BetaManagedAgentsUserToolResultEvent object` 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. - `type: "user.tool_result"` - `id: string` Unique identifier for this event. - `tool_use_id: 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?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `processed_at: optional string or null` Timestamp when this result was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this result was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsSessionThreadStatusRescheduledEvent object` 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. - `type: "session.thread_status_rescheduled"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that is retrying. - `BetaManagedAgentsSessionUpdatedEvent object` 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. - `type: "session.updated"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the update was applied. format: date-time - `agent: optional BetaManagedAgentsSessionAgent or null` The session's effective agent configuration after the update. Present only when the update changed `agent` (tools or mcp_servers); when present it is the full materialised snapshot, not a diff. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsSessionMultiagent or null` Resolved multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsSessionMultiagentCoordinator object` Resolved coordinator topology with full agent definitions for each roster member. - `type: "coordinator"` - `agents: array of BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` Full `agent` definitions the coordinator may spawn as session threads. - `BetaManagedAgentsSessionThreadAgent object` 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`. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsSessionMultiagent20261001 object` Resolved multiagent configuration with three members, as copied to the `session` at creation. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsSessionMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsSessionMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that this agent can spawn as session threads. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsSessionMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsSessionMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that a run's plan can use. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `BetaManagedAgentsMCPToolset object` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `version: number` format: int32 - `budget: optional BetaManagedAgentsBudgetLimit or null` The session's budget after the update: the new budget when set or replaced, or null when the update removed it. Present only when the update changed the budget. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `metadata: optional map[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: optional string or null` The session's new title. Present only when the update changed it. - `BetaManagedAgentsSystemMessageEvent object` A mid-conversation system message event. Carries system-role content that is appended to the session as a `role: "system"` turn. - `type: "system.message"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `processed_at: optional string or null` Timestamp when this system message was processed. format: date-time - `BetaManagedAgentsSessionUsageEvent object` Periodic snapshot of the session's cumulative usage and tracked list cost. - `type: "session.usage"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the snapshot was taken. format: date-time - `usage: BetaManagedAgentsSessionUsageSnapshot` The session's cumulative usage at the snapshot time. - `active_seconds: optional number` Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once. This is the duration the session's runtime cost is priced on. format: double - `cache_creation: optional BetaManagedAgentsCacheCreationUsage` Tokens used to create prompt cache entries, broken down by cache TTL. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. format: int32 - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. format: int32 - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. format: int32 - `input_tokens: optional number` Total input tokens consumed across all turns. format: int32 - `list_cost: optional BetaMonetaryAmount` Cumulative list cost of the session across all turns, priced at public list rates. - `output_tokens: optional number` Total output tokens generated across all turns. format: int32 - `server_tool_use: optional BetaManagedAgentsServerToolUsage` Cumulative server-executed tool usage across all turns. - `web_fetch_requests: optional number` Number of server-executed web fetch requests. format: int32 - `web_search_requests: optional number` Number of server-executed web search requests. format: int32 - `budget: optional BetaManagedAgentsBudgetLimit or null` The session's configured budget at the snapshot time, or null when the session has no budget. - `BetaManagedAgentsWorkflowRunCreatedEvent object` A workflow run was created. A workflow run is background work that the session's agent starts. Emitted once per run, before the run's other `workflow_run.*` events. - `type: "workflow_run.created"` - `id: string` Unique identifier for this event. - `description: string or null` Description that the agent gave the run, passed on as written, or `null` if it gave none. - `name: string` Name that the agent gave the run, passed on as written, or a name that the server assigned. - `phases: array of BetaManagedAgentsWorkflowRunPhase` The phases that the run's plan declares, in the plan's order. Can be empty. - `id: string` Unique identifier for the phase. - `description: string or null` Description that the agent gave the phase, passed on as written, or `null` if it gave none. - `name: string` Name that the agent gave the phase, passed on as written. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunStatusEndedEvent object` A workflow run ended. Emitted once per run, as the last of the run's `workflow_run.*` events. - `type: "workflow_run.status_ended"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `result: BetaManagedAgentsWorkflowRunResult` How the run ended. - `BetaManagedAgentsWorkflowRunResultCompleted object` The run's plan, a program that the agent wrote, finished. This does not say whether the work succeeded. - `type: "completed"` - `BetaManagedAgentsWorkflowRunResultError object` The run failed or reached its time limit. - `type: "error"` - `error: BetaManagedAgentsWorkflowRunError` Why the run did not finish. - `BetaManagedAgentsTimeoutWorkflowRunError object` The run reached its time limit. - `type: "timeout_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsProgramWorkflowRunError object` The plan, a program that the agent wrote, failed, or the server refused it. - `type: "program_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsUnknownWorkflowRunError object` A failure that has no type of its own. - `type: "unknown_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsThreadLimitWorkflowRunError object` The run exceeded the limit on the number of threads that a run can create. - `type: "thread_limit_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsMaxWorkflowRunsWorkflowRunError object` No run was created, because the session was at its limit of open workflow runs, which are runs that have not ended. Only `workflow_run.error` carries this type. - `type: "max_workflow_runs_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsWorkflowRunResultStopped object` The agent stopped the run. - `type: "stopped"` - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunPhaseStartedEvent object` A workflow run's plan entered a phase. - `type: "workflow_run.phase_started"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `workflow_run_phase_id: string` Identifier of the phase, as in `phases` on the run's `workflow_run.created` event. - `BetaManagedAgentsWorkflowRunPhaseEndedEvent object` A workflow run's plan left a phase, or the run's end closed it. Emitted once for every `workflow_run.phase_started` event, before the run's `workflow_run.status_ended` event. The event does not say whether the plan finished the phase's work, or why it left. - `type: "workflow_run.phase_ended"` - `id: string` Unique identifier for this event. - `phase_started_id: string` Identifier of the `workflow_run.phase_started` event that opened the phase. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `workflow_run_phase_id: string` Identifier of the phase, as in `phases` on the run's `workflow_run.created` event. - `BetaManagedAgentsWorkflowRunStatusRunningEvent object` A workflow run is running. Emitted when the run starts to execute, and each time it resumes after being idle. A run that starts idle emits `workflow_run.status_idle` first. - `type: "workflow_run.status_running"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunStatusIdleEvent object` A workflow run is idle. Emitted each time the run goes idle, whatever the cause. If the run ends while idle, no `workflow_run.status_running` comes between this event and its `workflow_run.status_ended`. - `type: "workflow_run.status_idle"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunErrorEvent object` A workflow run met an error, or an error kept a run from being created. A run that ends with a `result.type` of `error` emits this event before its `workflow_run.status_ended`, with the same `error`. - `type: "workflow_run.error"` - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsWorkflowRunError` Why the run did not finish, or was not created. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string or null` Identifier of the run that met the error, or `null` when the error kept a run from being created. - `next_page: optional string or null` Opaque cursor for the next page. Null when no more results. #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID/threads/$THREAD_ID/events \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "sevt_011CZkZGPp1iBcp4kaQSihUm", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" }, { "id": "sevt_011CZkZHPq1jCdq5mbRTjiVn", "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=" } ``` ### Stream Session Thread Events **GET** `/v1/sessions/{session_id}/threads/{thread_id}/stream` Stream Session Thread Events #### Path parameters - `session_id: string` - `thread_id: string` #### Query parameters - `event_deltas: optional array of BetaManagedAgentsDeltaType` When set, this connection also receives streaming deltas (`event_start`, `event_delta`) while an event is being produced, before the event itself arrives. Deltas are best-effort; when the final event is produced it carries the complete content. A model request that ends early (an error or interrupt) produces no final event — its terminal `span.model_request_end` closes the preview. Accepts one or more event types to preview and may be repeated: `agent.message` streams `content_delta` fragments; `agent.thinking` is start-only — a signal that the agent has begun extended thinking, concluded by the `agent.thinking` event itself. Only previews of the requested event types are sent. - `"agent.message"` - `"agent.thinking"` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsStreamSessionThreadEvents = BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 41 more` Server-sent event in a single thread's stream. - `BetaManagedAgentsUserMessageEvent object` A user message event in the session conversation. - `type: "user.message"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks comprising the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `processed_at: optional string or null` Timestamp when the agent finished processing this message. format: date-time - `BetaManagedAgentsUserInterruptEvent object` An interrupt event that pauses agent execution and returns control to the user. - `type: "user.interrupt"` - `id: string` Unique identifier for this event. - `processed_at: optional string or null` Timestamp when the interrupt was processed. format: date-time - `session_thread_id: optional string or null` 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. - `BetaManagedAgentsUserToolConfirmationEvent object` A tool confirmation event that approves or denies a pending tool execution. - `type: "user.tool_confirmation"` - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` The confirmation result: 'allow' or 'deny'. - `"allow"` - `"deny"` - `tool_use_id: 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?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `deny_message: optional string or null` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. maxLength: 10000 - `processed_at: optional string or null` Timestamp when the confirmation was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this confirmation was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsUserCustomToolResultEvent object` Event sent by the client providing the result of a custom tool execution. - `type: "user.custom_tool_result"` - `id: string` Unique identifier for this event. - `custom_tool_use_id: string` The id of the `agent.custom_tool_use` event this result corresponds to. It is also listed in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `type: "search_result"` - `citations: BetaManagedAgentsSearchResultCitations` Citation settings for this search result. - `enabled: boolean` Whether citations are enabled for this search result. - `content: array of BetaManagedAgentsSearchResultContent` Array of text content blocks from the search result. - `type: "text"` - `text: string` The text content. minLength: 1 - `source: string` The URL source of the search result. minLength: 1 - `title: string` The title of the search result. minLength: 1 - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `processed_at: optional string or null` Timestamp when this result was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this result was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsAgentCustomToolUseEvent object` 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. The client can send it as soon as this event arrives, without waiting for `session.status_idle`. - `type: "agent.custom_tool_use"` - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the custom tool being called. - `processed_at: string` Timestamp when this tool use was processed. format: date-time - `session_thread_id: optional string or null` 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. Informational only: the server routes the matching `user.custom_tool_result` by `custom_tool_use_id`, so clients do not send it back. - `BetaManagedAgentsAgentMessageEvent object` An agent response event in the session conversation. - `type: "agent.message"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsRedactedBlock` Array of text blocks comprising the agent response. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `processed_at: string` Timestamp when this response was generated. format: date-time - `BetaManagedAgentsAgentThinkingEvent object` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `type: "agent.thinking"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this thinking was produced. format: date-time - `BetaManagedAgentsAgentMCPToolUseEvent object` Event emitted when the agent invokes a tool provided by an MCP server. - `type: "agent.mcp_tool_use"` - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `mcp_server_name: string` Name of the MCP server providing the tool. - `name: string` Name of the MCP tool being used. - `processed_at: string` Timestamp when this event was processed. format: date-time - `evaluated_permission: optional BetaManagedAgentsAgentEvaluatedPermission` The evaluated permission policy for this tool invocation. - `"allow"` - `"ask"` - `"deny"` - `evaluation: optional BetaManagedAgentsAgentToolEvaluation` Which resolved permission_policy produced evaluated_permission: always_allow, always_ask, or auto (with the server's per-invocation judgement). Absent only when the server refused the call before any policy applied (for example, the named tool is not enabled in the session); such a refusal has evaluated_permission deny. An event recorded before this field existed reads as the arm its evaluated_permission implies (always_allow for allow, always_ask for ask). - `BetaManagedAgentsAgentToolEvaluationAlwaysAllow object` The resolved permission_policy was always_allow; accompanies evaluated_permission "allow". - `type: "always_allow"` - `BetaManagedAgentsAgentToolEvaluationAlwaysAsk object` The resolved permission_policy was always_ask; accompanies evaluated_permission "ask". - `type: "always_ask"` - `BetaManagedAgentsAgentToolEvaluationAuto object` The resolved permission_policy was auto: the server judged this invocation individually. - `type: "auto"` - `evaluated_permission: BetaManagedAgentsAgentAutoEvaluatedPermission` The server's judgement for this invocation. - `BetaManagedAgentsAgentAutoEvaluatedPermissionAllow object` The server judged the invocation safe to execute without client approval. - `type: "allow"` - `BetaManagedAgentsAgentAutoEvaluatedPermissionAsk object` The server reached no judgement; the invocation is held for client approval. - `type: "ask"` - `reason_code: string` The judgement's grounds in registry-bound terms, for client branching and audit rather than end-user display. Open registry; currently "indeterminate" (no judgement was reached). Clients must tolerate values outside this set. maxLength: 64 - `BetaManagedAgentsAgentAutoEvaluatedPermissionDeny object` The server judged the invocation high-risk; it does not execute and a synthetic error tool result is appended. - `type: "deny"` - `reason_code: string` The judgement's grounds in registry-bound terms. Open registry; currently "high_risk" (judged high-risk; the call does not run). Clients must tolerate values outside this set. maxLength: 64 - `session_thread_id: optional string or null` 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. Informational only: the server routes the matching `user.tool_confirmation` by `tool_use_id`, so clients do not send it back. - `BetaManagedAgentsAgentMCPToolResultEvent object` Event representing the result of an MCP tool execution. - `type: "agent.mcp_tool_result"` - `id: string` Unique identifier for this event. - `mcp_tool_use_id: string` The id of the `agent.mcp_tool_use` event this result corresponds to. - `processed_at: string` Timestamp when this event was processed. format: date-time - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `BetaManagedAgentsAgentToolUseEvent object` Event emitted when the agent invokes a built-in agent tool. - `type: "agent.tool_use"` - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the agent tool being used. - `processed_at: string` Timestamp when this event was processed. format: date-time - `evaluated_permission: optional BetaManagedAgentsAgentEvaluatedPermission` The evaluated permission policy for this tool invocation. - `evaluation: optional BetaManagedAgentsAgentToolEvaluation` Which resolved permission_policy produced evaluated_permission: always_allow, always_ask, or auto (with the server's per-invocation judgement). Absent only when the server refused the call before any policy applied (for example, the named tool is not enabled in the session); such a refusal has evaluated_permission deny. An event recorded before this field existed reads as the arm its evaluated_permission implies (always_allow for allow, always_ask for ask). - `session_thread_id: optional string or null` 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. Informational only: the server routes the matching `user.tool_confirmation` or `user.tool_result` by `tool_use_id`, so clients do not send it back. - `BetaManagedAgentsAgentToolResultEvent object` Event representing the result of an agent tool execution. - `type: "agent.tool_result"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `tool_use_id: string` The id of the `agent.tool_use` event this result corresponds to. - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `BetaManagedAgentsAgentThreadMessageReceivedEvent object` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `type: "agent.thread_message_received"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Message content blocks. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `from_session_thread_id: string` Public `sthr_` ID of the thread that sent the message. - `processed_at: string` Timestamp when the message was received. format: date-time - `from_agent_name: optional string or null` Name of the callable agent this message came from. Absent when received from the primary agent. - `BetaManagedAgentsAgentThreadMessageSentEvent object` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `type: "agent.thread_message_sent"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Message content blocks. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `processed_at: string` Timestamp when the message was sent. format: date-time - `to_session_thread_id: string` Public `sthr_` ID of the thread the message was sent to. - `to_agent_name: optional string or null` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `BetaManagedAgentsAgentThreadContextCompactedEvent object` Indicates that context compaction (summarization) occurred during the session. - `type: "agent.thread_context_compacted"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when compaction was processed. format: date-time - `BetaManagedAgentsSessionErrorEvent object` An error event indicating a problem occurred during session execution. - `type: "session.error"` - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 10 more` - `BetaManagedAgentsUnknownError object` 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: "unknown_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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: "retrying"` - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `BetaManagedAgentsModelOverloadedError object` The model is currently overloaded. Emitted after automatic retries are exhausted. - `type: "model_overloaded_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsModelRateLimitedError object` The model request was rate-limited. - `type: "model_rate_limited_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsModelRequestFailedError object` A model request failed for a reason other than overload or rate-limiting. - `type: "model_request_failed_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsMCPConnectionFailedError object` Failed to connect to an MCP server. - `type: "mcp_connection_failed_error"` - `mcp_server_name: string` Name of the MCP server that failed to connect. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsMCPAuthenticationFailedError object` Authentication to an MCP server failed. - `type: "mcp_authentication_failed_error"` - `mcp_server_name: string` Name of the MCP server that failed authentication. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsBillingError object` 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. - `type: "billing_error"` - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsCredentialHostUnreachableError object` An `environment_variable` credential's `auth.networking.allowed_hosts` includes a host the environment's network policy does not permit. - `type: "credential_host_unreachable_error"` - `credential_id: string` ID of the affected credential. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `vault_id: string` ID of the vault containing the affected credential. - `BetaManagedAgentsRepositoryAuthenticationError object` The repository host rejected the credentials, or required credentials and received none. - `type: "repository_authentication_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryForbiddenError object` The repository host refused access to the repository. - `type: "repository_forbidden_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryNotFoundError object` The repository host reported the repository as not found. - `type: "repository_not_found_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryCheckoutError object` The requested branch or commit does not exist in the repository. - `type: "repository_checkout_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `BetaManagedAgentsRepositoryCloneError object` The repository could not be cloned. - `type: "repository_clone_error"` - `message: string` Human-readable error description. - `repository_url: string or null` URL of the repository that could not be cloned. Null when it could not be identified. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next. Always `retrying`: the session keeps running without the repository. - `BetaManagedAgentsRetryStatusRetrying object` 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. - `BetaManagedAgentsRetryStatusExhausted object` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `BetaManagedAgentsRetryStatusTerminal object` The session encountered a terminal error and will transition to `terminated` state. - `processed_at: string` Timestamp when the error occurred. format: date-time - `BetaManagedAgentsSessionStatusRescheduledEvent object` Indicates the session is recovering from an error state and is rescheduled for execution. - `type: "session.status_rescheduled"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `BetaManagedAgentsSessionStatusRunningEvent object` Indicates the session is actively running and the agent is working. - `type: "session.status_running"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `BetaManagedAgentsSessionStatusIdleEvent object` Indicates the agent has paused and is awaiting user input. - `type: "session.status_idle"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `stop_details: BetaManagedAgentsSessionRefusalStopDetails or null` Structured information about why the session stopped. `null` when there is nothing more to report. - `type: "refusal"` - `category: "cyber" or "bio" or "frontier_llm" or 2 more or null` The policy category that triggered the refusal, or `null` when there is no named category. New values can be added over time. - `"cyber"` - `"bio"` - `"frontier_llm"` - `"reasoning_extraction"` - `"general_harms"` - `explanation: string or null` Human-readable explanation of the refusal, or `null` when none is available. The wording can change, so do not parse it. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted or 2 more` - `BetaManagedAgentsSessionEndTurn object` The agent completed its turn naturally and is ready for the next user message. - `type: "end_turn"` - `BetaManagedAgentsSessionRequiresAction object` 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: "requires_action"` - `event_ids: array of string` The ids of events the agent is blocked on. Resolving fewer than all re-emits `session.status_idle` with the remainder. - `BetaManagedAgentsSessionRetriesExhausted object` The turn ended because repeated errors exhausted the retry budget or an error escalated to `retry_status: 'exhausted'`. - `type: "retries_exhausted"` - `BetaManagedAgentsSessionBudgetReached object` The agent stopped because the session's tracked list cost reached its budget, or because its usage includes a model with no list price (which the budget cannot measure). Raise the budget to continue — or, if raising is rejected because a model has no list price, remove the budget. - `type: "budget_reached"` - `BetaManagedAgentsSessionRefusal object` The turn ended because the model's response was refused, for example by a safety classifier. - `type: "refusal"` - `BetaManagedAgentsSessionStatusTerminatedEvent object` Indicates the session has terminated, either due to an error or completion. - `type: "session.status_terminated"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp of status change. format: date-time - `BetaManagedAgentsSessionThreadCreatedEvent object` Emitted when a child thread is created. Written to the parent thread's output stream so clients observing the session see child creation. - `type: "session.thread_created"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the callable agent the thread runs. - `processed_at: string` Timestamp when the thread was created. format: date-time - `session_thread_id: string` Public `sthr_` ID of the newly created thread. - `workflow_run_id: string or null` Identifier of the workflow run that created the thread, or `null` for any other thread. - `BetaManagedAgentsSpanOutcomeEvaluationStartEvent object` Emitted when an outcome evaluation cycle begins. - `type: "span.outcome_evaluation_start"` - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle. 0 is the first evaluation; 1 is the re-evaluation after the first revision; etc. format: int32 - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` Timestamp when outcome evaluation started. format: date-time - `BetaManagedAgentsSpanOutcomeEvaluationEndEvent object` 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. - `type: "span.outcome_evaluation_end"` - `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: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. format: int32 - `outcome_evaluation_start_id: string` The id of the corresponding `span.outcome_evaluation_start` event. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` Timestamp when outcome evaluation ended. format: date-time - `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. - `usage: BetaManagedAgentsSpanModelUsage` Aggregate token usage for this evaluation cycle. Sums across all grader model requests within the cycle. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. format: int32 - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. format: int32 - `input_tokens: number` Input tokens consumed by this request. format: int32 - `output_tokens: number` Output tokens generated by this request. format: int32 - `speed: optional "standard" or "fast" or null` Inference speed tier this request actually ran at. Mirrors `usage.speed` on /v1/messages. Only present when the fast-mode beta is active. - `"standard"` - `"fast"` - `BetaManagedAgentsSpanModelRequestStartEvent object` Emitted when a model request is initiated by the agent. - `type: "span.model_request_start"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the model request started. format: date-time - `BetaManagedAgentsSpanModelRequestEndEvent object` Emitted when a model request completes. - `type: "span.model_request_end"` - `id: string` Unique identifier for this event. - `is_error: boolean or null` Whether the model request resulted in an error. - `model_request_start_id: string` The id of the corresponding `span.model_request_start` event. - `model_usage: BetaManagedAgentsSpanModelUsage` Token usage for this model request. - `processed_at: string` Timestamp when the model request completed. format: date-time - `BetaManagedAgentsSpanOutcomeEvaluationOngoingEvent object` 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. - `type: "span.outcome_evaluation_ongoing"` - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. format: int32 - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` Timestamp when this heartbeat was emitted. format: date-time - `BetaManagedAgentsUserDefineOutcomeEvent object` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `type: "user.define_outcome"` - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number or null` Evaluate-then-revise cycles before giving up. Default 3, max 20. format: int32 - `outcome_id: string` Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. - `processed_at: string` Timestamp when the outcome was accepted. format: date-time - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` How to grade the outcome. File rubrics are currently resolved to their text content; clients should handle both variants. - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `BetaManagedAgentsSessionDeletedEvent object` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `type: "session.deleted"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the session was deleted. format: date-time - `BetaManagedAgentsSessionThreadStatusRunningEvent object` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `type: "session.thread_status_running"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that started running. - `BetaManagedAgentsSessionThreadStatusIdleEvent object` 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. - `type: "session.thread_status_idle"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that went idle. - `stop_details: BetaManagedAgentsSessionRefusalStopDetails or null` Structured information about why the thread stopped. `null` when there is nothing more to report. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted or 2 more` - `BetaManagedAgentsSessionEndTurn object` The agent completed its turn naturally and is ready for the next user message. - `BetaManagedAgentsSessionRequiresAction object` 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. - `BetaManagedAgentsSessionRetriesExhausted object` The turn ended because repeated errors exhausted the retry budget or an error escalated to `retry_status: 'exhausted'`. - `BetaManagedAgentsSessionBudgetReached object` The agent stopped because the session's tracked list cost reached its budget, or because its usage includes a model with no list price (which the budget cannot measure). Raise the budget to continue — or, if raising is rejected because a model has no list price, remove the budget. - `BetaManagedAgentsSessionRefusal object` The turn ended because the model's response was refused, for example by a safety classifier. - `BetaManagedAgentsSessionThreadStatusTerminatedEvent object` 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. - `type: "session.thread_status_terminated"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that terminated. - `BetaManagedAgentsUserToolResultEvent object` 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. - `type: "user.tool_result"` - `id: string` Unique identifier for this event. - `tool_use_id: 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?sdk_languages=http#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `BetaManagedAgentsTextBlock object` Regular text content. - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `BetaManagedAgentsSearchResultBlock object` A block containing a web search result. - `is_error: optional boolean or null` Whether the tool execution resulted in an error. - `processed_at: optional string or null` Timestamp when this result was processed. format: date-time - `session_thread_id: optional string or null` Set by the server to the subagent thread this result was routed to. Omitted when it was routed to the primary thread. - `BetaManagedAgentsSessionThreadStatusRescheduledEvent object` 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. - `type: "session.thread_status_rescheduled"` - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` Timestamp of the status transition. format: date-time - `session_thread_id: string` Public sthr_ ID of the thread that is retrying. - `BetaManagedAgentsSessionUpdatedEvent object` 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. - `type: "session.updated"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the update was applied. format: date-time - `agent: optional BetaManagedAgentsSessionAgent or null` The session's effective agent configuration after the update. Present only when the update changed `agent` (tools or mcp_servers); when present it is the full materialised snapshot, not a diff. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `BetaManagedAgentsAWSRoleExecutionIdentity object` An AWS IAM role principal as returned in API responses. - `type: "aws_role"` - `role_arn: string` The IAM role's ARN. - `BetaManagedAgentsServiceAccountExecutionIdentity object` The Anthropic-managed service account as returned in API responses. - `type: "service_account"` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `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. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `string` - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - `BetaManagedAgentsEffortMedium object` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `BetaManagedAgentsEffortHigh object` High effort. Favors reasoning depth. - `type: "high"` - `BetaManagedAgentsEffortXhigh object` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `BetaManagedAgentsEffortMax object` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed: optional "standard" or "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsSessionMultiagent or null` Resolved multiagent orchestration configuration. Null when the agent is single-threaded. - `BetaManagedAgentsSessionMultiagentCoordinator object` Resolved coordinator topology with full agent definitions for each roster member. - `type: "coordinator"` - `agents: array of BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` Full `agent` definitions the coordinator may spawn as session threads. - `BetaManagedAgentsSessionThreadAgent object` 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`. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `type: "url"` - `name: string` - `url: string` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `type: "agent_toolset_20260401"` - `configs: array of BetaManagedAgentsAgentToolConfig` - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "always_ask"` - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `BetaManagedAgentsEditToolConfig object` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsReadToolConfig object` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWriteToolConfig object` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGlobToolConfig object` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsGrepToolConfig object` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsWebFetchToolConfig object` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources or null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `type: "all"` - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `type: "none"` - `BetaManagedAgentsWebFetchURLSourceOnly object` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `BetaManagedAgentsWebFetchURLSourceExcept object` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: array of BetaManagedAgentsWebFetchURLSourceToolReference` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter or null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput or null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `BetaManagedAgentsWebFetchURLSourceAll object` Every URL from this source may be fetched. This is the default. - `BetaManagedAgentsWebFetchURLSourceNone object` This source contributes no URLs that may be fetched. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `max_content_tokens: optional number or null` format: int32 - `BetaManagedAgentsWebSearchToolConfig object` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains: optional array of string` - `blocked_domains: optional array of string` - `user_location: optional BetaManagedAgentsUserLocation or null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city: optional string or null` City name. minLength: 1, maxLength: 255 - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase. - `region: optional string or null` Region or state name. minLength: 1, maxLength: 255 - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `BetaManagedAgentsMCPToolset object` - `type: "mcp_toolset"` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `BetaManagedAgentsAutoPolicy object` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties: optional map[unknown] or null` - `required: optional array of string or null` - `name: string` - `version: number` format: int32 - `BetaManagedAgentsAdvisor object` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `BetaManagedAgentsSessionMultiagent20261001 object` Resolved multiagent configuration with three members, as copied to the `session` at creation. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `BetaManagedAgentsMultiagentAdvisorEnabled object` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `BetaManagedAgentsMultiagentAdvisorDisabled object` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsSessionMultiagentSubagents` Whether the agent can spawn session threads. - `BetaManagedAgentsSessionMultiagentSubagentsEnabled object` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `BetaManagedAgentsMultiagentInlineAgentsEnabled object` The agent can define inline agents. - `type: "enabled"` - `BetaManagedAgentsMultiagentInlineAgentsDisabled object` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that this agent can spawn as session threads. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentSubagentsDisabled object` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsSessionMultiagentWorkflows` Whether the agent can start workflow runs. - `BetaManagedAgentsSessionMultiagentWorkflowsEnabled object` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions of the predefined agents, which are saved agents that a run's plan can use. - `type: "agent"` - `id: string` - `description: string or null` - `execution_identity: BetaManagedAgentsExecutionIdentity` Execution principal snapshotted from the agent at session creation. Always present; `{"type": "service_account"}` when runs carry no customer-named principal. - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `version: number` format: int32 - `BetaManagedAgentsMultiagentWorkflowsDisabled object` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill. - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill. - `system: string or null` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `BetaManagedAgentsAgentToolset20260401 object` - `BetaManagedAgentsMCPToolset object` - `BetaManagedAgentsCustomTool object` A custom tool as returned in API responses. - `version: number` format: int32 - `budget: optional BetaManagedAgentsBudgetLimit or null` The session's budget after the update: the new budget when set or replaced, or null when the update removed it. Present only when the update changed the budget. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `metadata: optional map[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: optional string or null` The session's new title. Present only when the update changed it. - `BetaManagedAgentsStartEvent object` Opens a preview of a buffered event. Carries the previewed event's type and id only. Followed by zero or more event_delta events with the same event id, normally concluded by the buffered event carrying that id. If the producing model request ends without that event (an error or interrupt mid-stream), its terminal span.model_request_end closes the preview. Only sent on stream connections that opt in via event_deltas; never appears in event history. - `type: "event_start"` - `event: BetaManagedAgentsStartEventPreview` The previewed event's type and id. The event type determines which delta types the preview's event_delta events carry: agent.message events stream content_delta fragments; agent.thinking previews are start-only — no deltas follow, and the buffered agent.thinking with the same id concludes them. - `BetaManagedAgentsAgentMessagePreview object` - `type: "agent.message"` - `id: string` The id the buffered agent.message will carry if it is emitted. Matches the event_id on this preview's event_delta events. - `BetaManagedAgentsAgentThinkingPreview object` - `type: "agent.thinking"` - `id: string` The id the buffered agent.thinking will carry if it is emitted. Start-only — no event_delta events follow. - `BetaManagedAgentsDeltaEvent object` An incremental update to an event that is still being streamed. Deltas are best-effort and may stop early; when the buffered event with id == event_id is produced it carries the complete content. A model request that ends early (an error or interrupt) produces no buffered event — its terminal span.model_request_end closes the preview. Only sent on stream connections that opt in via event_deltas; never appears in event history. - `type: "event_delta"` - `delta: BetaManagedAgentsDeltaContent` One fragment of the previewed event. The delta type is named for the previewed event's field it streams into: agent.message events stream content_delta fragments, each a partial element of the content array. - `type: "content_delta"` - `content: BetaManagedAgentsTextBlock` A partial element of the content array at index, typed like the element itself — the same shape the buffered agent.message carries in content. - `index: optional number` Which entry in the previewed event's content array this fragment lands in. Insert content as that entry when the index is new; append to the existing entry otherwise. - `event_id: string` The id of the event being previewed. Matches event.id on the corresponding event_start and the buffered event that reconciles the preview. - `BetaManagedAgentsSystemMessageEvent object` A mid-conversation system message event. Carries system-role content that is appended to the session as a `role: "system"` turn. - `type: "system.message"` - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `processed_at: optional string or null` Timestamp when this system message was processed. format: date-time - `BetaManagedAgentsSessionUsageEvent object` Periodic snapshot of the session's cumulative usage and tracked list cost. - `type: "session.usage"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when the snapshot was taken. format: date-time - `usage: BetaManagedAgentsSessionUsageSnapshot` The session's cumulative usage at the snapshot time. - `active_seconds: optional number` Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once. This is the duration the session's runtime cost is priced on. format: double - `cache_creation: optional BetaManagedAgentsCacheCreationUsage` Tokens used to create prompt cache entries, broken down by cache TTL. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. format: int32 - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. format: int32 - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. format: int32 - `input_tokens: optional number` Total input tokens consumed across all turns. format: int32 - `list_cost: optional BetaMonetaryAmount` Cumulative list cost of the session across all turns, priced at public list rates. - `output_tokens: optional number` Total output tokens generated across all turns. format: int32 - `server_tool_use: optional BetaManagedAgentsServerToolUsage` Cumulative server-executed tool usage across all turns. - `web_fetch_requests: optional number` Number of server-executed web fetch requests. format: int32 - `web_search_requests: optional number` Number of server-executed web search requests. format: int32 - `budget: optional BetaManagedAgentsBudgetLimit or null` The session's configured budget at the snapshot time, or null when the session has no budget. - `BetaManagedAgentsWorkflowRunCreatedEvent object` A workflow run was created. A workflow run is background work that the session's agent starts. Emitted once per run, before the run's other `workflow_run.*` events. - `type: "workflow_run.created"` - `id: string` Unique identifier for this event. - `description: string or null` Description that the agent gave the run, passed on as written, or `null` if it gave none. - `name: string` Name that the agent gave the run, passed on as written, or a name that the server assigned. - `phases: array of BetaManagedAgentsWorkflowRunPhase` The phases that the run's plan declares, in the plan's order. Can be empty. - `id: string` Unique identifier for the phase. - `description: string or null` Description that the agent gave the phase, passed on as written, or `null` if it gave none. - `name: string` Name that the agent gave the phase, passed on as written. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunStatusEndedEvent object` A workflow run ended. Emitted once per run, as the last of the run's `workflow_run.*` events. - `type: "workflow_run.status_ended"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `result: BetaManagedAgentsWorkflowRunResult` How the run ended. - `BetaManagedAgentsWorkflowRunResultCompleted object` The run's plan, a program that the agent wrote, finished. This does not say whether the work succeeded. - `type: "completed"` - `BetaManagedAgentsWorkflowRunResultError object` The run failed or reached its time limit. - `type: "error"` - `error: BetaManagedAgentsWorkflowRunError` Why the run did not finish. - `BetaManagedAgentsTimeoutWorkflowRunError object` The run reached its time limit. - `type: "timeout_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsProgramWorkflowRunError object` The plan, a program that the agent wrote, failed, or the server refused it. - `type: "program_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsUnknownWorkflowRunError object` A failure that has no type of its own. - `type: "unknown_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsThreadLimitWorkflowRunError object` The run exceeded the limit on the number of threads that a run can create. - `type: "thread_limit_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsMaxWorkflowRunsWorkflowRunError object` No run was created, because the session was at its limit of open workflow runs, which are runs that have not ended. Only `workflow_run.error` carries this type. - `type: "max_workflow_runs_error"` - `message: string` Short explanation written by the server. It never contains content from the run or its agents. - `BetaManagedAgentsWorkflowRunResultStopped object` The agent stopped the run. - `type: "stopped"` - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunPhaseStartedEvent object` A workflow run's plan entered a phase. - `type: "workflow_run.phase_started"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `workflow_run_phase_id: string` Identifier of the phase, as in `phases` on the run's `workflow_run.created` event. - `BetaManagedAgentsWorkflowRunPhaseEndedEvent object` A workflow run's plan left a phase, or the run's end closed it. Emitted once for every `workflow_run.phase_started` event, before the run's `workflow_run.status_ended` event. The event does not say whether the plan finished the phase's work, or why it left. - `type: "workflow_run.phase_ended"` - `id: string` Unique identifier for this event. - `phase_started_id: string` Identifier of the `workflow_run.phase_started` event that opened the phase. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `workflow_run_phase_id: string` Identifier of the phase, as in `phases` on the run's `workflow_run.created` event. - `BetaManagedAgentsWorkflowRunStatusRunningEvent object` A workflow run is running. Emitted when the run starts to execute, and each time it resumes after being idle. A run that starts idle emits `workflow_run.status_idle` first. - `type: "workflow_run.status_running"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunStatusIdleEvent object` A workflow run is idle. Emitted each time the run goes idle, whatever the cause. If the run ends while idle, no `workflow_run.status_running` comes between this event and its `workflow_run.status_ended`. - `type: "workflow_run.status_idle"` - `id: string` Unique identifier for this event. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string` Identifier of the run. The same value is on all of the run's `workflow_run.*` events. - `BetaManagedAgentsWorkflowRunErrorEvent object` A workflow run met an error, or an error kept a run from being created. A run that ends with a `result.type` of `error` emits this event before its `workflow_run.status_ended`, with the same `error`. - `type: "workflow_run.error"` - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsWorkflowRunError` Why the run did not finish, or was not created. - `processed_at: string` Timestamp when this event was processed. format: date-time - `workflow_run_id: string or null` Identifier of the run that met the error, or `null` when the error kept a run from being created. #### Example ```bash curl https://api.anthropic.com/v1/sessions/$SESSION_ID/threads/$THREAD_ID/stream \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "sevt_011CZkZGPp1iBcp4kaQSihUm", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } ``` ## Beta › Deployments ### Create Deployment **POST** `/v1/deployments` Create Deployment #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `agent: string or BetaManagedAgentsAgentParams` Agent to deploy. Accepts the `agent` ID string, which pins the latest version, or an `agent` object with both id and version specified. The agent must exist and not be archived. - `string` - `BetaManagedAgentsAgentParams object` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `type: "agent"` - `id: string` The `agent` ID. minLength: 1, maxLength: 128 - `version: optional number` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. format: int32 - `environment_id: string` ID of the `environment` defining the container configuration for sessions created from this deployment. minLength: 1, maxLength: 128 - `initial_events: array of BetaManagedAgentsDeploymentInitialEventParams` Events to send to each session immediately after creation. At least 1, maximum 50. - `BetaManagedAgentsUserMessageEventParams object` Parameters for sending a user message to the session. - `type: "user.message"` - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks for the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `BetaManagedAgentsUserDefineOutcomeEventParams object` Parameters for defining an outcome the agent should work toward. The agent begins work on receipt. - `type: "user.define_outcome"` - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams` How to grade the outcome. Text or file reference. - `BetaManagedAgentsFileRubricParams object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubricParams object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. maxLength: 262144 - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsSystemMessageEventParams object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt. At most one per request: it must be the final event and immediately follow the `user.message`, `user.tool_result`, or `user.custom_tool_result` it accompanies. Only supported on models that accept mid-conversation system messages. - `type: "system.message"` - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks to append. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `name: string` Human-readable name for the deployment. minLength: 1, maxLength: 256 - `budget: optional BetaManagedAgentsBudgetLimit or null` Enforced spend ceiling stamped onto each session created from this deployment, copied at session-creation time. Omit to leave sessions uncapped. The deployment agent's model must have a public list price, or the request is rejected; a multiagent roster is re-validated in full when each fire copies the cap, which fails closed the same way. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `description: optional string or null` Description of what the deployment does. maxLength: 2048 - `metadata: optional map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `resources: optional array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam` Resources (e.g. repositories, files) to mount into each session's container. Maximum 500. - `BetaManagedAgentsGitHubRepositoryResourceParams object` Mount a GitHub repository into the session's container. - `type: "github_repository"` - `url: string` Github URL of the repository minLength: 1, maxLength: 2048 - `authorization_token: optional string` GitHub authorization token used to clone the repository. Required for private repositories; optional for public ones. minLength: 1, maxLength: 4096 - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` Branch or commit to check out. Defaults to the repository's default branch. - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/`. minLength: 1, maxLength: 4096 - `BetaManagedAgentsFileResourceParams object` Mount a file uploaded via the Files API into the session. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1, maxLength: 128 - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/`. minLength: 1, maxLength: 4096 - `BetaManagedAgentsMemoryStoreResourceParam object` Parameters for attaching a memory store to an agent session. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `instructions: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. maxLength: 4096 - `schedule: optional BetaManagedAgentsScheduleParams or null` Optional recurring cron schedule. When present, the deployment fires automatically. Both expression and timezone are required when schedule is set. - `type: "cron"` - `expression: string` 5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily). minLength: 1, maxLength: 256 - `timezone: string` Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database. minLength: 1 - `vault_ids: optional array of string` Vault IDs for stored credentials the agent can use during sessions created from this deployment. Maximum 50. #### Returns - `BetaManagedAgentsDeployment object` A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule. - `type: "deployment"` - `id: string` Unique identifier for this deployment. - `agent: BetaManagedAgentsAgentReference` Reference to the agent this deployment runs, resolved to a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `archived_at: string or null` Time the deployment was archived. Null if not archived. format: date-time - `created_at: string` Time the deployment was created. format: date-time - `description: string or null` Description of what the deployment does. - `environment_id: string` ID of the `environment` where sessions run. - `initial_events: array of BetaManagedAgentsDeploymentInitialEvent` Events sent to each session immediately after creation. - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session. - `type: "user.message"` - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks for the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt. - `type: "user.define_outcome"` - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` How to grade the outcome. Text or file reference. - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt. - `type: "system.message"` - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks to append. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs. - `name: string` Human-readable name. - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null` Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise. - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment. - `type: "error"` - `error: BetaManagedAgentsDeploymentPausedReasonError` The failed run's error. - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`. - `type: "unknown_error"` - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` The deployment configures resources, but its environment is self-hosted and cannot mount them. - `type: "self_hosted_resources_unsupported_error"` - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `type: "mcp_egress_blocked_error"` - `resources: array of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - `BetaManagedAgentsGitHubRepositoryResourceConfig object` A GitHub repository mounted into each session's container. The authorization token is write-only and never returned. - `type: "github_repository"` - `url: string` Github URL of the repository - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` Branch or commit to check out. Defaults to the repository's default branch. - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/`. - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container. - `type: "file"` - `file_id: string` ID of a previously uploaded file. - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/`. - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `instructions: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `schedule: BetaManagedAgentsSchedule or null` Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant. - `type: "cron"` - `expression: string` 5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily). minLength: 1, maxLength: 256 - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). minLength: 1 - `last_run_at: optional string or null` Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this. format: date-time - `upcoming_runs_at: optional array of string` Up to 5 timestamps of upcoming cron occurrences. Non-empty for active and paused deployments (reflects what the schedule would do if unpaused); empty once the deployment is archived (`archived_at` set). Each fire is offset by a small per-schedule jitter, so a run will actually start at or shortly after its listed time. - `status: BetaManagedAgentsDeploymentStatus` Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set. - `"active"` The deployment is active and can run sessions. Archived deployments also report this status; check `archived_at` to distinguish them. - `"paused"` The deployment is paused. Autonomous triggers are suppressed; manual runs are still permitted. - `updated_at: string` Time the deployment was last updated. format: date-time - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment. - `budget: optional BetaManagedAgentsBudgetLimit or null` Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. #### Example ```bash curl https://api.anthropic.com/v1/deployments \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "agent": "string", "environment_id": "x", "initial_events": [ { "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message" } ], "name": "x", "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron" } }' ``` ##### Response (200) ```json { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } ``` ### List Deployments **GET** `/v1/deployments` List Deployments #### Query parameters - `agent_id: optional string` Filter by agent ID. - `"created_at[gte]": optional string` Return deployments created at or after this time (inclusive). format: date-time - `"created_at[lte]": optional string` Return deployments created at or before this time (inclusive). format: date-time - `include_archived: optional boolean` When true, includes archived deployments. Default: false (exclude archived). - `limit: optional number` Maximum results per page. Default 20, maximum 100. format: int32 - `page: optional string` Opaque pagination cursor. - `status: optional BetaManagedAgentsDeploymentStatus` Filter by status: `active` or `paused`. Omit for both. To include archived deployments, use `include_archived` instead; the two cannot be combined. - `"active"` The deployment is active and can run sessions. Archived deployments also report this status; check `archived_at` to distinguish them. - `"paused"` The deployment is paused. Autonomous triggers are suppressed; manual runs are still permitted. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaManagedAgentsDeployment` List of deployments. - `type: "deployment"` - `id: string` Unique identifier for this deployment. - `agent: BetaManagedAgentsAgentReference` Reference to the agent this deployment runs, resolved to a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `archived_at: string or null` Time the deployment was archived. Null if not archived. format: date-time - `created_at: string` Time the deployment was created. format: date-time - `description: string or null` Description of what the deployment does. - `environment_id: string` ID of the `environment` where sessions run. - `initial_events: array of BetaManagedAgentsDeploymentInitialEvent` Events sent to each session immediately after creation. - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session. - `type: "user.message"` - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks for the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt. - `type: "user.define_outcome"` - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` How to grade the outcome. Text or file reference. - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt. - `type: "system.message"` - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks to append. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs. - `name: string` Human-readable name. - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null` Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise. - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment. - `type: "error"` - `error: BetaManagedAgentsDeploymentPausedReasonError` The failed run's error. - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`. - `type: "unknown_error"` - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` The deployment configures resources, but its environment is self-hosted and cannot mount them. - `type: "self_hosted_resources_unsupported_error"` - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `type: "mcp_egress_blocked_error"` - `resources: array of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - `BetaManagedAgentsGitHubRepositoryResourceConfig object` A GitHub repository mounted into each session's container. The authorization token is write-only and never returned. - `type: "github_repository"` - `url: string` Github URL of the repository - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` Branch or commit to check out. Defaults to the repository's default branch. - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/`. - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container. - `type: "file"` - `file_id: string` ID of a previously uploaded file. - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/`. - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `instructions: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `schedule: BetaManagedAgentsSchedule or null` Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant. - `type: "cron"` - `expression: string` 5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily). minLength: 1, maxLength: 256 - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). minLength: 1 - `last_run_at: optional string or null` Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this. format: date-time - `upcoming_runs_at: optional array of string` Up to 5 timestamps of upcoming cron occurrences. Non-empty for active and paused deployments (reflects what the schedule would do if unpaused); empty once the deployment is archived (`archived_at` set). Each fire is offset by a small per-schedule jitter, so a run will actually start at or shortly after its listed time. - `status: BetaManagedAgentsDeploymentStatus` Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set. - `"active"` The deployment is active and can run sessions. Archived deployments also report this status; check `archived_at` to distinguish them. - `"paused"` The deployment is paused. Autonomous triggers are suppressed; manual runs are still permitted. - `updated_at: string` Time the deployment was last updated. format: date-time - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment. - `budget: optional BetaManagedAgentsBudgetLimit or null` Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `next_page: optional string or null` Opaque cursor for the next page. Null when no more results. #### Example ```bash curl https://api.anthropic.com/v1/deployments \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ### Get Deployment **GET** `/v1/deployments/{deployment_id}` Get Deployment #### Path parameters - `deployment_id: string` Unique identifier of the deployment. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsDeployment object` A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule. - `type: "deployment"` - `id: string` Unique identifier for this deployment. - `agent: BetaManagedAgentsAgentReference` Reference to the agent this deployment runs, resolved to a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `archived_at: string or null` Time the deployment was archived. Null if not archived. format: date-time - `created_at: string` Time the deployment was created. format: date-time - `description: string or null` Description of what the deployment does. - `environment_id: string` ID of the `environment` where sessions run. - `initial_events: array of BetaManagedAgentsDeploymentInitialEvent` Events sent to each session immediately after creation. - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session. - `type: "user.message"` - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks for the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt. - `type: "user.define_outcome"` - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` How to grade the outcome. Text or file reference. - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt. - `type: "system.message"` - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks to append. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs. - `name: string` Human-readable name. - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null` Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise. - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment. - `type: "error"` - `error: BetaManagedAgentsDeploymentPausedReasonError` The failed run's error. - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`. - `type: "unknown_error"` - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` The deployment configures resources, but its environment is self-hosted and cannot mount them. - `type: "self_hosted_resources_unsupported_error"` - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `type: "mcp_egress_blocked_error"` - `resources: array of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - `BetaManagedAgentsGitHubRepositoryResourceConfig object` A GitHub repository mounted into each session's container. The authorization token is write-only and never returned. - `type: "github_repository"` - `url: string` Github URL of the repository - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` Branch or commit to check out. Defaults to the repository's default branch. - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/`. - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container. - `type: "file"` - `file_id: string` ID of a previously uploaded file. - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/`. - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `instructions: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `schedule: BetaManagedAgentsSchedule or null` Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant. - `type: "cron"` - `expression: string` 5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily). minLength: 1, maxLength: 256 - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). minLength: 1 - `last_run_at: optional string or null` Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this. format: date-time - `upcoming_runs_at: optional array of string` Up to 5 timestamps of upcoming cron occurrences. Non-empty for active and paused deployments (reflects what the schedule would do if unpaused); empty once the deployment is archived (`archived_at` set). Each fire is offset by a small per-schedule jitter, so a run will actually start at or shortly after its listed time. - `status: BetaManagedAgentsDeploymentStatus` Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set. - `"active"` The deployment is active and can run sessions. Archived deployments also report this status; check `archived_at` to distinguish them. - `"paused"` The deployment is paused. Autonomous triggers are suppressed; manual runs are still permitted. - `updated_at: string` Time the deployment was last updated. format: date-time - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment. - `budget: optional BetaManagedAgentsBudgetLimit or null` Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. #### Example ```bash curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } ``` ### Update Deployment **POST** `/v1/deployments/{deployment_id}` Update Deployment #### Path parameters - `deployment_id: string` Unique identifier of the deployment to update. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `agent: optional string or BetaManagedAgentsAgentParams` Agent to deploy. Accepts the `agent` ID string, which re-pins to the latest version, or an `agent` object with both id and version specified. Omit to preserve. Cannot be cleared. - `string` - `BetaManagedAgentsAgentParams object` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `type: "agent"` - `id: string` The `agent` ID. minLength: 1, maxLength: 128 - `version: optional number` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. format: int32 - `budget: optional BetaManagedAgentsBudgetLimit or null` Spend ceiling for future sessions. Full replacement. Omit to preserve; send null to clear (sessions created afterwards are uncapped). The deployment agent's model must have a public list price, or the request is rejected; a multiagent roster is re-validated in full when each fire copies the cap, which fails closed the same way. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - `description: optional string or null` Description. Omit to preserve; send empty string or null to clear. maxLength: 2048 - `environment_id: optional string` ID of the `environment` where sessions run. Omit to preserve. Cannot be cleared. maxLength: 128 - `initial_events: optional array of BetaManagedAgentsDeploymentInitialEventParams` Initial events. Full replacement. Omit to preserve. Cannot be cleared. At least 1, maximum 50. - `BetaManagedAgentsUserMessageEventParams object` Parameters for sending a user message to the session. - `type: "user.message"` - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks for the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `BetaManagedAgentsUserDefineOutcomeEventParams object` Parameters for defining an outcome the agent should work toward. The agent begins work on receipt. - `type: "user.define_outcome"` - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams` How to grade the outcome. Text or file reference. - `BetaManagedAgentsFileRubricParams object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubricParams object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. maxLength: 262144 - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsSystemMessageEventParams object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt. At most one per request: it must be the final event and immediately follow the `user.message`, `user.tool_result`, or `user.custom_tool_result` it accompanies. Only supported on models that accept mid-conversation system messages. - `type: "system.message"` - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks to append. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `metadata: optional map[string] or null` 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: optional string` Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared. maxLength: 256 - `resources: optional array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam or null` Session resources. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 500. - `BetaManagedAgentsGitHubRepositoryResourceParams object` Mount a GitHub repository into the session's container. - `type: "github_repository"` - `url: string` Github URL of the repository minLength: 1, maxLength: 2048 - `authorization_token: optional string` GitHub authorization token used to clone the repository. Required for private repositories; optional for public ones. minLength: 1, maxLength: 4096 - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` Branch or commit to check out. Defaults to the repository's default branch. - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/`. minLength: 1, maxLength: 4096 - `BetaManagedAgentsFileResourceParams object` Mount a file uploaded via the Files API into the session. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1, maxLength: 128 - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/`. minLength: 1, maxLength: 4096 - `BetaManagedAgentsMemoryStoreResourceParam object` Parameters for attaching a memory store to an agent session. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `instructions: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. maxLength: 4096 - `schedule: optional BetaManagedAgentsScheduleParams or null` Cron schedule. Full replacement. Omit to preserve; send null to clear (revert to manual-only). - `type: "cron"` - `expression: string` 5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily). minLength: 1, maxLength: 256 - `timezone: string` Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database. minLength: 1 - `vault_ids: optional array of string or null` Vault IDs. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 50. #### Returns - `BetaManagedAgentsDeployment object` A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule. - `type: "deployment"` - `id: string` Unique identifier for this deployment. - `agent: BetaManagedAgentsAgentReference` Reference to the agent this deployment runs, resolved to a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `archived_at: string or null` Time the deployment was archived. Null if not archived. format: date-time - `created_at: string` Time the deployment was created. format: date-time - `description: string or null` Description of what the deployment does. - `environment_id: string` ID of the `environment` where sessions run. - `initial_events: array of BetaManagedAgentsDeploymentInitialEvent` Events sent to each session immediately after creation. - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session. - `type: "user.message"` - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks for the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt. - `type: "user.define_outcome"` - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` How to grade the outcome. Text or file reference. - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt. - `type: "system.message"` - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks to append. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs. - `name: string` Human-readable name. - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null` Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise. - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment. - `type: "error"` - `error: BetaManagedAgentsDeploymentPausedReasonError` The failed run's error. - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`. - `type: "unknown_error"` - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` The deployment configures resources, but its environment is self-hosted and cannot mount them. - `type: "self_hosted_resources_unsupported_error"` - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `type: "mcp_egress_blocked_error"` - `resources: array of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - `BetaManagedAgentsGitHubRepositoryResourceConfig object` A GitHub repository mounted into each session's container. The authorization token is write-only and never returned. - `type: "github_repository"` - `url: string` Github URL of the repository - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` Branch or commit to check out. Defaults to the repository's default branch. - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/`. - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container. - `type: "file"` - `file_id: string` ID of a previously uploaded file. - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/`. - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `instructions: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `schedule: BetaManagedAgentsSchedule or null` Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant. - `type: "cron"` - `expression: string` 5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily). minLength: 1, maxLength: 256 - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). minLength: 1 - `last_run_at: optional string or null` Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this. format: date-time - `upcoming_runs_at: optional array of string` Up to 5 timestamps of upcoming cron occurrences. Non-empty for active and paused deployments (reflects what the schedule would do if unpaused); empty once the deployment is archived (`archived_at` set). Each fire is offset by a small per-schedule jitter, so a run will actually start at or shortly after its listed time. - `status: BetaManagedAgentsDeploymentStatus` Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set. - `"active"` The deployment is active and can run sessions. Archived deployments also report this status; check `archived_at` to distinguish them. - `"paused"` The deployment is paused. Autonomous triggers are suppressed; manual runs are still permitted. - `updated_at: string` Time the deployment was last updated. format: date-time - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment. - `budget: optional BetaManagedAgentsBudgetLimit or null` Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. #### Example ```bash curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron" } }' ``` ##### Response (200) ```json { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } ``` ### Archive Deployment **POST** `/v1/deployments/{deployment_id}/archive` Archive Deployment #### Path parameters - `deployment_id: string` Unique identifier of the deployment to archive. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsDeployment object` A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule. - `type: "deployment"` - `id: string` Unique identifier for this deployment. - `agent: BetaManagedAgentsAgentReference` Reference to the agent this deployment runs, resolved to a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `archived_at: string or null` Time the deployment was archived. Null if not archived. format: date-time - `created_at: string` Time the deployment was created. format: date-time - `description: string or null` Description of what the deployment does. - `environment_id: string` ID of the `environment` where sessions run. - `initial_events: array of BetaManagedAgentsDeploymentInitialEvent` Events sent to each session immediately after creation. - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session. - `type: "user.message"` - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks for the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt. - `type: "user.define_outcome"` - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` How to grade the outcome. Text or file reference. - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt. - `type: "system.message"` - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks to append. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs. - `name: string` Human-readable name. - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null` Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise. - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment. - `type: "error"` - `error: BetaManagedAgentsDeploymentPausedReasonError` The failed run's error. - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`. - `type: "unknown_error"` - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` The deployment configures resources, but its environment is self-hosted and cannot mount them. - `type: "self_hosted_resources_unsupported_error"` - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `type: "mcp_egress_blocked_error"` - `resources: array of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - `BetaManagedAgentsGitHubRepositoryResourceConfig object` A GitHub repository mounted into each session's container. The authorization token is write-only and never returned. - `type: "github_repository"` - `url: string` Github URL of the repository - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` Branch or commit to check out. Defaults to the repository's default branch. - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/`. - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container. - `type: "file"` - `file_id: string` ID of a previously uploaded file. - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/`. - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `instructions: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `schedule: BetaManagedAgentsSchedule or null` Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant. - `type: "cron"` - `expression: string` 5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily). minLength: 1, maxLength: 256 - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). minLength: 1 - `last_run_at: optional string or null` Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this. format: date-time - `upcoming_runs_at: optional array of string` Up to 5 timestamps of upcoming cron occurrences. Non-empty for active and paused deployments (reflects what the schedule would do if unpaused); empty once the deployment is archived (`archived_at` set). Each fire is offset by a small per-schedule jitter, so a run will actually start at or shortly after its listed time. - `status: BetaManagedAgentsDeploymentStatus` Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set. - `"active"` The deployment is active and can run sessions. Archived deployments also report this status; check `archived_at` to distinguish them. - `"paused"` The deployment is paused. Autonomous triggers are suppressed; manual runs are still permitted. - `updated_at: string` Time the deployment was last updated. format: date-time - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment. - `budget: optional BetaManagedAgentsBudgetLimit or null` Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. #### Example ```bash curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } ``` ### Run Deployment Now **POST** `/v1/deployments/{deployment_id}/run` Run Deployment Now #### Path parameters - `deployment_id: string` Unique identifier of the deployment to run. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsDeploymentRun object` A persistent, append-only record of a single deployment execution. Records session creation success or failure — no session lifecycle tracking. - `type: "deployment_run"` - `id: string` Unique identifier for this run (`drun_...`). - `agent: BetaManagedAgentsAgentReference` Snapshot of the agent at fire time. Always fully resolved — deployments pin agent + version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `created_at: string` Time this run record was persisted. format: date-time - `deployment_id: string` ID of the deployment that produced this run. - `error: BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null` Populated on creation failure. Null on success. Exactly one of `session_id` or `error` is non-null. - `BetaManagedAgentsEnvironmentArchivedRunError object` The deployment's environment was archived. - `type: "environment_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsAgentArchivedRunError object` The deployment's agent was archived. - `type: "agent_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsEnvironmentNotFoundRunError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsVaultNotFoundRunError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsVaultArchivedRunError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsFileNotFoundRunError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsMemoryStoreArchivedRunError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSkillNotFoundRunError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSessionResourceNotFoundRunError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsWorkspaceArchivedRunError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsOrganizationDisabledRunError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSessionRateLimitedRunError object` Session creation was rejected due to rate limiting. The schedule keeps firing; subsequent runs may succeed. - `type: "session_rate_limited_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSessionCreationRejectedRunError object` The session create request was rejected with a non-retryable validation error. - `type: "session_creation_rejected_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsUnknownRunError object` An unknown or unexpected error caused the run to fail. A fallback variant; clients that do not recognize a new error type can match on message alone. - `type: "unknown_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSelfHostedResourcesUnsupportedRunError object` The deployment configures resources, but its environment is self-hosted and cannot mount them. - `type: "self_hosted_resources_unsupported_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsMCPEgressBlockedRunError object` An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `type: "mcp_egress_blocked_error"` - `message: string` Human-readable error description. - `session_id: string or null` Populated on success. Null on creation failure. Exactly one of `session_id` or `error` is non-null. - `trigger_context: BetaManagedAgentsTriggerContext` What triggered this run and trigger-specific metadata. - `BetaManagedAgentsScheduleTriggerContext object` The run was fired by the deployment's cron schedule. - `type: "schedule"` - `scheduled_at: string` The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair. format: date-time - `BetaManagedAgentsManualTriggerContext object` The run was started manually by creating a session directly against the deployment. - `type: "manual"` #### Example ```bash curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/run \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 }, "created_at": "2019-12-27T18:11:19.117Z", "deployment_id": "deployment_id", "error": { "message": "message", "type": "environment_archived_error" }, "session_id": "session_id", "trigger_context": { "scheduled_at": "2019-12-27T18:11:19.117Z", "type": "schedule" }, "type": "deployment_run" } ``` ### Pause Deployment **POST** `/v1/deployments/{deployment_id}/pause` Pause Deployment #### Path parameters - `deployment_id: string` Unique identifier of the deployment to pause. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsDeployment object` A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule. - `type: "deployment"` - `id: string` Unique identifier for this deployment. - `agent: BetaManagedAgentsAgentReference` Reference to the agent this deployment runs, resolved to a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `archived_at: string or null` Time the deployment was archived. Null if not archived. format: date-time - `created_at: string` Time the deployment was created. format: date-time - `description: string or null` Description of what the deployment does. - `environment_id: string` ID of the `environment` where sessions run. - `initial_events: array of BetaManagedAgentsDeploymentInitialEvent` Events sent to each session immediately after creation. - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session. - `type: "user.message"` - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks for the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt. - `type: "user.define_outcome"` - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` How to grade the outcome. Text or file reference. - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt. - `type: "system.message"` - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks to append. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs. - `name: string` Human-readable name. - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null` Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise. - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment. - `type: "error"` - `error: BetaManagedAgentsDeploymentPausedReasonError` The failed run's error. - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`. - `type: "unknown_error"` - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` The deployment configures resources, but its environment is self-hosted and cannot mount them. - `type: "self_hosted_resources_unsupported_error"` - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `type: "mcp_egress_blocked_error"` - `resources: array of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - `BetaManagedAgentsGitHubRepositoryResourceConfig object` A GitHub repository mounted into each session's container. The authorization token is write-only and never returned. - `type: "github_repository"` - `url: string` Github URL of the repository - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` Branch or commit to check out. Defaults to the repository's default branch. - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/`. - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container. - `type: "file"` - `file_id: string` ID of a previously uploaded file. - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/`. - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `instructions: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `schedule: BetaManagedAgentsSchedule or null` Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant. - `type: "cron"` - `expression: string` 5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily). minLength: 1, maxLength: 256 - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). minLength: 1 - `last_run_at: optional string or null` Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this. format: date-time - `upcoming_runs_at: optional array of string` Up to 5 timestamps of upcoming cron occurrences. Non-empty for active and paused deployments (reflects what the schedule would do if unpaused); empty once the deployment is archived (`archived_at` set). Each fire is offset by a small per-schedule jitter, so a run will actually start at or shortly after its listed time. - `status: BetaManagedAgentsDeploymentStatus` Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set. - `"active"` The deployment is active and can run sessions. Archived deployments also report this status; check `archived_at` to distinguish them. - `"paused"` The deployment is paused. Autonomous triggers are suppressed; manual runs are still permitted. - `updated_at: string` Time the deployment was last updated. format: date-time - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment. - `budget: optional BetaManagedAgentsBudgetLimit or null` Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. #### Example ```bash curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/pause \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } ``` ### Unpause Deployment **POST** `/v1/deployments/{deployment_id}/unpause` Unpause Deployment #### Path parameters - `deployment_id: string` Unique identifier of the deployment to unpause. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsDeployment object` A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule. - `type: "deployment"` - `id: string` Unique identifier for this deployment. - `agent: BetaManagedAgentsAgentReference` Reference to the agent this deployment runs, resolved to a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `archived_at: string or null` Time the deployment was archived. Null if not archived. format: date-time - `created_at: string` Time the deployment was created. format: date-time - `description: string or null` Description of what the deployment does. - `environment_id: string` ID of the `environment` where sessions run. - `initial_events: array of BetaManagedAgentsDeploymentInitialEvent` Events sent to each session immediately after creation. - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session. - `type: "user.message"` - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` Array of content blocks for the user message. - `BetaManagedAgentsTextBlock object` Regular text content. - `type: "text"` - `text: string` The text content. minLength: 1 - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL. - `type: "image"` - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` The source of the image data. - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data. - `type: "base64"` - `data: string` Base64-encoded image data. minLength: 1 - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). minLength: 1 - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - `url: string` URL of the image to fetch. minLength: 1 - `BetaManagedAgentsFileImageSource object` Image referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `type: "document"` - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` The source of the document data. - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data. - `type: "base64"` - `data: string` Base64-encoded document data. minLength: 1 - `media_type: string` MIME type of the document (e.g., "application/pdf"). minLength: 1 - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content. - `type: "text"` - `data: string` The plain text content. minLength: 1 - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - `url: string` URL of the document to fetch. minLength: 1 - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID. - `type: "file"` - `file_id: string` ID of a previously uploaded file. minLength: 1 - `context: optional string or null` Additional context about the document for the model. - `title: optional string or null` The title of the document. - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt. - `type: "user.define_outcome"` - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` How to grade the outcome. Text or file reference. - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API. - `type: "file"` - `file_id: string` ID of the rubric file. - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text. - `type: "text"` - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. format: int32 - `BetaManagedAgentsDeploymentSystemMessageEvent object` Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: "system"` turn rather than replacing the top-level system prompt. - `type: "system.message"` - `content: array of BetaManagedAgentsSystemContentBlock` System content blocks to append. Text-only. - `type: "text"` - `text: string` The text content. minLength: 1 - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs. - `name: string` Human-readable name. - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null` Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise. - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment. - `type: "error"` - `error: BetaManagedAgentsDeploymentPausedReasonError` The failed run's error. - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`. - `type: "unknown_error"` - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` The deployment configures resources, but its environment is self-hosted and cannot mount them. - `type: "self_hosted_resources_unsupported_error"` - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `type: "mcp_egress_blocked_error"` - `resources: array of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - `BetaManagedAgentsGitHubRepositoryResourceConfig object` A GitHub repository mounted into each session's container. The authorization token is write-only and never returned. - `type: "github_repository"` - `url: string` Github URL of the repository - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` Branch or commit to check out. Defaults to the repository's default branch. - `BetaManagedAgentsBranchCheckout object` - `type: "branch"` - `name: string` Branch name to check out. minLength: 1, maxLength: 255 - `BetaManagedAgentsCommitCheckout object` - `type: "commit"` - `sha: string` Full commit SHA to check out. minLength: 7, maxLength: 64 - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/`. - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container. - `type: "file"` - `file_id: string` ID of a previously uploaded file. - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/`. - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment. - `type: "memory_store"` - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `access: optional "read_write" or "read_only" or null` Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. - `"read_write"` - `"read_only"` - `instructions: optional string or null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `schedule: BetaManagedAgentsSchedule or null` Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant. - `type: "cron"` - `expression: string` 5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily). minLength: 1, maxLength: 256 - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). minLength: 1 - `last_run_at: optional string or null` Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this. format: date-time - `upcoming_runs_at: optional array of string` Up to 5 timestamps of upcoming cron occurrences. Non-empty for active and paused deployments (reflects what the schedule would do if unpaused); empty once the deployment is archived (`archived_at` set). Each fire is offset by a small per-schedule jitter, so a run will actually start at or shortly after its listed time. - `status: BetaManagedAgentsDeploymentStatus` Computed status of the deployment: `active` or `paused`. Archived deployments report `active` with `archived_at` set. - `"active"` The deployment is active and can run sessions. Archived deployments also report this status; check `archived_at` to distinguish them. - `"paused"` The deployment is paused. Autonomous triggers are suppressed; manual runs are still permitted. - `updated_at: string` Time the deployment was last updated. format: date-time - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment. - `budget: optional BetaManagedAgentsBudgetLimit or null` Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set. - `type: "limit"` - `max_list_cost: BetaMonetaryAmount` Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. - `amount: string` Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - `currency: BetaCurrency` Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. #### Example ```bash curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/unpause \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "depl_011CZkZcDH3vPqd7xnEfwTai", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Compiles yesterday's orders into a report every weekday morning.", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "initial_events": [ { "content": [ { "text": "Compile yesterday's orders into report.md.", "type": "text" } ], "type": "user.message" } ], "metadata": {}, "name": "Daily order report", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "0 9 * * 1-5", "timezone": "America/Los_Angeles", "type": "cron", "last_run_at": "2026-03-16T16:00:09Z", "upcoming_runs_at": [ "2026-03-17T16:00:00Z", "2026-03-18T16:00:00Z" ] }, "status": "active", "type": "deployment", "updated_at": "2026-03-15T10:00:00Z", "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ], "budget": { "max_list_cost": { "amount": "2500", "currency": "USD" }, "type": "limit" } } ``` ## Beta › Deployment Runs ### List Deployment Runs **GET** `/v1/deployment_runs` List Deployment Runs #### Query parameters - `"created_at[gt]": optional string` Return runs created strictly after this time (exclusive). format: date-time - `"created_at[gte]": optional string` Return runs created at or after this time (inclusive). format: date-time - `"created_at[lt]": optional string` Return runs created strictly before this time (exclusive). format: date-time - `"created_at[lte]": optional string` Return runs created at or before this time (inclusive). format: date-time - `deployment_id: optional string` Filter to a specific deployment. Omit to list across all deployments in the workspace. Filtering by a non-existent `deployment_id` returns 200 with empty data. - `has_error: optional boolean` Filter: true for runs with non-null `error`, false for runs with non-null `session_id`. Omit for all. - `limit: optional number` Maximum results per page. Default 20, maximum 1000. format: int32 - `page: optional string` Opaque pagination cursor. Pass `next_page` from the previous response. Invalid or expired cursors return 400. - `trigger_type: optional BetaManagedAgentsTriggerType` Filter runs by what triggered them. Omit to return all runs. - `"schedule"` The run was fired by the deployment's cron schedule. - `"manual"` The run was started manually by creating a session directly against the deployment. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaManagedAgentsDeploymentRun` List of deployment runs. - `type: "deployment_run"` - `id: string` Unique identifier for this run (`drun_...`). - `agent: BetaManagedAgentsAgentReference` Snapshot of the agent at fire time. Always fully resolved — deployments pin agent + version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `created_at: string` Time this run record was persisted. format: date-time - `deployment_id: string` ID of the deployment that produced this run. - `error: BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null` Populated on creation failure. Null on success. Exactly one of `session_id` or `error` is non-null. - `BetaManagedAgentsEnvironmentArchivedRunError object` The deployment's environment was archived. - `type: "environment_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsAgentArchivedRunError object` The deployment's agent was archived. - `type: "agent_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsEnvironmentNotFoundRunError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsVaultNotFoundRunError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsVaultArchivedRunError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsFileNotFoundRunError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsMemoryStoreArchivedRunError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSkillNotFoundRunError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSessionResourceNotFoundRunError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsWorkspaceArchivedRunError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsOrganizationDisabledRunError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSessionRateLimitedRunError object` Session creation was rejected due to rate limiting. The schedule keeps firing; subsequent runs may succeed. - `type: "session_rate_limited_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSessionCreationRejectedRunError object` The session create request was rejected with a non-retryable validation error. - `type: "session_creation_rejected_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsUnknownRunError object` An unknown or unexpected error caused the run to fail. A fallback variant; clients that do not recognize a new error type can match on message alone. - `type: "unknown_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSelfHostedResourcesUnsupportedRunError object` The deployment configures resources, but its environment is self-hosted and cannot mount them. - `type: "self_hosted_resources_unsupported_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsMCPEgressBlockedRunError object` An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `type: "mcp_egress_blocked_error"` - `message: string` Human-readable error description. - `session_id: string or null` Populated on success. Null on creation failure. Exactly one of `session_id` or `error` is non-null. - `trigger_context: BetaManagedAgentsTriggerContext` What triggered this run and trigger-specific metadata. - `BetaManagedAgentsScheduleTriggerContext object` The run was fired by the deployment's cron schedule. - `type: "schedule"` - `scheduled_at: string` The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair. format: date-time - `BetaManagedAgentsManualTriggerContext object` The run was started manually by creating a session directly against the deployment. - `type: "manual"` - `next_page: optional string or null` Opaque cursor for the next page. Null when no more results. #### Example ```bash curl https://api.anthropic.com/v1/deployment_runs \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "id", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 }, "created_at": "2019-12-27T18:11:19.117Z", "deployment_id": "deployment_id", "error": { "message": "message", "type": "environment_archived_error" }, "session_id": "session_id", "trigger_context": { "scheduled_at": "2019-12-27T18:11:19.117Z", "type": "schedule" }, "type": "deployment_run" } ], "next_page": "next_page" } ``` ### Get Deployment Run **GET** `/v1/deployment_runs/{deployment_run_id}` Get Deployment Run #### Path parameters - `deployment_run_id: string` Unique identifier of the deployment run. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsDeploymentRun object` A persistent, append-only record of a single deployment execution. Records session creation success or failure — no session lifecycle tracking. - `type: "deployment_run"` - `id: string` Unique identifier for this run (`drun_...`). - `agent: BetaManagedAgentsAgentReference` Snapshot of the agent at fire time. Always fully resolved — deployments pin agent + version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `created_at: string` Time this run record was persisted. format: date-time - `deployment_id: string` ID of the deployment that produced this run. - `error: BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null` Populated on creation failure. Null on success. Exactly one of `session_id` or `error` is non-null. - `BetaManagedAgentsEnvironmentArchivedRunError object` The deployment's environment was archived. - `type: "environment_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsAgentArchivedRunError object` The deployment's agent was archived. - `type: "agent_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsEnvironmentNotFoundRunError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsVaultNotFoundRunError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsVaultArchivedRunError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsFileNotFoundRunError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsMemoryStoreArchivedRunError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSkillNotFoundRunError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSessionResourceNotFoundRunError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsWorkspaceArchivedRunError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsOrganizationDisabledRunError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSessionRateLimitedRunError object` Session creation was rejected due to rate limiting. The schedule keeps firing; subsequent runs may succeed. - `type: "session_rate_limited_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSessionCreationRejectedRunError object` The session create request was rejected with a non-retryable validation error. - `type: "session_creation_rejected_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsUnknownRunError object` An unknown or unexpected error caused the run to fail. A fallback variant; clients that do not recognize a new error type can match on message alone. - `type: "unknown_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsSelfHostedResourcesUnsupportedRunError object` The deployment configures resources, but its environment is self-hosted and cannot mount them. - `type: "self_hosted_resources_unsupported_error"` - `message: string` Human-readable error description. - `BetaManagedAgentsMCPEgressBlockedRunError object` An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `type: "mcp_egress_blocked_error"` - `message: string` Human-readable error description. - `session_id: string or null` Populated on success. Null on creation failure. Exactly one of `session_id` or `error` is non-null. - `trigger_context: BetaManagedAgentsTriggerContext` What triggered this run and trigger-specific metadata. - `BetaManagedAgentsScheduleTriggerContext object` The run was fired by the deployment's cron schedule. - `type: "schedule"` - `scheduled_at: string` The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair. format: date-time - `BetaManagedAgentsManualTriggerContext object` The run was started manually by creating a session directly against the deployment. - `type: "manual"` #### Example ```bash curl https://api.anthropic.com/v1/deployment_runs/$DEPLOYMENT_RUN_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 }, "created_at": "2019-12-27T18:11:19.117Z", "deployment_id": "deployment_id", "error": { "message": "message", "type": "environment_archived_error" }, "session_id": "session_id", "trigger_context": { "scheduled_at": "2019-12-27T18:11:19.117Z", "type": "schedule" }, "type": "deployment_run" } ``` ## Beta › Vaults ### Create Vault **POST** `/v1/vaults` Create Vault #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `display_name: string` Human-readable name for the vault. 1-255 characters. minLength: 1, maxLength: 255 - `metadata: optional map[string]` Arbitrary key-value metadata to attach to the vault. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. #### Returns - `BetaManagedAgentsVault object` A vault that stores credentials for use by agents during sessions. - `type: "vault"` - `id: string` Unique identifier for the vault. - `archived_at: string or null` When the vault was archived. Null if not archived. format: date-time - `created_at: string` A timestamp in RFC 3339 format format: date-time - `display_name: string` Human-readable name for the vault. - `metadata: map[string]` Arbitrary key-value metadata attached to the vault. - `updated_at: string` A timestamp in RFC 3339 format format: date-time #### Example ```bash curl https://api.anthropic.com/v1/vaults \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "display_name": "Example vault", "metadata": { "environment": "production" } }' ``` ##### Response (200) ```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 **GET** `/v1/vaults` List Vaults #### Query parameters - `include_archived: optional boolean` Whether to include archived vaults in the results. - `limit: optional number` Maximum number of vaults to return per page. Defaults to 20, maximum 100. format: int32 - `page: optional string` Opaque pagination token from a previous `list_vaults` response. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: optional array of BetaManagedAgentsVault` List of vaults. - `type: "vault"` - `id: string` Unique identifier for the vault. - `archived_at: string or null` When the vault was archived. Null if not archived. format: date-time - `created_at: string` A timestamp in RFC 3339 format format: date-time - `display_name: string` Human-readable name for the vault. - `metadata: map[string]` Arbitrary key-value metadata attached to the vault. - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `next_page: optional string or null` Pagination token for the next page, or null if no more results. #### Example ```bash curl https://api.anthropic.com/v1/vaults \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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 **GET** `/v1/vaults/{vault_id}` Get Vault #### Path parameters - `vault_id: string` Unique identifier of the vault to retrieve. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsVault object` A vault that stores credentials for use by agents during sessions. - `type: "vault"` - `id: string` Unique identifier for the vault. - `archived_at: string or null` When the vault was archived. Null if not archived. format: date-time - `created_at: string` A timestamp in RFC 3339 format format: date-time - `display_name: string` Human-readable name for the vault. - `metadata: map[string]` Arbitrary key-value metadata attached to the vault. - `updated_at: string` A timestamp in RFC 3339 format format: date-time #### Example ```bash curl https://api.anthropic.com/v1/vaults/$VAULT_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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 **POST** `/v1/vaults/{vault_id}` Update Vault #### Path parameters - `vault_id: string` Unique identifier of the vault to update. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `display_name: optional string or null` Updated human-readable name for the vault. 1-255 characters. minLength: 1, maxLength: 255 - `metadata: optional map[string] or null` Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omitted keys are preserved. #### Returns - `BetaManagedAgentsVault object` A vault that stores credentials for use by agents during sessions. - `type: "vault"` - `id: string` Unique identifier for the vault. - `archived_at: string or null` When the vault was archived. Null if not archived. format: date-time - `created_at: string` A timestamp in RFC 3339 format format: date-time - `display_name: string` Human-readable name for the vault. - `metadata: map[string]` Arbitrary key-value metadata attached to the vault. - `updated_at: string` A timestamp in RFC 3339 format format: date-time #### Example ```bash curl https://api.anthropic.com/v1/vaults/$VAULT_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "display_name": "Example vault", "metadata": { "environment": "production" } }' ``` ##### Response (200) ```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 **DELETE** `/v1/vaults/{vault_id}` Delete Vault #### Path parameters - `vault_id: string` Unique identifier of the vault to delete. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsDeletedVault object` Confirmation of a deleted vault. - `type: "vault_deleted"` - `id: string` Unique identifier of the deleted vault. #### Example ```bash curl https://api.anthropic.com/v1/vaults/$VAULT_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "type": "vault_deleted" } ``` ### Archive Vault **POST** `/v1/vaults/{vault_id}/archive` Archive Vault #### Path parameters - `vault_id: string` Unique identifier of the vault to archive. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsVault object` A vault that stores credentials for use by agents during sessions. - `type: "vault"` - `id: string` Unique identifier for the vault. - `archived_at: string or null` When the vault was archived. Null if not archived. format: date-time - `created_at: string` A timestamp in RFC 3339 format format: date-time - `display_name: string` Human-readable name for the vault. - `metadata: map[string]` Arbitrary key-value metadata attached to the vault. - `updated_at: string` A timestamp in RFC 3339 format format: date-time #### Example ```bash curl https://api.anthropic.com/v1/vaults/$VAULT_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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" } ``` ## Beta › Vaults › Credentials ### Create Credential **POST** `/v1/vaults/{vault_id}/credentials` Create Credential #### Path parameters - `vault_id: string` Identifier of the vault to create the credential in. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `auth: BetaManagedAgentsMCPOAuthCreateParams or BetaManagedAgentsStaticBearerCreateParams or BetaManagedAgentsEnvironmentVariableCreateParams` Authentication configuration for the credential. - `BetaManagedAgentsMCPOAuthCreateParams object` Parameters for creating an MCP OAuth credential. - `type: "mcp_oauth"` - `access_token: string` OAuth access token. minLength: 1, maxLength: 8192 - `mcp_server_url: string` URL of the MCP server this credential authenticates against. minLength: 1, maxLength: 2047 - `expires_at: optional string or null` A timestamp in RFC 3339 format format: date-time - `refresh: optional BetaManagedAgentsMCPOAuthRefreshParams or null` Refresh token configuration, if the credential supports token refresh. - `client_id: string` OAuth client ID. minLength: 1, maxLength: 1024 - `refresh_token: string` OAuth refresh token. minLength: 1, maxLength: 8192 - `token_endpoint: string` Token endpoint URL used to refresh the access token. minLength: 1, maxLength: 2047 - `token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneParam or BetaManagedAgentsTokenEndpointAuthBasicParam or BetaManagedAgentsTokenEndpointAuthPostParam` - `BetaManagedAgentsTokenEndpointAuthNoneParam object` Token endpoint requires no client authentication. - `type: "none"` - `BetaManagedAgentsTokenEndpointAuthBasicParam object` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `client_secret: string` OAuth client secret. minLength: 1, maxLength: 512 - `BetaManagedAgentsTokenEndpointAuthPostParam object` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `client_secret: string` OAuth client secret. minLength: 1, maxLength: 512 - `resource: optional string or null` OAuth resource indicator. minLength: 1, maxLength: 2047 - `scope: optional string or null` OAuth scope for the refresh request. minLength: 1, maxLength: 8192 - `BetaManagedAgentsStaticBearerCreateParams object` Parameters for creating a static bearer token credential. - `type: "static_bearer"` - `token: string` Static bearer token value. minLength: 1, maxLength: 8192 - `mcp_server_url: string` URL of the MCP server this credential authenticates against. minLength: 1, maxLength: 2047 - `BetaManagedAgentsEnvironmentVariableCreateParams object` Parameters for creating an environment variable credential. - `type: "environment_variable"` - `networking: BetaManagedAgentsCredentialNetworkingParams` Outbound hosts the secret value is substituted on. - `BetaManagedAgentsUnrestrictedCredentialNetworkingParams object` Substitute the secret on any host the session's Environment network policy permits egress to. The Environment's network policy is the only boundary on where the secret can reach. - `type: "unrestricted"` - `BetaManagedAgentsLimitedCredentialNetworkingParams object` Substitute the secret only on requests to the listed hosts. - `type: "limited"` - `allowed_hosts: array of string` Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries. - `secret_name: string` Name of the environment variable. Immutable after create. minLength: 1, maxLength: 255 - `secret_value: string` Secret value. Write-only; never returned in responses. minLength: 1, maxLength: 4096 - `injection_location: optional BetaManagedAgentsInjectionLocationParams` Where in the outbound request the secret value may be substituted. - `body: optional boolean` Substitute when the placeholder appears in the request body. - `header: optional boolean` Substitute when the placeholder appears in a request header value. - `display_name: optional string or null` Human-readable name for the credential. Up to 255 characters. maxLength: 255 - `metadata: optional map[string]` Arbitrary key-value metadata to attach to the credential. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. #### Returns - `BetaManagedAgentsCredential object` A credential stored in a vault. Sensitive fields are never returned in responses. - `type: "vault_credential"` - `id: string` Unique identifier for the credential. - `archived_at: string or null` When the credential was archived. Null if not archived. format: date-time - `auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse or BetaManagedAgentsEnvironmentVariableAuthResponse` Authentication configuration for this credential. - `BetaManagedAgentsMCPOAuthAuthResponse object` OAuth credential details for an MCP server. - `type: "mcp_oauth"` - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `expires_at: optional string or null` A timestamp in RFC 3339 format format: date-time - `refresh: optional BetaManagedAgentsMCPOAuthRefreshResponse or null` Refresh token configuration, if the credential supports token refresh. - `client_id: string` OAuth client ID. - `token_endpoint: string` Token endpoint URL used to refresh the access token. - `token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneResponse or BetaManagedAgentsTokenEndpointAuthBasicResponse or BetaManagedAgentsTokenEndpointAuthPostResponse` - `BetaManagedAgentsTokenEndpointAuthNoneResponse object` Token endpoint requires no client authentication. - `type: "none"` - `BetaManagedAgentsTokenEndpointAuthBasicResponse object` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `BetaManagedAgentsTokenEndpointAuthPostResponse object` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `resource: optional string or null` OAuth resource indicator. - `scope: optional string or null` OAuth scope for the refresh request. - `BetaManagedAgentsStaticBearerAuthResponse object` Static bearer token credential details for an MCP server. - `type: "static_bearer"` - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `BetaManagedAgentsEnvironmentVariableAuthResponse object` Environment variable credential details. The secret value is never returned. - `type: "environment_variable"` - `injection_location: BetaManagedAgentsInjectionLocationResponse` Where in the outbound request the secret value is substituted. - `body: boolean` Whether the placeholder is substituted in the request body. - `header: boolean` Whether the placeholder is substituted in request header values. - `networking: BetaManagedAgentsUnrestrictedCredentialNetworkingResponse or BetaManagedAgentsLimitedCredentialNetworkingResponse` Outbound hosts the secret value is substituted on. - `BetaManagedAgentsUnrestrictedCredentialNetworkingResponse object` The secret is substituted on any host the session's Environment network policy permits egress to. - `type: "unrestricted"` - `BetaManagedAgentsLimitedCredentialNetworkingResponse object` The secret is substituted only on requests to the listed hosts. - `type: "limited"` - `allowed_hosts: array of string` Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself. - `secret_name: string` Name of the environment variable. - `created_at: string` A timestamp in RFC 3339 format format: date-time - `metadata: map[string]` Arbitrary key-value metadata attached to the credential. - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `vault_id: string` Identifier of the vault this credential belongs to. - `display_name: optional string or null` Human-readable name for the credential. #### Example ```bash curl https://api.anthropic.com/v1/vaults/$VAULT_ID/credentials \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "auth": { "token": "bearer_exampletoken", "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "display_name": "Example credential", "metadata": { "environment": "production" } }' ``` ##### Response (200) ```json { "id": "vcrd_011CZkZEMt8gZan2iYPQfSkw", "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 **GET** `/v1/vaults/{vault_id}/credentials` List Credentials #### Path parameters - `vault_id: string` Identifier of the vault to list credentials for. #### Query parameters - `include_archived: optional boolean` Whether to include archived credentials in the results. - `limit: optional number` Maximum number of credentials to return per page. Defaults to 20, maximum 100. format: int32 - `page: optional string` Opaque pagination token from a previous `list_credentials` response. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: optional array of BetaManagedAgentsCredential` List of credentials. - `type: "vault_credential"` - `id: string` Unique identifier for the credential. - `archived_at: string or null` When the credential was archived. Null if not archived. format: date-time - `auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse or BetaManagedAgentsEnvironmentVariableAuthResponse` Authentication configuration for this credential. - `BetaManagedAgentsMCPOAuthAuthResponse object` OAuth credential details for an MCP server. - `type: "mcp_oauth"` - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `expires_at: optional string or null` A timestamp in RFC 3339 format format: date-time - `refresh: optional BetaManagedAgentsMCPOAuthRefreshResponse or null` Refresh token configuration, if the credential supports token refresh. - `client_id: string` OAuth client ID. - `token_endpoint: string` Token endpoint URL used to refresh the access token. - `token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneResponse or BetaManagedAgentsTokenEndpointAuthBasicResponse or BetaManagedAgentsTokenEndpointAuthPostResponse` - `BetaManagedAgentsTokenEndpointAuthNoneResponse object` Token endpoint requires no client authentication. - `type: "none"` - `BetaManagedAgentsTokenEndpointAuthBasicResponse object` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `BetaManagedAgentsTokenEndpointAuthPostResponse object` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `resource: optional string or null` OAuth resource indicator. - `scope: optional string or null` OAuth scope for the refresh request. - `BetaManagedAgentsStaticBearerAuthResponse object` Static bearer token credential details for an MCP server. - `type: "static_bearer"` - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `BetaManagedAgentsEnvironmentVariableAuthResponse object` Environment variable credential details. The secret value is never returned. - `type: "environment_variable"` - `injection_location: BetaManagedAgentsInjectionLocationResponse` Where in the outbound request the secret value is substituted. - `body: boolean` Whether the placeholder is substituted in the request body. - `header: boolean` Whether the placeholder is substituted in request header values. - `networking: BetaManagedAgentsUnrestrictedCredentialNetworkingResponse or BetaManagedAgentsLimitedCredentialNetworkingResponse` Outbound hosts the secret value is substituted on. - `BetaManagedAgentsUnrestrictedCredentialNetworkingResponse object` The secret is substituted on any host the session's Environment network policy permits egress to. - `type: "unrestricted"` - `BetaManagedAgentsLimitedCredentialNetworkingResponse object` The secret is substituted only on requests to the listed hosts. - `type: "limited"` - `allowed_hosts: array of string` Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself. - `secret_name: string` Name of the environment variable. - `created_at: string` A timestamp in RFC 3339 format format: date-time - `metadata: map[string]` Arbitrary key-value metadata attached to the credential. - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `vault_id: string` Identifier of the vault this credential belongs to. - `display_name: optional string or null` Human-readable name for the credential. - `next_page: optional string or null` Pagination token for the next page, or null if no more results. #### Example ```bash curl https://api.anthropic.com/v1/vaults/$VAULT_ID/credentials \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "vcrd_011CZkZEMt8gZan2iYPQfSkw", "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 **GET** `/v1/vaults/{vault_id}/credentials/{credential_id}` Get Credential #### Path parameters - `vault_id: string` Identifier of the vault containing the credential. - `credential_id: string` Unique identifier of the credential to retrieve. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsCredential object` A credential stored in a vault. Sensitive fields are never returned in responses. - `type: "vault_credential"` - `id: string` Unique identifier for the credential. - `archived_at: string or null` When the credential was archived. Null if not archived. format: date-time - `auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse or BetaManagedAgentsEnvironmentVariableAuthResponse` Authentication configuration for this credential. - `BetaManagedAgentsMCPOAuthAuthResponse object` OAuth credential details for an MCP server. - `type: "mcp_oauth"` - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `expires_at: optional string or null` A timestamp in RFC 3339 format format: date-time - `refresh: optional BetaManagedAgentsMCPOAuthRefreshResponse or null` Refresh token configuration, if the credential supports token refresh. - `client_id: string` OAuth client ID. - `token_endpoint: string` Token endpoint URL used to refresh the access token. - `token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneResponse or BetaManagedAgentsTokenEndpointAuthBasicResponse or BetaManagedAgentsTokenEndpointAuthPostResponse` - `BetaManagedAgentsTokenEndpointAuthNoneResponse object` Token endpoint requires no client authentication. - `type: "none"` - `BetaManagedAgentsTokenEndpointAuthBasicResponse object` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `BetaManagedAgentsTokenEndpointAuthPostResponse object` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `resource: optional string or null` OAuth resource indicator. - `scope: optional string or null` OAuth scope for the refresh request. - `BetaManagedAgentsStaticBearerAuthResponse object` Static bearer token credential details for an MCP server. - `type: "static_bearer"` - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `BetaManagedAgentsEnvironmentVariableAuthResponse object` Environment variable credential details. The secret value is never returned. - `type: "environment_variable"` - `injection_location: BetaManagedAgentsInjectionLocationResponse` Where in the outbound request the secret value is substituted. - `body: boolean` Whether the placeholder is substituted in the request body. - `header: boolean` Whether the placeholder is substituted in request header values. - `networking: BetaManagedAgentsUnrestrictedCredentialNetworkingResponse or BetaManagedAgentsLimitedCredentialNetworkingResponse` Outbound hosts the secret value is substituted on. - `BetaManagedAgentsUnrestrictedCredentialNetworkingResponse object` The secret is substituted on any host the session's Environment network policy permits egress to. - `type: "unrestricted"` - `BetaManagedAgentsLimitedCredentialNetworkingResponse object` The secret is substituted only on requests to the listed hosts. - `type: "limited"` - `allowed_hosts: array of string` Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself. - `secret_name: string` Name of the environment variable. - `created_at: string` A timestamp in RFC 3339 format format: date-time - `metadata: map[string]` Arbitrary key-value metadata attached to the credential. - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `vault_id: string` Identifier of the vault this credential belongs to. - `display_name: optional string or null` Human-readable name for the credential. #### Example ```bash curl https://api.anthropic.com/v1/vaults/$VAULT_ID/credentials/$CREDENTIAL_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "vcrd_011CZkZEMt8gZan2iYPQfSkw", "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 **POST** `/v1/vaults/{vault_id}/credentials/{credential_id}` Update Credential #### Path parameters - `vault_id: string` Identifier of the vault containing the credential. - `credential_id: string` Unique identifier of the credential to update. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `auth: optional BetaManagedAgentsMCPOAuthUpdateParams or BetaManagedAgentsStaticBearerUpdateParams or BetaManagedAgentsEnvironmentVariableUpdateParams` Updated authentication configuration. The `type` is immutable; the variant sent must match the stored credential's type. - `BetaManagedAgentsMCPOAuthUpdateParams object` Parameters for updating an MCP OAuth credential. The `mcp_server_url` is immutable. - `type: "mcp_oauth"` - `access_token: optional string or null` Updated OAuth access token. minLength: 1, maxLength: 8192 - `expires_at: optional string or null` A timestamp in RFC 3339 format format: date-time - `refresh: optional BetaManagedAgentsMCPOAuthRefreshUpdateParams or null` Updated refresh token configuration. - `refresh_token: optional string or null` Updated OAuth refresh token. minLength: 1, maxLength: 8192 - `scope: optional string or null` Updated OAuth scope for the refresh request. maxLength: 8192 - `token_endpoint_auth: optional BetaManagedAgentsTokenEndpointAuthBasicUpdateParam or BetaManagedAgentsTokenEndpointAuthPostUpdateParam` - `BetaManagedAgentsTokenEndpointAuthBasicUpdateParam object` Updated HTTP Basic authentication parameters for the token endpoint. - `type: "client_secret_basic"` - `client_secret: optional string or null` Updated OAuth client secret. minLength: 1, maxLength: 512 - `BetaManagedAgentsTokenEndpointAuthPostUpdateParam object` Updated POST body authentication parameters for the token endpoint. - `type: "client_secret_post"` - `client_secret: optional string or null` Updated OAuth client secret. minLength: 1, maxLength: 512 - `BetaManagedAgentsStaticBearerUpdateParams object` Parameters for updating a static bearer token credential. The `mcp_server_url` is immutable. - `type: "static_bearer"` - `token: optional string or null` Updated static bearer token value. minLength: 1, maxLength: 8192 - `BetaManagedAgentsEnvironmentVariableUpdateParams object` Parameters for updating an environment variable credential. `secret_name` is immutable. - `type: "environment_variable"` - `injection_location: optional BetaManagedAgentsInjectionLocationUpdateParams` Updated injection location. - `body: optional boolean` Substitute when the placeholder appears in the request body. - `header: optional boolean` Substitute when the placeholder appears in a request header value. - `networking: optional BetaManagedAgentsCredentialNetworkingParams or null` Updated networking scope. Full replacement. - `BetaManagedAgentsUnrestrictedCredentialNetworkingParams object` Substitute the secret on any host the session's Environment network policy permits egress to. The Environment's network policy is the only boundary on where the secret can reach. - `type: "unrestricted"` - `BetaManagedAgentsLimitedCredentialNetworkingParams object` Substitute the secret only on requests to the listed hosts. - `type: "limited"` - `allowed_hosts: array of string` Hostnames on which the secret will be substituted. Each entry is a bare hostname (`api.example.com`), an IPv4 address (`192.0.2.1`), or a `*.`-prefixed wildcard (`*.example.com`). URLs, ports, paths, and IPv6 addresses are not accepted. At most 16 entries. - `secret_value: optional string or null` Updated secret value. minLength: 1, maxLength: 4096 - `display_name: optional string or null` Updated human-readable name for the credential. 1-255 characters. minLength: 1, maxLength: 255 - `metadata: optional map[string] or null` Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omitted keys are preserved. #### Returns - `BetaManagedAgentsCredential object` A credential stored in a vault. Sensitive fields are never returned in responses. - `type: "vault_credential"` - `id: string` Unique identifier for the credential. - `archived_at: string or null` When the credential was archived. Null if not archived. format: date-time - `auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse or BetaManagedAgentsEnvironmentVariableAuthResponse` Authentication configuration for this credential. - `BetaManagedAgentsMCPOAuthAuthResponse object` OAuth credential details for an MCP server. - `type: "mcp_oauth"` - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `expires_at: optional string or null` A timestamp in RFC 3339 format format: date-time - `refresh: optional BetaManagedAgentsMCPOAuthRefreshResponse or null` Refresh token configuration, if the credential supports token refresh. - `client_id: string` OAuth client ID. - `token_endpoint: string` Token endpoint URL used to refresh the access token. - `token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneResponse or BetaManagedAgentsTokenEndpointAuthBasicResponse or BetaManagedAgentsTokenEndpointAuthPostResponse` - `BetaManagedAgentsTokenEndpointAuthNoneResponse object` Token endpoint requires no client authentication. - `type: "none"` - `BetaManagedAgentsTokenEndpointAuthBasicResponse object` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `BetaManagedAgentsTokenEndpointAuthPostResponse object` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `resource: optional string or null` OAuth resource indicator. - `scope: optional string or null` OAuth scope for the refresh request. - `BetaManagedAgentsStaticBearerAuthResponse object` Static bearer token credential details for an MCP server. - `type: "static_bearer"` - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `BetaManagedAgentsEnvironmentVariableAuthResponse object` Environment variable credential details. The secret value is never returned. - `type: "environment_variable"` - `injection_location: BetaManagedAgentsInjectionLocationResponse` Where in the outbound request the secret value is substituted. - `body: boolean` Whether the placeholder is substituted in the request body. - `header: boolean` Whether the placeholder is substituted in request header values. - `networking: BetaManagedAgentsUnrestrictedCredentialNetworkingResponse or BetaManagedAgentsLimitedCredentialNetworkingResponse` Outbound hosts the secret value is substituted on. - `BetaManagedAgentsUnrestrictedCredentialNetworkingResponse object` The secret is substituted on any host the session's Environment network policy permits egress to. - `type: "unrestricted"` - `BetaManagedAgentsLimitedCredentialNetworkingResponse object` The secret is substituted only on requests to the listed hosts. - `type: "limited"` - `allowed_hosts: array of string` Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself. - `secret_name: string` Name of the environment variable. - `created_at: string` A timestamp in RFC 3339 format format: date-time - `metadata: map[string]` Arbitrary key-value metadata attached to the credential. - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `vault_id: string` Identifier of the vault this credential belongs to. - `display_name: optional string or null` Human-readable name for the credential. #### Example ```bash curl https://api.anthropic.com/v1/vaults/$VAULT_ID/credentials/$CREDENTIAL_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "display_name": "Example credential", "metadata": { "environment": "production" } }' ``` ##### Response (200) ```json { "id": "vcrd_011CZkZEMt8gZan2iYPQfSkw", "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 **DELETE** `/v1/vaults/{vault_id}/credentials/{credential_id}` Delete Credential #### Path parameters - `vault_id: string` Identifier of the vault containing the credential. - `credential_id: string` Unique identifier of the credential to delete. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsDeletedCredential object` Confirmation of a deleted credential. - `type: "vault_credential_deleted"` - `id: string` Unique identifier of the deleted credential. #### Example ```bash curl https://api.anthropic.com/v1/vaults/$VAULT_ID/credentials/$CREDENTIAL_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "vcrd_011CZkZEMt8gZan2iYPQfSkw", "type": "vault_credential_deleted" } ``` ### Archive Credential **POST** `/v1/vaults/{vault_id}/credentials/{credential_id}/archive` Archive Credential #### Path parameters - `vault_id: string` Identifier of the vault containing the credential. - `credential_id: string` Unique identifier of the credential to archive. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsCredential object` A credential stored in a vault. Sensitive fields are never returned in responses. - `type: "vault_credential"` - `id: string` Unique identifier for the credential. - `archived_at: string or null` When the credential was archived. Null if not archived. format: date-time - `auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse or BetaManagedAgentsEnvironmentVariableAuthResponse` Authentication configuration for this credential. - `BetaManagedAgentsMCPOAuthAuthResponse object` OAuth credential details for an MCP server. - `type: "mcp_oauth"` - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `expires_at: optional string or null` A timestamp in RFC 3339 format format: date-time - `refresh: optional BetaManagedAgentsMCPOAuthRefreshResponse or null` Refresh token configuration, if the credential supports token refresh. - `client_id: string` OAuth client ID. - `token_endpoint: string` Token endpoint URL used to refresh the access token. - `token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneResponse or BetaManagedAgentsTokenEndpointAuthBasicResponse or BetaManagedAgentsTokenEndpointAuthPostResponse` - `BetaManagedAgentsTokenEndpointAuthNoneResponse object` Token endpoint requires no client authentication. - `type: "none"` - `BetaManagedAgentsTokenEndpointAuthBasicResponse object` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `BetaManagedAgentsTokenEndpointAuthPostResponse object` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `resource: optional string or null` OAuth resource indicator. - `scope: optional string or null` OAuth scope for the refresh request. - `BetaManagedAgentsStaticBearerAuthResponse object` Static bearer token credential details for an MCP server. - `type: "static_bearer"` - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `BetaManagedAgentsEnvironmentVariableAuthResponse object` Environment variable credential details. The secret value is never returned. - `type: "environment_variable"` - `injection_location: BetaManagedAgentsInjectionLocationResponse` Where in the outbound request the secret value is substituted. - `body: boolean` Whether the placeholder is substituted in the request body. - `header: boolean` Whether the placeholder is substituted in request header values. - `networking: BetaManagedAgentsUnrestrictedCredentialNetworkingResponse or BetaManagedAgentsLimitedCredentialNetworkingResponse` Outbound hosts the secret value is substituted on. - `BetaManagedAgentsUnrestrictedCredentialNetworkingResponse object` The secret is substituted on any host the session's Environment network policy permits egress to. - `type: "unrestricted"` - `BetaManagedAgentsLimitedCredentialNetworkingResponse object` The secret is substituted only on requests to the listed hosts. - `type: "limited"` - `allowed_hosts: array of string` Hostnames on which the secret will be substituted. An entry matches the request host exactly; a `*.`-prefixed entry matches any subdomain of the named domain but not the domain itself. - `secret_name: string` Name of the environment variable. - `created_at: string` A timestamp in RFC 3339 format format: date-time - `metadata: map[string]` Arbitrary key-value metadata attached to the credential. - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `vault_id: string` Identifier of the vault this credential belongs to. - `display_name: optional string or null` Human-readable name for the credential. #### Example ```bash curl https://api.anthropic.com/v1/vaults/$VAULT_ID/credentials/$CREDENTIAL_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "vcrd_011CZkZEMt8gZan2iYPQfSkw", "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 **POST** `/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate` Validate Credential #### Path parameters - `vault_id: string` Identifier of the vault containing the credential. - `credential_id: string` Unique identifier of the credential to validate. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsCredentialValidation object` Result of live-probing a credential against its configured MCP server. - `type: "vault_credential_validation"` - `credential_id: string` Unique identifier of the credential that was validated. - `has_refresh_token: boolean` Whether the credential has a refresh token configured. - `mcp_probe: BetaManagedAgentsMCPProbe or null` Details of the failing MCP probe step. Null when the probe succeeded. - `http_response: BetaManagedAgentsRefreshHTTPResponse or null` The captured HTTP error response. Null when no HTTP response was received (timeout, DNS, TLS). - `body: string` Response body. May be truncated and has sensitive values scrubbed. - `body_truncated: boolean` Whether `body` was truncated. - `content_type: string` Value of the `Content-Type` response header. - `status_code: number` HTTP status code. format: int32 - `method: string` The MCP method that failed (for example `initialize` or `tools/list`). - `refresh: BetaManagedAgentsRefreshObject or null` Details of the refresh-token exchange attempted on a 401. Null when no refresh was attempted. - `http_response: BetaManagedAgentsRefreshHTTPResponse or null` The captured HTTP error response from the token endpoint. Populated only when `status` is `failed`. - `status: "succeeded" or "failed" or "connect_error" or "no_refresh_token"` Outcome of the refresh attempt. - `"succeeded"` The token endpoint returned a new access token. - `"failed"` The token endpoint returned an error response. See `http_response` for detail. - `"connect_error"` The token endpoint could not be reached (DNS, TLS, or connection error). - `"no_refresh_token"` No refresh token is stored for the credential, so no exchange was attempted. - `status: BetaManagedAgentsCredentialValidationStatus` Overall verdict of the validation probe. - `"valid"` The credential successfully authenticated against its MCP server. - `"invalid"` The probe reached the MCP server and was rejected, and a refresh (if attempted) did not recover it. - `"unknown"` The probe could not determine validity — for example, a transport error or a successful refresh that was not re-probed. - `validated_at: string` When the validation probe was performed. format: date-time - `vault_id: string` Identifier of the vault containing the credential. #### Example ```bash curl https://api.anthropic.com/v1/vaults/$VAULT_ID/credentials/$CREDENTIAL_ID/mcp_oauth_validate \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "credential_id": "vcrd_011CZkZEMt8gZan2iYPQfSkw", "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" } ``` ## Beta › Memory Stores ### Create a memory store **POST** `/v1/memory_stores` Create a memory store #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `agent-memory-2026-07-22` or `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `name: string` 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. minLength: 1, maxLength: 255 - `description: optional 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. maxLength: 1024 - `metadata: optional map[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. Not visible to the agent. #### Returns - `BetaManagedAgentsMemoryStore object` 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. - `type: "memory_store"` - `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. - `archived_at: string or null` Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions. format: date-time - `created_at: string` Timestamp when the store was created. format: date-time - `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]` 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. - `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. - `updated_at: string` Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this. format: date-time #### Example ```bash curl https://api.anthropic.com/v1/memory_stores \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: agent-memory-2026-07-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "name": "x" }' ``` ##### Response (200) ```json { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" }, "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ### List memory stores **GET** `/v1/memory_stores` List memory stores #### Query parameters - `"created_at[gte]": optional string` Return only stores whose `created_at` is at or after this time (inclusive). Sent on the wire as `created_at[gte]`. format: date-time - `"created_at[lte]": optional string` Return only stores whose `created_at` is at or before this time (inclusive). Sent on the wire as `created_at[lte]`. format: date-time - `include_archived: optional boolean` When `true`, archived stores are included in the results. Defaults to `false` (archived stores are excluded). - `limit: optional number` Maximum number of stores to return per page. Must be between 1 and 100. Defaults to 20 when omitted. format: int32 - `page: optional string` 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. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `agent-memory-2026-07-22` or `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: optional array of BetaManagedAgentsMemoryStore` Memory stores on this page, newest first. Empty when there are no stores matching the filters. - `type: "memory_store"` - `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. - `archived_at: string or null` Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions. format: date-time - `created_at: string` Timestamp when the store was created. format: date-time - `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]` 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. - `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. - `updated_at: string` Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this. format: date-time - `next_page: optional string or null` Opaque cursor for the next page (a `page_...` value). Pass as `page` on the next request. `null` when there are no more results. #### Example ```bash curl https://api.anthropic.com/v1/memory_stores \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: agent-memory-2026-07-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "memstore_01Wf3kQ8tZxB2mVr7HcJ4aNd", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "Per-user preferences and project context.", "metadata": {}, "name": "User Preferences", "type": "memory_store", "updated_at": "2026-03-15T10:00:00Z" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ### Retrieve a memory store **GET** `/v1/memory_stores/{memory_store_id}` Retrieve a memory store #### Path parameters - `memory_store_id: string` ID of the memory store to retrieve (a `memstore_...` identifier). Required. Enumerate IDs via `GET /v1/memory_stores`. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `agent-memory-2026-07-22` or `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsMemoryStore object` 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. - `type: "memory_store"` - `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. - `archived_at: string or null` Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions. format: date-time - `created_at: string` Timestamp when the store was created. format: date-time - `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]` 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. - `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. - `updated_at: string` Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this. format: date-time #### Example ```bash curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: agent-memory-2026-07-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" }, "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ### Update a memory store **POST** `/v1/memory_stores/{memory_store_id}` Update a memory store #### Path parameters - `memory_store_id: string` ID of the memory store to update (a `memstore_...` identifier). Required. Enumerate IDs via `GET /v1/memory_stores`. Updating an archived store returns 400. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `agent-memory-2026-07-22` or `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `description: optional string or null` New description for the store, up to 1024 characters. Pass an empty string to clear it. maxLength: 1024 - `metadata: optional map[string] or null` 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: optional string or null` 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. minLength: 1, maxLength: 255 #### Returns - `BetaManagedAgentsMemoryStore object` 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. - `type: "memory_store"` - `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. - `archived_at: string or null` Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions. format: date-time - `created_at: string` Timestamp when the store was created. format: date-time - `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]` 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. - `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. - `updated_at: string` Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this. format: date-time #### Example ```bash curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: agent-memory-2026-07-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{}' ``` ##### Response (200) ```json { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" }, "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ### Delete a memory store **DELETE** `/v1/memory_stores/{memory_store_id}` Delete a memory store #### Path parameters - `memory_store_id: string` ID of the memory store to permanently delete (a `memstore_...` identifier). Required. Deletion cascades to all memories and memory versions in the store and cannot be undone. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `agent-memory-2026-07-22` or `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsDeletedMemoryStore object` Confirmation that a `memory_store` was deleted. - `type: "memory_store_deleted"` - `id: string` ID of the deleted memory store (a `memstore_...` identifier). The store and all its memories and versions are no longer retrievable. #### Example ```bash curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: agent-memory-2026-07-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "type": "memory_store_deleted" } ``` ### Archive a memory store **POST** `/v1/memory_stores/{memory_store_id}/archive` Archive a memory store #### Path parameters - `memory_store_id: string` ID of the memory store to archive (a `memstore_...` identifier). Required. Archiving is one-way and idempotent; archived stores cannot be unarchived. Enumerate IDs via `GET /v1/memory_stores`. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `agent-memory-2026-07-22` or `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsMemoryStore object` 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. - `type: "memory_store"` - `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. - `archived_at: string or null` Timestamp when the store was archived, or `null` if active. Set once and never cleared; archiving is one-way. Archived stores are read-only and cannot be attached to new sessions. format: date-time - `created_at: string` Timestamp when the store was created. format: date-time - `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]` 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. - `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. - `updated_at: string` Timestamp when the store's `name`, `description`, or `metadata` was last modified. Memory writes inside the store do not advance this. format: date-time #### Example ```bash curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: agent-memory-2026-07-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" }, "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ## Beta › Memory Stores › Memories ### Create a memory **POST** `/v1/memory_stores/{memory_store_id}/memories` Create a memory #### Path parameters - `memory_store_id: string` The ID of the memory store to create the memory in (`memstore_...`). #### Query parameters - `view: optional BetaManagedAgentsMemoryView` 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. - `"basic"` Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content. - `"full"` Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `agent-memory-2026-07-22` or `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `content: string or null` UTF-8 text content for the new memory. Maximum 100 kB (102,400 bytes). Required; pass `""` explicitly to create an empty memory. - `path: string` 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, or the Unicode line and paragraph separators (U+2028, U+2029), and must be NFC-normalized. Paths are case-sensitive. minLength: 2, maxLength: 1024 #### Returns - `BetaManagedAgentsMemory object` 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. - `type: "memory"` - `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. - `content_sha256: 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`. - `content_size_bytes: number` Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`. format: int32 - `created_at: string` When this memory was created, in RFC 3339 format. format: date-time - `memory_store_id: string` ID of the memory store this memory belongs to (a `memstore_...` value). - `memory_version_id: 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 history via [List memory versions](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list?sdk_languages=http). - `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. - `updated_at: string` When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list?sdk_languages=http). format: date-time - `content: optional string or null` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). #### Example ```bash curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID/memories \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: agent-memory-2026-07-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "content": "content", "path": "xx" }' ``` ##### Response (200) ```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 **GET** `/v1/memory_stores/{memory_store_id}/memories` List memories #### Path parameters - `memory_store_id: string` The ID of the memory store to list memories from (`memstore_...`). #### Query parameters - `depth: optional number` `0` (or omitted) returns all descendants below `path_prefix` (recursive). `1` returns immediate children only; deeper entries roll up as `memory_prefix` items. `depth=1` behaves like `ls`; omitting `depth` behaves like `find`. format: int32 - `limit: optional number` Maximum number of items to return per page. Must be between 1 and 100. Defaults to 20 when omitted. Capped at 20 when `view=full`. Both `memory` and `memory_prefix` items count toward the limit. format: int32 - `page: optional string` 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. - `path_prefix: optional string` Optional path prefix filter. Must end with `/` (segment-aligned), e.g., `/notes/`. This value appears in request URLs. Do not include secrets or personally identifiable information. - `view: optional BetaManagedAgentsMemoryView` Which projection of each `memory` to return. Defaults to `basic` (content omitted). `full` populates `content` on each item and caps `limit` at 20; use this as the bulk-read path for export and sync. - `"basic"` Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content. - `"full"` Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `agent-memory-2026-07-22` or `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: optional array of BetaManagedAgentsMemoryListItem` One page of results. Each item is either a `memory` object or, when `depth` was set, a `memory_prefix` rollup marker. Items are returned in a stable, server-defined order. - `BetaManagedAgentsMemory object` 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. - `type: "memory"` - `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. - `content_sha256: 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`. - `content_size_bytes: number` Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`. format: int32 - `created_at: string` When this memory was created, in RFC 3339 format. format: date-time - `memory_store_id: string` ID of the memory store this memory belongs to (a `memstore_...` value). - `memory_version_id: 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 history via [List memory versions](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list?sdk_languages=http). - `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. - `updated_at: string` When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list?sdk_languages=http). format: date-time - `content: optional string or null` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). - `BetaManagedAgentsMemoryPrefix object` A rolled-up directory marker returned by [List memories](https://platform.claude.com/docs/en/api/beta/memory_stores/memories/list?sdk_languages=http) 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. - `type: "memory_prefix"` - `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. - `next_page: optional string or null` Opaque cursor for the next page (a `page_...` value), or `null` if there are no more results. Pass as `page` on the next request. #### Example ```bash curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID/memories \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: agent-memory-2026-07-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "mem_011CZkZ9X2dpNyB6YbtxvB6e", "content_sha256": "ba7936d94c84d948a2232088f78228f175df6a8353b2d5bc9228eee5794a0024", "content_size_bytes": 28, "created_at": "2026-03-15T10:00:00Z", "memory_store_id": "memstore_01Wf3kQ8tZxB2mVr7HcJ4aNd", "memory_version_id": "memver_011CZkZBJq5dWxk9fVLNcPht", "path": "/preferences/formatting.md", "type": "memory", "updated_at": "2026-03-15T10:00:00Z", "content": null } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ### Retrieve a memory **GET** `/v1/memory_stores/{memory_store_id}/memories/{memory_id}` Retrieve a memory #### Path parameters - `memory_store_id: string` The ID of the memory store that holds the memory (`memstore_...`). - `memory_id: string` The ID of the memory to retrieve (`mem_...`). #### Query parameters - `view: optional BetaManagedAgentsMemoryView` 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. - `"basic"` Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content. - `"full"` Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `agent-memory-2026-07-22` or `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsMemory object` 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. - `type: "memory"` - `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. - `content_sha256: 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`. - `content_size_bytes: number` Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`. format: int32 - `created_at: string` When this memory was created, in RFC 3339 format. format: date-time - `memory_store_id: string` ID of the memory store this memory belongs to (a `memstore_...` value). - `memory_version_id: 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 history via [List memory versions](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list?sdk_languages=http). - `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. - `updated_at: string` When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list?sdk_languages=http). format: date-time - `content: optional string or null` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). #### Example ```bash curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID/memories/$MEMORY_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: agent-memory-2026-07-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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 **POST** `/v1/memory_stores/{memory_store_id}/memories/{memory_id}` Update a memory #### Path parameters - `memory_store_id: string` The ID of the memory store that holds the memory (`memstore_...`). - `memory_id: string` The ID of the memory to update (`mem_...`). #### Query parameters - `view: optional BetaManagedAgentsMemoryView` 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. - `"basic"` Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content. - `"full"` Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `agent-memory-2026-07-22` or `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `content: optional string or null` 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: optional string or null` 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, or the Unicode line and paragraph separators (U+2028, U+2029), and must be NFC-normalized. Paths are case-sensitive. The memory's `id` is preserved across renames. Omit to leave the path unchanged. minLength: 2, maxLength: 1024 - `precondition: optional BetaManagedAgentsPrecondition` Optional optimistic-concurrency precondition. When supplied, the update applies only if the memory's current state matches; on mismatch the request returns `memory_precondition_failed_error` (HTTP 409). When omitted, the update is unconditional. - `type: "content_sha256"` - `content_sha256: optional 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. #### Returns - `BetaManagedAgentsMemory object` 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. - `type: "memory"` - `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. - `content_sha256: 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`. - `content_size_bytes: number` Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`. format: int32 - `created_at: string` When this memory was created, in RFC 3339 format. format: date-time - `memory_store_id: string` ID of the memory store this memory belongs to (a `memstore_...` value). - `memory_version_id: 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 history via [List memory versions](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list?sdk_languages=http). - `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. - `updated_at: string` When this memory was last modified, in RFC 3339 format. Use this as a cheap freshness signal; for who made the change, look up the head version's `created_by` via [List memory versions](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list?sdk_languages=http). format: date-time - `content: optional string or null` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). #### Example ```bash curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID/memories/$MEMORY_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: agent-memory-2026-07-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{}' ``` ##### Response (200) ```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 **DELETE** `/v1/memory_stores/{memory_store_id}/memories/{memory_id}` Delete a memory #### Path parameters - `memory_store_id: string` The ID of the memory store that holds the memory (`memstore_...`). - `memory_id: string` The ID of the memory to delete (`mem_...`). #### Query parameters - `expected_content_sha256: optional string` Delete the memory only if its current `content_sha256` equals this value, given as 64 lowercase hexadecimal characters. Omit it to delete unconditionally. If the hashes differ, the request fails with HTTP status 409 and nothing is deleted. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `agent-memory-2026-07-22` or `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsDeletedMemory object` Tombstone returned by [Delete a memory](https://platform.claude.com/docs/en/api/beta/memory_stores/memories/delete?sdk_languages=http). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list?sdk_languages=http) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted). - `type: "memory_deleted"` - `id: string` ID of the deleted memory (a `mem_...` value). #### Example ```bash curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID/memories/$MEMORY_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: agent-memory-2026-07-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "type": "memory_deleted" } ``` ## Beta › Memory Stores › Memory Versions ### List memory versions **GET** `/v1/memory_stores/{memory_store_id}/memory_versions` List memory versions #### Path parameters - `memory_store_id: string` The ID of the memory store whose version history to list (`memstore_...`). #### Query parameters - `api_key_id: optional string` Return only versions written with the API key that has this ID. - `"created_at[gte]": optional string` Return versions created at or after this time (inclusive). format: date-time - `"created_at[lte]": optional string` Return versions created at or before this time (inclusive). format: date-time - `limit: optional number` The maximum number of versions to return per page. Defaults to 20. format: int32 - `memory_id: optional string` Return only versions of the memory with this ID (`mem_...`). The filter still works after the memory is deleted. The results then include the version whose `operation` is `deleted`. - `operation: optional BetaManagedAgentsMemoryVersionOperation` Return only versions that record this kind of change. - `"created"` The memory was created. The first version in any memory's lineage. - `"modified"` The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`. - `"deleted"` The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash. - `page: optional string` The `next_page` value from a previous response, to get the next page. Omit it to get the first page. - `service_account_id: optional string` Return only versions written by the service account with this ID (`svac_...`). - `session_id: optional string` Return only versions written by the session with this ID. - `view: optional BetaManagedAgentsMemoryView` 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. - `"basic"` Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content. - `"full"` Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `agent-memory-2026-07-22` or `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: optional array of BetaManagedAgentsMemoryVersion` One page of `memory_version` objects, ordered by `created_at` descending (newest first), with `id` as tiebreak. - `type: "memory_version"` - `id: string` Unique identifier for this version (a `memver_...` value). - `created_at: string` When this version was written, in RFC 3339 format. format: date-time - `memory_id: 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](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list?sdk_languages=http) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` ID of the memory store this version belongs to (a `memstore_...` value). - `operation: BetaManagedAgentsMemoryVersionOperation` The kind of mutation this version records: `created`, `modified`, or `deleted`. - `"created"` The memory was created. The first version in any memory's lineage. - `"modified"` The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`. - `"deleted"` The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash. - `content: optional string or null` 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. - `content_sha256: optional string or null` 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. - `content_size_bytes: optional number or null` Size of `content` in bytes as of this version. `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. format: int32 - `created_by: optional BetaManagedAgentsActor` Who performed this write: one of `session_actor`, `api_actor`, `user_actor`, or `service_account_actor`; `null` when no writer is recorded. Captured at write time and preserved through redaction. A `session_actor` is an agent writing through the store's mounted filesystem at `/mnt/memory/`. The API key that created that session is not recorded on agent writes, so attribution names who made the write, not who is ultimately responsible; look up session provenance via the [Sessions API](https://platform.claude.com/docs/en/api/beta/sessions/retrieve?sdk_languages=http). - `BetaManagedAgentsSessionActor object` An agent acting during a session, for example through the session's mounted filesystem. It names the session itself, not the user or API key that started the session. - `type: "session_actor"` - `session_id: string` ID of the session (a `sesn_...` value). Look up the session via [Retrieve a session](https://platform.claude.com/docs/en/api/beta/sessions/retrieve?sdk_languages=http) for further provenance. minLength: 1 - `BetaManagedAgentsAPIActor object` A direct caller of the public API, identified by the API key that authenticated the request. - `type: "api_actor"` - `api_key_id: string` ID of the API key (an `apikey_...` value). This identifies the key, not the secret. minLength: 1 - `BetaManagedAgentsUserActor object` A human user, for example acting through the Anthropic Console. - `type: "user_actor"` - `user_id: string` ID of the user (a `user_...` value). minLength: 1 - `BetaManagedAgentsServiceAccountActor object` A workload authenticated as a service account, for example via Workload Identity Federation. - `type: "service_account_actor"` - `service_account_id: string` ID of the service account (a `svac_...` value). minLength: 1 - `path: optional string or null` The memory's path at the time of this write. `null` if and only if `redacted_at` is set. - `redacted_at: optional string or null` When this version was redacted, in RFC 3339 format, or `null` if it has not been redacted. When set, `content`, `path`, `content_size_bytes`, and `content_sha256` are all `null`. See [Redact a memory version](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/redact?sdk_languages=http). format: date-time - `redacted_by: optional BetaManagedAgentsActor` Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor`, `user_actor`, or `service_account_actor` (agents do not have a redact capability). - `next_page: optional string or null` Opaque cursor for the next page (a `page_...` value), or `null` if there are no more results. Pass as `page` on the next request. #### Example ```bash curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID/memory_versions \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: agent-memory-2026-07-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "memver_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "memory_id": "mem_011CZkZ9X2dpNyB6YbtxvB6e", "memory_store_id": "memstore_01Wf3kQ8tZxB2mVr7HcJ4aNd", "operation": "created", "type": "memory_version", "content": null, "content_sha256": "ba7936d94c84d948a2232088f78228f175df6a8353b2d5bc9228eee5794a0024", "content_size_bytes": 28, "created_by": { "session_id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "type": "session_actor" }, "path": "/preferences/formatting.md", "redacted_at": null, "redacted_by": { "session_id": "x", "type": "session_actor" } } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ### Retrieve a memory version **GET** `/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}` Retrieve a memory version #### Path parameters - `memory_store_id: string` The ID of the memory store that holds the version (`memstore_...`). - `memory_version_id: string` The ID of the memory version to retrieve (`memver_...`). #### Query parameters - `view: optional BetaManagedAgentsMemoryView` 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. - `"basic"` Return the object with `content` set to `null`. The `content_size_bytes` and `content_sha256` fields remain populated, so sync clients can diff without fetching content. - `"full"` Return the object with `content` populated. On list endpoints, `view=full` caps `limit` at 20. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `agent-memory-2026-07-22` or `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsMemoryVersion object` 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 are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself 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. - `type: "memory_version"` - `id: string` Unique identifier for this version (a `memver_...` value). - `created_at: string` When this version was written, in RFC 3339 format. format: date-time - `memory_id: 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](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list?sdk_languages=http) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` ID of the memory store this version belongs to (a `memstore_...` value). - `operation: BetaManagedAgentsMemoryVersionOperation` The kind of mutation this version records: `created`, `modified`, or `deleted`. - `"created"` The memory was created. The first version in any memory's lineage. - `"modified"` The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`. - `"deleted"` The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash. - `content: optional string or null` 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. - `content_sha256: optional string or null` 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. - `content_size_bytes: optional number or null` Size of `content` in bytes as of this version. `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. format: int32 - `created_by: optional BetaManagedAgentsActor` Who performed this write: one of `session_actor`, `api_actor`, `user_actor`, or `service_account_actor`; `null` when no writer is recorded. Captured at write time and preserved through redaction. A `session_actor` is an agent writing through the store's mounted filesystem at `/mnt/memory/`. The API key that created that session is not recorded on agent writes, so attribution names who made the write, not who is ultimately responsible; look up session provenance via the [Sessions API](https://platform.claude.com/docs/en/api/beta/sessions/retrieve?sdk_languages=http). - `BetaManagedAgentsSessionActor object` An agent acting during a session, for example through the session's mounted filesystem. It names the session itself, not the user or API key that started the session. - `type: "session_actor"` - `session_id: string` ID of the session (a `sesn_...` value). Look up the session via [Retrieve a session](https://platform.claude.com/docs/en/api/beta/sessions/retrieve?sdk_languages=http) for further provenance. minLength: 1 - `BetaManagedAgentsAPIActor object` A direct caller of the public API, identified by the API key that authenticated the request. - `type: "api_actor"` - `api_key_id: string` ID of the API key (an `apikey_...` value). This identifies the key, not the secret. minLength: 1 - `BetaManagedAgentsUserActor object` A human user, for example acting through the Anthropic Console. - `type: "user_actor"` - `user_id: string` ID of the user (a `user_...` value). minLength: 1 - `BetaManagedAgentsServiceAccountActor object` A workload authenticated as a service account, for example via Workload Identity Federation. - `type: "service_account_actor"` - `service_account_id: string` ID of the service account (a `svac_...` value). minLength: 1 - `path: optional string or null` The memory's path at the time of this write. `null` if and only if `redacted_at` is set. - `redacted_at: optional string or null` When this version was redacted, in RFC 3339 format, or `null` if it has not been redacted. When set, `content`, `path`, `content_size_bytes`, and `content_sha256` are all `null`. See [Redact a memory version](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/redact?sdk_languages=http). format: date-time - `redacted_by: optional BetaManagedAgentsActor` Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor`, `user_actor`, or `service_account_actor` (agents do not have a redact capability). #### Example ```bash curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID/memory_versions/$MEMORY_VERSION_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: agent-memory-2026-07-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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 **POST** `/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact` Redact a memory version #### Path parameters - `memory_store_id: string` The ID of the memory store that holds the version (`memstore_...`). - `memory_version_id: string` The ID of the memory version to redact (`memver_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `agent-memory-2026-07-22` or `managed-agents-2026-04-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaManagedAgentsMemoryVersion object` 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 are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself 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. - `type: "memory_version"` - `id: string` Unique identifier for this version (a `memver_...` value). - `created_at: string` When this version was written, in RFC 3339 format. format: date-time - `memory_id: 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](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/list?sdk_languages=http) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. - `memory_store_id: string` ID of the memory store this version belongs to (a `memstore_...` value). - `operation: BetaManagedAgentsMemoryVersionOperation` The kind of mutation this version records: `created`, `modified`, or `deleted`. - `"created"` The memory was created. The first version in any memory's lineage. - `"modified"` The memory's `content`, `path`, or both were changed via update. Writes the agent makes through the filesystem mount also appear as `modified`. - `"deleted"` The memory was deleted. The `content`, `content_size_bytes`, and `content_sha256` fields are `null` on this version. The preceding version, while it is retained, records the deleted content's size and hash. - `content: optional string or null` 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. - `content_sha256: optional string or null` 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. - `content_size_bytes: optional number or null` Size of `content` in bytes as of this version. `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. format: int32 - `created_by: optional BetaManagedAgentsActor` Who performed this write: one of `session_actor`, `api_actor`, `user_actor`, or `service_account_actor`; `null` when no writer is recorded. Captured at write time and preserved through redaction. A `session_actor` is an agent writing through the store's mounted filesystem at `/mnt/memory/`. The API key that created that session is not recorded on agent writes, so attribution names who made the write, not who is ultimately responsible; look up session provenance via the [Sessions API](https://platform.claude.com/docs/en/api/beta/sessions/retrieve?sdk_languages=http). - `BetaManagedAgentsSessionActor object` An agent acting during a session, for example through the session's mounted filesystem. It names the session itself, not the user or API key that started the session. - `type: "session_actor"` - `session_id: string` ID of the session (a `sesn_...` value). Look up the session via [Retrieve a session](https://platform.claude.com/docs/en/api/beta/sessions/retrieve?sdk_languages=http) for further provenance. minLength: 1 - `BetaManagedAgentsAPIActor object` A direct caller of the public API, identified by the API key that authenticated the request. - `type: "api_actor"` - `api_key_id: string` ID of the API key (an `apikey_...` value). This identifies the key, not the secret. minLength: 1 - `BetaManagedAgentsUserActor object` A human user, for example acting through the Anthropic Console. - `type: "user_actor"` - `user_id: string` ID of the user (a `user_...` value). minLength: 1 - `BetaManagedAgentsServiceAccountActor object` A workload authenticated as a service account, for example via Workload Identity Federation. - `type: "service_account_actor"` - `service_account_id: string` ID of the service account (a `svac_...` value). minLength: 1 - `path: optional string or null` The memory's path at the time of this write. `null` if and only if `redacted_at` is set. - `redacted_at: optional string or null` When this version was redacted, in RFC 3339 format, or `null` if it has not been redacted. When set, `content`, `path`, `content_size_bytes`, and `content_sha256` are all `null`. See [Redact a memory version](https://platform.claude.com/docs/en/api/beta/memory_stores/memory_versions/redact?sdk_languages=http). format: date-time - `redacted_by: optional BetaManagedAgentsActor` Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor`, `user_actor`, or `service_account_actor` (agents do not have a redact capability). #### Example ```bash curl https://api.anthropic.com/v1/memory_stores/$MEMORY_STORE_ID/memory_versions/$MEMORY_VERSION_ID/redact \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: agent-memory-2026-07-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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" } } ``` ## Beta › Files ### Upload File **POST** `/v1/files` Upload File #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters (form-data) - `file: string` The file to upload. Only the final path component of the part's `filename` is kept; an absent or empty `filename` is replaced with `unnamed` plus the extension for the file's stored `mime_type`, when known. format: binary - `expires_in_seconds: optional number` Seconds from upload until the file expires and its bytes become permanently unavailable. Must be between 3600 (one hour) and 7776000 (ninety days). minimum: 3600, maximum: 7776000 #### Returns - `BetaFileMetadata object` - `type: "file"` Object type. For files, this is always `"file"`. - `id: string` Unique object identifier. The format and length of IDs may change over time. - `created_at: string` RFC 3339 datetime string representing when the file was created. format: date-time - `filename: string` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `mime_type: string` MIME type of the file. minLength: 1, maxLength: 255 - `size_bytes: number` Size of the file in bytes. minimum: 0 - `downloadable: optional boolean` Whether the file can be downloaded. default: false - `expires_at: optional string or null` RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value. format: date-time - `scope: optional BetaFileScope or null` The scope of this file, indicating the context in which it was created (e.g., a session). - `type: "session"` The type of scope (e.g., `"session"`). - `id: string` The ID of the scoping resource (e.g., the session ID). #### Example ```bash curl https://api.anthropic.com/v1/files \ -H 'Content-Type: multipart/form-data' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -F 'file=@/path/to/file' ``` ##### Response (200) ```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, "expires_at": "2025-05-15T18:37:24.100435Z", "scope": { "id": "id", "type": "session" } } ``` ### List Files **GET** `/v1/files` List Files #### Query parameters - `ids: optional array of string` Restrict the result set to Files whose `id` is in this list. At most 100 entries (after de-duplication). Mutually exclusive with `page` and `limit`. When supplied, the response is always a single page (`next_page` is null). IDs that do not resolve to a visible File — including deleted Files — are silently omitted. - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 - `page: optional string` Opaque page cursor returned in a prior list response's `next_page`. Prefixed `page_`. - `scope_id: optional string` Filter by scope ID. Only returns files associated with the specified scope (e.g., a session ID). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaFileMetadata` List of file metadata objects. - `type: "file"` Object type. For files, this is always `"file"`. - `id: string` Unique object identifier. The format and length of IDs may change over time. - `created_at: string` RFC 3339 datetime string representing when the file was created. format: date-time - `filename: string` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `mime_type: string` MIME type of the file. minLength: 1, maxLength: 255 - `size_bytes: number` Size of the file in bytes. minimum: 0 - `downloadable: optional boolean` Whether the file can be downloaded. default: false - `expires_at: optional string or null` RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value. format: date-time - `scope: optional BetaFileScope or null` The scope of this file, indicating the context in which it was created (e.g., a session). - `type: "session"` The type of scope (e.g., `"session"`). - `id: string` The ID of the scoping resource (e.g., the session ID). - `next_page: optional string or null` Opaque cursor for the next page. Supply as `?page=` to fetch the next page; null when there are no more results. #### Example ```bash curl https://api.anthropic.com/v1/files \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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, "expires_at": "2025-05-15T18:37:24.100435Z", "scope": { "id": "id", "type": "session" } } ], "next_page": "next_page" } ``` ### Download File **GET** `/v1/files/{file_id}/content` Download File #### Path parameters - `file_id: string` ID of the File. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Example ```bash curl https://api.anthropic.com/v1/files/$FILE_ID/content \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ### Get File Metadata **GET** `/v1/files/{file_id}` Get File Metadata #### Path parameters - `file_id: string` ID of the File. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaFileMetadata object` - `type: "file"` Object type. For files, this is always `"file"`. - `id: string` Unique object identifier. The format and length of IDs may change over time. - `created_at: string` RFC 3339 datetime string representing when the file was created. format: date-time - `filename: string` Original filename of the uploaded file. minLength: 1, maxLength: 500 - `mime_type: string` MIME type of the file. minLength: 1, maxLength: 255 - `size_bytes: number` Size of the file in bytes. minimum: 0 - `downloadable: optional boolean` Whether the file can be downloaded. default: false - `expires_at: optional string or null` RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value. format: date-time - `scope: optional BetaFileScope or null` The scope of this file, indicating the context in which it was created (e.g., a session). - `type: "session"` The type of scope (e.g., `"session"`). - `id: string` The ID of the scoping resource (e.g., the session ID). #### Example ```bash curl https://api.anthropic.com/v1/files/$FILE_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```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, "expires_at": "2025-05-15T18:37:24.100435Z", "scope": { "id": "id", "type": "session" } } ``` ### Delete File **DELETE** `/v1/files/{file_id}` Delete File #### Path parameters - `file_id: string` ID of the File. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaDeletedFile object` - `type: optional "file_deleted"` Deleted object type. For file deletion, this is always `"file_deleted"`. default: file_deleted - `id: string` ID of the deleted file. #### Example ```bash curl https://api.anthropic.com/v1/files/$FILE_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "file_011CNha8iCJcU1wXNR6q4V8w", "type": "file_deleted" } ``` ## Beta › Skills ### Create Skill **POST** `/v1/skills` Create Skill #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters (form-data) - `files: array of string` 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. - `display_name: optional string or null` Human-readable, single-line label for the Skill. Maximum 255 characters. Always set: derived from the SKILL.md frontmatter `name` when omitted at creation. Not unique. #### Returns - `BetaSkill object` - `type: "skill"` Object type. For Skills, this is always `"skill"`. default: skill - `id: string` Unique identifier for the skill. The format and length of IDs may change over time. - `created_at: string` ISO 8601 timestamp of when the skill was created. format: date-time - `display_name: string` Human-readable, single-line label for the Skill. Maximum 255 characters. Always set: derived from the SKILL.md frontmatter `name` when omitted at creation. Not unique. - `latest_version_id: string` ID of the newest Skill Version — what `latest` references resolve to. Always set: a Skill holds at least one version. - `source: BetaSkillSource` Where the Skill comes from. Possible values: * `"custom"`: authored by the platform user; private to their workspace * `"anthropic"`: published by Anthropic; shared and read-only * `"anthropic_example"`: Anthropic-published sample Skill * `"plugin"`: resolved from an installed plugin - `type: "custom" or "anthropic" or "anthropic_example" or "plugin"` Where the Skill comes from. Possible values: * `"custom"`: authored by the platform user; private to their workspace * `"anthropic"`: published by Anthropic; shared and read-only * `"anthropic_example"`: Anthropic-published sample Skill * `"plugin"`: resolved from an installed plugin - `"custom"` - `"anthropic"` - `"anthropic_example"` - `"plugin"` - `updated_at: string` ISO 8601 timestamp of when the skill was last updated. format: date-time #### Example ```bash curl https://api.anthropic.com/v1/skills \ -H 'Content-Type: multipart/form-data' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -F 'files[]=@/path/to/file' ``` ##### Response (200) ```json { "id": "skill_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "display_name", "latest_version_id": "latest_version_id", "source": { "type": "custom" }, "type": "skill", "updated_at": "2024-10-30T23:58:27.427722Z" } ``` ### List Skills **GET** `/v1/skills` List Skills #### Query parameters - `limit: optional number` Number of results to return per page. Ranges from `1` to `1000`. Defaults to `20`. default: 20, minimum: 1, maximum: 1000 - `page: optional string` 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: optional string` 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 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaSkill` List of skills. - `type: "skill"` Object type. For Skills, this is always `"skill"`. default: skill - `id: string` Unique identifier for the skill. The format and length of IDs may change over time. - `created_at: string` ISO 8601 timestamp of when the skill was created. format: date-time - `display_name: string` Human-readable, single-line label for the Skill. Maximum 255 characters. Always set: derived from the SKILL.md frontmatter `name` when omitted at creation. Not unique. - `latest_version_id: string` ID of the newest Skill Version — what `latest` references resolve to. Always set: a Skill holds at least one version. - `source: BetaSkillSource` Where the Skill comes from. Possible values: * `"custom"`: authored by the platform user; private to their workspace * `"anthropic"`: published by Anthropic; shared and read-only * `"anthropic_example"`: Anthropic-published sample Skill * `"plugin"`: resolved from an installed plugin - `type: "custom" or "anthropic" or "anthropic_example" or "plugin"` Where the Skill comes from. Possible values: * `"custom"`: authored by the platform user; private to their workspace * `"anthropic"`: published by Anthropic; shared and read-only * `"anthropic_example"`: Anthropic-published sample Skill * `"plugin"`: resolved from an installed plugin - `"custom"` - `"anthropic"` - `"anthropic_example"` - `"plugin"` - `updated_at: string` ISO 8601 timestamp of when the skill was last updated. format: date-time - `next_page: string or null` Token for fetching the next page of results. If `null`, there are no more results available. Pass this value to the `page` parameter in the next request to get the next page. #### Example ```bash curl https://api.anthropic.com/v1/skills \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "skill_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "display_name", "latest_version_id": "latest_version_id", "source": { "type": "custom" }, "type": "skill", "updated_at": "2024-10-30T23:58:27.427722Z" } ], "next_page": "next_page" } ``` ### Get Skill **GET** `/v1/skills/{skill_id}` Get Skill #### Path parameters - `skill_id: string` Unique identifier for the skill. The format and length of IDs may change over time. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaSkill object` - `type: "skill"` Object type. For Skills, this is always `"skill"`. default: skill - `id: string` Unique identifier for the skill. The format and length of IDs may change over time. - `created_at: string` ISO 8601 timestamp of when the skill was created. format: date-time - `display_name: string` Human-readable, single-line label for the Skill. Maximum 255 characters. Always set: derived from the SKILL.md frontmatter `name` when omitted at creation. Not unique. - `latest_version_id: string` ID of the newest Skill Version — what `latest` references resolve to. Always set: a Skill holds at least one version. - `source: BetaSkillSource` Where the Skill comes from. Possible values: * `"custom"`: authored by the platform user; private to their workspace * `"anthropic"`: published by Anthropic; shared and read-only * `"anthropic_example"`: Anthropic-published sample Skill * `"plugin"`: resolved from an installed plugin - `type: "custom" or "anthropic" or "anthropic_example" or "plugin"` Where the Skill comes from. Possible values: * `"custom"`: authored by the platform user; private to their workspace * `"anthropic"`: published by Anthropic; shared and read-only * `"anthropic_example"`: Anthropic-published sample Skill * `"plugin"`: resolved from an installed plugin - `"custom"` - `"anthropic"` - `"anthropic_example"` - `"plugin"` - `updated_at: string` ISO 8601 timestamp of when the skill was last updated. format: date-time #### Example ```bash curl https://api.anthropic.com/v1/skills/$SKILL_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "skill_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "display_name", "latest_version_id": "latest_version_id", "source": { "type": "custom" }, "type": "skill", "updated_at": "2024-10-30T23:58:27.427722Z" } ``` ### Delete Skill **DELETE** `/v1/skills/{skill_id}` Delete Skill #### Path parameters - `skill_id: string` Unique identifier for the skill. The format and length of IDs may change over time. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaDeletedSkill object` - `type: "skill_deleted"` Deleted object type. For Skills, this is always `"skill_deleted"`. default: skill_deleted - `id: string` Unique identifier for the skill. The format and length of IDs may change over time. #### Example ```bash curl https://api.anthropic.com/v1/skills/$SKILL_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "skill_deleted" } ``` ## Beta › Skills › Versions ### Create Skill Version **POST** `/v1/skills/{skill_id}/versions` Create Skill Version #### Path parameters - `skill_id: string` Unique identifier for the skill. The format and length of IDs may change over time. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters (form-data) - `files: array of string` 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. #### Returns - `BetaSkillVersion object` - `type: "skill_version"` Object type. For Skill Versions, this is always `"skill_version"`. default: skill_version - `id: string` Unique identifier for this Skill Version. The id addresses the version in paths and pins it in references. - `created_at: string` ISO 8601 timestamp of when the skill was created. format: date-time - `description: string` Description of the skill version. This is extracted from the SKILL.md file in the skill upload. - `name: string` The Skill's immutable kebab-case slug, set at creation from the first upload's SKILL.md frontmatter `name` (or its enclosing directory). Every later upload must resolve to the same value. Also the top-level directory of the Skill's mounted files and the base name of a downloaded archive. - `skill_id: string` Unique identifier for the skill. The format and length of IDs may change over time. #### Example ```bash curl https://api.anthropic.com/v1/skills/$SKILL_ID/versions \ -H 'Content-Type: multipart/form-data' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -F 'files[]=@/path/to/file' ``` ##### Response (200) ```json { "id": "id", "created_at": "2024-10-30T23:58:27.427722Z", "description": "description", "name": "name", "skill_id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "skill_version" } ``` ### List Skill Versions **GET** `/v1/skills/{skill_id}/versions` List Skill Versions #### Path parameters - `skill_id: string` Unique identifier for the skill. The format and length of IDs may change over time. #### Query parameters - `limit: optional number` Number of results to return per page. Ranges from `1` to `1000`. Defaults to `20`. default: 20, minimum: 1, maximum: 1000 - `page: optional string` Optionally set to the `next_page` token from the previous response. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaSkillVersion` List of skills. - `type: "skill_version"` Object type. For Skill Versions, this is always `"skill_version"`. default: skill_version - `id: string` Unique identifier for this Skill Version. The id addresses the version in paths and pins it in references. - `created_at: string` ISO 8601 timestamp of when the skill was created. format: date-time - `description: string` Description of the skill version. This is extracted from the SKILL.md file in the skill upload. - `name: string` The Skill's immutable kebab-case slug, set at creation from the first upload's SKILL.md frontmatter `name` (or its enclosing directory). Every later upload must resolve to the same value. Also the top-level directory of the Skill's mounted files and the base name of a downloaded archive. - `skill_id: string` Unique identifier for the skill. The format and length of IDs may change over time. - `next_page: string or null` Token for fetching the next page of results. If `null`, there are no more results available. Pass this value to the `page` parameter in the next request to get the next page. #### Example ```bash curl https://api.anthropic.com/v1/skills/$SKILL_ID/versions \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "id", "created_at": "2024-10-30T23:58:27.427722Z", "description": "description", "name": "name", "skill_id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "skill_version" } ], "next_page": "next_page" } ``` ### Download Skill Version Content **GET** `/v1/skills/{skill_id}/versions/{version}/content` Download a skill version's content as a zip archive. #### Path parameters - `skill_id: string` Unique identifier for the skill. The format and length of IDs may change over time. - `version: string` Identifies the skill version by its version ID. Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Example ```bash curl https://api.anthropic.com/v1/skills/$SKILL_ID/versions/$VERSION/content \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ### Get Skill Version **GET** `/v1/skills/{skill_id}/versions/{version}` Get Skill Version #### Path parameters - `skill_id: string` Unique identifier for the skill. The format and length of IDs may change over time. - `version: string` Identifies the skill version: a version ID, or the literal `latest` for the skill's most recent version. Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaSkillVersion object` - `type: "skill_version"` Object type. For Skill Versions, this is always `"skill_version"`. default: skill_version - `id: string` Unique identifier for this Skill Version. The id addresses the version in paths and pins it in references. - `created_at: string` ISO 8601 timestamp of when the skill was created. format: date-time - `description: string` Description of the skill version. This is extracted from the SKILL.md file in the skill upload. - `name: string` The Skill's immutable kebab-case slug, set at creation from the first upload's SKILL.md frontmatter `name` (or its enclosing directory). Every later upload must resolve to the same value. Also the top-level directory of the Skill's mounted files and the base name of a downloaded archive. - `skill_id: string` Unique identifier for the skill. The format and length of IDs may change over time. #### Example ```bash curl https://api.anthropic.com/v1/skills/$SKILL_ID/versions/$VERSION \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "created_at": "2024-10-30T23:58:27.427722Z", "description": "description", "name": "name", "skill_id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "skill_version" } ``` ### Delete Skill Version **DELETE** `/v1/skills/{skill_id}/versions/{version}` Delete Skill Version #### Path parameters - `skill_id: string` Unique identifier for the skill. The format and length of IDs may change over time. - `version: string` Identifies the skill version by its version ID. Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaDeletedSkillVersion object` - `type: "skill_version_deleted"` Deleted object type. For Skill Versions, this is always `"skill_version_deleted"`. default: skill_version_deleted - `id: string` Unique identifier for this Skill Version. The id addresses the version in paths and pins it in references. #### Example ```bash curl https://api.anthropic.com/v1/skills/$SKILL_ID/versions/$VERSION \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "type": "skill_version_deleted" } ``` ## Beta › User Profiles ### Create User Profile **POST** `/v1/user_profiles` Create User Profile #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `user-profiles-2026-03-24`, `user-profiles-2026-08-18`, or `user-profiles-2026-09-04` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `access_type: optional "application" or "passthrough"` How the platform uses the API for this entity. `application` (default): the profile represents an individual end-user of the platform's product. `passthrough`: the profile identifies a company the platform resells Claude access to. - `"application"` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `"passthrough"` The user profile represents a company that the platform resells Claude access to. - `external_id: optional string or null` Platform's own identifier for this user. Not enforced unique. Maximum 255 characters. Accepted under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` send `external_user_details.reference_id` instead. minLength: 1, maxLength: 255 - `external_user_details: optional BetaUserProfileExternalUserDetailsParams` Details about the entity this profile represents, as the platform states them. Every field is optional. Accepted under the `user-profiles-2026-09-04` beta header only. - `account_status: optional "active" or "suspended" or "blocked" or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: optional string or null` The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked. - `email_hash: optional string or null` A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters. minLength: 1, maxLength: 255 - `entity_type: optional "individual" or "business" or "non_profit" or "government" or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: optional string or null` A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters. minLength: 1, maxLength: 255 - `onboarded_at: optional string` When the entity opened its account with the platform, in RFC 3339 format: for an `application` profile, when the end-user signed up; for a `passthrough` profile, when the company became the platform's customer. Must be a complete timestamp no more than 1 minute in the future. format: date-time - `reference_id: optional string or null` The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters. minLength: 1, maxLength: 255 - `external_user_onboarded_at: optional string` When the entity this profile represents opened its account with the platform, in RFC 3339 format: for an `application` profile, when the end-user signed up; for a `passthrough` profile, when the company became the platform's customer. Must be a complete timestamp no more than 1 minute in the future. Optional. Accepted under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` send `external_user_details.onboarded_at` instead. format: date-time - `metadata: optional map[string]` 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: optional string or null` Optional for all profiles. Real-world name of the entity this profile represents (company or individual); for a company the platform resells Claude access to (`access_type` `passthrough`), that company's name where known. Maximum 255 characters. minLength: 1, maxLength: 255 #### Returns - `BetaUserProfile object` A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to. A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity. - `type: "user_profile"` Object type. Always `user_profile`. - `id: string` Unique identifier for this user profile, prefixed `uprof_`. - `created_at: string` When this user profile was created, in RFC 3339 format. format: date-time - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `trust_grants: map[BetaUserProfileTrustGrant]` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `status: "active" or "pending" or "rejected"` Status of the trust grant. - `"active"` - `"pending"` - `"rejected"` - `updated_at: string` When this user profile was last modified, in RFC 3339 format. Trust-grant status changes also bump this timestamp. format: date-time - `access_type: optional "application" or "passthrough"` How the platform uses the API for this entity: `application` (default) or `passthrough`. Present under the `user-profiles-2026-08-18` and later beta headers. - `"application"` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `"passthrough"` The user profile represents a company that the platform resells Claude access to. - `external_id: optional string or null` Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`. - `external_user_details: optional BetaUserProfileExternalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Present under the `user-profiles-2026-09-04` beta header, with every field present and `null` until the platform supplies a value; the earlier beta headers serve `reference_id` as the top-level `external_id`, and `user-profiles-2026-08-18` serves `onboarded_at` as `external_user_onboarded_at`. - `account_status: "active" or "suspended" or "blocked" or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: string or null` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `email_hash: string or null` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `entity_type: "individual" or "business" or "non_profit" or "government" or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: string or null` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `onboarded_at: string or null` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `reference_id: string or null` The platform's own reference for the entity. `null` until the platform supplies one. - `external_user_onboarded_at: optional string or null` When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Present under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` the value is `external_user_details.onboarded_at`. format: date-time - `name: optional string or null` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. #### Example ```bash curl https://api.anthropic.com/v1/user_profiles \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: user-profiles-2026-08-18' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "external_id": "user_12345", "external_user_onboarded_at": "2024-11-02T08:15:00Z", "metadata": {} }' ``` ##### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "country", "email_hash": "email_hash", "entity_type": "individual", "name_hash": "name_hash", "onboarded_at": "2019-12-27T18:11:19.117Z", "reference_id": "reference_id" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z", "name": "Example User" } ``` ### List User Profiles **GET** `/v1/user_profiles` List User Profiles #### Query parameters - `limit: optional number` The maximum number of user profiles to return, from 1 to 100. Defaults to 20. format: int32 - `order: optional "asc" or "desc"` The sort direction, applied to the field that `order_by` selects. Defaults to `desc`. - `"asc"` Oldest first when `order_by` is `created_at`, or names in ascending order when `order_by` is `name`. - `"desc"` Newest first when `order_by` is `created_at`, or names in descending order when `order_by` is `name`. This is the default. - `order_by: optional "created_at" or "name"` The field to sort user profiles by, in the direction that `order` sets. Defaults to `created_at`. - `"created_at"` Sort by when each user profile was created. This is the default. - `"name"` Sort by `name`, ignoring the case of ASCII letters. Profiles without a name come last in either direction. - `page: optional string` The cursor for the page to return, taken from `next_page` in a previous response. Leave it out to get the first page. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `user-profiles-2026-03-24`, `user-profiles-2026-08-18`, or `user-profiles-2026-09-04` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaUserProfile` User profiles on this page. - `type: "user_profile"` Object type. Always `user_profile`. - `id: string` Unique identifier for this user profile, prefixed `uprof_`. - `created_at: string` When this user profile was created, in RFC 3339 format. format: date-time - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `trust_grants: map[BetaUserProfileTrustGrant]` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `status: "active" or "pending" or "rejected"` Status of the trust grant. - `"active"` - `"pending"` - `"rejected"` - `updated_at: string` When this user profile was last modified, in RFC 3339 format. Trust-grant status changes also bump this timestamp. format: date-time - `access_type: optional "application" or "passthrough"` How the platform uses the API for this entity: `application` (default) or `passthrough`. Present under the `user-profiles-2026-08-18` and later beta headers. - `"application"` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `"passthrough"` The user profile represents a company that the platform resells Claude access to. - `external_id: optional string or null` Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`. - `external_user_details: optional BetaUserProfileExternalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Present under the `user-profiles-2026-09-04` beta header, with every field present and `null` until the platform supplies a value; the earlier beta headers serve `reference_id` as the top-level `external_id`, and `user-profiles-2026-08-18` serves `onboarded_at` as `external_user_onboarded_at`. - `account_status: "active" or "suspended" or "blocked" or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: string or null` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `email_hash: string or null` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `entity_type: "individual" or "business" or "non_profit" or "government" or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: string or null` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `onboarded_at: string or null` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `reference_id: string or null` The platform's own reference for the entity. `null` until the platform supplies one. - `external_user_onboarded_at: optional string or null` When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Present under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` the value is `external_user_details.onboarded_at`. format: date-time - `name: optional string or null` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. - `next_page: string or null` Cursor for the next page, or `null` when there are no more results. #### Example ```bash curl https://api.anthropic.com/v1/user_profiles \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: user-profiles-2026-08-18' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "country", "email_hash": "email_hash", "entity_type": "individual", "name_hash": "name_hash", "onboarded_at": "2019-12-27T18:11:19.117Z", "reference_id": "reference_id" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z", "name": "Example User" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ### Get User Profile **GET** `/v1/user_profiles/{user_profile_id}` Get User Profile #### Path parameters - `user_profile_id: string` The ID of the user profile to get (`uprof_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `user-profiles-2026-03-24`, `user-profiles-2026-08-18`, or `user-profiles-2026-09-04` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaUserProfile object` A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to. A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity. - `type: "user_profile"` Object type. Always `user_profile`. - `id: string` Unique identifier for this user profile, prefixed `uprof_`. - `created_at: string` When this user profile was created, in RFC 3339 format. format: date-time - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `trust_grants: map[BetaUserProfileTrustGrant]` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `status: "active" or "pending" or "rejected"` Status of the trust grant. - `"active"` - `"pending"` - `"rejected"` - `updated_at: string` When this user profile was last modified, in RFC 3339 format. Trust-grant status changes also bump this timestamp. format: date-time - `access_type: optional "application" or "passthrough"` How the platform uses the API for this entity: `application` (default) or `passthrough`. Present under the `user-profiles-2026-08-18` and later beta headers. - `"application"` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `"passthrough"` The user profile represents a company that the platform resells Claude access to. - `external_id: optional string or null` Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`. - `external_user_details: optional BetaUserProfileExternalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Present under the `user-profiles-2026-09-04` beta header, with every field present and `null` until the platform supplies a value; the earlier beta headers serve `reference_id` as the top-level `external_id`, and `user-profiles-2026-08-18` serves `onboarded_at` as `external_user_onboarded_at`. - `account_status: "active" or "suspended" or "blocked" or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: string or null` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `email_hash: string or null` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `entity_type: "individual" or "business" or "non_profit" or "government" or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: string or null` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `onboarded_at: string or null` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `reference_id: string or null` The platform's own reference for the entity. `null` until the platform supplies one. - `external_user_onboarded_at: optional string or null` When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Present under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` the value is `external_user_details.onboarded_at`. format: date-time - `name: optional string or null` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. #### Example ```bash curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: user-profiles-2026-08-18' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "country", "email_hash": "email_hash", "entity_type": "individual", "name_hash": "name_hash", "onboarded_at": "2019-12-27T18:11:19.117Z", "reference_id": "reference_id" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z", "name": "Example User" } ``` ### Update User Profile **POST** `/v1/user_profiles/{user_profile_id}` Update User Profile #### Path parameters - `user_profile_id: string` The ID of the user profile to update (`uprof_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `user-profiles-2026-03-24`, `user-profiles-2026-08-18`, or `user-profiles-2026-09-04` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `access_type: optional "application" or "passthrough" or null` If present, replaces the stored access type. Omit to leave unchanged. - `"application"` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `"passthrough"` The user profile represents a company that the platform resells Claude access to. - `external_id: optional string or null` If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. Accepted under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` send `external_user_details.reference_id` instead. minLength: 1, maxLength: 255 - `external_user_details: optional BetaUserProfileExternalUserDetailsParams` Details about the entity this profile represents, as the platform states them. Each field sent replaces the stored value; omit a field to leave it unchanged. Once set, a value cannot be cleared and `null` is rejected. Accepted under the `user-profiles-2026-09-04` beta header only. - `account_status: optional "active" or "suspended" or "blocked" or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: optional string or null` The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked. - `email_hash: optional string or null` A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters. minLength: 1, maxLength: 255 - `entity_type: optional "individual" or "business" or "non_profit" or "government" or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: optional string or null` A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters. minLength: 1, maxLength: 255 - `onboarded_at: optional string` When the entity opened its account with the platform, in RFC 3339 format: for an `application` profile, when the end-user signed up; for a `passthrough` profile, when the company became the platform's customer. Must be a complete timestamp no more than 1 minute in the future. format: date-time - `reference_id: optional string or null` The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters. minLength: 1, maxLength: 255 - `external_user_onboarded_at: optional string` If present, replaces the stored account creation time. Omit to leave unchanged; once set, the value cannot be cleared and `null` is rejected. Must be a complete RFC 3339 timestamp no more than 1 minute in the future. Accepted under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` send `external_user_details.onboarded_at` instead. format: date-time - `metadata: optional map[string]` 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: optional string or null` If present, replaces the stored name. Omit to leave unchanged. Maximum 255 characters. minLength: 1, maxLength: 255 #### Returns - `BetaUserProfile object` A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to. A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity. - `type: "user_profile"` Object type. Always `user_profile`. - `id: string` Unique identifier for this user profile, prefixed `uprof_`. - `created_at: string` When this user profile was created, in RFC 3339 format. format: date-time - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `trust_grants: map[BetaUserProfileTrustGrant]` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `status: "active" or "pending" or "rejected"` Status of the trust grant. - `"active"` - `"pending"` - `"rejected"` - `updated_at: string` When this user profile was last modified, in RFC 3339 format. Trust-grant status changes also bump this timestamp. format: date-time - `access_type: optional "application" or "passthrough"` How the platform uses the API for this entity: `application` (default) or `passthrough`. Present under the `user-profiles-2026-08-18` and later beta headers. - `"application"` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `"passthrough"` The user profile represents a company that the platform resells Claude access to. - `external_id: optional string or null` Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`. - `external_user_details: optional BetaUserProfileExternalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Present under the `user-profiles-2026-09-04` beta header, with every field present and `null` until the platform supplies a value; the earlier beta headers serve `reference_id` as the top-level `external_id`, and `user-profiles-2026-08-18` serves `onboarded_at` as `external_user_onboarded_at`. - `account_status: "active" or "suspended" or "blocked" or null` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. - `country: string or null` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `email_hash: string or null` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `entity_type: "individual" or "business" or "non_profit" or "government" or null` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `"individual"` - `"business"` - `"non_profit"` - `"government"` - `name_hash: string or null` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `onboarded_at: string or null` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `reference_id: string or null` The platform's own reference for the entity. `null` until the platform supplies one. - `external_user_onboarded_at: optional string or null` When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Present under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` the value is `external_user_details.onboarded_at`. format: date-time - `name: optional string or null` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. #### Example ```bash curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: user-profiles-2026-08-18' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "external_id": "user_12345" }' ``` ##### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "country", "email_hash": "email_hash", "entity_type": "individual", "name_hash": "name_hash", "onboarded_at": "2019-12-27T18:11:19.117Z", "reference_id": "reference_id" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z", "name": "Example User" } ``` ### Create Enrollment URL **POST** `/v1/user_profiles/{user_profile_id}/enrollment_url` Create Enrollment URL #### Path parameters - `user_profile_id: string` The ID of the user profile to create an enrollment URL for (`uprof_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `user-profiles-2026-03-24`, `user-profiles-2026-08-18`, or `user-profiles-2026-09-04` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaUserProfileEnrollmentURL object` A URL to give to the entity that a user profile represents, so that the entity can enroll for a trust grant. - `type: "enrollment_url"` Object type. Always `enrollment_url`. - `expires_at: string` When this enrollment URL expires, in RFC 3339 format. format: date-time - `url: string` Enrollment URL to send to the end user. Valid until `expires_at`. #### Example ```bash curl https://api.anthropic.com/v1/user_profiles/$USER_PROFILE_ID/enrollment_url \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: user-profiles-2026-08-18' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "expires_at": "2026-03-15T10:15:00Z", "type": "enrollment_url", "url": "https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1" } ``` ## Beta › Dreams ### Create a Dream **POST** `/v1/dreams` Start an asynchronous job that uses past sessions to produce a reorganized version of a memory store and get back the dream to poll for the result. By default the dream writes its result to a new memory store and doesn't change the input memory store. The response has `status` set to `pending` and an empty `outputs` array. Poll the dream until `status` is `completed`, `failed`, or `canceled`. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#create-a-dream) to learn more about creating dreams. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `dreaming-2026-04-21` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `inputs: array of BetaDreamInput` The memory store and sessions for the dream to read, as exactly one `memory_store` entry and exactly one `sessions` entry. - `BetaDreamMemoryStoreInput object` The memory store that a dream reads, given as an entry in `inputs`. With `output_behavior` set to `update_existing`, the dream writes its result into this memory store. Otherwise the dream doesn't change it. - `type: "memory_store"` - `memory_store_id: string` The ID of the memory store for the dream to read (`memstore_...`). The memory store must be in the same workspace as the dream and must not be archived. minLength: 1 - `BetaDreamSessionsInput object` The sessions that a dream reads, given as an entry in `inputs`. - `type: "sessions"` - `session_ids: array of string` The IDs of the sessions whose transcripts the dream reads (`sesn_...`). Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order. The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream. - `model: string or BetaDreamModelConfigParam` The model that runs a dream, given as a model ID or as an object with `id` and `speed`. In the object form, `speed` can only be `standard`. The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists the supported models. - `string` - `BetaDreamModelConfigParam object` The object form of `model` in a request to create a dream. - `id: string` The ID of the model to run the dream with. The ID can be 1 to 256 characters long. The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists the supported models. minLength: 1, maxLength: 256 - `speed: optional "standard" or "fast" or null` How fast the model generates output for the dream. Defaults to `standard`. Dreams accept only `standard`. - `"standard"` - `"fast"` - `instructions: optional string or null` Guidance that steers how the dream reads the sessions and organizes the output memory store, from 1 to 4,096 characters. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#steer-with-instructions) for what kinds of instructions work well. minLength: 1, maxLength: 4096 - `output_behavior: optional BetaOutputBehavior` Which memory store a dream writes its result to. Defaults to `create_new` when left out of a create request. - `BetaOutputBehaviorCreateNew object` Write the result to a new memory store that starts as a copy of the input memory store. This is the default. The new memory store is in the same workspace as the dream. The dream doesn't change the input memory store. - `type: "create_new"` - `BetaOutputBehaviorUpdateExisting object` Write the result into the input memory store instead of a new memory store. The credential must be allowed to write memory stores, or the request returns a 403 error. While another `update_existing` dream on the same memory store hasn't fully stopped, the request returns a 409 error. - `type: "update_existing"` - `memory_store_id: string` The ID of the memory store for the dream to write its result to (`memstore_...`). It must be the memory store in the `memory_store` entry of `inputs`. minLength: 1 #### Returns - `BetaDream object` An asynchronous job that reads a memory store and past sessions, then writes a reorganized version of that memory store. By default the dream writes its result to a new memory store and doesn't change the input memory store. With `output_behavior` set to `update_existing`, it writes its result into the input memory store instead. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#how-it-works) for what a dream reads and produces. - `type: "dream"` - `id: string` The unique ID of the dream (`drm_...`). - `archived_at: string or null` When the dream was archived, in RFC 3339, or `null` if it hasn't been archived. format: date-time - `created_at: string` When the dream was created, in RFC 3339. Lists of dreams are sorted by this time, newest first. format: date-time - `ended_at: string or null` When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`. format: date-time - `error: BetaDreamError or null` Why the dream failed, or `null` if `status` isn't `failed`. - `type: string` A code for why the dream failed, such as `timeout` or `internal_error`. The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#errors) lists common error codes and when they occur. - `message: string` A human-readable explanation of why the dream failed. - `inputs: array of BetaDreamInput` The sources that the dream reads, from the request that created it. - `BetaDreamMemoryStoreInput object` The memory store that a dream reads, given as an entry in `inputs`. With `output_behavior` set to `update_existing`, the dream writes its result into this memory store. Otherwise the dream doesn't change it. - `type: "memory_store"` - `memory_store_id: string` The ID of the memory store for the dream to read (`memstore_...`). The memory store must be in the same workspace as the dream and must not be archived. minLength: 1 - `BetaDreamSessionsInput object` The sessions that a dream reads, given as an entry in `inputs`. - `type: "sessions"` - `session_ids: array of string` The IDs of the sessions whose transcripts the dream reads (`sesn_...`). Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order. The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream. - `instructions: string or null` The guidance given when the dream was created, or `null` if none was given. - `model: BetaDreamModelConfig` The model that runs a dream, from the request that created it. The dream uses this model for all of its work. The response always gives the model as an object, even if the request gave only a model ID. - `id: string` The ID of the model that runs the dream, as given in the request that created it. minLength: 1, maxLength: 256 - `speed: optional "standard" or "fast"` How fast the model generates output for the dream. Always `standard`. - `"standard"` - `"fast"` - `output_behavior: BetaOutputBehavior` Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior. - `BetaOutputBehaviorCreateNew object` Write the result to a new memory store that starts as a copy of the input memory store. This is the default. The new memory store is in the same workspace as the dream. The dream doesn't change the input memory store. - `type: "create_new"` - `BetaOutputBehaviorUpdateExisting object` Write the result into the input memory store instead of a new memory store. The credential must be allowed to write memory stores, or the request returns a 403 error. While another `update_existing` dream on the same memory store hasn't fully stopped, the request returns a 409 error. - `type: "update_existing"` - `memory_store_id: string` The ID of the memory store for the dream to write its result to (`memstore_...`). It must be the memory store in the `memory_store` entry of `inputs`. minLength: 1 - `outputs: array of BetaDreamOutput` The memory store that holds the dream's result, as a one-item array, or an empty array until the dream records that memory store. The array is empty while the dream is `pending` and for a short time after it starts `running`. It can stay empty if the dream fails or is canceled before then. The memory store holds the complete result only once `status` is `completed`. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#use-the-output) for how to review and use the result. - `type: "memory_store"` - `memory_store_id: string` The ID of the memory store that the dream writes its result to (`memstore_...`). With `output_behavior` set to `create_new`, this is a new memory store. With `update_existing`, it is the input memory store. - `session_id: string or null` The ID of the session that runs the dream (`sesn_...`), or `null` if that session hasn't started. Stream that session's events to follow what the dream reads and writes. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#watch-the-pipeline-run) for how to watch a running dream. - `status: BetaDreamStatus` Where a dream is in its lifecycle. `completed`, `failed`, and `canceled` are final: once a dream has one of these statuses, its status doesn't change again. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#lifecycle) for what each status means. - `"pending"` The dream is waiting to start and hasn't read its inputs yet. `outputs` is empty and every `usage` count is zero. - `"running"` The dream is reading its inputs and writing its result. `usage` updates while the dream has this status. - `"completed"` The dream finished and its output memory store holds the complete result. - `"failed"` The dream stopped with an error, which `error` describes. If `outputs` references a memory store, that memory store keeps what the dream wrote before it stopped. - `"canceled"` A cancel request stopped the dream before it reached `completed` or `failed`. If `outputs` references a memory store, that memory store keeps what the dream wrote. `usage` can keep changing after the cancel. - `usage: BetaDreamUsage` The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing. - `cache_creation_input_tokens: number` The dream's input tokens that were written to the prompt cache, for both the 5-minute and 1-hour cache durations. format: int32 - `cache_read_input_tokens: number` The dream's input tokens that were read from the prompt cache. format: int32 - `input_tokens: number` The dream's input tokens that weren't read from or written to the prompt cache. format: int32 - `output_tokens: number` The tokens that the model generated for the dream. format: int32 #### Example ```bash curl https://api.anthropic.com/v1/dreams \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: dreaming-2026-04-21' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "inputs": [ { "memory_store_id": "x", "type": "memory_store" } ], "model": "string" }' ``` ##### Response (200) ```json { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "ended_at": "2019-12-27T18:11:19.117Z", "error": { "message": "message", "type": "type" }, "inputs": [ { "memory_store_id": "x", "type": "memory_store" } ], "instructions": "instructions", "model": { "id": "x", "speed": "standard" }, "output_behavior": { "type": "create_new" }, "outputs": [ { "memory_store_id": "memory_store_id", "type": "memory_store" } ], "session_id": "session_id", "status": "pending", "type": "dream", "usage": { "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } ``` ### List Dreams **GET** `/v1/dreams` List the dreams in the workspace, newest first. Archived dreams are left out unless `include_archived` is `true`. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#list-dreams) for how to page through dreams. #### Query parameters - `"created_at[gt]": optional string` Return only dreams created after this time (exclusive), in RFC 3339. format: date-time - `"created_at[lt]": optional string` Return only dreams created before this time (exclusive), in RFC 3339. format: date-time - `include_archived: optional boolean` Whether to include archived dreams. Defaults to `false`. - `limit: optional number` The maximum number of dreams to return, from 1 to 100. Defaults to 20. format: int32 - `page: optional string` The cursor for the page to return, taken from `next_page` in a previous response. Leave it out to get the first page. - `statuses: optional array of BetaDreamStatus` Return only dreams that have one of these statuses. Repeat the parameter to give more than one status. Leave it out to return dreams of every status. - `"pending"` The dream is waiting to start and hasn't read its inputs yet. `outputs` is empty and every `usage` count is zero. - `"running"` The dream is reading its inputs and writing its result. `usage` updates while the dream has this status. - `"completed"` The dream finished and its output memory store holds the complete result. - `"failed"` The dream stopped with an error, which `error` describes. If `outputs` references a memory store, that memory store keeps what the dream wrote before it stopped. - `"canceled"` A cancel request stopped the dream before it reached `completed` or `failed`. If `outputs` references a memory store, that memory store keeps what the dream wrote. `usage` can keep changing after the cancel. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `dreaming-2026-04-21` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaDream` The dreams on this page, newest first. - `type: "dream"` - `id: string` The unique ID of the dream (`drm_...`). - `archived_at: string or null` When the dream was archived, in RFC 3339, or `null` if it hasn't been archived. format: date-time - `created_at: string` When the dream was created, in RFC 3339. Lists of dreams are sorted by this time, newest first. format: date-time - `ended_at: string or null` When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`. format: date-time - `error: BetaDreamError or null` Why the dream failed, or `null` if `status` isn't `failed`. - `type: string` A code for why the dream failed, such as `timeout` or `internal_error`. The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#errors) lists common error codes and when they occur. - `message: string` A human-readable explanation of why the dream failed. - `inputs: array of BetaDreamInput` The sources that the dream reads, from the request that created it. - `BetaDreamMemoryStoreInput object` The memory store that a dream reads, given as an entry in `inputs`. With `output_behavior` set to `update_existing`, the dream writes its result into this memory store. Otherwise the dream doesn't change it. - `type: "memory_store"` - `memory_store_id: string` The ID of the memory store for the dream to read (`memstore_...`). The memory store must be in the same workspace as the dream and must not be archived. minLength: 1 - `BetaDreamSessionsInput object` The sessions that a dream reads, given as an entry in `inputs`. - `type: "sessions"` - `session_ids: array of string` The IDs of the sessions whose transcripts the dream reads (`sesn_...`). Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order. The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream. - `instructions: string or null` The guidance given when the dream was created, or `null` if none was given. - `model: BetaDreamModelConfig` The model that runs a dream, from the request that created it. The dream uses this model for all of its work. The response always gives the model as an object, even if the request gave only a model ID. - `id: string` The ID of the model that runs the dream, as given in the request that created it. minLength: 1, maxLength: 256 - `speed: optional "standard" or "fast"` How fast the model generates output for the dream. Always `standard`. - `"standard"` - `"fast"` - `output_behavior: BetaOutputBehavior` Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior. - `BetaOutputBehaviorCreateNew object` Write the result to a new memory store that starts as a copy of the input memory store. This is the default. The new memory store is in the same workspace as the dream. The dream doesn't change the input memory store. - `type: "create_new"` - `BetaOutputBehaviorUpdateExisting object` Write the result into the input memory store instead of a new memory store. The credential must be allowed to write memory stores, or the request returns a 403 error. While another `update_existing` dream on the same memory store hasn't fully stopped, the request returns a 409 error. - `type: "update_existing"` - `memory_store_id: string` The ID of the memory store for the dream to write its result to (`memstore_...`). It must be the memory store in the `memory_store` entry of `inputs`. minLength: 1 - `outputs: array of BetaDreamOutput` The memory store that holds the dream's result, as a one-item array, or an empty array until the dream records that memory store. The array is empty while the dream is `pending` and for a short time after it starts `running`. It can stay empty if the dream fails or is canceled before then. The memory store holds the complete result only once `status` is `completed`. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#use-the-output) for how to review and use the result. - `type: "memory_store"` - `memory_store_id: string` The ID of the memory store that the dream writes its result to (`memstore_...`). With `output_behavior` set to `create_new`, this is a new memory store. With `update_existing`, it is the input memory store. - `session_id: string or null` The ID of the session that runs the dream (`sesn_...`), or `null` if that session hasn't started. Stream that session's events to follow what the dream reads and writes. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#watch-the-pipeline-run) for how to watch a running dream. - `status: BetaDreamStatus` Where a dream is in its lifecycle. `completed`, `failed`, and `canceled` are final: once a dream has one of these statuses, its status doesn't change again. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#lifecycle) for what each status means. - `"pending"` The dream is waiting to start and hasn't read its inputs yet. `outputs` is empty and every `usage` count is zero. - `"running"` The dream is reading its inputs and writing its result. `usage` updates while the dream has this status. - `"completed"` The dream finished and its output memory store holds the complete result. - `"failed"` The dream stopped with an error, which `error` describes. If `outputs` references a memory store, that memory store keeps what the dream wrote before it stopped. - `"canceled"` A cancel request stopped the dream before it reached `completed` or `failed`. If `outputs` references a memory store, that memory store keeps what the dream wrote. `usage` can keep changing after the cancel. - `usage: BetaDreamUsage` The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing. - `cache_creation_input_tokens: number` The dream's input tokens that were written to the prompt cache, for both the 5-minute and 1-hour cache durations. format: int32 - `cache_read_input_tokens: number` The dream's input tokens that were read from the prompt cache. format: int32 - `input_tokens: number` The dream's input tokens that weren't read from or written to the prompt cache. format: int32 - `output_tokens: number` The tokens that the model generated for the dream. format: int32 - `next_page: string or null` The cursor for the next page, or `null` if this is the last page. Pass it as `page` to get the next page. #### Example ```bash curl https://api.anthropic.com/v1/dreams \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: dreaming-2026-04-21' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "ended_at": "2019-12-27T18:11:19.117Z", "error": { "message": "message", "type": "type" }, "inputs": [ { "memory_store_id": "x", "type": "memory_store" } ], "instructions": "instructions", "model": { "id": "x", "speed": "standard" }, "output_behavior": { "type": "create_new" }, "outputs": [ { "memory_store_id": "memory_store_id", "type": "memory_store" } ], "session_id": "session_id", "status": "pending", "type": "dream", "usage": { "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } ], "next_page": "next_page" } ``` ### Get a Dream **GET** `/v1/dreams/{dream_id}` Get a dream by ID to check its status, output memory store, and token usage. Archived dreams are returned too. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#track-progress) for how to poll a dream and what each status means. #### Path parameters - `dream_id: string` The ID of the dream to get (`drm_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `dreaming-2026-04-21` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaDream object` An asynchronous job that reads a memory store and past sessions, then writes a reorganized version of that memory store. By default the dream writes its result to a new memory store and doesn't change the input memory store. With `output_behavior` set to `update_existing`, it writes its result into the input memory store instead. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#how-it-works) for what a dream reads and produces. - `type: "dream"` - `id: string` The unique ID of the dream (`drm_...`). - `archived_at: string or null` When the dream was archived, in RFC 3339, or `null` if it hasn't been archived. format: date-time - `created_at: string` When the dream was created, in RFC 3339. Lists of dreams are sorted by this time, newest first. format: date-time - `ended_at: string or null` When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`. format: date-time - `error: BetaDreamError or null` Why the dream failed, or `null` if `status` isn't `failed`. - `type: string` A code for why the dream failed, such as `timeout` or `internal_error`. The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#errors) lists common error codes and when they occur. - `message: string` A human-readable explanation of why the dream failed. - `inputs: array of BetaDreamInput` The sources that the dream reads, from the request that created it. - `BetaDreamMemoryStoreInput object` The memory store that a dream reads, given as an entry in `inputs`. With `output_behavior` set to `update_existing`, the dream writes its result into this memory store. Otherwise the dream doesn't change it. - `type: "memory_store"` - `memory_store_id: string` The ID of the memory store for the dream to read (`memstore_...`). The memory store must be in the same workspace as the dream and must not be archived. minLength: 1 - `BetaDreamSessionsInput object` The sessions that a dream reads, given as an entry in `inputs`. - `type: "sessions"` - `session_ids: array of string` The IDs of the sessions whose transcripts the dream reads (`sesn_...`). Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order. The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream. - `instructions: string or null` The guidance given when the dream was created, or `null` if none was given. - `model: BetaDreamModelConfig` The model that runs a dream, from the request that created it. The dream uses this model for all of its work. The response always gives the model as an object, even if the request gave only a model ID. - `id: string` The ID of the model that runs the dream, as given in the request that created it. minLength: 1, maxLength: 256 - `speed: optional "standard" or "fast"` How fast the model generates output for the dream. Always `standard`. - `"standard"` - `"fast"` - `output_behavior: BetaOutputBehavior` Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior. - `BetaOutputBehaviorCreateNew object` Write the result to a new memory store that starts as a copy of the input memory store. This is the default. The new memory store is in the same workspace as the dream. The dream doesn't change the input memory store. - `type: "create_new"` - `BetaOutputBehaviorUpdateExisting object` Write the result into the input memory store instead of a new memory store. The credential must be allowed to write memory stores, or the request returns a 403 error. While another `update_existing` dream on the same memory store hasn't fully stopped, the request returns a 409 error. - `type: "update_existing"` - `memory_store_id: string` The ID of the memory store for the dream to write its result to (`memstore_...`). It must be the memory store in the `memory_store` entry of `inputs`. minLength: 1 - `outputs: array of BetaDreamOutput` The memory store that holds the dream's result, as a one-item array, or an empty array until the dream records that memory store. The array is empty while the dream is `pending` and for a short time after it starts `running`. It can stay empty if the dream fails or is canceled before then. The memory store holds the complete result only once `status` is `completed`. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#use-the-output) for how to review and use the result. - `type: "memory_store"` - `memory_store_id: string` The ID of the memory store that the dream writes its result to (`memstore_...`). With `output_behavior` set to `create_new`, this is a new memory store. With `update_existing`, it is the input memory store. - `session_id: string or null` The ID of the session that runs the dream (`sesn_...`), or `null` if that session hasn't started. Stream that session's events to follow what the dream reads and writes. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#watch-the-pipeline-run) for how to watch a running dream. - `status: BetaDreamStatus` Where a dream is in its lifecycle. `completed`, `failed`, and `canceled` are final: once a dream has one of these statuses, its status doesn't change again. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#lifecycle) for what each status means. - `"pending"` The dream is waiting to start and hasn't read its inputs yet. `outputs` is empty and every `usage` count is zero. - `"running"` The dream is reading its inputs and writing its result. `usage` updates while the dream has this status. - `"completed"` The dream finished and its output memory store holds the complete result. - `"failed"` The dream stopped with an error, which `error` describes. If `outputs` references a memory store, that memory store keeps what the dream wrote before it stopped. - `"canceled"` A cancel request stopped the dream before it reached `completed` or `failed`. If `outputs` references a memory store, that memory store keeps what the dream wrote. `usage` can keep changing after the cancel. - `usage: BetaDreamUsage` The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing. - `cache_creation_input_tokens: number` The dream's input tokens that were written to the prompt cache, for both the 5-minute and 1-hour cache durations. format: int32 - `cache_read_input_tokens: number` The dream's input tokens that were read from the prompt cache. format: int32 - `input_tokens: number` The dream's input tokens that weren't read from or written to the prompt cache. format: int32 - `output_tokens: number` The tokens that the model generated for the dream. format: int32 #### Example ```bash curl https://api.anthropic.com/v1/dreams/$DREAM_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: dreaming-2026-04-21' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "ended_at": "2019-12-27T18:11:19.117Z", "error": { "message": "message", "type": "type" }, "inputs": [ { "memory_store_id": "x", "type": "memory_store" } ], "instructions": "instructions", "model": { "id": "x", "speed": "standard" }, "output_behavior": { "type": "create_new" }, "outputs": [ { "memory_store_id": "memory_store_id", "type": "memory_store" } ], "session_id": "session_id", "status": "pending", "type": "dream", "usage": { "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } ``` ### Cancel a Dream **POST** `/v1/dreams/{dream_id}/cancel` Stop a `pending` or `running` dream. The response shows `status` as `canceled`, unless the dream reached `completed` or `failed` first. `usage` can keep changing after the response. Canceling a `canceled` dream returns it unchanged. Canceling a `completed` or `failed` dream returns a 400 error. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#cancel-a-dream) to learn more about canceling dreams. #### Path parameters - `dream_id: string` The ID of the dream to cancel (`drm_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `dreaming-2026-04-21` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaDream object` An asynchronous job that reads a memory store and past sessions, then writes a reorganized version of that memory store. By default the dream writes its result to a new memory store and doesn't change the input memory store. With `output_behavior` set to `update_existing`, it writes its result into the input memory store instead. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#how-it-works) for what a dream reads and produces. - `type: "dream"` - `id: string` The unique ID of the dream (`drm_...`). - `archived_at: string or null` When the dream was archived, in RFC 3339, or `null` if it hasn't been archived. format: date-time - `created_at: string` When the dream was created, in RFC 3339. Lists of dreams are sorted by this time, newest first. format: date-time - `ended_at: string or null` When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`. format: date-time - `error: BetaDreamError or null` Why the dream failed, or `null` if `status` isn't `failed`. - `type: string` A code for why the dream failed, such as `timeout` or `internal_error`. The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#errors) lists common error codes and when they occur. - `message: string` A human-readable explanation of why the dream failed. - `inputs: array of BetaDreamInput` The sources that the dream reads, from the request that created it. - `BetaDreamMemoryStoreInput object` The memory store that a dream reads, given as an entry in `inputs`. With `output_behavior` set to `update_existing`, the dream writes its result into this memory store. Otherwise the dream doesn't change it. - `type: "memory_store"` - `memory_store_id: string` The ID of the memory store for the dream to read (`memstore_...`). The memory store must be in the same workspace as the dream and must not be archived. minLength: 1 - `BetaDreamSessionsInput object` The sessions that a dream reads, given as an entry in `inputs`. - `type: "sessions"` - `session_ids: array of string` The IDs of the sessions whose transcripts the dream reads (`sesn_...`). Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order. The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream. - `instructions: string or null` The guidance given when the dream was created, or `null` if none was given. - `model: BetaDreamModelConfig` The model that runs a dream, from the request that created it. The dream uses this model for all of its work. The response always gives the model as an object, even if the request gave only a model ID. - `id: string` The ID of the model that runs the dream, as given in the request that created it. minLength: 1, maxLength: 256 - `speed: optional "standard" or "fast"` How fast the model generates output for the dream. Always `standard`. - `"standard"` - `"fast"` - `output_behavior: BetaOutputBehavior` Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior. - `BetaOutputBehaviorCreateNew object` Write the result to a new memory store that starts as a copy of the input memory store. This is the default. The new memory store is in the same workspace as the dream. The dream doesn't change the input memory store. - `type: "create_new"` - `BetaOutputBehaviorUpdateExisting object` Write the result into the input memory store instead of a new memory store. The credential must be allowed to write memory stores, or the request returns a 403 error. While another `update_existing` dream on the same memory store hasn't fully stopped, the request returns a 409 error. - `type: "update_existing"` - `memory_store_id: string` The ID of the memory store for the dream to write its result to (`memstore_...`). It must be the memory store in the `memory_store` entry of `inputs`. minLength: 1 - `outputs: array of BetaDreamOutput` The memory store that holds the dream's result, as a one-item array, or an empty array until the dream records that memory store. The array is empty while the dream is `pending` and for a short time after it starts `running`. It can stay empty if the dream fails or is canceled before then. The memory store holds the complete result only once `status` is `completed`. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#use-the-output) for how to review and use the result. - `type: "memory_store"` - `memory_store_id: string` The ID of the memory store that the dream writes its result to (`memstore_...`). With `output_behavior` set to `create_new`, this is a new memory store. With `update_existing`, it is the input memory store. - `session_id: string or null` The ID of the session that runs the dream (`sesn_...`), or `null` if that session hasn't started. Stream that session's events to follow what the dream reads and writes. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#watch-the-pipeline-run) for how to watch a running dream. - `status: BetaDreamStatus` Where a dream is in its lifecycle. `completed`, `failed`, and `canceled` are final: once a dream has one of these statuses, its status doesn't change again. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#lifecycle) for what each status means. - `"pending"` The dream is waiting to start and hasn't read its inputs yet. `outputs` is empty and every `usage` count is zero. - `"running"` The dream is reading its inputs and writing its result. `usage` updates while the dream has this status. - `"completed"` The dream finished and its output memory store holds the complete result. - `"failed"` The dream stopped with an error, which `error` describes. If `outputs` references a memory store, that memory store keeps what the dream wrote before it stopped. - `"canceled"` A cancel request stopped the dream before it reached `completed` or `failed`. If `outputs` references a memory store, that memory store keeps what the dream wrote. `usage` can keep changing after the cancel. - `usage: BetaDreamUsage` The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing. - `cache_creation_input_tokens: number` The dream's input tokens that were written to the prompt cache, for both the 5-minute and 1-hour cache durations. format: int32 - `cache_read_input_tokens: number` The dream's input tokens that were read from the prompt cache. format: int32 - `input_tokens: number` The dream's input tokens that weren't read from or written to the prompt cache. format: int32 - `output_tokens: number` The tokens that the model generated for the dream. format: int32 #### Example ```bash curl https://api.anthropic.com/v1/dreams/$DREAM_ID/cancel \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: dreaming-2026-04-21' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "ended_at": "2019-12-27T18:11:19.117Z", "error": { "message": "message", "type": "type" }, "inputs": [ { "memory_store_id": "x", "type": "memory_store" } ], "instructions": "instructions", "model": { "id": "x", "speed": "standard" }, "output_behavior": { "type": "create_new" }, "outputs": [ { "memory_store_id": "memory_store_id", "type": "memory_store" } ], "session_id": "session_id", "status": "pending", "type": "dream", "usage": { "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } ``` ### Archive a Dream **POST** `/v1/dreams/{dream_id}/archive` Hide a `completed`, `failed`, or `canceled` dream from the default list of dreams. Archiving a `pending` or `running` dream returns a 400 error, so cancel it first. Archiving an archived dream returns it unchanged. An archived dream can still be fetched by ID. Archiving can't be undone. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#archive-a-dream) to learn more about archiving dreams. #### Path parameters - `dream_id: string` The ID of the dream to archive (`drm_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `dreaming-2026-04-21` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaDream object` An asynchronous job that reads a memory store and past sessions, then writes a reorganized version of that memory store. By default the dream writes its result to a new memory store and doesn't change the input memory store. With `output_behavior` set to `update_existing`, it writes its result into the input memory store instead. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#how-it-works) for what a dream reads and produces. - `type: "dream"` - `id: string` The unique ID of the dream (`drm_...`). - `archived_at: string or null` When the dream was archived, in RFC 3339, or `null` if it hasn't been archived. format: date-time - `created_at: string` When the dream was created, in RFC 3339. Lists of dreams are sorted by this time, newest first. format: date-time - `ended_at: string or null` When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `null` if it is still `pending` or `running`. format: date-time - `error: BetaDreamError or null` Why the dream failed, or `null` if `status` isn't `failed`. - `type: string` A code for why the dream failed, such as `timeout` or `internal_error`. The [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#errors) lists common error codes and when they occur. - `message: string` A human-readable explanation of why the dream failed. - `inputs: array of BetaDreamInput` The sources that the dream reads, from the request that created it. - `BetaDreamMemoryStoreInput object` The memory store that a dream reads, given as an entry in `inputs`. With `output_behavior` set to `update_existing`, the dream writes its result into this memory store. Otherwise the dream doesn't change it. - `type: "memory_store"` - `memory_store_id: string` The ID of the memory store for the dream to read (`memstore_...`). The memory store must be in the same workspace as the dream and must not be archived. minLength: 1 - `BetaDreamSessionsInput object` The sessions that a dream reads, given as an entry in `inputs`. - `type: "sessions"` - `session_ids: array of string` The IDs of the sessions whose transcripts the dream reads (`sesn_...`). Give 1 to 100 IDs, with no duplicates. Each session must be in the same workspace as the dream. Responses list the IDs in sorted order. The [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#limits) lists all the limits on a dream. - `instructions: string or null` The guidance given when the dream was created, or `null` if none was given. - `model: BetaDreamModelConfig` The model that runs a dream, from the request that created it. The dream uses this model for all of its work. The response always gives the model as an object, even if the request gave only a model ID. - `id: string` The ID of the model that runs the dream, as given in the request that created it. minLength: 1, maxLength: 256 - `speed: optional "standard" or "fast"` How fast the model generates output for the dream. Always `standard`. - `"standard"` - `"fast"` - `output_behavior: BetaOutputBehavior` Where the dream writes its result, as set in the request that created the dream. If that request left out `output_behavior`, the dream used the `create_new` behavior. - `BetaOutputBehaviorCreateNew object` Write the result to a new memory store that starts as a copy of the input memory store. This is the default. The new memory store is in the same workspace as the dream. The dream doesn't change the input memory store. - `type: "create_new"` - `BetaOutputBehaviorUpdateExisting object` Write the result into the input memory store instead of a new memory store. The credential must be allowed to write memory stores, or the request returns a 403 error. While another `update_existing` dream on the same memory store hasn't fully stopped, the request returns a 409 error. - `type: "update_existing"` - `memory_store_id: string` The ID of the memory store for the dream to write its result to (`memstore_...`). It must be the memory store in the `memory_store` entry of `inputs`. minLength: 1 - `outputs: array of BetaDreamOutput` The memory store that holds the dream's result, as a one-item array, or an empty array until the dream records that memory store. The array is empty while the dream is `pending` and for a short time after it starts `running`. It can stay empty if the dream fails or is canceled before then. The memory store holds the complete result only once `status` is `completed`. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#use-the-output) for how to review and use the result. - `type: "memory_store"` - `memory_store_id: string` The ID of the memory store that the dream writes its result to (`memstore_...`). With `output_behavior` set to `create_new`, this is a new memory store. With `update_existing`, it is the input memory store. - `session_id: string or null` The ID of the session that runs the dream (`sesn_...`), or `null` if that session hasn't started. Stream that session's events to follow what the dream reads and writes. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#watch-the-pipeline-run) for how to watch a running dream. - `status: BetaDreamStatus` Where a dream is in its lifecycle. `completed`, `failed`, and `canceled` are final: once a dream has one of these statuses, its status doesn't change again. See the [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams?sdk_languages=http#lifecycle) for what each status means. - `"pending"` The dream is waiting to start and hasn't read its inputs yet. `outputs` is empty and every `usage` count is zero. - `"running"` The dream is reading its inputs and writing its result. `usage` updates while the dream has this status. - `"completed"` The dream finished and its output memory store holds the complete result. - `"failed"` The dream stopped with an error, which `error` describes. If `outputs` references a memory store, that memory store keeps what the dream wrote before it stopped. - `"canceled"` A cancel request stopped the dream before it reached `completed` or `failed`. If `outputs` references a memory store, that memory store keeps what the dream wrote. `usage` can keep changing after the cancel. - `usage: BetaDreamUsage` The dream's token counts, which stop changing once its `status` is `completed` or `failed`. After a cancel, they can keep changing. - `cache_creation_input_tokens: number` The dream's input tokens that were written to the prompt cache, for both the 5-minute and 1-hour cache durations. format: int32 - `cache_read_input_tokens: number` The dream's input tokens that were read from the prompt cache. format: int32 - `input_tokens: number` The dream's input tokens that weren't read from or written to the prompt cache. format: int32 - `output_tokens: number` The tokens that the model generated for the dream. format: int32 #### Example ```bash curl https://api.anthropic.com/v1/dreams/$DREAM_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: dreaming-2026-04-21' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "ended_at": "2019-12-27T18:11:19.117Z", "error": { "message": "message", "type": "type" }, "inputs": [ { "memory_store_id": "x", "type": "memory_store" } ], "instructions": "instructions", "model": { "id": "x", "speed": "standard" }, "output_behavior": { "type": "create_new" }, "outputs": [ { "memory_store_id": "memory_store_id", "type": "memory_store" } ], "session_id": "session_id", "status": "pending", "type": "dream", "usage": { "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } ``` ## Beta › Tunnels ### Create Tunnel **POST** `/v1/tunnels` The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Creates a tunnel. Creation allocates a fresh hostname and provisions the tunnel; it is not idempotent. The new tunnel rejects MCP traffic until at least one CA certificate is added. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-06-22` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `display_name: optional string or null` Optional human-readable name for the tunnel (1-255 characters). minLength: 1, maxLength: 255 #### Returns - `BetaTunnel object` An MCP tunnel. - `type: "tunnel"` - `id: string` Unique identifier for the tunnel, prefixed with `tnl_`. - `archived_at: string or null` RFC 3339 datetime string indicating when the tunnel was archived. Null if it is not archived. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the tunnel was created. format: date-time - `display_name: string or null` Human-readable name for the tunnel (1-255 characters). Null if unset. - `domain: string` Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived. #### Example ```bash curl https://api.anthropic.com/v1/tunnels \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{}' ``` ##### Response (200) ```json { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "display_name": "display_name", "domain": "domain", "type": "tunnel" } ``` ### Get Tunnel **GET** `/v1/tunnels/{tunnel_id}` The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Fetches a tunnel by ID. #### Path parameters - `tunnel_id: string` ID of the tunnel (`tnl_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-06-22` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaTunnel object` An MCP tunnel. - `type: "tunnel"` - `id: string` Unique identifier for the tunnel, prefixed with `tnl_`. - `archived_at: string or null` RFC 3339 datetime string indicating when the tunnel was archived. Null if it is not archived. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the tunnel was created. format: date-time - `display_name: string or null` Human-readable name for the tunnel (1-255 characters). Null if unset. - `domain: string` Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived. #### Example ```bash curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "display_name": "display_name", "domain": "domain", "type": "tunnel" } ``` ### List Tunnels **GET** `/v1/tunnels` The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Lists tunnels. Results are ordered by creation time, newest first; archived tunnels are excluded unless include_archived is set. #### Query parameters - `include_archived: optional boolean` Whether to include archived tunnels in the results. Defaults to false. - `limit: optional number` Maximum number of tunnels to return per page. Defaults to 20, maximum 1000. format: int32 - `page: optional string` Opaque pagination cursor from a previous `list_tunnels` response. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-06-22` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaTunnel` List of tunnels, ordered by created_at descending. - `type: "tunnel"` - `id: string` Unique identifier for the tunnel, prefixed with `tnl_`. - `archived_at: string or null` RFC 3339 datetime string indicating when the tunnel was archived. Null if it is not archived. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the tunnel was created. format: date-time - `display_name: string or null` Human-readable name for the tunnel (1-255 characters). Null if unset. - `domain: string` Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived. - `next_page: string or null` Pagination cursor for the next page, or null if no more results. #### Example ```bash curl https://api.anthropic.com/v1/tunnels \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "display_name": "display_name", "domain": "domain", "type": "tunnel" } ], "next_page": "next_page" } ``` ### Archive Tunnel **POST** `/v1/tunnels/{tunnel_id}/archive` The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Archives a tunnel. Archival is irreversible: every non-archived certificate on the tunnel is archived in the same operation, the hostname is retired and never re-allocated, and the tunnel token is invalidated. Retrying against an already-archived tunnel returns the existing record unchanged. #### Path parameters - `tunnel_id: string` ID of the tunnel (`tnl_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-06-22` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaTunnel object` An MCP tunnel. - `type: "tunnel"` - `id: string` Unique identifier for the tunnel, prefixed with `tnl_`. - `archived_at: string or null` RFC 3339 datetime string indicating when the tunnel was archived. Null if it is not archived. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the tunnel was created. format: date-time - `display_name: string or null` Human-readable name for the tunnel (1-255 characters). Null if unset. - `domain: string` Anthropic-assigned hostname for the tunnel. MCP server URLs whose host is a subdomain of this value are routed through the tunnel. Globally unique and never reused, even after the tunnel is archived. #### Example ```bash curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "display_name": "display_name", "domain": "domain", "type": "tunnel" } ``` ### Reveal Tunnel Token **POST** `/v1/tunnels/{tunnel_id}/reveal_token` The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Reveals a tunnel's connector token. The value is fetched live on each call; Anthropic does not store it. Repeated calls return the same value until the token is rotated. Exposed as POST so the token does not appear in intermediary access logs. #### Path parameters - `tunnel_id: string` ID of the tunnel (`tnl_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-06-22` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaTunnelToken object` A tunnel's connector token. - `type: "tunnel_token"` - `id: string` Stable identifier for the current token value. Changes when the token is rotated. - `tunnel_token: string` The connector token used to run the tunnel. Treat as a credential. #### Example ```bash curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/reveal_token \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "tunnel_token": "tunnel_token", "type": "tunnel_token" } ``` ### Rotate Tunnel Token **POST** `/v1/tunnels/{tunnel_id}/rotate_token` The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Rotates a tunnel's connector token. Rotation invalidates the current token for new connections and returns a fresh value; established connections are not severed. A connector restarted after rotation must use the new value. #### Path parameters - `tunnel_id: string` ID of the tunnel (`tnl_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-06-22` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `reason: optional string or null` Optional free-text reason for the rotation, recorded for audit. maxLength: 1024 #### Returns - `BetaTunnelToken object` A tunnel's connector token. - `type: "tunnel_token"` - `id: string` Stable identifier for the current token value. Changes when the token is rotated. - `tunnel_token: string` The connector token used to run the tunnel. Treat as a credential. #### Example ```bash curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/rotate_token \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{}' ``` ##### Response (200) ```json { "id": "id", "tunnel_token": "tunnel_token", "type": "tunnel_token" } ``` ## Beta › Tunnels › Certificates ### Create Tunnel Certificate **POST** `/v1/tunnels/{tunnel_id}/certificates` The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Registers a public CA certificate on a tunnel. Anthropic verifies the gateway's server certificate against this CA when it terminates the inner TLS session. A tunnel holds at most two non-archived certificates. #### Path parameters - `tunnel_id: string` ID of the tunnel (`tnl_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-06-22` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Body parameters - `ca_certificate_pem: string` PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. Maximum 8KB. maxLength: 8192 #### Returns - `BetaTunnelCertificate object` A CA certificate attached to a tunnel. - `type: "tunnel_certificate"` - `id: string` Unique identifier for the certificate, prefixed with `tcrt_`. - `archived_at: string or null` RFC 3339 datetime string indicating when the certificate was archived. Null if it is still in the trusted set. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the certificate was registered. format: date-time - `expires_at: string or null` RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire. format: date-time - `fingerprint: string` Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. - `tunnel_id: string` ID of the tunnel the certificate is registered against. #### Example ```bash curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "ca_certificate_pem": "ca_certificate_pem" }' ``` ##### Response (200) ```json { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "expires_at": "2019-12-27T18:11:19.117Z", "fingerprint": "fingerprint", "tunnel_id": "tunnel_id", "type": "tunnel_certificate" } ``` ### Get Tunnel Certificate **GET** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}` The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Fetches a tunnel certificate by ID. #### Path parameters - `tunnel_id: string` ID of the tunnel (`tnl_...`). - `certificate_id: string` ID of the certificate (`tcrt_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-06-22` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaTunnelCertificate object` A CA certificate attached to a tunnel. - `type: "tunnel_certificate"` - `id: string` Unique identifier for the certificate, prefixed with `tcrt_`. - `archived_at: string or null` RFC 3339 datetime string indicating when the certificate was archived. Null if it is still in the trusted set. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the certificate was registered. format: date-time - `expires_at: string or null` RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire. format: date-time - `fingerprint: string` Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. - `tunnel_id: string` ID of the tunnel the certificate is registered against. #### Example ```bash curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "expires_at": "2019-12-27T18:11:19.117Z", "fingerprint": "fingerprint", "tunnel_id": "tunnel_id", "type": "tunnel_certificate" } ``` ### List Tunnel Certificates **GET** `/v1/tunnels/{tunnel_id}/certificates` The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Lists the certificates registered on a tunnel. Archived certificates are excluded unless include_archived is set. #### Path parameters - `tunnel_id: string` ID of the tunnel (`tnl_...`). #### Query parameters - `include_archived: optional boolean` Whether to include archived certificates in the results. Defaults to false. - `limit: optional number` Maximum number of certificates to return per page. Defaults to 20, maximum 1000. format: int32 - `page: optional string` Opaque pagination cursor from a previous `list_tunnel_certificates` response. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-06-22` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `data: array of BetaTunnelCertificate` List of certificates, ordered by created_at descending. - `type: "tunnel_certificate"` - `id: string` Unique identifier for the certificate, prefixed with `tcrt_`. - `archived_at: string or null` RFC 3339 datetime string indicating when the certificate was archived. Null if it is still in the trusted set. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the certificate was registered. format: date-time - `expires_at: string or null` RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire. format: date-time - `fingerprint: string` Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. - `tunnel_id: string` ID of the tunnel the certificate is registered against. - `next_page: string or null` Pagination cursor for the next page, or null if no more results. #### Example ```bash curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "expires_at": "2019-12-27T18:11:19.117Z", "fingerprint": "fingerprint", "tunnel_id": "tunnel_id", "type": "tunnel_certificate" } ], "next_page": "next_page" } ``` ### Archive Tunnel Certificate **POST** `/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` The Tunnels API is in research preview. It requires the `anthropic-beta: mcp-tunnels-2026-06-22` header and may change without a deprecation period. It supersedes the Admin API endpoints at `/v1/organizations/tunnels`, which remain available during a migration window. Archives a tunnel certificate, removing it from the set Anthropic trusts for the tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. #### Path parameters - `tunnel_id: string` ID of the tunnel (`tnl_...`). - `certificate_id: string` ID of the certificate to archive (`tcrt_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-06-22` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` - `"anthropic-workspace-id": optional string` Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `BetaTunnelCertificate object` A CA certificate attached to a tunnel. - `type: "tunnel_certificate"` - `id: string` Unique identifier for the certificate, prefixed with `tcrt_`. - `archived_at: string or null` RFC 3339 datetime string indicating when the certificate was archived. Null if it is still in the trusted set. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the certificate was registered. format: date-time - `expires_at: string or null` RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire. format: date-time - `fingerprint: string` Lowercase hex SHA-256 fingerprint of the certificate's DER encoding. - `tunnel_id: string` ID of the tunnel the certificate is registered against. #### Example ```bash curl https://api.anthropic.com/v1/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-06-22' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "expires_at": "2019-12-27T18:11:19.117Z", "fingerprint": "fingerprint", "tunnel_id": "tunnel_id", "type": "tunnel_certificate" } ``` ## Beta › Organization ### Get Current Organization **GET** `/v1/organizations/me` Retrieve information about the organization associated with the authenticated API key. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `BetaOrganization object` - `type: "organization"` Object type. For Organizations, this is always `"organization"`. default: organization - `id: string` ID of the Organization. format: uuid - `name: string` Name of the Organization. #### Example ```bash curl https://api.anthropic.com/v1/organizations/me \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "12345678-1234-5678-1234-567812345678", "name": "Organization Name", "type": "organization" } ``` ## Beta › Organization › API Keys ### List API Keys **GET** `/v1/organizations/api_keys` List API Keys #### Query parameters - `after_id: optional string` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `before_id: optional string` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `created_by_user_id: optional string` Filter by the ID of the User who created the object. - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 - `status: optional "active" or "archived" or "expired" or "inactive"` Filter by API key status. - `"active"` - `"archived"` - `"expired"` - `"inactive"` - `workspace_id: optional string` Filter by Workspace ID. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaAPIKey` - `type: "api_key"` Object type. For API Keys, this is always `"api_key"`. default: api_key - `id: string` ID of the API key. - `created_at: string` RFC 3339 datetime string indicating when the API Key was created. format: date-time - `created_by: BetaAPIKeyCreatedBy or null` The ID and type of the actor that created the API key, or `null` when the creator is not recorded (legacy, workload-identity-federated, or system-created keys). - `type: "service_account" or "user"` Type of the actor that created the object. - `"service_account"` - `"user"` - `id: string` ID of the actor that created the object. - `expires_at: string or null` RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. format: date-time - `name: string` Name of the API key. - `partial_key_hint: string or null` Partially redacted hint for the API key. - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. - `BetaAPIKeyUserActor object` - `type: "user_actor"` Principal type. Always `"user_actor"` for a User. default: user_actor - `user_id: string` ID of the User the API key acts as. - `BetaAPIKeyServiceAccountActor object` - `type: "service_account_actor"` Principal type. Always `"service_account_actor"` for a Service Account. default: service_account_actor - `service_account_id: string` ID of the Service Account the API key acts as. - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. - `BetaAPIKeyOrganizationScope object` - `type: "organization"` Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. default: organization - `BetaAPIKeyWorkspaceScope object` - `type: "workspace"` Scope type. Always `"workspace"`: the API key belongs to one Workspace. default: workspace - `workspace_id: string` ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. - `status: "active" or "archived" or "expired" or "inactive"` Status of the API key. - `"active"` - `"archived"` - `"expired"` - `"inactive"` - `workspace_id: string or null` **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. - `first_id: string or null` First ID in the `data` list. Can be used as the `before_id` for the previous page. - `has_more: boolean` Indicates if there are more results in the requested page direction. - `last_id: string or null` Last ID in the `data` list. Can be used as the `after_id` for the next page. #### Example ```bash curl https://api.anthropic.com/v1/organizations/api_keys \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", "created_at": "2024-10-30T23:58:27.427722Z", "created_by": { "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "type": "user" }, "expires_at": "2024-10-30T23:58:27.427722Z", "name": "Developer Key", "partial_key_hint": "sk-ant-api03-R2D...igAA", "principal": { "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "scope": { "type": "workspace", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" }, "status": "active", "type": "api_key", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ### Retrieve API Key (Admin API) **GET** `/v1/organizations/api_keys/{api_key_id}` Retrieve information about a single API key in your organization, looked up by its ID. This Admin API endpoint requires an Admin API key, is intended for programmatic key management, and never returns the key's secret value. To view or create your own API keys, go to [API keys](https://platform.claude.com/settings/keys) in the Claude Console. #### Path parameters - `api_key_id: string` ID of the API key. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `BetaAPIKey object` - `type: "api_key"` Object type. For API Keys, this is always `"api_key"`. default: api_key - `id: string` ID of the API key. - `created_at: string` RFC 3339 datetime string indicating when the API Key was created. format: date-time - `created_by: BetaAPIKeyCreatedBy or null` The ID and type of the actor that created the API key, or `null` when the creator is not recorded (legacy, workload-identity-federated, or system-created keys). - `type: "service_account" or "user"` Type of the actor that created the object. - `"service_account"` - `"user"` - `id: string` ID of the actor that created the object. - `expires_at: string or null` RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. format: date-time - `name: string` Name of the API key. - `partial_key_hint: string or null` Partially redacted hint for the API key. - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. - `BetaAPIKeyUserActor object` - `type: "user_actor"` Principal type. Always `"user_actor"` for a User. default: user_actor - `user_id: string` ID of the User the API key acts as. - `BetaAPIKeyServiceAccountActor object` - `type: "service_account_actor"` Principal type. Always `"service_account_actor"` for a Service Account. default: service_account_actor - `service_account_id: string` ID of the Service Account the API key acts as. - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. - `BetaAPIKeyOrganizationScope object` - `type: "organization"` Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. default: organization - `BetaAPIKeyWorkspaceScope object` - `type: "workspace"` Scope type. Always `"workspace"`: the API key belongs to one Workspace. default: workspace - `workspace_id: string` ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. - `status: "active" or "archived" or "expired" or "inactive"` Status of the API key. - `"active"` - `"archived"` - `"expired"` - `"inactive"` - `workspace_id: string or null` **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. #### Example ```bash curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", "created_at": "2024-10-30T23:58:27.427722Z", "created_by": { "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "type": "user" }, "expires_at": "2024-10-30T23:58:27.427722Z", "name": "Developer Key", "partial_key_hint": "sk-ant-api03-R2D...igAA", "principal": { "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "scope": { "type": "workspace", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" }, "status": "active", "type": "api_key", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ``` ### Update API Key **POST** `/v1/organizations/api_keys/{api_key_id}` Update API Key #### Path parameters - `api_key_id: string` ID of the API key. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Body parameters - `name: optional string or null` Name of the API key. minLength: 1, maxLength: 500 - `status: optional "active" or "archived" or "inactive" or null` Status of the API key. - `"active"` - `"archived"` - `"inactive"` #### Returns - `BetaAPIKey object` - `type: "api_key"` Object type. For API Keys, this is always `"api_key"`. default: api_key - `id: string` ID of the API key. - `created_at: string` RFC 3339 datetime string indicating when the API Key was created. format: date-time - `created_by: BetaAPIKeyCreatedBy or null` The ID and type of the actor that created the API key, or `null` when the creator is not recorded (legacy, workload-identity-federated, or system-created keys). - `type: "service_account" or "user"` Type of the actor that created the object. - `"service_account"` - `"user"` - `id: string` ID of the actor that created the object. - `expires_at: string or null` RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires. format: date-time - `name: string` Name of the API key. - `partial_key_hint: string or null` Partially redacted hint for the API key. - `principal: BetaAPIKeyUserActor or BetaAPIKeyServiceAccountActor or null` The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal. - `BetaAPIKeyUserActor object` - `type: "user_actor"` Principal type. Always `"user_actor"` for a User. default: user_actor - `user_id: string` ID of the User the API key acts as. - `BetaAPIKeyServiceAccountActor object` - `type: "service_account_actor"` Principal type. Always `"service_account_actor"` for a Service Account. default: service_account_actor - `service_account_id: string` ID of the Service Account the API key acts as. - `scope: BetaAPIKeyOrganizationScope or BetaAPIKeyWorkspaceScope` Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace. - `BetaAPIKeyOrganizationScope object` - `type: "organization"` Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope. default: organization - `BetaAPIKeyWorkspaceScope object` - `type: "workspace"` Scope type. Always `"workspace"`: the API key belongs to one Workspace. default: workspace - `workspace_id: string` ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace. - `status: "active" or "archived" or "expired" or "inactive"` Status of the API key. - `"active"` - `"archived"` - `"expired"` - `"inactive"` - `workspace_id: string or null` **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace. Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart. #### Example ```bash curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{}' ``` ##### Response (200) ```json { "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", "created_at": "2024-10-30T23:58:27.427722Z", "created_by": { "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "type": "user" }, "expires_at": "2024-10-30T23:58:27.427722Z", "name": "Developer Key", "partial_key_hint": "sk-ant-api03-R2D...igAA", "principal": { "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "scope": { "type": "workspace", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" }, "status": "active", "type": "api_key", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ``` ## Beta › Organization › External Keys ### Create External Key **POST** `/v1/organizations/external_keys` Create an external key config owned by the caller's organization. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Body parameters - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam` KMS provider identity and auth coordinates. - `BetaAWSExternalKeyConfig object` - `type: "aws"` - `kms_arn: string` Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected. maxLength: 2048 - `region: optional string or null` AWS region. Derived from `kms_arn` if omitted. - `role_arn: optional string or null` **Deprecated** IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored. - `BetaGCPExternalKeyConfig object` - `type: "gcp"` - `key_name: string` Full resource name of the Cloud KMS key. - `BetaAzureExternalKeyConfigParam object` Azure Key Vault provider configuration. - `type: "azure"` - `key_name: string` Name of the key within the vault. - `tenant_id: string` Azure AD tenant ID. - `vault_uri: string` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `client_id: optional string or null` Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. - `display_name: optional string or null` Human-friendly display name. minLength: 1, maxLength: 255 - `geo: optional "us"` Data residency geo. Only `us` is supported. #### Returns - `BetaExternalKey object` CMEK external key config belonging to the caller's organization. Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt). - `type: "external_key"` default: external_key - `id: string` Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. - `BetaExternalKeyAttachedAttachment object` - `type: "attached"` default: attached - `BetaExternalKeyUnattachedAttachment object` - `type: "unattached"` default: unattached - `created_at: string` format: date-time - `display_name: string or null` Human-friendly display name. Null if none was set. - `geo: string` Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` KMS provider identity and auth coordinates. - `BetaAWSExternalKeyConfig object` - `type: "aws"` - `kms_arn: string` Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected. maxLength: 2048 - `region: optional string or null` AWS region. Derived from `kms_arn` if omitted. - `role_arn: optional string or null` **Deprecated** IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored. - `BetaGCPExternalKeyConfig object` - `type: "gcp"` - `key_name: string` Full resource name of the Cloud KMS key. - `BetaAzureExternalKeyConfig object` - `type: "azure"` - `key_name: string` Name of the key within the vault. - `tenant_id: string` Azure AD tenant ID. - `vault_uri: string` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `client_id: optional string or null` Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. - `updated_at: string` format: date-time #### Example ```bash curl https://api.anthropic.com/v1/organizations/external_keys \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "provider_config": { "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", "type": "aws" } }' ``` ##### Response (200) ```json { "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "attachment": { "type": "attached" }, "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "prod-us-key", "geo": "us", "provider_config": { "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", "type": "aws", "region": "us-east-1", "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" }, "type": "external_key", "updated_at": "2024-10-30T23:58:27.427722Z" } ``` ### List External Keys **GET** `/v1/organizations/external_keys` List external key configs in the caller's organization. Results are ordered by creation time (newest first). Use the `next_page` cursor from the response to fetch subsequent pages. #### Query parameters - `limit: optional number` Number of results per page. default: 20, minimum: 1, maximum: 100 - `page: optional string` Opaque cursor from a previous response's `next_page`. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaExternalKey` - `type: "external_key"` default: external_key - `id: string` Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. - `BetaExternalKeyAttachedAttachment object` - `type: "attached"` default: attached - `BetaExternalKeyUnattachedAttachment object` - `type: "unattached"` default: unattached - `created_at: string` format: date-time - `display_name: string or null` Human-friendly display name. Null if none was set. - `geo: string` Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` KMS provider identity and auth coordinates. - `BetaAWSExternalKeyConfig object` - `type: "aws"` - `kms_arn: string` Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected. maxLength: 2048 - `region: optional string or null` AWS region. Derived from `kms_arn` if omitted. - `role_arn: optional string or null` **Deprecated** IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored. - `BetaGCPExternalKeyConfig object` - `type: "gcp"` - `key_name: string` Full resource name of the Cloud KMS key. - `BetaAzureExternalKeyConfig object` - `type: "azure"` - `key_name: string` Name of the key within the vault. - `tenant_id: string` Azure AD tenant ID. - `vault_uri: string` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `client_id: optional string or null` Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. - `updated_at: string` format: date-time - `next_page: string or null` Opaque cursor for the next page, or null if no more results. Pass as `?page=` to fetch the next page. #### Example ```bash curl https://api.anthropic.com/v1/organizations/external_keys \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "attachment": { "type": "attached" }, "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "prod-us-key", "geo": "us", "provider_config": { "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", "type": "aws", "region": "us-east-1", "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" }, "type": "external_key", "updated_at": "2024-10-30T23:58:27.427722Z" } ], "next_page": "next_page" } ``` ### Get External Key **GET** `/v1/organizations/external_keys/{external_key_id}` Retrieve a single external key config in the caller's organization by ID. #### Path parameters - `external_key_id: string` ID of the External Key. maxLength: 2048 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `BetaExternalKey object` CMEK external key config belonging to the caller's organization. Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt). - `type: "external_key"` default: external_key - `id: string` Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. - `BetaExternalKeyAttachedAttachment object` - `type: "attached"` default: attached - `BetaExternalKeyUnattachedAttachment object` - `type: "unattached"` default: unattached - `created_at: string` format: date-time - `display_name: string or null` Human-friendly display name. Null if none was set. - `geo: string` Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` KMS provider identity and auth coordinates. - `BetaAWSExternalKeyConfig object` - `type: "aws"` - `kms_arn: string` Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected. maxLength: 2048 - `region: optional string or null` AWS region. Derived from `kms_arn` if omitted. - `role_arn: optional string or null` **Deprecated** IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored. - `BetaGCPExternalKeyConfig object` - `type: "gcp"` - `key_name: string` Full resource name of the Cloud KMS key. - `BetaAzureExternalKeyConfig object` - `type: "azure"` - `key_name: string` Name of the key within the vault. - `tenant_id: string` Azure AD tenant ID. - `vault_uri: string` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `client_id: optional string or null` Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. - `updated_at: string` format: date-time #### Example ```bash curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "attachment": { "type": "attached" }, "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "prod-us-key", "geo": "us", "provider_config": { "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", "type": "aws", "region": "us-east-1", "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" }, "type": "external_key", "updated_at": "2024-10-30T23:58:27.427722Z" } ``` ### Update External Key **POST** `/v1/organizations/external_keys/{external_key_id}` Partially update an external key config. Omitted fields are left unchanged. `display_name` is always editable. `geo` and `provider_config` cannot be changed once any workspace references this config, because previously encrypted data requires the original key identity to decrypt. #### Path parameters - `external_key_id: string` ID of the External Key. maxLength: 2048 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Body parameters - `display_name: optional string or null` Human-friendly display name. minLength: 1, maxLength: 255 - `geo: optional "us" or null` Data residency geo. Only `us` is supported. - `provider_config: optional BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam or null` KMS provider identity and auth coordinates. - `BetaAWSExternalKeyConfig object` - `type: "aws"` - `kms_arn: string` Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected. maxLength: 2048 - `region: optional string or null` AWS region. Derived from `kms_arn` if omitted. - `role_arn: optional string or null` **Deprecated** IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored. - `BetaGCPExternalKeyConfig object` - `type: "gcp"` - `key_name: string` Full resource name of the Cloud KMS key. - `BetaAzureExternalKeyConfigParam object` Azure Key Vault provider configuration. - `type: "azure"` - `key_name: string` Name of the key within the vault. - `tenant_id: string` Azure AD tenant ID. - `vault_uri: string` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `client_id: optional string or null` Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. #### Returns - `BetaExternalKey object` CMEK external key config belonging to the caller's organization. Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt). - `type: "external_key"` default: external_key - `id: string` Identifier of the external key config. A tagged ID prefixed `ekey_`, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN. - `attachment: BetaExternalKeyAttachedAttachment or BetaExternalKeyUnattachedAttachment` Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an `unattached` config is inert and can be deleted. - `BetaExternalKeyAttachedAttachment object` - `type: "attached"` default: attached - `BetaExternalKeyUnattachedAttachment object` - `type: "unattached"` default: unattached - `created_at: string` format: date-time - `display_name: string or null` Human-friendly display name. Null if none was set. - `geo: string` Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips. - `provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig` KMS provider identity and auth coordinates. - `BetaAWSExternalKeyConfig object` - `type: "aws"` - `kms_arn: string` Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected. maxLength: 2048 - `region: optional string or null` AWS region. Derived from `kms_arn` if omitted. - `role_arn: optional string or null` **Deprecated** IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored. - `BetaGCPExternalKeyConfig object` - `type: "gcp"` - `key_name: string` Full resource name of the Cloud KMS key. - `BetaAzureExternalKeyConfig object` - `type: "azure"` - `key_name: string` Name of the key within the vault. - `tenant_id: string` Azure AD tenant ID. - `vault_uri: string` Key Vault data-plane URI — `https://{vault-name}.vault.azure.net` or `https://{hsm-name}.managedhsm.azure.net`. - `client_id: optional string or null` Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory. - `updated_at: string` format: date-time #### Example ```bash curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{}' ``` ##### Response (200) ```json { "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "attachment": { "type": "attached" }, "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "prod-us-key", "geo": "us", "provider_config": { "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222", "type": "aws", "region": "us-east-1", "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek" }, "type": "external_key", "updated_at": "2024-10-30T23:58:27.427722Z" } ``` ### Delete External Key **DELETE** `/v1/organizations/external_keys/{external_key_id}` Delete an external key config. The request is rejected if any workspace still references this config. #### Path parameters - `external_key_id: string` ID of the External Key. maxLength: 2048 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `type: "external_key_deleted"` default: external_key_deleted - `id: string` ID of the deleted External Key. #### Example ```bash curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv", "type": "external_key_deleted" } ``` ### Validate External Key **POST** `/v1/organizations/external_keys/{external_key_id}/validate` Validate an external key config against the customer's KMS. Anthropic performs an encrypt/decrypt roundtrip against the configured KMS key and waits up to 30 seconds for the result. The response status is `success` if the roundtrip succeeded, or `failure` with an error message if it failed or timed out. #### Path parameters - `external_key_id: string` ID of the External Key. maxLength: 2048 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `type: "external_key_validation"` default: external_key_validation - `error: string or null` Error message when status is `failure`. Null otherwise. - `status: "failure" or "success"` `success` — encrypt/decrypt roundtrip succeeded. `failure` — the roundtrip failed or timed out; see `error`. - `"failure"` - `"success"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID/validate \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "error": "error", "status": "failure", "type": "external_key_validation" } ``` ## Beta › Organization › Federation › Issuers ### Create Federation Issuer **POST** `/v1/organizations/federation_issuers` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Register an OIDC issuer that Anthropic will trust for workload identity federation in your organization. The `jwks` field controls how the issuer's signing keys are obtained and takes one of three shapes selected by `type`: `discovery` (resolve keys through OIDC discovery), `explicit_url` (fetch keys from a fixed JWKS URL), or `inline` (provide a static key set). When `jwks.type` is `discovery` and no `discovery_base` is set, the issuer URL must be publicly reachable over HTTPS so Anthropic can fetch the discovery document; for `explicit_url` and `inline` modes the issuer URL is only matched as the JWT's `iss` claim and is not fetched. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `issuer_url: string` The `iss` claim value to match against. minLength: 1 - `name: string` Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. minLength: 1, maxLength: 255 - `check_jti: optional boolean or null` Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Defaults to true. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. - `jwks: optional BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` How signing keys are obtained. Defaults to OIDC discovery. - `BetaJWKSDiscovery object` JWKS via the issuer's OIDC discovery document. - `type: "discovery"` - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. maxLength: 8192 - `discovery_base: optional string or null` Set when the discovery URL differs from `issuer_url`. - `BetaJWKSExplicitURL object` JWKS fetched from a fixed endpoint. - `type: "explicit_url"` - `url: string` JWKS endpoint. minLength: 1 - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. maxLength: 8192 - `BetaJWKSInline object` JWKS supplied directly; no network fetch. - `type: "inline"` - `keys: array of map[unknown]` Inline JWK objects. minItems: 1 - `max_jwt_lifetime_seconds: optional number or null` Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Defaults to 3600 (1h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. minimum: 1, maximum: 176400 #### Returns - `BetaFederationIssuer object` Registered external OIDC identity provider. Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. - `type: "federation_issuer"` default: federation_issuer - `id: string` Tagged ID of the federation issuer. - `archived_at: string or null` If set, all rules referencing this issuer reject token exchange. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. - `check_jti: boolean` Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. - `created_at: string` When this issuer was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this issuer. - `issuer_url: string` The `iss` claim value. Incoming JWTs must match exactly. - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` How signing keys are obtained for signature verification. - `BetaJWKSDiscovery object` JWKS via the issuer's OIDC discovery document. - `type: "discovery"` - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. maxLength: 8192 - `discovery_base: optional string or null` Set when the discovery URL differs from `issuer_url`. - `BetaJWKSExplicitURL object` JWKS fetched from a fixed endpoint. - `type: "explicit_url"` - `url: string` JWKS endpoint. minLength: 1 - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. maxLength: 8192 - `BetaJWKSInline object` JWKS supplied directly; no network fetch. - `type: "inline"` - `keys: array of map[unknown]` Inline JWK objects. minItems: 1 - `jwks_polling_disabled_at: string or null` If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. format: date-time - `max_jwt_lifetime_seconds: number` Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. - `name: string` Admin-chosen slug identifier. - `poll_status: BetaFederationIssuerPollStatus or null` Live state of Anthropic's JWKS polling for this issuer. Populated on both single-issuer retrieval and list responses, including archived issuers. Typically null for inline-key issuers (no polling), or when poll status is temporarily unavailable or polling has not started yet. - `consecutive_failures: number` Consecutive fetch failures since the last success. - `last_fetched_at: string or null` When the last successful fetch completed. format: date-time - `next_poll_at: string or null` When the next fetch is scheduled. Null if paused. format: date-time - `updated_at: string` When this issuer was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. #### Example ```bash curl https://api.anthropic.com/v1/organizations/federation_issuers \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "issuer_url": "x", "name": "x" }' ``` ##### Response (200) ```json { "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "check_jti": true, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "issuer_url": "https://token.actions.githubusercontent.com", "jwks": { "type": "discovery", "ca_cert_pem": "ca_cert_pem", "discovery_base": "discovery_base" }, "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", "max_jwt_lifetime_seconds": 0, "name": "github-actions", "poll_status": { "consecutive_failures": 0, "last_fetched_at": "2019-12-27T18:11:19.117Z", "next_poll_at": "2019-12-27T18:11:19.117Z" }, "type": "federation_issuer", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } ``` ### List Federation Issuers **GET** `/v1/organizations/federation_issuers` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). List federation issuers in your organization. Archived issuers are excluded unless `include_archived=true`. #### Query parameters - `include_archived: optional boolean` Include archived resources. Defaults to false. default: false - `limit: optional number` Number of results per page. default: 20, minimum: 1, maximum: 100 - `page: optional string` Opaque cursor from a previous response's `next_page`. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaFederationIssuer` - `type: "federation_issuer"` default: federation_issuer - `id: string` Tagged ID of the federation issuer. - `archived_at: string or null` If set, all rules referencing this issuer reject token exchange. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. - `check_jti: boolean` Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. - `created_at: string` When this issuer was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this issuer. - `issuer_url: string` The `iss` claim value. Incoming JWTs must match exactly. - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` How signing keys are obtained for signature verification. - `BetaJWKSDiscovery object` JWKS via the issuer's OIDC discovery document. - `type: "discovery"` - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. maxLength: 8192 - `discovery_base: optional string or null` Set when the discovery URL differs from `issuer_url`. - `BetaJWKSExplicitURL object` JWKS fetched from a fixed endpoint. - `type: "explicit_url"` - `url: string` JWKS endpoint. minLength: 1 - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. maxLength: 8192 - `BetaJWKSInline object` JWKS supplied directly; no network fetch. - `type: "inline"` - `keys: array of map[unknown]` Inline JWK objects. minItems: 1 - `jwks_polling_disabled_at: string or null` If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. format: date-time - `max_jwt_lifetime_seconds: number` Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. - `name: string` Admin-chosen slug identifier. - `poll_status: BetaFederationIssuerPollStatus or null` Live state of Anthropic's JWKS polling for this issuer. Populated on both single-issuer retrieval and list responses, including archived issuers. Typically null for inline-key issuers (no polling), or when poll status is temporarily unavailable or polling has not started yet. - `consecutive_failures: number` Consecutive fetch failures since the last success. - `last_fetched_at: string or null` When the last successful fetch completed. format: date-time - `next_poll_at: string or null` When the next fetch is scheduled. Null if paused. format: date-time - `updated_at: string` When this issuer was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. - `next_page: string or null` Opaque cursor for the next page, or null if no more results. #### Example ```bash curl https://api.anthropic.com/v1/organizations/federation_issuers \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "check_jti": true, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "issuer_url": "https://token.actions.githubusercontent.com", "jwks": { "type": "discovery", "ca_cert_pem": "ca_cert_pem", "discovery_base": "discovery_base" }, "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", "max_jwt_lifetime_seconds": 0, "name": "github-actions", "poll_status": { "consecutive_failures": 0, "last_fetched_at": "2019-12-27T18:11:19.117Z", "next_poll_at": "2019-12-27T18:11:19.117Z" }, "type": "federation_issuer", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } ], "next_page": "next_page" } ``` ### Get Federation Issuer **GET** `/v1/organizations/federation_issuers/{federation_issuer_id}` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Retrieve a federation issuer by its ID (`fdis_...`). #### Path parameters - `federation_issuer_id: string` ID of the federation issuer. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaFederationIssuer object` Registered external OIDC identity provider. Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. - `type: "federation_issuer"` default: federation_issuer - `id: string` Tagged ID of the federation issuer. - `archived_at: string or null` If set, all rules referencing this issuer reject token exchange. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. - `check_jti: boolean` Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. - `created_at: string` When this issuer was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this issuer. - `issuer_url: string` The `iss` claim value. Incoming JWTs must match exactly. - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` How signing keys are obtained for signature verification. - `BetaJWKSDiscovery object` JWKS via the issuer's OIDC discovery document. - `type: "discovery"` - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. maxLength: 8192 - `discovery_base: optional string or null` Set when the discovery URL differs from `issuer_url`. - `BetaJWKSExplicitURL object` JWKS fetched from a fixed endpoint. - `type: "explicit_url"` - `url: string` JWKS endpoint. minLength: 1 - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. maxLength: 8192 - `BetaJWKSInline object` JWKS supplied directly; no network fetch. - `type: "inline"` - `keys: array of map[unknown]` Inline JWK objects. minItems: 1 - `jwks_polling_disabled_at: string or null` If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. format: date-time - `max_jwt_lifetime_seconds: number` Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. - `name: string` Admin-chosen slug identifier. - `poll_status: BetaFederationIssuerPollStatus or null` Live state of Anthropic's JWKS polling for this issuer. Populated on both single-issuer retrieval and list responses, including archived issuers. Typically null for inline-key issuers (no polling), or when poll status is temporarily unavailable or polling has not started yet. - `consecutive_failures: number` Consecutive fetch failures since the last success. - `last_fetched_at: string or null` When the last successful fetch completed. format: date-time - `next_poll_at: string or null` When the next fetch is scheduled. Null if paused. format: date-time - `updated_at: string` When this issuer was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. #### Example ```bash curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "check_jti": true, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "issuer_url": "https://token.actions.githubusercontent.com", "jwks": { "type": "discovery", "ca_cert_pem": "ca_cert_pem", "discovery_base": "discovery_base" }, "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", "max_jwt_lifetime_seconds": 0, "name": "github-actions", "poll_status": { "consecutive_failures": 0, "last_fetched_at": "2019-12-27T18:11:19.117Z", "next_poll_at": "2019-12-27T18:11:19.117Z" }, "type": "federation_issuer", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } ``` ### Update Federation Issuer **POST** `/v1/organizations/federation_issuers/{federation_issuer_id}` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Partially update a federation issuer. Setting `jwks` replaces the full JWKS shape at once. Archived issuers cannot be updated; this returns 400. Create a new issuer instead. Updating an issuer that backs a rule with a scope outside `workspace:developer` or `workspace:inference` requires a Console session. #### Path parameters - `federation_issuer_id: string` ID of the federation issuer to update. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `check_jti: optional boolean or null` Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. - `issuer_url: optional string or null` Replaces the `iss` claim value to match against. For discovery-mode issuers without a `discovery_base`, this is also the URL Anthropic fetches the OIDC discovery document and signing keys from, so changing it repoints the JWKS source. Changing the issuer URL to a well-known shared platform is rejected while any live rule under this issuer would not constrain tenant identity. minLength: 1 - `jwks: optional BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline or null` Replaces the entire JWKS configuration. - `BetaJWKSDiscovery object` JWKS via the issuer's OIDC discovery document. - `type: "discovery"` - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. maxLength: 8192 - `discovery_base: optional string or null` Set when the discovery URL differs from `issuer_url`. - `BetaJWKSExplicitURL object` JWKS fetched from a fixed endpoint. - `type: "explicit_url"` - `url: string` JWKS endpoint. minLength: 1 - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. maxLength: 8192 - `BetaJWKSInline object` JWKS supplied directly; no network fetch. - `type: "inline"` - `keys: array of map[unknown]` Inline JWK objects. minItems: 1 - `jwks_polling_disabled: optional boolean or null` Only `false` is accepted, to re-enable polling after the system pauses it. Polling is paused automatically; sending `true` is rejected. - `max_jwt_lifetime_seconds: optional number or null` Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. minimum: 1, maximum: 176400 - `name: optional string or null` Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. minLength: 1, maxLength: 255 #### Returns - `BetaFederationIssuer object` Registered external OIDC identity provider. Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. - `type: "federation_issuer"` default: federation_issuer - `id: string` Tagged ID of the federation issuer. - `archived_at: string or null` If set, all rules referencing this issuer reject token exchange. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. - `check_jti: boolean` Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. - `created_at: string` When this issuer was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this issuer. - `issuer_url: string` The `iss` claim value. Incoming JWTs must match exactly. - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` How signing keys are obtained for signature verification. - `BetaJWKSDiscovery object` JWKS via the issuer's OIDC discovery document. - `type: "discovery"` - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. maxLength: 8192 - `discovery_base: optional string or null` Set when the discovery URL differs from `issuer_url`. - `BetaJWKSExplicitURL object` JWKS fetched from a fixed endpoint. - `type: "explicit_url"` - `url: string` JWKS endpoint. minLength: 1 - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. maxLength: 8192 - `BetaJWKSInline object` JWKS supplied directly; no network fetch. - `type: "inline"` - `keys: array of map[unknown]` Inline JWK objects. minItems: 1 - `jwks_polling_disabled_at: string or null` If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. format: date-time - `max_jwt_lifetime_seconds: number` Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. - `name: string` Admin-chosen slug identifier. - `poll_status: BetaFederationIssuerPollStatus or null` Live state of Anthropic's JWKS polling for this issuer. Populated on both single-issuer retrieval and list responses, including archived issuers. Typically null for inline-key issuers (no polling), or when poll status is temporarily unavailable or polling has not started yet. - `consecutive_failures: number` Consecutive fetch failures since the last success. - `last_fetched_at: string or null` When the last successful fetch completed. format: date-time - `next_poll_at: string or null` When the next fetch is scheduled. Null if paused. format: date-time - `updated_at: string` When this issuer was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. #### Example ```bash curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{}' ``` ##### Response (200) ```json { "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "check_jti": true, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "issuer_url": "https://token.actions.githubusercontent.com", "jwks": { "type": "discovery", "ca_cert_pem": "ca_cert_pem", "discovery_base": "discovery_base" }, "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", "max_jwt_lifetime_seconds": 0, "name": "github-actions", "poll_status": { "consecutive_failures": 0, "last_fetched_at": "2019-12-27T18:11:19.117Z", "next_poll_at": "2019-12-27T18:11:19.117Z" }, "type": "federation_issuer", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } ``` ### Archive Federation Issuer **POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Archive a federation issuer. Idempotent; re-archiving returns the issuer with its original `archived_at`. Rejected with 400 if any live (non-archived) federation rule still references the issuer; archive those rules first (a rule's issuer cannot be changed), or recreate them against another issuer. #### Path parameters - `federation_issuer_id: string` ID of the federation issuer to archive. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaFederationIssuer object` Registered external OIDC identity provider. Records an external IdP the organization trusts for the RFC 7523 jwt-bearer grant. The `issuer_url` must match the JWT `iss` claim exactly. - `type: "federation_issuer"` default: federation_issuer - `id: string` Tagged ID of the federation issuer. - `archived_at: string or null` If set, all rules referencing this issuer reject token exchange. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this issuer. - `check_jti: boolean` Whether the jwt-bearer exchange enforces JTI single-use (replay protection) for tokens from this issuer. Applies only to assertions carrying a `jti` claim; tokens without one are accepted without single-use enforcement. - `created_at: string` When this issuer was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this issuer. - `issuer_url: string` The `iss` claim value. Incoming JWTs must match exactly. - `jwks: BetaJWKSDiscovery or BetaJWKSExplicitURL or BetaJWKSInline` How signing keys are obtained for signature verification. - `BetaJWKSDiscovery object` JWKS via the issuer's OIDC discovery document. - `type: "discovery"` - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. maxLength: 8192 - `discovery_base: optional string or null` Set when the discovery URL differs from `issuer_url`. - `BetaJWKSExplicitURL object` JWKS fetched from a fixed endpoint. - `type: "explicit_url"` - `url: string` JWKS endpoint. minLength: 1 - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. maxLength: 8192 - `BetaJWKSInline object` JWKS supplied directly; no network fetch. - `type: "inline"` - `keys: array of map[unknown]` Inline JWK objects. minItems: 1 - `jwks_polling_disabled_at: string or null` If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. format: date-time - `max_jwt_lifetime_seconds: number` Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected. - `name: string` Admin-chosen slug identifier. - `poll_status: BetaFederationIssuerPollStatus or null` Live state of Anthropic's JWKS polling for this issuer. Populated on both single-issuer retrieval and list responses, including archived issuers. Typically null for inline-key issuers (no polling), or when poll status is temporarily unavailable or polling has not started yet. - `consecutive_failures: number` Consecutive fetch failures since the last success. - `last_fetched_at: string or null` When the last successful fetch completed. format: date-time - `next_poll_at: string or null` When the next fetch is scheduled. Null if paused. format: date-time - `updated_at: string` When this issuer was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. #### Example ```bash curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "fdis_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "check_jti": true, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "issuer_url": "https://token.actions.githubusercontent.com", "jwks": { "type": "discovery", "ca_cert_pem": "ca_cert_pem", "discovery_base": "discovery_base" }, "jwks_polling_disabled_at": "2019-12-27T18:11:19.117Z", "max_jwt_lifetime_seconds": 0, "name": "github-actions", "poll_status": { "consecutive_failures": 0, "last_fetched_at": "2019-12-27T18:11:19.117Z", "next_poll_at": "2019-12-27T18:11:19.117Z" }, "type": "federation_issuer", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } ``` ## Beta › Organization › Federation › Rules ### Create Federation Rule **POST** `/v1/organizations/federation_rules` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Create a federation rule owned by your organization. The referenced issuer and the target service account must already exist in the same organization; invalid references are rejected with a 400 error. The workspace reference is validated. Membership is not checked at rule creation: token exchange resolves a single enabled workspace per call and is rejected unless the target service account is a member of that workspace (it is implicitly a member of the default workspace). Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, Terraform Cloud, Google) must constrain tenant identity via an identity-bearing claim, a tenant-pinning subject prefix (such as `repo:YOUR_ORG/...`), or a CEL condition referencing one of those identity claims (e.g. `claims.repository_owner`). OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `issuer_id: string` Tagged ID of the federation issuer. - `match: BetaFederationRuleMatch` Conditions the verified JWT must satisfy for this rule to apply. At least one of `subject_prefix` (other than a wildcard-only value like `*`), `claims`, or `condition` is required; `audience` alone is not sufficient. - `audience: optional string or null` Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. maxLength: 1024 - `claims: optional map[string] or null` Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. - `condition: optional string or null` CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. maxLength: 4096 - `subject_prefix: optional string or null` Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. maxLength: 1024 - `name: string` Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. minLength: 1, maxLength: 255 - `oauth_scope: string` Space-separated OAuth scopes. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. minLength: 1 - `target: BetaServiceAccountTarget` Identity that tokens minted via this rule act as. Currently always a `service_account` target. - `type: "service_account"` - `service_account_id: string` Tagged ID of the service account to mint tokens for. - `service_account_name: optional string or null` Service account's display name at read time. Ignored on writes. - `applies_to_all_workspaces: optional boolean` When true, enable this rule for every workspace in the org (including workspaces created later). - `attributes: optional map[string] or null` CEL expressions `{name: expr}` extracting named values from claims. Not yet supported; any non-empty value is rejected with 400. - `description: optional string or null` Optional free-text description. maxLength: 2000 - `token_lifetime_seconds: optional number` Lifetime in seconds for access tokens minted via this rule (60-86400). Defaults to 3600 (1h). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. minimum: 60, maximum: 86400 - `workspace_id: optional string or null` Tagged ID of the workspace to enable this rule for. Required unless `applies_to_all_workspaces` is true. Additional workspaces can be added via the `/federation_rules/{federation_rule_id}/workspaces` sub-resource. #### Returns - `BetaFederationRule object` Authorization rule binding an external OIDC identity to Anthropic. Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this. - `type: "federation_rule"` default: federation_rule - `id: string` Tagged ID of the federation rule. - `applies_to_all_workspaces: boolean` When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. - `archived_at: string or null` If set, this rule is archived and rejects token exchange. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this rule. - `attributes: map[string] or null` CEL expressions extracting named values from claims. Not yet supported; always null. - `created_at: string` When this rule was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this rule. - `description: string or null` Optional free-text description. - `issuer_id: string` Tagged ID of the issuer whose tokens this rule accepts. - `issuer_name: string or null` Issuer's display name at read time. - `match: BetaFederationRuleMatch` Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. - `audience: optional string or null` Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. maxLength: 1024 - `claims: optional map[string] or null` Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. - `condition: optional string or null` CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. maxLength: 4096 - `subject_prefix: optional string or null` Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. maxLength: 1024 - `name: string` Admin-chosen slug identifier. - `oauth_scope: string` Space-separated OAuth scopes granted on the minted token. - `target: BetaServiceAccountTarget` What this rule targets. Check `type` before reading the other fields. Tokens minted via a rule whose target `type` is `service_account` act as that service account. - `type: "service_account"` - `service_account_id: string` Tagged ID of the service account to mint tokens for. - `service_account_name: optional string or null` Service account's display name at read time. Ignored on writes. - `token_lifetime_seconds: number` Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. - `updated_at: string` When this rule was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. - `workspace_id: string or null` Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. - `workspace_ids: array of string` Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). #### Example ```bash curl https://api.anthropic.com/v1/organizations/federation_rules \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "issuer_id": "issuer_id", "match": {}, "name": "x", "oauth_scope": "x", "target": { "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "type": "service_account" } }' ``` ##### Response (200) ```json { "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", "applies_to_all_workspaces": true, "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "attributes": { "foo": "string" }, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "issuer_id": "issuer_id", "issuer_name": "issuer_name", "match": { "audience": "audience", "claims": { "foo": "string" }, "condition": "condition", "subject_prefix": "subject_prefix" }, "name": "prod-deploy-pipeline", "oauth_scope": "oauth_scope", "target": { "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "type": "service_account", "service_account_name": "service_account_name" }, "token_lifetime_seconds": 0, "type": "federation_rule", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id", "workspace_id": "workspace_id", "workspace_ids": [ "string" ] } ``` ### List Federation Rules **GET** `/v1/organizations/federation_rules` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). List federation rules in your organization. Optionally filter by issuer with `issuer_id`. Archived rules are excluded unless `include_archived=true`. #### Query parameters - `include_archived: optional boolean` Include archived resources. Defaults to false. default: false - `issuer_id: optional string` Filter to rules referencing this federation issuer. - `limit: optional number` Number of results per page. default: 20, minimum: 1, maximum: 100 - `page: optional string` Opaque cursor from a previous response's `next_page`. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaFederationRule` - `type: "federation_rule"` default: federation_rule - `id: string` Tagged ID of the federation rule. - `applies_to_all_workspaces: boolean` When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. - `archived_at: string or null` If set, this rule is archived and rejects token exchange. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this rule. - `attributes: map[string] or null` CEL expressions extracting named values from claims. Not yet supported; always null. - `created_at: string` When this rule was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this rule. - `description: string or null` Optional free-text description. - `issuer_id: string` Tagged ID of the issuer whose tokens this rule accepts. - `issuer_name: string or null` Issuer's display name at read time. - `match: BetaFederationRuleMatch` Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. - `audience: optional string or null` Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. maxLength: 1024 - `claims: optional map[string] or null` Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. - `condition: optional string or null` CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. maxLength: 4096 - `subject_prefix: optional string or null` Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. maxLength: 1024 - `name: string` Admin-chosen slug identifier. - `oauth_scope: string` Space-separated OAuth scopes granted on the minted token. - `target: BetaServiceAccountTarget` What this rule targets. Check `type` before reading the other fields. Tokens minted via a rule whose target `type` is `service_account` act as that service account. - `type: "service_account"` - `service_account_id: string` Tagged ID of the service account to mint tokens for. - `service_account_name: optional string or null` Service account's display name at read time. Ignored on writes. - `token_lifetime_seconds: number` Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. - `updated_at: string` When this rule was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. - `workspace_id: string or null` Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. - `workspace_ids: array of string` Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). - `next_page: string or null` Opaque cursor for the next page, or null if no more results. #### Example ```bash curl https://api.anthropic.com/v1/organizations/federation_rules \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", "applies_to_all_workspaces": true, "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "attributes": { "foo": "string" }, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "issuer_id": "issuer_id", "issuer_name": "issuer_name", "match": { "audience": "audience", "claims": { "foo": "string" }, "condition": "condition", "subject_prefix": "subject_prefix" }, "name": "prod-deploy-pipeline", "oauth_scope": "oauth_scope", "target": { "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "type": "service_account", "service_account_name": "service_account_name" }, "token_lifetime_seconds": 0, "type": "federation_rule", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id", "workspace_id": "workspace_id", "workspace_ids": [ "string" ] } ], "next_page": "next_page" } ``` ### Get Federation Rule **GET** `/v1/organizations/federation_rules/{federation_rule_id}` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Retrieve a federation rule by its ID (`fdrl_...`). #### Path parameters - `federation_rule_id: string` ID of the federation rule. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaFederationRule object` Authorization rule binding an external OIDC identity to Anthropic. Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this. - `type: "federation_rule"` default: federation_rule - `id: string` Tagged ID of the federation rule. - `applies_to_all_workspaces: boolean` When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. - `archived_at: string or null` If set, this rule is archived and rejects token exchange. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this rule. - `attributes: map[string] or null` CEL expressions extracting named values from claims. Not yet supported; always null. - `created_at: string` When this rule was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this rule. - `description: string or null` Optional free-text description. - `issuer_id: string` Tagged ID of the issuer whose tokens this rule accepts. - `issuer_name: string or null` Issuer's display name at read time. - `match: BetaFederationRuleMatch` Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. - `audience: optional string or null` Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. maxLength: 1024 - `claims: optional map[string] or null` Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. - `condition: optional string or null` CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. maxLength: 4096 - `subject_prefix: optional string or null` Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. maxLength: 1024 - `name: string` Admin-chosen slug identifier. - `oauth_scope: string` Space-separated OAuth scopes granted on the minted token. - `target: BetaServiceAccountTarget` What this rule targets. Check `type` before reading the other fields. Tokens minted via a rule whose target `type` is `service_account` act as that service account. - `type: "service_account"` - `service_account_id: string` Tagged ID of the service account to mint tokens for. - `service_account_name: optional string or null` Service account's display name at read time. Ignored on writes. - `token_lifetime_seconds: number` Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. - `updated_at: string` When this rule was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. - `workspace_id: string or null` Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. - `workspace_ids: array of string` Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). #### Example ```bash curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", "applies_to_all_workspaces": true, "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "attributes": { "foo": "string" }, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "issuer_id": "issuer_id", "issuer_name": "issuer_name", "match": { "audience": "audience", "claims": { "foo": "string" }, "condition": "condition", "subject_prefix": "subject_prefix" }, "name": "prod-deploy-pipeline", "oauth_scope": "oauth_scope", "target": { "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "type": "service_account", "service_account_name": "service_account_name" }, "token_lifetime_seconds": 0, "type": "federation_rule", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id", "workspace_id": "workspace_id", "workspace_ids": [ "string" ] } ``` ### Update Federation Rule **POST** `/v1/organizations/federation_rules/{federation_rule_id}` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Partially update a federation rule. `issuer_id` is immutable. `match` and `target` are replaced as whole objects when set. Referenced service accounts and workspaces must exist in your organization; invalid references are rejected with a 400 error. Archived rules cannot be updated; this returns 400. Create a new rule instead. Rules on well-known shared issuers (GitHub Actions, GitLab, Buildkite, Terraform Cloud, Google) must constrain tenant identity via an identity-bearing claim, a tenant-pinning subject prefix (such as `repo:YOUR_ORG/...`), or a CEL condition referencing one of those identity claims (e.g. `claims.repository_owner`). On these issuers the requirement is re-checked on every update; if an existing rule's stored match does not yet constrain tenant identity, any update (even a rename or description change) must also supply a conforming `match` in the same request. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session. #### Path parameters - `federation_rule_id: string` ID of the federation rule to update. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `applies_to_all_workspaces: optional boolean or null` When true, enables this rule for every workspace in the org (including workspaces created later). Setting `false` is rejected with 400 if no workspace would remain enabled; a rule with only a legacy `workspace_id` binding continues to mint. - `attributes: optional map[string] or null` Replaces the CEL expressions `{name: expr}` extracting named values from claims. Send null to clear them. Not yet supported; any non-empty value is rejected with 400. - `description: optional string or null` Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). maxLength: 2000 - `match: optional BetaFederationRuleMatch or null` Replaces the entire match object. All populated matcher fields must pass. - `audience: optional string or null` Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. maxLength: 1024 - `claims: optional map[string] or null` Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. - `condition: optional string or null` CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. maxLength: 4096 - `subject_prefix: optional string or null` Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. maxLength: 1024 - `name: optional string or null` Replaces the slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. minLength: 1, maxLength: 255 - `oauth_scope: optional string or null` Replaces the space-separated OAuth scopes granted on minted tokens. OAuth callers may only set `workspace:developer` or `workspace:inference`; other scopes (such as `org:admin`) require a Console session. minLength: 1 - `target: optional BetaServiceAccountTarget or null` Replaces the entire target object. Currently always a `service_account` target. - `type: "service_account"` - `service_account_id: string` Tagged ID of the service account to mint tokens for. - `service_account_name: optional string or null` Service account's display name at read time. Ignored on writes. - `token_lifetime_seconds: optional number or null` Replaces the lifetime in seconds for access tokens minted via this rule (60-86400). Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. minimum: 60, maximum: 86400 - `workspace_id: optional string or null` Replaces the existing single workspace enablement (the previous one is removed). Rejected with 400 if the rule is enabled for more than one workspace; use the `/federation_rules/{federation_rule_id}/workspaces` sub-resource instead. #### Returns - `BetaFederationRule object` Authorization rule binding an external OIDC identity to Anthropic. Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this. - `type: "federation_rule"` default: federation_rule - `id: string` Tagged ID of the federation rule. - `applies_to_all_workspaces: boolean` When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. - `archived_at: string or null` If set, this rule is archived and rejects token exchange. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this rule. - `attributes: map[string] or null` CEL expressions extracting named values from claims. Not yet supported; always null. - `created_at: string` When this rule was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this rule. - `description: string or null` Optional free-text description. - `issuer_id: string` Tagged ID of the issuer whose tokens this rule accepts. - `issuer_name: string or null` Issuer's display name at read time. - `match: BetaFederationRuleMatch` Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. - `audience: optional string or null` Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. maxLength: 1024 - `claims: optional map[string] or null` Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. - `condition: optional string or null` CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. maxLength: 4096 - `subject_prefix: optional string or null` Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. maxLength: 1024 - `name: string` Admin-chosen slug identifier. - `oauth_scope: string` Space-separated OAuth scopes granted on the minted token. - `target: BetaServiceAccountTarget` What this rule targets. Check `type` before reading the other fields. Tokens minted via a rule whose target `type` is `service_account` act as that service account. - `type: "service_account"` - `service_account_id: string` Tagged ID of the service account to mint tokens for. - `service_account_name: optional string or null` Service account's display name at read time. Ignored on writes. - `token_lifetime_seconds: number` Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. - `updated_at: string` When this rule was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. - `workspace_id: string or null` Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. - `workspace_ids: array of string` Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). #### Example ```bash curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{}' ``` ##### Response (200) ```json { "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", "applies_to_all_workspaces": true, "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "attributes": { "foo": "string" }, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "issuer_id": "issuer_id", "issuer_name": "issuer_name", "match": { "audience": "audience", "claims": { "foo": "string" }, "condition": "condition", "subject_prefix": "subject_prefix" }, "name": "prod-deploy-pipeline", "oauth_scope": "oauth_scope", "target": { "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "type": "service_account", "service_account_name": "service_account_name" }, "token_lifetime_seconds": 0, "type": "federation_rule", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id", "workspace_id": "workspace_id", "workspace_ids": [ "string" ] } ``` ### Archive Federation Rule **POST** `/v1/organizations/federation_rules/{federation_rule_id}/archive` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Archive a federation rule. Token exchange through this rule stops immediately. Idempotent; re-archiving returns the rule with its original `archived_at`. Archiving clears the rule's workspace targeting (`workspace_id` and `workspace_ids` are emptied). Tokens already minted before archive remain valid until they expire. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session. #### Path parameters - `federation_rule_id: string` ID of the federation rule to archive. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaFederationRule object` Authorization rule binding an external OIDC identity to Anthropic. Evaluates the match conditions and mints an OAuth access token for the resolved target, scoped to a single workspace where the rule is enabled (chosen by the caller at exchange time when the rule is enabled for more than one). For rules enabled via `workspace_ids` or `applies_to_all_workspaces`, the target service account must be a member of that workspace (it is implicitly a member of the default workspace); rules carrying only the legacy `workspace_id` binding do not enforce this. - `type: "federation_rule"` default: federation_rule - `id: string` Tagged ID of the federation rule. - `applies_to_all_workspaces: boolean` When true, this rule is enabled for every workspace in the org (including ones created after the rule). `workspace_ids` is ignored at exchange time. - `archived_at: string or null` If set, this rule is archived and rejects token exchange. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this rule. - `attributes: map[string] or null` CEL expressions extracting named values from claims. Not yet supported; always null. - `created_at: string` When this rule was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this rule. - `description: string or null` Optional free-text description. - `issuer_id: string` Tagged ID of the issuer whose tokens this rule accepts. - `issuer_name: string or null` Issuer's display name at read time. - `match: BetaFederationRuleMatch` Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass. - `audience: optional string or null` Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default. maxLength: 1024 - `claims: optional map[string] or null` Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims. - `condition: optional string or null` CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400. maxLength: 4096 - `subject_prefix: optional string or null` Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`. maxLength: 1024 - `name: string` Admin-chosen slug identifier. - `oauth_scope: string` Space-separated OAuth scopes granted on the minted token. - `target: BetaServiceAccountTarget` What this rule targets. Check `type` before reading the other fields. Tokens minted via a rule whose target `type` is `service_account` act as that service account. - `type: "service_account"` - `service_account_id: string` Tagged ID of the service account to mint tokens for. - `service_account_name: optional string or null` Service account's display name at read time. Ignored on writes. - `token_lifetime_seconds: number` Lifetime in seconds of access tokens minted via this rule. Minted tokens are capped at `max(60, min(this value, 2 × remaining assertion validity))` seconds. - `updated_at: string` When this rule was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this rule. - `workspace_id: string or null` Legacy single-workspace binding. Prefer `workspace_ids` and the `/federation_rules/{federation_rule_id}/workspaces` sub-resource for managing workspace enablement. - `workspace_ids: array of string` Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty). #### Example ```bash curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK", "applies_to_all_workspaces": true, "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "attributes": { "foo": "string" }, "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "issuer_id": "issuer_id", "issuer_name": "issuer_name", "match": { "audience": "audience", "claims": { "foo": "string" }, "condition": "condition", "subject_prefix": "subject_prefix" }, "name": "prod-deploy-pipeline", "oauth_scope": "oauth_scope", "target": { "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "type": "service_account", "service_account_name": "service_account_name" }, "token_lifetime_seconds": 0, "type": "federation_rule", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id", "workspace_id": "workspace_id", "workspace_ids": [ "string" ] } ``` ## Beta › Organization › Federation › Rules › Workspaces ### Add Federation Rule Workspace **POST** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Enable a federation rule for a workspace. Idempotent; re-enabling returns the existing enablement. The rule and workspace must both belong to your organization. Membership of the rule's target service account in this workspace is not checked at enablement: token exchange into this workspace is rejected unless the target is a member (it is implicitly a member of the default workspace). Archived rules are rejected with 400. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session. #### Path parameters - `federation_rule_id: string` ID of the federation rule. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `workspace_id: string` Tagged ID of the workspace to enable this rule for. #### Returns - `BetaFederationRuleWorkspace object` - `type: "federation_rule_workspace"` default: federation_rule_workspace - `created_at: string` When this workspace was enabled for the rule. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. - `federation_rule_id: string` Tagged ID of the federation rule. - `workspace_id: string` Tagged ID of the workspace this rule is enabled for. - `workspace_name: string or null` Workspace display name. Populated when listing; null in the enable response. #### Example ```bash curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "workspace_id": "workspace_id" }' ``` ##### Response (200) ```json { "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "federation_rule_id": "federation_rule_id", "type": "federation_rule_workspace", "workspace_id": "workspace_id", "workspace_name": "workspace_name" } ``` ### List Federation Rule Workspaces **GET** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). List workspaces where this federation rule is enabled. Returns all workspace enablements in a single response; the `limit` and `page` parameters are accepted but have no effect, and `next_page` is always `null`. Returns explicit per-workspace enablements only; for rules with `applies_to_all_workspaces` or a legacy single `workspace_id`, check those fields on the rule itself. #### Path parameters - `federation_rule_id: string` ID of the federation rule. #### Query parameters - `limit: optional number` Number of results per page. default: 20, minimum: 1, maximum: 100 - `page: optional string` Opaque cursor from a previous response's `next_page`. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaFederationRuleWorkspace` - `type: "federation_rule_workspace"` default: federation_rule_workspace - `created_at: string` When this workspace was enabled for the rule. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_...` or `svac_...`) of the actor that enabled this workspace for the rule, if known. - `federation_rule_id: string` Tagged ID of the federation rule. - `workspace_id: string` Tagged ID of the workspace this rule is enabled for. - `workspace_name: string or null` Workspace display name. Populated when listing; null in the enable response. - `next_page: string or null` Opaque cursor for the next page; null when there are no more results. #### Example ```bash curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "federation_rule_id": "federation_rule_id", "type": "federation_rule_workspace", "workspace_id": "workspace_id", "workspace_name": "workspace_name" } ], "next_page": "next_page" } ``` ### Remove Federation Rule Workspace **DELETE** `/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Disable a federation rule for a workspace. Idempotent; succeeds even if the enablement was already removed. OAuth callers may only manage rules whose `oauth_scope` is `workspace:developer` or `workspace:inference`; other scopes require a Console session. #### Path parameters - `federation_rule_id: string` ID of the federation rule. - `workspace_id: string` ID of the workspace to disable for. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `type: "federation_rule_workspace_deleted"` default: federation_rule_workspace_deleted - `federation_rule_id: string` Tagged ID of the federation rule. - `workspace_id: string` Tagged ID of the workspace named in the delete request. Removal is idempotent. #### Example ```bash curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID/workspaces/$WORKSPACE_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "federation_rule_id": "federation_rule_id", "type": "federation_rule_workspace_deleted", "workspace_id": "workspace_id" } ``` ## Beta › Organization › Invites ### Create Invite **POST** `/v1/organizations/invites` Invite a user to join the organization by email. On plans that draw members from a finite pool of purchased seats, the invite automatically consumes a seat from the lowest tier with availability; there is no seat-tier parameter. When no seat is free the request fails with a 400 error rather than purchasing a seat. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Body parameters - `email: string` Email of the User. format: email - `role: "billing" or "claude_code_user" or "developer" or 2 more` Role for the invited User. The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`; inviting with the `managed` role requires the `write:rbac_groups` scope in addition to `write:members`. - `"billing"` - `"claude_code_user"` - `"developer"` - `"managed"` - `"user"` - `rbac_group_ids: optional array of string` RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the `write:rbac_groups` scope. maxItems: 100 #### Returns - `BetaOrganizationInvite object` - `type: "invite"` Object type. For Invites, this is always `"invite"`. default: invite - `id: string` ID of the Invite. - `accepted_at: string or null` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `email: string` Email of the User being invited. - `expires_at: string` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `invited_at: string` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `rbac_group_ids: array of string` RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. - `role: BetaOrganizationRole` Organization role of the User. - `"admin"` - `"billing"` - `"claude_code_user"` - `"developer"` - `"managed"` - `"membership_admin"` - `"owner"` - `"primary_owner"` - `"user"` - `status: "accepted" or "deleted" or "expired" or "pending"` Status of the Invite. - `"accepted"` - `"deleted"` - `"expired"` - `"pending"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/invites \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "email": "user@emaildomain.com", "role": "user" }' ``` ##### Response (200) ```json { "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", "accepted_at": "2019-12-27T18:11:19.117Z", "email": "user@emaildomain.com", "expires_at": "2024-11-20T23:58:27.427722Z", "invited_at": "2024-10-30T23:58:27.427722Z", "rbac_group_ids": [ "string" ], "role": "admin", "status": "pending", "type": "invite" } ``` ### List Invites **GET** `/v1/organizations/invites` List the organization's invites. #### Query parameters - `after_id: optional string` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `before_id: optional string` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `email: optional string` Filter by the email address the Invite was sent to. Matches the same way as the Users list's `email` filter (normalized, case-insensitive). format: email - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 - `roles: optional array of string` Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. - `statuses: optional array of "accepted" or "expired" or "pending"` Filter by Invite status. Repeatable; values are OR'ed together. Omit to return `pending`, `accepted`, and `expired` Invites alike. - `"accepted"` - `"expired"` - `"pending"` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaOrganizationInvite` - `type: "invite"` Object type. For Invites, this is always `"invite"`. default: invite - `id: string` ID of the Invite. - `accepted_at: string or null` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `email: string` Email of the User being invited. - `expires_at: string` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `invited_at: string` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `rbac_group_ids: array of string` RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. - `role: BetaOrganizationRole` Organization role of the User. - `"admin"` - `"billing"` - `"claude_code_user"` - `"developer"` - `"managed"` - `"membership_admin"` - `"owner"` - `"primary_owner"` - `"user"` - `status: "accepted" or "deleted" or "expired" or "pending"` Status of the Invite. - `"accepted"` - `"deleted"` - `"expired"` - `"pending"` - `first_id: string or null` First ID in the `data` list. Can be used as the `before_id` for the previous page. - `has_more: boolean` Indicates if there are more results in the requested page direction. - `last_id: string or null` Last ID in the `data` list. Can be used as the `after_id` for the next page. #### Example ```bash curl https://api.anthropic.com/v1/organizations/invites \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", "accepted_at": "2019-12-27T18:11:19.117Z", "email": "user@emaildomain.com", "expires_at": "2024-11-20T23:58:27.427722Z", "invited_at": "2024-10-30T23:58:27.427722Z", "rbac_group_ids": [ "string" ], "role": "admin", "status": "pending", "type": "invite" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ### Get Invite **GET** `/v1/organizations/invites/{invite_id}` Retrieve an invite by ID. #### Path parameters - `invite_id: string` ID of the Invite. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `BetaOrganizationInvite object` - `type: "invite"` Object type. For Invites, this is always `"invite"`. default: invite - `id: string` ID of the Invite. - `accepted_at: string or null` RFC 3339 datetime string indicating when the Invite was accepted, or null. format: date-time - `email: string` Email of the User being invited. - `expires_at: string` RFC 3339 datetime string indicating when the Invite expires. format: date-time - `invited_at: string` RFC 3339 datetime string indicating when the Invite was created. format: date-time - `rbac_group_ids: array of string` RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. `[]` when none. - `role: BetaOrganizationRole` Organization role of the User. - `"admin"` - `"billing"` - `"claude_code_user"` - `"developer"` - `"managed"` - `"membership_admin"` - `"owner"` - `"primary_owner"` - `"user"` - `status: "accepted" or "deleted" or "expired" or "pending"` Status of the Invite. - `"accepted"` - `"deleted"` - `"expired"` - `"pending"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", "accepted_at": "2019-12-27T18:11:19.117Z", "email": "user@emaildomain.com", "expires_at": "2024-11-20T23:58:27.427722Z", "invited_at": "2024-10-30T23:58:27.427722Z", "rbac_group_ids": [ "string" ], "role": "admin", "status": "pending", "type": "invite" } ``` ### Delete Invite **DELETE** `/v1/organizations/invites/{invite_id}` Delete a pending invite. #### Path parameters - `invite_id: string` ID of the Invite. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `type: "invite_deleted"` Deleted object type. For Invites, this is always `"invite_deleted"`. default: invite_deleted - `id: string` ID of the Invite. #### Example ```bash curl https://api.anthropic.com/v1/organizations/invites/$INVITE_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu", "type": "invite_deleted" } ``` ## Beta › Organization › Service Accounts ### Create Service Account **POST** `/v1/organizations/service_accounts` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Create a service account. A service account is a named workload identity that federation rules target. `organization_role` is `developer` (default) or `admin`; a rule may only be created or retargeted to grant `org:admin` scope when the target's `organization_role` is `admin`. Creating an `admin`-role service account requires an interactive credential (a user OAuth token or a Console session) — a workload may only create `developer`-role service accounts. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `name: string` Slug identifier (lowercase, digits, hyphens). Unique within the organization; a duplicate name returns 409. minLength: 1, maxLength: 255 - `description: optional string or null` Optional free-text description. maxLength: 2000 - `organization_role: optional "admin" or "developer"` Org-level role. Defaults to `developer`. - `"admin"` - `"developer"` #### Returns - `BetaServiceAccount object` Named non-human identity within the caller's organization. A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules). - `type: "service_account"` default: service_account - `id: string` Tagged ID of the service account. - `archived_at: string or null` If set, this service account is archived. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this service account. - `created_at: string` When this service account was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this service account. - `description: string or null` Optional free-text description. - `name: string` Admin-chosen slug identifier. - `organization_role: "admin" or "developer"` Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. - `"admin"` - `"developer"` - `updated_at: string` When this service account was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. #### Example ```bash curl https://api.anthropic.com/v1/organizations/service_accounts \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "name": "ci-deploy-bot" }' ``` ##### Response (200) ```json { "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "name": "ci-deploy-bot", "organization_role": "admin", "type": "service_account", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } ``` ### List Service Accounts **GET** `/v1/organizations/service_accounts` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). List service accounts in the caller's organization. Results are ordered by creation time, newest first. Use `limit` and the `next_page` cursor to paginate; set `include_archived=true` to include archived service accounts. #### Query parameters - `include_archived: optional boolean` Include archived resources. Defaults to false. default: false - `limit: optional number` Number of results per page. default: 20, minimum: 1, maximum: 100 - `page: optional string` Opaque cursor from a previous response's `next_page`. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaServiceAccount` - `type: "service_account"` default: service_account - `id: string` Tagged ID of the service account. - `archived_at: string or null` If set, this service account is archived. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this service account. - `created_at: string` When this service account was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this service account. - `description: string or null` Optional free-text description. - `name: string` Admin-chosen slug identifier. - `organization_role: "admin" or "developer"` Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. - `"admin"` - `"developer"` - `updated_at: string` When this service account was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. - `next_page: string or null` Opaque cursor for the next page, or null if no more results. #### Example ```bash curl https://api.anthropic.com/v1/organizations/service_accounts \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "name": "ci-deploy-bot", "organization_role": "admin", "type": "service_account", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } ], "next_page": "next_page" } ``` ### Get Service Account **GET** `/v1/organizations/service_accounts/{service_account_id}` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Retrieve a service account by its ID (`svac_...`). #### Path parameters - `service_account_id: string` ID of the service account. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaServiceAccount object` Named non-human identity within the caller's organization. A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules). - `type: "service_account"` default: service_account - `id: string` Tagged ID of the service account. - `archived_at: string or null` If set, this service account is archived. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this service account. - `created_at: string` When this service account was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this service account. - `description: string or null` Optional free-text description. - `name: string` Admin-chosen slug identifier. - `organization_role: "admin" or "developer"` Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. - `"admin"` - `"developer"` - `updated_at: string` When this service account was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. #### Example ```bash curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "name": "ci-deploy-bot", "organization_role": "admin", "type": "service_account", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } ``` ### Update Service Account **POST** `/v1/organizations/service_accounts/{service_account_id}` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Update a service account. Only `description` and `organization_role` are mutable; `name` cannot be changed. Archived service accounts cannot be updated; this returns 400. Setting `organization_role` to `admin` (even when unchanged) requires an interactive credential (a user OAuth token or a Console session). #### Path parameters - `service_account_id: string` ID of the service account to update. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `description: optional string or null` Replaces the description. Omit to leave unchanged; send `null` to clear (the field is stored as an empty string). maxLength: 2000 - `organization_role: optional "admin" or "developer" or null` Replaces the org-level role. Omit or send `null` to leave unchanged. - `"admin"` - `"developer"` #### Returns - `BetaServiceAccount object` Named non-human identity within the caller's organization. A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules). - `type: "service_account"` default: service_account - `id: string` Tagged ID of the service account. - `archived_at: string or null` If set, this service account is archived. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this service account. - `created_at: string` When this service account was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this service account. - `description: string or null` Optional free-text description. - `name: string` Admin-chosen slug identifier. - `organization_role: "admin" or "developer"` Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. - `"admin"` - `"developer"` - `updated_at: string` When this service account was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. #### Example ```bash curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{}' ``` ##### Response (200) ```json { "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "name": "ci-deploy-bot", "organization_role": "admin", "type": "service_account", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } ``` ### Archive Service Account **POST** `/v1/organizations/service_accounts/{service_account_id}/archive` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Archive a service account. Idempotent; re-archiving returns the service account with its original `archived_at`. Rejected with 400 if any live (non-archived) federation rule still targets this service account, same as issuer archival; archive those rules first or change their target to another service account. #### Path parameters - `service_account_id: string` ID of the service account to archive. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaServiceAccount object` Named non-human identity within the caller's organization. A service account is a pure identity: name + org. Authorization lives on whatever references it (federation rules). - `type: "service_account"` default: service_account - `id: string` Tagged ID of the service account. - `archived_at: string or null` If set, this service account is archived. format: date-time - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this service account. - `created_at: string` When this service account was created. format: date-time - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this service account. - `description: string or null` Optional free-text description. - `name: string` Admin-chosen slug identifier. - `organization_role: "admin" or "developer"` Org-level role. A federation rule may only be created or retargeted to grant `org:admin` scope when this is `admin`. A rule granting `org:admin` whose target is later demoted to `developer` is rejected at token exchange. Rules granting `org:admin` are managed in the Console. - `"admin"` - `"developer"` - `updated_at: string` When this service account was last updated. format: date-time - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this service account. #### Example ```bash curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "svac_01SDCCSbTxrXDpWc1phhtcfK", "archived_at": "2019-12-27T18:11:19.117Z", "archived_by_actor_id": "archived_by_actor_id", "created_at": "2024-10-30T23:58:27.427722Z", "created_by_actor_id": "created_by_actor_id", "description": "description", "name": "ci-deploy-bot", "organization_role": "admin", "type": "service_account", "updated_at": "2024-10-30T23:58:27.427722Z", "updated_by_actor_id": "updated_by_actor_id" } ``` ## Beta › Organization › Service Accounts › Workspaces ### Add Workspace To Service Account **POST** `/v1/organizations/service_accounts/{service_account_id}/workspaces` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Add a service account to a workspace with the given `workspace_role`. Mirror of `POST /workspaces/{workspace_id}/service_accounts`, addressed from the service-account side; both create the same membership. If the service account is already an explicit member of the workspace, its `workspace_role` is replaced with the value supplied here. Archived workspaces return 400. Archived service accounts cannot be added and are rejected. #### Path parameters - `service_account_id: string` ID of the service account. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `workspace_id: string` Tagged workspace ID to add the service account to. - `workspace_role: BetaNoBillingWorkspaceRole` Role to assign to the service account in this workspace. - `"workspace_admin"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` #### Returns - `BetaServiceAccountWorkspaceMember object` - `type: "service_account_workspace_member"` default: service_account_workspace_member - `created_by_actor_id: string or null` Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - `implicit: boolean or null` True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - `service_account_id: string` Tagged service account ID (`svac_...`). - `workspace_id: string` Tagged workspace ID (`wrkspc_...`). - `workspace_role: BetaWorkspaceRole` Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - `"workspace_admin"` - `"workspace_billing"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "workspace_id": "workspace_id", "workspace_role": "workspace_admin" }' ``` ##### Response (200) ```json { "created_by_actor_id": "created_by_actor_id", "implicit": true, "service_account_id": "service_account_id", "type": "service_account_workspace_member", "workspace_id": "workspace_id", "workspace_role": "workspace_admin" } ``` ### List Workspaces For Service Account **GET** `/v1/organizations/service_accounts/{service_account_id}/workspaces` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). List the workspaces a service account is a member of. Each entry includes the service account's `workspace_role` in that workspace. Use `limit` and the `next_page` cursor to paginate. When the service account has no explicit default-workspace membership, the implicit (`implicit: true`) membership is returned as the first entry on the first page; with `limit=1` the first page may return up to 2 entries (the implicit entry plus one explicit membership) so a pagination cursor can be derived. Memberships are returned only while the service account is active. Without a `page` cursor, an archived service account returns an empty list. A `page` cursor that does not match an active membership returns a 400 invalid-request error. A cursor stops matching when the membership is removed, the workspace is deleted, or the service account is archived. Restart pagination from the first page to recover. #### Path parameters - `service_account_id: string` ID of the service account. #### Query parameters - `limit: optional number` Number of results per page. default: 20, minimum: 1, maximum: 100 - `page: optional string` Opaque cursor from a previous response's `next_page`. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaServiceAccountWorkspaceMember` - `type: "service_account_workspace_member"` default: service_account_workspace_member - `created_by_actor_id: string or null` Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - `implicit: boolean or null` True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - `service_account_id: string` Tagged service account ID (`svac_...`). - `workspace_id: string` Tagged workspace ID (`wrkspc_...`). - `workspace_role: BetaWorkspaceRole` Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - `"workspace_admin"` - `"workspace_billing"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` - `next_page: string or null` Opaque cursor for the next page, or null if no more results. #### Example ```bash curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "created_by_actor_id": "created_by_actor_id", "implicit": true, "service_account_id": "service_account_id", "type": "service_account_workspace_member", "workspace_id": "workspace_id", "workspace_role": "workspace_admin" } ], "next_page": "next_page" } ``` ### Remove Workspace From Service Account **DELETE** `/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Remove a service account from a workspace. Mirror of `DELETE /workspaces/{workspace_id}/service_accounts/{service_account_id}`, addressed from the service-account side. Removal is idempotent (returns 200 even if the membership was already removed). A DELETE against the implicit default-workspace membership returns 200 but is a no-op and the membership persists; deleting an explicit default-workspace row reverts to the implicit `workspace_user` membership. Archived workspaces return 400. #### Path parameters - `service_account_id: string` ID of the service account. - `workspace_id: string` ID of the workspace. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `type: "service_account_workspace_member_deleted"` default: service_account_workspace_member_deleted - `service_account_id: string` Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. - `workspace_id: string` Tagged workspace ID (`wrkspc_...`) named in the delete request. #### Example ```bash curl https://api.anthropic.com/v1/organizations/service_accounts/$SERVICE_ACCOUNT_ID/workspaces/$WORKSPACE_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "service_account_id": "service_account_id", "type": "service_account_workspace_member_deleted", "workspace_id": "workspace_id" } ``` ## Beta › Organization › Users ### List Users **GET** `/v1/organizations/users` List the organization's members. #### Query parameters - `after_id: optional string` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `before_id: optional string` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `email: optional string` Filter by user email. format: email - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 - `roles: optional array of string` Filter to items whose `role` equals one of the supplied values. Repeatable; values are OR'ed together. Accepted values depend on the organization type: Console and API organizations accept `user`, `developer`, `billing`, `admin`, and `claude_code_user`; Claude Enterprise organizations accept `user`, `owner`, `primary_owner`, `membership_admin`, and `managed`. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaOrganizationUser` - `type: "user"` Object type. For Users, this is always `"user"`. default: user - `id: string` ID of the User. - `added_at: string` RFC 3339 datetime string indicating when the User joined the Organization. format: date-time - `email: string` Email of the User. - `name: string` Name of the User. - `role: BetaOrganizationRole` Organization role of the User. - `"admin"` - `"billing"` - `"claude_code_user"` - `"developer"` - `"managed"` - `"membership_admin"` - `"owner"` - `"primary_owner"` - `"user"` - `first_id: string or null` First ID in the `data` list. Can be used as the `before_id` for the previous page. - `has_more: boolean` Indicates if there are more results in the requested page direction. - `last_id: string or null` Last ID in the `data` list. Can be used as the `after_id` for the next page. #### Example ```bash curl https://api.anthropic.com/v1/organizations/users \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "added_at": "2024-10-30T23:58:27.427722Z", "email": "user@emaildomain.com", "name": "Jane Doe", "role": "admin", "type": "user" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ### Get User **GET** `/v1/organizations/users/{user_id}` Retrieve a member of the organization by user ID. #### Path parameters - `user_id: string` ID of the User. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `BetaOrganizationUser object` - `type: "user"` Object type. For Users, this is always `"user"`. default: user - `id: string` ID of the User. - `added_at: string` RFC 3339 datetime string indicating when the User joined the Organization. format: date-time - `email: string` Email of the User. - `name: string` Name of the User. - `role: BetaOrganizationRole` Organization role of the User. - `"admin"` - `"billing"` - `"claude_code_user"` - `"developer"` - `"managed"` - `"membership_admin"` - `"owner"` - `"primary_owner"` - `"user"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "added_at": "2024-10-30T23:58:27.427722Z", "email": "user@emaildomain.com", "name": "Jane Doe", "role": "admin", "type": "user" } ``` ### Update User **POST** `/v1/organizations/users/{user_id}` Update a member's organization role. #### Path parameters - `user_id: string` ID of the User. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Body parameters - `role: "billing" or "claude_code_user" or "developer" or 2 more` New role for the User. The accepted values depend on the organization type. Console and API organizations accept `user`, `developer`, `billing`, and `claude_code_user`; `admin` cannot be assigned through the API. Claude Enterprise organizations accept `user` and `managed`; changing a User's role to `managed` requires the `write:rbac_groups` scope in addition to `write:members`. - `"billing"` - `"claude_code_user"` - `"developer"` - `"managed"` - `"user"` #### Returns - `BetaOrganizationUser object` - `type: "user"` Object type. For Users, this is always `"user"`. default: user - `id: string` ID of the User. - `added_at: string` RFC 3339 datetime string indicating when the User joined the Organization. format: date-time - `email: string` Email of the User. - `name: string` Name of the User. - `role: BetaOrganizationRole` Organization role of the User. - `"admin"` - `"billing"` - `"claude_code_user"` - `"developer"` - `"managed"` - `"membership_admin"` - `"owner"` - `"primary_owner"` - `"user"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "role": "user" }' ``` ##### Response (200) ```json { "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "added_at": "2024-10-30T23:58:27.427722Z", "email": "user@emaildomain.com", "name": "Jane Doe", "role": "admin", "type": "user" } ``` ### Remove User **DELETE** `/v1/organizations/users/{user_id}` Remove a member from the organization. #### Path parameters - `user_id: string` ID of the User. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `type: "user_deleted"` Deleted object type. For Users, this is always `"user_deleted"`. default: user_deleted - `id: string` ID of the User. #### Example ```bash curl https://api.anthropic.com/v1/organizations/users/$USER_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "type": "user_deleted" } ``` ## Beta › Organization › Workspaces ### List Workspaces **GET** `/v1/organizations/workspaces` List Workspaces #### Query parameters - `after_id: optional string` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `before_id: optional string` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `include_archived: optional boolean` Whether to include Workspaces that have been archived in the response default: false - `include_default: optional boolean` Whether to include the organization's default Workspace in the response default: false - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaWorkspace` - `type: "workspace"` Object type. For Workspaces, this is always `"workspace"`. default: workspace - `id: string` ID of the Workspace. - `archived_at: string or null` RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. format: date-time - `compartment_id: string` Identifier for this Workspace's encryption compartment. When you configure a customer-managed encryption key (CMEK) on AWS, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: the key is validated against this Workspace's own value when it is attached, so if your key policy uses the compartment condition, add this value to it before attaching the key. - `created_at: string` RFC 3339 datetime string indicating when the Workspace was created. format: date-time - `data_residency: BetaDataResidency` Data residency configuration. - `allowed_inference_geos: array of BetaAllowedInferenceGeo or "unrestricted"` Permitted inference geo values. 'unrestricted' means all geos are allowed. - `Geos = array of BetaAllowedInferenceGeo` - `"global"` - `"us"` - `"unrestricted"` - `default_inference_geo: "global" or "us"` Default inference geo applied when requests omit the parameter. - `"global"` - `"us"` - `workspace_geo: "us"` Geographic region for workspace data storage. Immutable after creation. - `display_color: string` Hex color code representing the Workspace in the Anthropic Console. - `external_key_id: string or null` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `name: string` Name of the Workspace. - `tags: map[string]` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. - `first_id: string or null` First ID in the `data` list. Can be used as the `before_id` for the previous page. - `has_more: boolean` Indicates if there are more results in the requested page direction. - `last_id: string or null` Last ID in the `data` list. Can be used as the `after_id` for the next page. #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ### Create Workspace **POST** `/v1/organizations/workspaces` Create Workspace #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `name: string` Name of the Workspace. minLength: 1, maxLength: 255 - `data_residency: optional BetaDataResidencyCreateConfig or null` Data residency configuration for the workspace. If omitted, defaults to `workspace_geo: "us"`, `allowed_inference_geos: "unrestricted"`, and `default_inference_geo: "global"`. - `allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted" or null` Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos. - `Geos = array of BetaAllowedInferenceGeo` - `"global"` - `"us"` - `"unrestricted"` - `default_inference_geo: optional "global" or "us" or null` Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. - `"global"` - `"us"` - `workspace_geo: optional "us" or null` Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted. - `display_color: optional string or null` Hex color code representing the Workspace in the Anthropic Console. maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ - `external_key_id: optional string or null` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `tags: optional map[string] or null` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. #### Returns - `BetaWorkspace object` - `type: "workspace"` Object type. For Workspaces, this is always `"workspace"`. default: workspace - `id: string` ID of the Workspace. - `archived_at: string or null` RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. format: date-time - `compartment_id: string` Identifier for this Workspace's encryption compartment. When you configure a customer-managed encryption key (CMEK) on AWS, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: the key is validated against this Workspace's own value when it is attached, so if your key policy uses the compartment condition, add this value to it before attaching the key. - `created_at: string` RFC 3339 datetime string indicating when the Workspace was created. format: date-time - `data_residency: BetaDataResidency` Data residency configuration. - `allowed_inference_geos: array of BetaAllowedInferenceGeo or "unrestricted"` Permitted inference geo values. 'unrestricted' means all geos are allowed. - `Geos = array of BetaAllowedInferenceGeo` - `"global"` - `"us"` - `"unrestricted"` - `default_inference_geo: "global" or "us"` Default inference geo applied when requests omit the parameter. - `"global"` - `"us"` - `workspace_geo: "us"` Geographic region for workspace data storage. Immutable after creation. - `display_color: string` Hex color code representing the Workspace in the Anthropic Console. - `external_key_id: string or null` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `name: string` Name of the Workspace. - `tags: map[string]` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "name": "x", "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "tags": { "env": "prod", "team": "platform" } }' ``` ##### Response (200) ```json { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } ``` ### Get Workspace **GET** `/v1/organizations/workspaces/{workspace_id}` Get Workspace #### Path parameters - `workspace_id: string` ID of the Workspace. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `BetaWorkspace object` - `type: "workspace"` Object type. For Workspaces, this is always `"workspace"`. default: workspace - `id: string` ID of the Workspace. - `archived_at: string or null` RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. format: date-time - `compartment_id: string` Identifier for this Workspace's encryption compartment. When you configure a customer-managed encryption key (CMEK) on AWS, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: the key is validated against this Workspace's own value when it is attached, so if your key policy uses the compartment condition, add this value to it before attaching the key. - `created_at: string` RFC 3339 datetime string indicating when the Workspace was created. format: date-time - `data_residency: BetaDataResidency` Data residency configuration. - `allowed_inference_geos: array of BetaAllowedInferenceGeo or "unrestricted"` Permitted inference geo values. 'unrestricted' means all geos are allowed. - `Geos = array of BetaAllowedInferenceGeo` - `"global"` - `"us"` - `"unrestricted"` - `default_inference_geo: "global" or "us"` Default inference geo applied when requests omit the parameter. - `"global"` - `"us"` - `workspace_geo: "us"` Geographic region for workspace data storage. Immutable after creation. - `display_color: string` Hex color code representing the Workspace in the Anthropic Console. - `external_key_id: string or null` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `name: string` Name of the Workspace. - `tags: map[string]` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } ``` ### Update Workspace **POST** `/v1/organizations/workspaces/{workspace_id}` Update Workspace #### Path parameters - `workspace_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Body parameters - `data_residency: optional BetaDataResidencyUpdateConfig or null` Data residency configuration for the workspace. - `allowed_inference_geos: optional array of BetaAllowedInferenceGeo or "unrestricted" or null` Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos. - `Geos = array of BetaAllowedInferenceGeo` - `"global"` - `"us"` - `"unrestricted"` - `default_inference_geo: optional "global" or "us" or null` Default inference geo applied when requests omit the parameter. Must be a member of `allowed_inference_geos` unless `allowed_inference_geos` is `"unrestricted"`. - `"global"` - `"us"` - `display_color: optional string` Hex color code representing the Workspace in the Anthropic Console. maxLength: 7, pattern: ^#[0-9A-Fa-f]{6}$ - `external_key_id: optional string` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `name: optional string` Name of the Workspace. minLength: 1, maxLength: 255 - `tags: optional map[string] or null` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. #### Returns - `BetaWorkspace object` - `type: "workspace"` Object type. For Workspaces, this is always `"workspace"`. default: workspace - `id: string` ID of the Workspace. - `archived_at: string or null` RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. format: date-time - `compartment_id: string` Identifier for this Workspace's encryption compartment. When you configure a customer-managed encryption key (CMEK) on AWS, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: the key is validated against this Workspace's own value when it is attached, so if your key policy uses the compartment condition, add this value to it before attaching the key. - `created_at: string` RFC 3339 datetime string indicating when the Workspace was created. format: date-time - `data_residency: BetaDataResidency` Data residency configuration. - `allowed_inference_geos: array of BetaAllowedInferenceGeo or "unrestricted"` Permitted inference geo values. 'unrestricted' means all geos are allowed. - `Geos = array of BetaAllowedInferenceGeo` - `"global"` - `"us"` - `"unrestricted"` - `default_inference_geo: "global" or "us"` Default inference geo applied when requests omit the parameter. - `"global"` - `"us"` - `workspace_geo: "us"` Geographic region for workspace data storage. Immutable after creation. - `display_color: string` Hex color code representing the Workspace in the Anthropic Console. - `external_key_id: string or null` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `name: string` Name of the Workspace. - `tags: map[string]` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "tags": { "env": "prod", "team": "platform" } }' ``` ##### Response (200) ```json { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } ``` ### Archive Workspace **POST** `/v1/organizations/workspaces/{workspace_id}/archive` Archive Workspace #### Path parameters - `workspace_id: string` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `BetaWorkspace object` - `type: "workspace"` Object type. For Workspaces, this is always `"workspace"`. default: workspace - `id: string` ID of the Workspace. - `archived_at: string or null` RFC 3339 datetime string indicating when the Workspace was archived, or `null` if the Workspace is not archived. format: date-time - `compartment_id: string` Identifier for this Workspace's encryption compartment. When you configure a customer-managed encryption key (CMEK) on AWS, reference this value in your KMS key-policy condition so the key is scoped to this compartment. On GCP and Azure, Anthropic enforces the compartment binding automatically; you do not need to reference this value in your key configuration. See the CMEK integration guide for the required key configuration; unless your organization is on Claude Platform on AWS, it includes a separate value used during key validation. On Claude Platform on AWS there is no separate validation value: the key is validated against this Workspace's own value when it is attached, so if your key policy uses the compartment condition, add this value to it before attaching the key. - `created_at: string` RFC 3339 datetime string indicating when the Workspace was created. format: date-time - `data_residency: BetaDataResidency` Data residency configuration. - `allowed_inference_geos: array of BetaAllowedInferenceGeo or "unrestricted"` Permitted inference geo values. 'unrestricted' means all geos are allowed. - `Geos = array of BetaAllowedInferenceGeo` - `"global"` - `"us"` - `"unrestricted"` - `default_inference_geo: "global" or "us"` Default inference geo applied when requests omit the parameter. - `"global"` - `"us"` - `workspace_geo: "us"` Geographic region for workspace data storage. Immutable after creation. - `display_color: string` Hex color code representing the Workspace in the Anthropic Console. - `external_key_id: string or null` ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. On Claude Platform on AWS the value is the AWS KMS key ARN, and the key must be a single-Region key in the same AWS account and Region as the Workspace. On that platform the key is validated against this Workspace when it is attached, so a key-policy problem is reported as an error on this request. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the `external_key_id` stays the same. - `name: string` Name of the Workspace. - `tags: map[string]` User-defined tags as string key-value pairs. Keys may not begin with `anthropic`. #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "archived_at": "2024-11-01T23:59:27.427722Z", "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c", "created_at": "2024-10-30T23:58:27.427722Z", "data_residency": { "allowed_inference_geos": "unrestricted", "default_inference_geo": "global", "workspace_geo": "us" }, "display_color": "#6C5BB9", "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK", "name": "Workspace Name", "tags": { "env": "prod", "team": "platform" }, "type": "workspace" } ``` ## Beta › Organization › Workspaces › Rate Limits ### List Workspace Rate Limits **GET** `/v1/organizations/workspaces/{workspace_id}/rate_limits` List a workspace's rate limits. By default, returns only the groups and limiter types that have a workspace-level override. With `include_inherited=true`, returns every group with organization-level limits the workspace can see, listing for each the values it inherits from the organization as well as its own overrides. Each value's `source` says which it is. When `limit` is omitted, every matching entry is returned in a single page; when `limit` truncates the result, follow `next_page` to fetch the remaining entries. #### Path parameters - `workspace_id: string` The ID of the workspace. #### Query parameters - `group_type: optional "batch" or "files" or "model_group" or 3 more` Filter by group type. - `"batch"` - `"files"` - `"model_group"` - `"skills"` - `"token_count"` - `"web_search"` - `include_inherited: optional boolean` Also list the limiter values the workspace inherits from the organization, including groups with no workspace-level override. default: false - `limit: optional number` Maximum number of items to return per page. Ranges from `1` to `1000`. When omitted, every remaining entry is returned in a single page and `next_page` is `null`. minimum: 1, maximum: 1000 - `page: optional string` Opaque cursor from a previous response's `next_page`. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaWorkspaceRateLimit` Rate-limit entries for the workspace: one per group with at least one override, or, with `include_inherited` set to `true`, one per group the workspace can see that has organization-level limits. - `type: "workspace_rate_limit"` Object type. Always `workspace_rate_limit` for workspace rate-limit entries. default: workspace_rate_limit - `group: BetaOrganizationRateLimitModelGroup or BetaOrganizationRateLimitBatchGroup or BetaOrganizationRateLimitTokenCountGroup or 3 more` The rate-limit group this entry's limits apply to. Its `type` equals `group_type`. - `BetaOrganizationRateLimitModelGroup object` - `type: "model_group"` Always `model_group`: a family of models. default: model_group - `id: string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `display_name: string` Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change. - `BetaOrganizationRateLimitBatchGroup object` - `type: "batch"` Always `batch`: the Message Batches API. default: batch - `id: string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `BetaOrganizationRateLimitTokenCountGroup object` - `type: "token_count"` Always `token_count`: the Token Count API. default: token_count - `id: string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `BetaOrganizationRateLimitFilesGroup object` - `type: "files"` Always `files`: the Files API. default: files - `id: string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `BetaOrganizationRateLimitSkillsGroup object` - `type: "skills"` Always `skills`: the Skills API. default: skills - `id: string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `BetaOrganizationRateLimitWebSearchGroup object` - `type: "web_search"` Always `web_search`: the Messages API web search tool. default: web_search - `id: string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `limits: array of BetaWorkspaceRateLimitValue` The workspace's limiter values for this group. By default only the limiter types with a workspace-level override are listed. With `include_inherited` set to `true`, the limiter types the workspace inherits from the organization are listed too, each marked by `source`. - `type: string` The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). - `org_limit: number or null` The organization-level value for the same limiter type, for reference. `null` when the organization has no limit configured for this limiter type. - `source: BetaWorkspaceRateLimitWorkspaceSource or BetaWorkspaceRateLimitOrganizationSource` Where `value` comes from. `organization` values are listed only when `include_inherited` is `true`, and then `value` equals `org_limit`. - `BetaWorkspaceRateLimitWorkspaceSource object` - `type: "workspace"` Always `workspace`: a workspace-level override is stored. default: workspace - `BetaWorkspaceRateLimitOrganizationSource object` - `type: "organization"` Always `organization`: no workspace-level override is stored, so the organization's value applies. default: organization - `value: number` The workspace's value for this limiter type: the workspace-level override when `source.type` is `workspace`, otherwise the organization's value. - `models: array of string or null` Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. - `rate_limit_id: string` The `id` of the organization's RateLimit entry this entry applies to. - `workspace_id: string` ID of the Workspace this entry applies to. - `group_type: "batch" or "files" or "model_group" or 3 more` **Deprecated**: Use `group.type` instead. `group_type` is still returned and always equals `group.type`. Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`. - `"batch"` - `"files"` - `"model_group"` - `"skills"` - `"token_count"` - `"web_search"` - `next_page: string or null` Opaque cursor for the next page of results, or `null` when no entries remain beyond this response. #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/rate_limits \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "group": { "id": "id", "display_name": "display_name", "type": "model_group" }, "group_type": "batch", "limits": [ { "org_limit": 0, "source": { "type": "workspace" }, "type": "type", "value": 0 } ], "models": [ "string" ], "rate_limit_id": "rate_limit_id", "type": "workspace_rate_limit", "workspace_id": "workspace_id" } ], "next_page": "next_page" } ``` ## Beta › Organization › Workspaces › Members ### List Workspace Members **GET** `/v1/organizations/workspaces/{workspace_id}/members` List Workspace Members #### Path parameters - `workspace_id: string` ID of the Workspace. #### Query parameters - `after_id: optional string` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `before_id: optional string` ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaWorkspaceMember` - `type: "workspace_member"` Object type. For Workspace Members, this is always `"workspace_member"`. default: workspace_member - `user_id: string` ID of the User. - `workspace_id: string` ID of the Workspace. - `workspace_role: BetaWorkspaceRole` Role of the Workspace Member. - `"workspace_admin"` - `"workspace_billing"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` - `first_id: string or null` First ID in the `data` list. Can be used as the `before_id` for the previous page. - `has_more: boolean` Indicates if there are more results in the requested page direction. - `last_id: string or null` Last ID in the `data` list. Can be used as the `after_id` for the next page. #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "type": "workspace_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "workspace_role": "workspace_admin" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ### Create Workspace Member **POST** `/v1/organizations/workspaces/{workspace_id}/members` Create Workspace Member #### Path parameters - `workspace_id: string` ID of the Workspace. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Body parameters - `user_id: string` ID of the User. - `workspace_role: BetaNoBillingWorkspaceRole` Role of the new Workspace Member. Cannot be `workspace_billing`. - `"workspace_admin"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` #### Returns - `BetaWorkspaceMember object` - `type: "workspace_member"` Object type. For Workspace Members, this is always `"workspace_member"`. default: workspace_member - `user_id: string` ID of the User. - `workspace_id: string` ID of the Workspace. - `workspace_role: BetaWorkspaceRole` Role of the Workspace Member. - `"workspace_admin"` - `"workspace_billing"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_role": "workspace_admin" }' ``` ##### Response (200) ```json { "type": "workspace_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "workspace_role": "workspace_admin" } ``` ### Get Workspace Member **GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` Get Workspace Member #### Path parameters - `workspace_id: string` ID of the Workspace. - `user_id: string` ID of the User. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `BetaWorkspaceMember object` - `type: "workspace_member"` Object type. For Workspace Members, this is always `"workspace_member"`. default: workspace_member - `user_id: string` ID of the User. - `workspace_id: string` ID of the Workspace. - `workspace_role: BetaWorkspaceRole` Role of the Workspace Member. - `"workspace_admin"` - `"workspace_billing"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "type": "workspace_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "workspace_role": "workspace_admin" } ``` ### Update Workspace Member **POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` Update Workspace Member #### Path parameters - `workspace_id: string` ID of the Workspace. - `user_id: string` ID of the User. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Body parameters - `workspace_role: BetaWorkspaceRole` New workspace role for the User. - `"workspace_admin"` - `"workspace_billing"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` #### Returns - `BetaWorkspaceMember object` - `type: "workspace_member"` Object type. For Workspace Members, this is always `"workspace_member"`. default: workspace_member - `user_id: string` ID of the User. - `workspace_id: string` ID of the Workspace. - `workspace_role: BetaWorkspaceRole` Role of the Workspace Member. - `"workspace_admin"` - `"workspace_billing"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "workspace_role": "workspace_admin" }' ``` ##### Response (200) ```json { "type": "workspace_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ", "workspace_role": "workspace_admin" } ``` ### Delete Workspace Member **DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` Delete Workspace Member #### Path parameters - `workspace_id: string` ID of the Workspace. - `user_id: string` ID of the User. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `type: "workspace_member_deleted"` Deleted object type. For Workspace Members, this is always `"workspace_member_deleted"`. default: workspace_member_deleted - `user_id: string` ID of the User. - `workspace_id: string` ID of the Workspace. #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "type": "workspace_member_deleted", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ``` ## Beta › Organization › Workspaces › Service Accounts ### List Service Account Workspace Members **GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). List the service accounts that are members of a workspace. Each entry includes the service account's `workspace_role`. Use `limit` and the `next_page` cursor to paginate. Archived workspaces return 400; use `GET /service_accounts/{id}/workspaces` to audit memberships of an archived workspace. The implicit default-workspace membership is not included in this list. Memberships of archived service accounts are omitted from the results. #### Path parameters - `workspace_id: string` ID of the workspace. #### Query parameters - `limit: optional number` Number of results per page. default: 20, minimum: 1, maximum: 100 - `page: optional string` Opaque cursor from a previous response's `next_page`. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaServiceAccountWorkspaceMember` - `type: "service_account_workspace_member"` default: service_account_workspace_member - `created_by_actor_id: string or null` Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - `implicit: boolean or null` True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - `service_account_id: string` Tagged service account ID (`svac_...`). - `workspace_id: string` Tagged workspace ID (`wrkspc_...`). - `workspace_role: BetaWorkspaceRole` Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - `"workspace_admin"` - `"workspace_billing"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` - `next_page: string or null` Opaque cursor for the next page, or null if no more results. #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "created_by_actor_id": "created_by_actor_id", "implicit": true, "service_account_id": "service_account_id", "type": "service_account_workspace_member", "workspace_id": "workspace_id", "workspace_role": "workspace_admin" } ], "next_page": "next_page" } ``` ### Create Service Account Workspace Member **POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Add a service account to a workspace with the given `workspace_role`. The role determines what the service account can do in the workspace and which workspace-scoped permissions it can be granted when authenticating through federation. Every service account is already an implicit `workspace_user` member of the default workspace; adding it explicitly assigns a chosen role. If the service account is already an explicit member of the workspace, its `workspace_role` is replaced with the value supplied here. Archived workspaces return 400. Archived service accounts cannot be added and are rejected. #### Path parameters - `workspace_id: string` ID of the workspace. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `service_account_id: string` Tagged service account ID to add. - `workspace_role: BetaNoBillingWorkspaceRole` Role to assign to the service account in this workspace. - `"workspace_admin"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` #### Returns - `BetaServiceAccountWorkspaceMember object` - `type: "service_account_workspace_member"` default: service_account_workspace_member - `created_by_actor_id: string or null` Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - `implicit: boolean or null` True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - `service_account_id: string` Tagged service account ID (`svac_...`). - `workspace_id: string` Tagged workspace ID (`wrkspc_...`). - `workspace_role: BetaWorkspaceRole` Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - `"workspace_admin"` - `"workspace_billing"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "service_account_id": "service_account_id", "workspace_role": "workspace_admin" }' ``` ##### Response (200) ```json { "created_by_actor_id": "created_by_actor_id", "implicit": true, "service_account_id": "service_account_id", "type": "service_account_workspace_member", "workspace_id": "workspace_id", "workspace_role": "workspace_admin" } ``` ### Get Service Account Workspace Member **GET** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Retrieve a service account's membership in a workspace. Returns the membership record, including the service account's `workspace_role` in this workspace. Archived workspaces return 400. For the default workspace, returns the implicit (`implicit: true`) membership when no explicit membership exists; an explicitly added membership is returned with its assigned role. An archived service account returns 404. #### Path parameters - `workspace_id: string` ID of the workspace. - `service_account_id: string` ID of the service account. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaServiceAccountWorkspaceMember object` - `type: "service_account_workspace_member"` default: service_account_workspace_member - `created_by_actor_id: string or null` Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - `implicit: boolean or null` True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - `service_account_id: string` Tagged service account ID (`svac_...`). - `workspace_id: string` Tagged workspace ID (`wrkspc_...`). - `workspace_role: BetaWorkspaceRole` Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - `"workspace_admin"` - `"workspace_billing"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "created_by_actor_id": "created_by_actor_id", "implicit": true, "service_account_id": "service_account_id", "type": "service_account_workspace_member", "workspace_id": "workspace_id", "workspace_role": "workspace_admin" } ``` ### Update Service Account Workspace Member **POST** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Change a service account's role in a workspace. The new `workspace_role` replaces the current one. Only explicit memberships can be updated; to set a role on the implicit default-workspace membership, add the service account explicitly with `POST /workspaces/{workspace_id}/service_accounts`. Archived workspaces return 400. Archived service accounts cannot be updated and are rejected. #### Path parameters - `workspace_id: string` ID of the workspace. - `service_account_id: string` ID of the service account. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `workspace_role: BetaNoBillingWorkspaceRole` New role for the service account in this workspace. - `"workspace_admin"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` #### Returns - `BetaServiceAccountWorkspaceMember object` - `type: "service_account_workspace_member"` default: service_account_workspace_member - `created_by_actor_id: string or null` Tagged ID (`user_...`/`svac_...`) of the actor who created this membership. - `implicit: boolean or null` True when this is the implicit default-workspace membership every service account has when no explicit membership exists. Implicit memberships have role `workspace_user` and cannot be removed. - `service_account_id: string` Tagged service account ID (`svac_...`). - `workspace_id: string` Tagged workspace ID (`wrkspc_...`). - `workspace_role: BetaWorkspaceRole` Role of the service account in this workspace. Service accounts cannot hold the `workspace_billing` role. - `"workspace_admin"` - `"workspace_billing"` - `"workspace_developer"` - `"workspace_restricted_developer"` - `"workspace_user"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "workspace_role": "workspace_admin" }' ``` ##### Response (200) ```json { "created_by_actor_id": "created_by_actor_id", "implicit": true, "service_account_id": "service_account_id", "type": "service_account_workspace_member", "workspace_id": "workspace_id", "workspace_role": "workspace_admin" } ``` ### Delete Service Account Workspace Member **DELETE** `/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}` **Requires an OAuth access token with the `org:admin` scope**, from `ant auth login --scope org:admin` or a workload identity federation rule; Admin API keys are not accepted. See [Manage WIF with the Admin API](https://platform.claude.com/docs/en/manage-claude/wif-admin-api?sdk_languages=http). Remove a service account from a workspace. Removal is idempotent (returns 200 even if the membership was already removed). A DELETE against the implicit default-workspace membership returns 200 but is a no-op and the membership persists; deleting an explicit default-workspace row reverts to the implicit `workspace_user` membership. Archived workspaces return 400. #### Path parameters - `workspace_id: string` ID of the workspace. - `service_account_id: string` ID of the service account. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `type: "service_account_workspace_member_deleted"` default: service_account_workspace_member_deleted - `service_account_id: string` Tagged service account ID (`svac_...`) named in the delete request. Removal is idempotent; see the endpoint description for the implicit-membership no-op. - `workspace_id: string` Tagged workspace ID (`wrkspc_...`) named in the delete request. #### Example ```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/service_accounts/$SERVICE_ACCOUNT_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "service_account_id": "service_account_id", "type": "service_account_workspace_member_deleted", "workspace_id": "workspace_id" } ``` ## Beta › Organization › Rate Limits ### List Organization Rate Limits **GET** `/v1/organizations/rate_limits` List Messages API rate limits for your organization. Each entry corresponds to one rate-limit group (either a model family or an API-surface category such as the Message Batches API or the web search tool) and contains the set of limiter values that apply to it. When `limit` is omitted, every matching entry is returned in a single page; when `limit` truncates the result, follow `next_page` to fetch the remaining entries. #### Query parameters - `group_type: optional "batch" or "files" or "model_group" or 3 more` Filter by group type. - `"batch"` - `"files"` - `"model_group"` - `"skills"` - `"token_count"` - `"web_search"` - `limit: optional number` Maximum number of items to return per page. Ranges from `1` to `1000`. When omitted, every remaining entry is returned in a single page and `next_page` is `null`. minimum: 1, maximum: 1000 - `model: optional string` Filter to the single entry containing this model. Accepts full model names and aliases. Returns 404 if the model is not found or has no rate limits for this organization. - `page: optional string` Opaque cursor from a previous response's `next_page`. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaOrganizationRateLimit` Rate-limit entries for the organization, one per group. - `type: "rate_limit"` Object type. Always `rate_limit` for organization rate-limit entries. default: rate_limit - `id: string` Identifier of this rate-limit entry. It is stable within the organization and differs between organizations; the group's own identifier is `group.id`. - `group: BetaOrganizationRateLimitModelGroup or BetaOrganizationRateLimitBatchGroup or BetaOrganizationRateLimitTokenCountGroup or 3 more` The rate-limit group this entry's limits apply to. Its `type` equals `group_type`. - `BetaOrganizationRateLimitModelGroup object` - `type: "model_group"` Always `model_group`: a family of models. default: model_group - `id: string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `display_name: string` Human-readable name of the model group (for example, `Claude Sonnet 4.x`). For display only; it may change. - `BetaOrganizationRateLimitBatchGroup object` - `type: "batch"` Always `batch`: the Message Batches API. default: batch - `id: string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `BetaOrganizationRateLimitTokenCountGroup object` - `type: "token_count"` Always `token_count`: the Token Count API. default: token_count - `id: string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `BetaOrganizationRateLimitFilesGroup object` - `type: "files"` Always `files`: the Files API. default: files - `id: string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `BetaOrganizationRateLimitSkillsGroup object` - `type: "skills"` Always `skills`: the Skills API. default: skills - `id: string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `BetaOrganizationRateLimitWebSearchGroup object` - `type: "web_search"` Always `web_search`: the Messages API web search tool. default: web_search - `id: string` Opaque identifier of the rate-limit group (for example, `rlg_01VPTCmyiu5ZLsWkcxYG2pY8`). It is the same in every organization and never changes, unlike the entry's own identifier, which differs per organization. - `limits: array of BetaOrganizationRateLimitValue` The limiter values that apply to this group. - `type: string` The limiter type (for example, `requests_per_minute` or `input_tokens_per_minute`). - `value: number` The configured limit value for this limiter type. - `models: array of string or null` Model names this entry's limits apply to, including aliases. `null` when `group_type` is not `"model_group"`. - `group_type: "batch" or "files" or "model_group" or 3 more` **Deprecated**: Use `group.type` instead. `group_type` is still returned and always equals `group.type`. Deprecated: use `group.type` instead. The kind of rate-limit group this entry represents. `model_group` entries apply to a family of models (listed in `models`); other values apply to an API-surface category and have `models` set to `null`. Always equal to `group.type`. - `"batch"` - `"files"` - `"model_group"` - `"skills"` - `"token_count"` - `"web_search"` - `next_page: string or null` Opaque cursor for the next page of results, or `null` when no entries remain beyond this response. #### Example ```bash curl https://api.anthropic.com/v1/organizations/rate_limits \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "id", "group": { "id": "id", "display_name": "display_name", "type": "model_group" }, "group_type": "batch", "limits": [ { "type": "type", "value": 0 } ], "models": [ "string" ], "type": "rate_limit" } ], "next_page": "next_page" } ``` ## Beta › Organization › Compliance Settings ### Get Compliance Settings **GET** `/v1/organizations/compliance_settings` Retrieve your organization's Compliance Settings. Compliance Settings is a singleton resource: there is exactly one per organization, addressed without an identifier. The `state` field reflects whether the Compliance API is enabled. An organization with a parent organization reads the state inherited from the parent's configuration. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `BetaComplianceSettings object` - `type: "compliance_settings"` default: compliance_settings - `state: BetaComplianceSettingsState` Whether the Compliance API is enabled for this organization. - `BetaComplianceSettingsStateEnabled object` - `type: "enabled"` default: enabled - `BetaComplianceSettingsStateDisabled object` - `type: "disabled"` default: disabled #### Example ```bash curl https://api.anthropic.com/v1/organizations/compliance_settings \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "state": { "type": "enabled" }, "type": "compliance_settings" } ``` ### Update Compliance Settings **POST** `/v1/organizations/compliance_settings` Update your organization's Compliance Settings. Setting `state` to `enabled` turns on the Compliance API and begins capturing organization activity events. Setting it to `disabled` turns both off. `state` reflects whether the Compliance API is enabled. A request that sets `state` to its current value succeeds and leaves the resource unchanged. A `disabled` request stays in effect until a later `enabled` request or the organization's next provisioning action that enables Access Transparency: enabling Access Transparency also enables the Compliance API, which serves its activity events, so such provisioning (including re-runs) re-enables the Compliance API even after a `disabled` request. Automated provisioning never disables compliance settings. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Body parameters - `state: BetaComplianceSettingsStateParam` Desired state. Accepts the string shorthand "enabled" or "disabled" in place of the object form; the response always returns the canonical object form. - `BetaComplianceSettingsStateEnabledParam object` - `type: "enabled"` - `BetaComplianceSettingsStateDisabledParam object` - `type: "disabled"` #### Returns - `BetaComplianceSettings object` - `type: "compliance_settings"` default: compliance_settings - `state: BetaComplianceSettingsState` Whether the Compliance API is enabled for this organization. - `BetaComplianceSettingsStateEnabled object` - `type: "enabled"` default: enabled - `BetaComplianceSettingsStateDisabled object` - `type: "disabled"` default: disabled #### Example ```bash curl https://api.anthropic.com/v1/organizations/compliance_settings \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "state": { "type": "enabled" } }' ``` ##### Response (200) ```json { "state": { "type": "enabled" }, "type": "compliance_settings" } ``` ## Beta › Organization › Usage Report ### Get Messages Usage Report **GET** `/v1/organizations/usage_report/messages` Get Messages Usage Report #### Query parameters - `starting_at: string` Time buckets that start on or after this RFC 3339 timestamp will be returned. Each time bucket will be snapped to the start of the minute/hour/day in UTC. format: date-time - `account_ids: optional array of string` Restrict usage returned to the specified user account ID(s). - `api_key_ids: optional array of string` Restrict usage returned to the specified API key ID(s). - `bucket_width: optional "1d" or "1h" or "1m"` Time granularity of the response data. default: 1d - `"1d"` - `"1h"` - `"1m"` - `context_window: optional array of BetaAnalyticsContextWindow` Restrict usage returned to the specified context window(s). - `"0-200k"` - `"200k-1M"` - `ending_at: optional string` Time buckets that end before this RFC 3339 timestamp will be returned. format: date-time - `group_by: optional array of "account_id" or "api_key_id" or "context_window" or 6 more` Group by any subset of the available options. - `"account_id"` - `"api_key_id"` - `"context_window"` - `"inference_geo"` - `"model"` - `"service_account_id"` - `"service_tier"` - `"speed"` - `"workspace_id"` - `inference_geos: optional array of BetaAnalyticsInferenceGeoFilter` Restrict usage returned to the specified inference geo(s). Use `not_available` for models that do not support specifying `inference_geo`. - `"global"` - `"not_available"` - `"us"` - `limit: optional number` Maximum number of time buckets to return in the response. The default and max limits depend on `bucket_width`: • `"1d"`: Default of 7 days, maximum of 31 days • `"1h"`: Default of 24 hours, maximum of 168 hours • `"1m"`: Default of 60 minutes, maximum of 1440 minutes - `models: optional array of string` Restrict usage returned to the specified model(s). - `page: optional string` Optionally set to the `next_page` token from the previous response. - `service_account_ids: optional array of string` Restrict usage returned to the specified service account ID(s). - `service_tiers: optional array of "batch" or "flex" or "flex_discount" or 3 more` Restrict usage returned to the specified service tier(s). - `"batch"` - `"flex"` - `"flex_discount"` - `"priority"` - `"priority_on_demand"` - `"standard"` - `speeds: optional array of "standard" or "fast"` Restrict usage returned to the specified speed(s). - `"standard"` - `"fast"` - `workspace_ids: optional array of string` Restrict usage returned to the specified workspace ID(s). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaMessagesUsageReport object` - `data: array of object` List of time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no usage (their `results` list is empty). A page holds at most `limit` buckets. - `ending_at: string` End of the time bucket (exclusive) in RFC 3339 format. format: date-time - `results: array of object` List of usage items for this time bucket. There may be multiple items if one or more `group_by[]` parameters are specified. - `account_id: string or null` ID of the user account that made the request. `null` if not grouping by account or for non-OAuth requests. - `api_key_id: string or null` ID of the API key used. `null` if not grouping by API key or for usage in the Anthropic Console. - `cache_creation: BetaCacheCreation` The number of input tokens for cache creation. - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `context_window: BetaAnalyticsContextWindow or null` Context window used. `null` if not grouping by context window. - `"0-200k"` - `"200k-1M"` - `inference_geo: BetaAnalyticsInferenceGeoFilter or null` Inference geo used matching requests' `inference_geo` parameter if set, otherwise the workspace's `default_inference_geo`. For models that do not support specifying `inference_geo` the value is `"not_available"`. Always `null` if not grouping by inference geo. - `"global"` - `"not_available"` - `"us"` - `model: string or null` Model used. `null` if not grouping by model. - `output_tokens: number` The number of output tokens generated. - `server_tool_use: BetaAnalyticsServerToolUse` Server-side tool usage metrics. - `web_search_requests: number` The number of web search requests made. - `service_account_id: string or null` ID of the service account that made the request. `null` if not grouping by service account or for non-OIDC-federation requests. - `service_tier: "batch" or "flex" or "flex_discount" or 3 more or null` Service tier used. `null` if not grouping by service tier. - `"batch"` - `"flex"` - `"flex_discount"` - `"priority"` - `"priority_on_demand"` - `"standard"` - `speed: "standard" or "fast" or null` Speed of the usage. `null` if not grouping by speed. - `"standard"` - `"fast"` - `uncached_input_tokens: number` The number of uncached input tokens processed. - `workspace_id: string or null` ID of the Workspace used. `null` if not grouping by workspace or for the default workspace. - `starting_at: string` Start of the time bucket (inclusive) in RFC 3339 format. format: date-time - `has_more: boolean` Indicates if there are more results. - `next_page: string or null` Opaque cursor for the next page, or `null` when `has_more` is false. Pass it as the `page` parameter in the next request. #### Example ```bash curl https://api.anthropic.com/v1/organizations/usage_report/messages \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "ending_at": "2025-08-02T00:00:00Z", "results": [ { "account_id": "user_01WCz1FkmYMm4gnmykNKUu3Q", "api_key_id": "apikey_01Rj2N8SVvo6BePZj99NhmiT", "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 200, "context_window": "0-200k", "inference_geo": "global", "model": "claude-opus-5-5", "output_tokens": 500, "server_tool_use": { "web_search_requests": 10 }, "service_account_id": "svac_01Hk3R9TWxq7CfQak00OiVw4", "service_tier": "standard", "speed": "standard", "uncached_input_tokens": 1500, "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ], "starting_at": "2025-08-01T00:00:00Z" } ], "has_more": true, "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ### Get Claude Code Usage Report **GET** `/v1/organizations/usage_report/claude_code` Retrieve daily aggregated usage metrics for Claude Code users. Enables organizations to analyze developer productivity and build custom dashboards. #### Query parameters - `starting_at: string` UTC date in YYYY-MM-DD format. Returns metrics for this single day only. format: date, pattern: ^\d{4}-\d{2}-\d{2}$ - `limit: optional number` Number of records per page (default: 20, max: 1000). default: 20, minimum: 1, maximum: 1000 - `page: optional string` Opaque cursor token from previous response's `next_page` field. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `BetaClaudeCodeUsageReport object` - `data: array of object` List of Claude Code usage records for the requested date. - `actor: UserActor or APIActor` The user or API key that performed the Claude Code actions. - `UserActor object` - `type: "user_actor"` Actor type. Always `"user_actor"` for a user. - `email_address: string` Email address of the user who performed Claude Code actions. - `APIActor object` - `type: "api_actor"` Actor type. Always `"api_actor"` for an API key. - `api_key_name: string` Name of the API key used to perform Claude Code actions. - `core_metrics: object` Core productivity metrics measuring Claude Code usage and impact. - `commits_by_claude_code: number` Number of git commits created through Claude Code's commit functionality. - `lines_of_code: object` Statistics on code changes made through Claude Code. - `added: number` Total number of lines of code added across all files by Claude Code. - `removed: number` Total number of lines of code removed across all files by Claude Code. - `num_sessions: number` Number of distinct Claude Code sessions initiated by this actor. - `pull_requests_by_claude_code: number` Number of pull requests created through Claude Code's PR functionality. - `customer_type: "api" or "subscription"` Type of customer account (api for API customers, subscription for Pro/Team customers). - `"api"` - `"subscription"` - `date: string` UTC day the usage metrics cover, as an RFC 3339 timestamp at midnight UTC (for example `2025-08-08T00:00:00Z`). format: date-time - `is_remote: boolean` Whether the usage came from remote Claude Code sessions, such as Claude Code on the web. Remote and local usage are reported as separate rows. - `model_breakdown: array of object` Token usage and cost breakdown by AI model used. - `estimated_cost: object` Estimated cost for using this model - `amount: number` Estimated cost amount in minor currency units (e.g., cents for USD). - `currency: string` Currency code for the estimated cost (e.g., 'USD'). - `model: string` Name of the AI model used for Claude Code interactions. - `tokens: object` Token usage breakdown for this model - `cache_creation: number` Number of cache creation tokens consumed by this model. - `cache_read: number` Number of cache read tokens consumed by this model. - `input: number` Number of input tokens consumed by this model. - `output: number` Number of output tokens generated by this model. - `organization_id: string` ID of the organization that owns the Claude Code usage. - `terminal_type: string` Type of terminal or environment where Claude Code was used. - `tool_actions: map[object]` Breakdown of tool action acceptance and rejection rates by tool type. - `accepted: number` Number of tool action proposals that the user accepted. - `rejected: number` Number of tool action proposals that the user rejected. - `subscription_type: optional "enterprise" or "team" or null` Subscription tier for subscription customers. `null` for API customers. - `"enterprise"` - `"team"` - `has_more: boolean` True if there are more records available beyond the current page. - `next_page: string or null` Opaque cursor token for fetching the next page of results, or null if no more pages are available. #### Example ```bash curl https://api.anthropic.com/v1/organizations/usage_report/claude_code \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "actor": { "email_address": "user@emaildomain.com", "type": "user_actor" }, "core_metrics": { "commits_by_claude_code": 8, "lines_of_code": { "added": 342, "removed": 128 }, "num_sessions": 15, "pull_requests_by_claude_code": 2 }, "customer_type": "api", "date": "2025-08-08T00:00:00Z", "is_remote": false, "model_breakdown": [ { "estimated_cost": { "amount": 186, "currency": "USD" }, "model": "claude-opus-5-5", "tokens": { "cache_creation": 2340, "cache_read": 8790, "input": 45230, "output": 12450 } }, { "estimated_cost": { "amount": 42, "currency": "USD" }, "model": "claude-sonnet-5-5", "tokens": { "cache_creation": 890, "cache_read": 3420, "input": 23100, "output": 5680 } } ], "organization_id": "12345678-1234-5678-1234-567812345678", "terminal_type": "iTerm.app", "tool_actions": { "edit_tool": { "accepted": 25, "rejected": 3 }, "multi_edit_tool": { "accepted": 12, "rejected": 1 }, "notebook_edit_tool": { "accepted": 5, "rejected": 2 }, "write_tool": { "accepted": 8, "rejected": 0 } }, "subscription_type": "enterprise" } ], "has_more": true, "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Beta › Organization › Cost Report ### Get Cost Report **GET** `/v1/organizations/cost_report` Get Cost Report #### Query parameters - `starting_at: string` Time buckets that start on or after this RFC 3339 timestamp will be returned. Each time bucket will be snapped to the start of the minute/hour/day in UTC. format: date-time - `bucket_width: optional "1d"` Time granularity of the response data. default: 1d - `ending_at: optional string` Time buckets that end before this RFC 3339 timestamp will be returned. format: date-time - `group_by: optional array of "description" or "workspace_id"` Group by any subset of the available options. - `"description"` - `"workspace_id"` - `limit: optional number` Maximum number of time buckets to return in the response. default: 7, minimum: 1, maximum: 31 - `page: optional string` Optionally set to the `next_page` token from the previous response. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaCostReport object` - `data: array of object` List of time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no costs (their `results` list is empty). A page holds at most `limit` buckets. - `ending_at: string` End of the time bucket (exclusive) in RFC 3339 format. format: date-time - `results: array of object` List of cost items for this time bucket. There may be multiple items if one or more `group_by[]` parameters are specified. - `amount: string` Cost amount in lowest currency units (e.g. cents) as a decimal string. For example, `"123.45"` in `"USD"` represents `$1.23`. - `context_window: BetaAnalyticsContextWindow or null` Input context window used. `null` if not grouping by description or for non-token costs. - `"0-200k"` - `"200k-1M"` - `cost_type: "code_execution" or "session_usage" or "tokens" or "web_search" or null` Type of cost. `null` if not grouping by description. - `"code_execution"` - `"session_usage"` - `"tokens"` - `"web_search"` - `currency: string` Currency code for the cost amount. Currently always `"USD"`. - `description: string or null` Description of the cost item. `null` if not grouping by description. - `inference_geo: BetaAnalyticsInferenceGeoFilter or null` Inference geo used matching requests' `inference_geo` parameter if set, otherwise the workspace's `default_inference_geo`. For models that do not support specifying `inference_geo` the value is `"not_available"`. Always `null` if not grouping by inference geo. - `"global"` - `"not_available"` - `"us"` - `model: string or null` Model name used. `null` if not grouping by description or for non-token costs. - `service_tier: "batch" or "standard" or null` Service tier used. `null` if not grouping by description or for non-token costs. - `"batch"` - `"standard"` - `speed: "standard" or "fast" or null` Speed used. `null` if not grouping by description, or for non-token costs. - `"standard"` - `"fast"` - `token_type: BetaAnalyticsTokenType or null` Type of token. `null` if not grouping by description or for non-token costs. - `"cache_creation.ephemeral_1h_input_tokens"` - `"cache_creation.ephemeral_5m_input_tokens"` - `"cache_read_input_tokens"` - `"output_tokens"` - `"uncached_input_tokens"` - `workspace_id: string or null` ID of the Workspace this cost is associated with. `null` if not grouping by workspace or for the default workspace. - `starting_at: string` Start of the time bucket (inclusive) in RFC 3339 format. format: date-time - `has_more: boolean` Indicates if there are more results. - `next_page: string or null` Opaque cursor for the next page, or `null` when `has_more` is false. Pass it as the `page` parameter in the next request. #### Example ```bash curl https://api.anthropic.com/v1/organizations/cost_report \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "ending_at": "2025-08-02T00:00:00Z", "results": [ { "amount": "123.78912", "context_window": "0-200k", "cost_type": "tokens", "currency": "USD", "description": "Claude Opus 5.5 Usage - Input Tokens", "inference_geo": "global", "model": "claude-opus-5-5", "service_tier": "standard", "speed": "standard", "token_type": "cache_creation.ephemeral_1h_input_tokens", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ], "starting_at": "2025-08-01T00:00:00Z" } ], "has_more": true, "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Beta › Organization › MCP Tunnels ### List Tunnels **GET** `/v1/organizations/tunnels` **Deprecated** **Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](https://platform.claude.com/docs/en/api/beta/tunnels?sdk_languages=http) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window. List the organization's tunnels. Results span the caller's organization, ordered by creation time (newest first). Use `workspace_id` to filter to a single workspace; archived tunnels are excluded unless `include_archived` is set. #### Query parameters - `include_archived: optional boolean` Include archived tunnels in the results. Archived tunnels are excluded by default. default: false - `limit: optional number` Maximum number of tunnels to return in a single page. default: 20, minimum: 1, maximum: 1000 - `page: optional string` Opaque pagination cursor from a previous response's `next_page`. Omit to fetch the first page. - `workspace_id: optional string` Return only tunnels in this Workspace. Accepts a `wrkspc_`-prefixed Workspace ID; omit to list tunnels across all Workspaces. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaOrganizationTunnel` - `type: "tunnel"` Object type. Always `tunnel` for Tunnels. default: tunnel - `id: string` ID of the Tunnel. - `archived_at: string or null` RFC 3339 datetime string indicating when the Tunnel was archived, or `null` if it is not archived. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the Tunnel was created. format: date-time - `display_name: string or null` Human-readable name for the Tunnel (1–255 characters), or `null` if unset. - `domain: string` Anthropic-assigned hostname for the Tunnel. MCP server URLs whose host is a subdomain of this value are routed through the Tunnel. Globally unique and never reused, even after the Tunnel is archived. - `workspace_id: string or null` ID of the Workspace this Tunnel belongs to. May be `null` for a Tunnel in the default Workspace. A Tunnel never moves to another Workspace. - `next_page: string or null` Opaque cursor for the next page, or `null` if there are no more results. #### Example ```bash curl https://api.anthropic.com/v1/organizations/tunnels \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-05-19' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8", "archived_at": "2024-11-01T23:59:27.427722Z", "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "Production", "domain": "a1b2c3d4.tunnel.anthropic.com", "type": "tunnel", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ### Get Tunnel **GET** `/v1/organizations/tunnels/{tunnel_id}` **Deprecated** **Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](https://platform.claude.com/docs/en/api/beta/tunnels?sdk_languages=http) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window. Retrieve a single tunnel in the caller's organization by ID. #### Path parameters - `tunnel_id: string` ID of the Tunnel. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaOrganizationTunnel object` - `type: "tunnel"` Object type. Always `tunnel` for Tunnels. default: tunnel - `id: string` ID of the Tunnel. - `archived_at: string or null` RFC 3339 datetime string indicating when the Tunnel was archived, or `null` if it is not archived. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the Tunnel was created. format: date-time - `display_name: string or null` Human-readable name for the Tunnel (1–255 characters), or `null` if unset. - `domain: string` Anthropic-assigned hostname for the Tunnel. MCP server URLs whose host is a subdomain of this value are routed through the Tunnel. Globally unique and never reused, even after the Tunnel is archived. - `workspace_id: string or null` ID of the Workspace this Tunnel belongs to. May be `null` for a Tunnel in the default Workspace. A Tunnel never moves to another Workspace. #### Example ```bash curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-05-19' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8", "archived_at": "2024-11-01T23:59:27.427722Z", "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "Production", "domain": "a1b2c3d4.tunnel.anthropic.com", "type": "tunnel", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ``` ### Archive Tunnel **POST** `/v1/organizations/tunnels/{tunnel_id}/archive` **Deprecated** **Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](https://platform.claude.com/docs/en/api/beta/tunnels?sdk_languages=http) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window. Archive a tunnel. Archival is irreversible. Every non-archived certificate on the tunnel is archived in the same operation, the hostname is retired and never re-allocated, and the tunnel token is invalidated. Retrying against an already-archived tunnel returns the existing record unchanged. #### Path parameters - `tunnel_id: string` ID of the Tunnel. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaOrganizationTunnel object` - `type: "tunnel"` Object type. Always `tunnel` for Tunnels. default: tunnel - `id: string` ID of the Tunnel. - `archived_at: string or null` RFC 3339 datetime string indicating when the Tunnel was archived, or `null` if it is not archived. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the Tunnel was created. format: date-time - `display_name: string or null` Human-readable name for the Tunnel (1–255 characters), or `null` if unset. - `domain: string` Anthropic-assigned hostname for the Tunnel. MCP server URLs whose host is a subdomain of this value are routed through the Tunnel. Globally unique and never reused, even after the Tunnel is archived. - `workspace_id: string or null` ID of the Workspace this Tunnel belongs to. May be `null` for a Tunnel in the default Workspace. A Tunnel never moves to another Workspace. #### Example ```bash curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-05-19' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8", "archived_at": "2024-11-01T23:59:27.427722Z", "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "Production", "domain": "a1b2c3d4.tunnel.anthropic.com", "type": "tunnel", "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ" } ``` ### Reveal Tunnel Token **POST** `/v1/organizations/tunnels/{tunnel_id}/reveal_token` **Deprecated** **Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](https://platform.claude.com/docs/en/api/beta/tunnels?sdk_languages=http) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window. Return the tunnel's current connection token. The value is fetched live on each call; Anthropic does not store it. Repeated calls return the same value until the token is rotated. Exposed as `POST` so the token does not appear in intermediary access logs. #### Path parameters - `tunnel_id: string` ID of the Tunnel. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaOrganizationTunnelToken object` - `type: "tunnel_token"` Object type. Always `tunnel_token` for Tunnel Tokens. default: tunnel_token - `id: string` Stable identifier for the current token value. Changes when the token is rotated. - `tunnel_token: string` The tunnel's connection token. #### Example ```bash curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/reveal_token \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-05-19' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0", "tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==", "type": "tunnel_token" } ``` ### Rotate Tunnel Token **POST** `/v1/organizations/tunnels/{tunnel_id}/rotate_token` **Deprecated** **Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](https://platform.claude.com/docs/en/api/beta/tunnels?sdk_languages=http) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window. Invalidate the tunnel's current token for new connections and return a fresh value. Established connections are not severed by rotation; a connector restarted after rotation must use the new value. An optional `reason` is captured for operational context. #### Path parameters - `tunnel_id: string` ID of the Tunnel. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `reason: optional string or null` Optional free-text reason for the rotation, recorded for audit. maxLength: 1024 #### Returns - `BetaOrganizationTunnelToken object` - `type: "tunnel_token"` Object type. Always `tunnel_token` for Tunnel Tokens. default: tunnel_token - `id: string` Stable identifier for the current token value. Changes when the token is rotated. - `tunnel_token: string` The tunnel's connection token. #### Example ```bash curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/rotate_token \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-05-19' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "ttkn_bb97000eaec162831399ca9b6684a4fdf5be49ace5683057b017aab5c87e19e0", "tunnel_token": "eyJhIjoiRVhBTVBMRSIsInQiOiJFWEFNUExFIiwicyI6IkVYQU1QTEUifQ==", "type": "tunnel_token" } ``` ## Beta › Organization › MCP Tunnels › Tunnel Certificates ### Create Tunnel Certificate **POST** `/v1/organizations/tunnels/{tunnel_id}/certificates` **Deprecated** **Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](https://platform.claude.com/docs/en/api/beta/tunnels?sdk_languages=http) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window. Register a public CA certificate for the tunnel. Anthropic verifies the gateway's server certificate against this CA when it terminates the inner TLS session. The PEM body must contain exactly one X.509 certificate and no private-key material. A tunnel holds at most two non-archived certificates. #### Path parameters - `tunnel_id: string` ID of the Tunnel. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `ca_certificate_pem: string` PEM-encoded X.509 CA certificate. Must contain exactly one certificate and no private-key material. maxLength: 8192 #### Returns - `BetaOrganizationTunnelCertificate object` - `type: "tunnel_certificate"` Object type. Always `tunnel_certificate` for Tunnel Certificates. default: tunnel_certificate - `id: string` ID of the Tunnel Certificate. - `archived_at: string or null` RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the certificate was registered. format: date-time - `expires_at: string or null` RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire. format: date-time - `fingerprint: string` The certificate's SHA-256 fingerprint, as a lowercase hex string. - `tunnel_id: string` ID of the Tunnel this certificate is registered against. #### Example ```bash curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-05-19' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "ca_certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIBexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexampleEXAMPLEexa\n...illustrative placeholder, not a real certificate...\n-----END CERTIFICATE-----\n" }' ``` ##### Response (200) ```json { "id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9", "archived_at": "2024-11-01T23:59:27.427722Z", "created_at": "2024-10-30T23:58:27.427722Z", "expires_at": "2024-10-30T23:58:27.427722Z", "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08", "tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8", "type": "tunnel_certificate" } ``` ### List Tunnel Certificates **GET** `/v1/organizations/tunnels/{tunnel_id}/certificates` **Deprecated** **Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](https://platform.claude.com/docs/en/api/beta/tunnels?sdk_languages=http) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window. List the certificates registered on a tunnel. Archived certificates are excluded unless `include_archived` is set. #### Path parameters - `tunnel_id: string` ID of the Tunnel. #### Query parameters - `include_archived: optional boolean` Include archived certificates in the results. Archived certificates are excluded by default. default: false - `limit: optional number` Maximum number of certificates to return. default: 20, minimum: 1, maximum: 1000 - `page: optional string` A tunnel has at most two active certificates, so this list is not paginated. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaOrganizationTunnelCertificate` - `type: "tunnel_certificate"` Object type. Always `tunnel_certificate` for Tunnel Certificates. default: tunnel_certificate - `id: string` ID of the Tunnel Certificate. - `archived_at: string or null` RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the certificate was registered. format: date-time - `expires_at: string or null` RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire. format: date-time - `fingerprint: string` The certificate's SHA-256 fingerprint, as a lowercase hex string. - `tunnel_id: string` ID of the Tunnel this certificate is registered against. - `next_page: string or null` Opaque cursor for the next page, or `null` if there are no more results. #### Example ```bash curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-05-19' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9", "archived_at": "2024-11-01T23:59:27.427722Z", "created_at": "2024-10-30T23:58:27.427722Z", "expires_at": "2024-10-30T23:58:27.427722Z", "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08", "tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8", "type": "tunnel_certificate" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ### Get Tunnel Certificate **GET** `/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}` **Deprecated** **Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](https://platform.claude.com/docs/en/api/beta/tunnels?sdk_languages=http) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window. Retrieve a single certificate registered on a tunnel by ID. #### Path parameters - `tunnel_id: string` ID of the Tunnel. - `certificate_id: string` ID of the Tunnel Certificate. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaOrganizationTunnelCertificate object` - `type: "tunnel_certificate"` Object type. Always `tunnel_certificate` for Tunnel Certificates. default: tunnel_certificate - `id: string` ID of the Tunnel Certificate. - `archived_at: string or null` RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the certificate was registered. format: date-time - `expires_at: string or null` RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire. format: date-time - `fingerprint: string` The certificate's SHA-256 fingerprint, as a lowercase hex string. - `tunnel_id: string` ID of the Tunnel this certificate is registered against. #### Example ```bash curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-05-19' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9", "archived_at": "2024-11-01T23:59:27.427722Z", "created_at": "2024-10-30T23:58:27.427722Z", "expires_at": "2024-10-30T23:58:27.427722Z", "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08", "tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8", "type": "tunnel_certificate" } ``` ### Archive Tunnel Certificate **POST** `/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive` **Deprecated** **Deprecated.** This Admin API endpoint is superseded by `/v1/tunnels` on the Claude API and will be removed after a migration window. New integrations should use [`/v1/tunnels`](https://platform.claude.com/docs/en/api/beta/tunnels?sdk_languages=http) with the `anthropic-beta: mcp-tunnels-2026-06-22` header and a WIF token carrying the `workspace:manage_tunnels` scope. Existing integrations continue to work with the `mcp-tunnels-2026-05-19` header and `org:manage_tunnels` scope during the migration window. Archive a certificate, removing it from the set Anthropic trusts for this tunnel. The certificate record is retained. Archiving the last non-archived certificate is permitted; the tunnel rejects MCP traffic until a new certificate is added. #### Path parameters - `tunnel_id: string` ID of the Tunnel. - `certificate_id: string` ID of the Tunnel Certificate. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": array of AnthropicBeta` This endpoint is in beta: requests must send `mcp-tunnels-2026-05-19` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaOrganizationTunnelCertificate object` - `type: "tunnel_certificate"` Object type. Always `tunnel_certificate` for Tunnel Certificates. default: tunnel_certificate - `id: string` ID of the Tunnel Certificate. - `archived_at: string or null` RFC 3339 datetime string indicating when the certificate was archived, or `null` if it is not archived. format: date-time - `created_at: string` RFC 3339 datetime string indicating when the certificate was registered. format: date-time - `expires_at: string or null` RFC 3339 datetime string indicating when the certificate expires, or `null` if it does not expire. format: date-time - `fingerprint: string` The certificate's SHA-256 fingerprint, as a lowercase hex string. - `tunnel_id: string` ID of the Tunnel this certificate is registered against. #### Example ```bash curl https://api.anthropic.com/v1/organizations/tunnels/$TUNNEL_ID/certificates/$CERTIFICATE_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: mcp-tunnels-2026-05-19' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "tcrt_01JmWq4ZxnBvR7tKpY2sLdH9", "archived_at": "2024-11-01T23:59:27.427722Z", "created_at": "2024-10-30T23:58:27.427722Z", "expires_at": "2024-10-30T23:58:27.427722Z", "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08", "tunnel_id": "tnl_01Hx9Kp2RtQvMn3sWbYdLcF8", "type": "tunnel_certificate" } ``` ## Beta › Organization › Analytics › Summaries ### Get Activity Summaries **GET** `/v1/organizations/analytics/summaries` Get organization-wide activity summaries for a date range. Returns one entry per day from `starting_date` (inclusive) to `ending_date` (exclusive) in `data`, the same `data` / `next_page` envelope as the other analytics list endpoints; the series is currently returned in full, so `next_page` is always null. Data is typically available with a 1-day lag and may be revised by a few percent over the following days: when `ending_date` is omitted it defaults to the most recent available day + 1, so the last entry covers the most recent available day. The series can be scoped to an RBAC group via `filter[]=rbac_group_id:{id}`. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope. #### Query parameters - `starting_date: string` UTC date in YYYY-MM-DD format. Start of the date range (inclusive). Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01. format: date - `ending_date: optional string` UTC date in YYYY-MM-DD format. End of the date range (exclusive). Data is typically available with a 1-day lag, so this can be at most today — which is also the default when omitted, making the last entry cover the most recent available day. Data may be revised by a few percent over the following days. The range may span at most 366 days. format: date - `filter: optional array of string` Filters as `dimension:value`. Only `rbac_group_id` is supported (e.g. `filter[]=rbac_group_id:{id}`); repeat the param to OR across groups. Scopes the whole day series to members of the matching group(s), re-aggregated from member-level activity — org-wide seat/invite fields and the adoption rates derived from them are null on scoped rows. `rbac_group_id` accepts the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each UTC day (time-of-usage attribution). At most 100 entries. maxItems: 100 - `limit: optional number` Number of results per page (1-1000, default 100). The day series (at most 366 entries) is currently returned in full in a single page, so `limit` does not yet shorten it. minimum: 1, maximum: 1000 - `page: optional string` Opaque cursor from a previous response's `next_page` field. `next_page` is currently always null, so there is never a cursor to send. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaAnalyticsSingleDayActivitySummary` One entry per day in the requested range, ascending by date. - `assigned_seat_count: number or null` Number of seats currently assigned to members. Null when the response is scoped to an RBAC group — seat assignment is org-wide and has no per-group analogue. - `cowork_daily_active_user_count: number` Number of users with Cowork activity on the requested day - `cowork_monthly_active_user_count: number` Number of users with Cowork activity in the 30-day rolling window - `cowork_weekly_active_user_count: number` Number of users with Cowork activity in the 7-day rolling window - `daily_active_user_count: number` Number of users with token consumption on the requested day - `daily_adoption_rate: number or null` Percentage of assigned seats with activity on the requested day (`DAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group. - `ending_at: string` End of the aggregation period (exclusive), UTC midnight in RFC 3339 format (e.g. `2026-01-16T00:00:00Z`). format: date-time - `monthly_active_user_count: number` Number of users with token consumption in the 30-day rolling window - `monthly_adoption_rate: number or null` Percentage of assigned seats with activity in the 30-day rolling window (`MAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group. - `pending_invite_count: number or null` Number of pending invitations to join the organization. Null when the response is scoped to an RBAC group. - `starting_at: string` Start of the aggregation period (inclusive), UTC midnight in RFC 3339 format (e.g. `2026-01-15T00:00:00Z`). format: date-time - `weekly_active_user_count: number` Number of users with token consumption in the 7-day rolling window - `weekly_adoption_rate: number or null` Percentage of assigned seats with activity in the 7-day rolling window (`WAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group. - `chat_cowork_unified_daily_active_user_count: optional number or null` Number of users with activity in Chat and Cowork unified on the requested day. Omitted from the response on deployments that do not offer Chat and Cowork unified. - `chat_cowork_unified_monthly_active_user_count: optional number or null` Number of users with activity in Chat and Cowork unified in the 28-day rolling window (30 days when the request filters by `rbac_group_id`). Omitted from the response on deployments that do not offer Chat and Cowork unified. - `chat_cowork_unified_weekly_active_user_count: optional number or null` Number of users with activity in Chat and Cowork unified in the 7-day rolling window. Omitted from the response on deployments that do not offer Chat and Cowork unified. - `chat_daily_active_user_count: optional number or null` Number of users with claude.ai (chat) activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization. - `chat_monthly_active_user_count: optional number or null` Number of users with claude.ai (chat) activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `chat_weekly_active_user_count: optional number or null` Number of users with claude.ai (chat) activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `claude_code_daily_active_user_count: optional number or null` Number of users with Claude Code activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization. - `claude_code_monthly_active_user_count: optional number or null` Number of users with Claude Code activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `claude_code_weekly_active_user_count: optional number or null` Number of users with Claude Code activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `claude_design_daily_active_user_count: optional number or null` Number of users with Claude Design activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization. - `claude_design_monthly_active_user_count: optional number or null` Number of users with Claude Design activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `claude_design_weekly_active_user_count: optional number or null` Number of users with Claude Design activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `office_agent_daily_active_user_count: optional number or null` Number of users with Claude in Office activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization. - `office_agent_monthly_active_user_count: optional number or null` Number of users with Claude in Office activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `office_agent_weekly_active_user_count: optional number or null` Number of users with Claude in Office activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `science_daily_active_user_count: optional number or null` Number of users with Claude Science activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization. - `science_entitled_user_count: optional number or null` Number of users with a Claude Science seat entitlement (per-seat RBAC) at the time of the daily snapshot. The funnel top; independent of the org-level Claude Science toggle. Null when the response is scoped to an RBAC group — entitlement is org-wide and has no per-group analogue. Omitted from the response while the per-product breakdown is not enabled for this organization. - `science_monthly_active_user_count: optional number or null` Number of users with Claude Science activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `science_weekly_active_user_count: optional number or null` Number of users with Claude Science activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `next_page: string or null` Opaque cursor for the next page, or null if no more results. Currently always null: the day series is returned in full. - `summaries: array of BetaAnalyticsSingleDayActivitySummary` **Deprecated** Deprecated: use `data`, which carries the same entries. - `assigned_seat_count: number or null` Number of seats currently assigned to members. Null when the response is scoped to an RBAC group — seat assignment is org-wide and has no per-group analogue. - `cowork_daily_active_user_count: number` Number of users with Cowork activity on the requested day - `cowork_monthly_active_user_count: number` Number of users with Cowork activity in the 30-day rolling window - `cowork_weekly_active_user_count: number` Number of users with Cowork activity in the 7-day rolling window - `daily_active_user_count: number` Number of users with token consumption on the requested day - `daily_adoption_rate: number or null` Percentage of assigned seats with activity on the requested day (`DAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group. - `ending_at: string` End of the aggregation period (exclusive), UTC midnight in RFC 3339 format (e.g. `2026-01-16T00:00:00Z`). format: date-time - `monthly_active_user_count: number` Number of users with token consumption in the 30-day rolling window - `monthly_adoption_rate: number or null` Percentage of assigned seats with activity in the 30-day rolling window (`MAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group. - `pending_invite_count: number or null` Number of pending invitations to join the organization. Null when the response is scoped to an RBAC group. - `starting_at: string` Start of the aggregation period (inclusive), UTC midnight in RFC 3339 format (e.g. `2026-01-15T00:00:00Z`). format: date-time - `weekly_active_user_count: number` Number of users with token consumption in the 7-day rolling window - `weekly_adoption_rate: number or null` Percentage of assigned seats with activity in the 7-day rolling window (`WAU / assigned_seat_count * 100`). Null when the response is scoped to an RBAC group. - `chat_cowork_unified_daily_active_user_count: optional number or null` Number of users with activity in Chat and Cowork unified on the requested day. Omitted from the response on deployments that do not offer Chat and Cowork unified. - `chat_cowork_unified_monthly_active_user_count: optional number or null` Number of users with activity in Chat and Cowork unified in the 28-day rolling window (30 days when the request filters by `rbac_group_id`). Omitted from the response on deployments that do not offer Chat and Cowork unified. - `chat_cowork_unified_weekly_active_user_count: optional number or null` Number of users with activity in Chat and Cowork unified in the 7-day rolling window. Omitted from the response on deployments that do not offer Chat and Cowork unified. - `chat_daily_active_user_count: optional number or null` Number of users with claude.ai (chat) activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization. - `chat_monthly_active_user_count: optional number or null` Number of users with claude.ai (chat) activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `chat_weekly_active_user_count: optional number or null` Number of users with claude.ai (chat) activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `claude_code_daily_active_user_count: optional number or null` Number of users with Claude Code activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization. - `claude_code_monthly_active_user_count: optional number or null` Number of users with Claude Code activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `claude_code_weekly_active_user_count: optional number or null` Number of users with Claude Code activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `claude_design_daily_active_user_count: optional number or null` Number of users with Claude Design activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization. - `claude_design_monthly_active_user_count: optional number or null` Number of users with Claude Design activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `claude_design_weekly_active_user_count: optional number or null` Number of users with Claude Design activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `office_agent_daily_active_user_count: optional number or null` Number of users with Claude in Office activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization. - `office_agent_monthly_active_user_count: optional number or null` Number of users with Claude in Office activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `office_agent_weekly_active_user_count: optional number or null` Number of users with Claude in Office activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `science_daily_active_user_count: optional number or null` Number of users with Claude Science activity on the requested day. Omitted from the response while the per-product breakdown is not enabled for this organization. - `science_entitled_user_count: optional number or null` Number of users with a Claude Science seat entitlement (per-seat RBAC) at the time of the daily snapshot. The funnel top; independent of the org-level Claude Science toggle. Null when the response is scoped to an RBAC group — entitlement is org-wide and has no per-group analogue. Omitted from the response while the per-product breakdown is not enabled for this organization. - `science_monthly_active_user_count: optional number or null` Number of users with Claude Science activity in the 30-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. - `science_weekly_active_user_count: optional number or null` Number of users with Claude Science activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. #### Example ```bash curl https://api.anthropic.com/v1/organizations/analytics/summaries \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "assigned_seat_count": 0, "cowork_daily_active_user_count": 0, "cowork_monthly_active_user_count": 0, "cowork_weekly_active_user_count": 0, "daily_active_user_count": 0, "daily_adoption_rate": 0, "ending_at": "2019-12-27T18:11:19.117Z", "monthly_active_user_count": 0, "monthly_adoption_rate": 0, "pending_invite_count": 0, "starting_at": "2019-12-27T18:11:19.117Z", "weekly_active_user_count": 0, "weekly_adoption_rate": 0, "chat_cowork_unified_daily_active_user_count": 0, "chat_cowork_unified_monthly_active_user_count": 0, "chat_cowork_unified_weekly_active_user_count": 0, "chat_daily_active_user_count": 0, "chat_monthly_active_user_count": 0, "chat_weekly_active_user_count": 0, "claude_code_daily_active_user_count": 0, "claude_code_monthly_active_user_count": 0, "claude_code_weekly_active_user_count": 0, "claude_design_daily_active_user_count": 0, "claude_design_monthly_active_user_count": 0, "claude_design_weekly_active_user_count": 0, "office_agent_daily_active_user_count": 0, "office_agent_monthly_active_user_count": 0, "office_agent_weekly_active_user_count": 0, "science_daily_active_user_count": 0, "science_entitled_user_count": 0, "science_monthly_active_user_count": 0, "science_weekly_active_user_count": 0 } ], "next_page": "next_page", "summaries": [ { "assigned_seat_count": 0, "cowork_daily_active_user_count": 0, "cowork_monthly_active_user_count": 0, "cowork_weekly_active_user_count": 0, "daily_active_user_count": 0, "daily_adoption_rate": 0, "ending_at": "2019-12-27T18:11:19.117Z", "monthly_active_user_count": 0, "monthly_adoption_rate": 0, "pending_invite_count": 0, "starting_at": "2019-12-27T18:11:19.117Z", "weekly_active_user_count": 0, "weekly_adoption_rate": 0, "chat_cowork_unified_daily_active_user_count": 0, "chat_cowork_unified_monthly_active_user_count": 0, "chat_cowork_unified_weekly_active_user_count": 0, "chat_daily_active_user_count": 0, "chat_monthly_active_user_count": 0, "chat_weekly_active_user_count": 0, "claude_code_daily_active_user_count": 0, "claude_code_monthly_active_user_count": 0, "claude_code_weekly_active_user_count": 0, "claude_design_daily_active_user_count": 0, "claude_design_monthly_active_user_count": 0, "claude_design_weekly_active_user_count": 0, "office_agent_daily_active_user_count": 0, "office_agent_monthly_active_user_count": 0, "office_agent_weekly_active_user_count": 0, "science_daily_active_user_count": 0, "science_entitled_user_count": 0, "science_monthly_active_user_count": 0, "science_weekly_active_user_count": 0 } ] } ``` ## Beta › Organization › Analytics › Users ### List User Activity **GET** `/v1/organizations/analytics/users` Get per-user activity for a given day, with cursor-based pagination. Returns activity metrics for each user in the organization, sorted by email address. Use `group_by[]` for per-RBAC-group aggregates, or `filter[]` to scope results to specific members, groups, or a chat project. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope. #### Query parameters - `date: optional string` UTC date in YYYY-MM-DD format. The day to get user activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01. format: date - `ending_date: optional string` UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`. format: date - `filter: optional array of string` Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `project_id`, `rbac_group_id`, `user_id`. Value forms: `project_id` takes a tagged project id (`claude_proj_...`); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries. A `project_id` filter limits each member's row to their claude.ai chat activity in that project and cannot be combined with `group_by[]` or an `rbac_group_id` filter. On these rows, every count in `chat_cowork_unified_metrics.sessions` is 0, because sessions are not measured per project. On any day a member sent a chat message in Chat and Cowork unified, all of that member's project activity for the day is counted in `chat_cowork_unified_metrics.chat` instead of `chat_metrics`. maxItems: 100 - `group_by: optional array of "rbac_group_id"` Dimensions to break results out by (e.g. `group_by[]=rbac_group_id`). Supported on this endpoint: `rbac_group_id`. Rows are already per-member, so the one supported grouping aggregates them per RBAC group instead. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries. maxItems: 100 - `limit: optional number` Number of results per page (1-1000, default 100). minimum: 1, maximum: 1000 - `order: optional "asc" or "desc"` Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted. - `"asc"` - `"desc"` - `order_by: optional string` Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set). - `page: optional string` Opaque cursor from a previous response's `next_page` field. - `starting_date: optional string` UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01. format: date #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaAnalyticsUserActivity` - `chat_metrics: BetaAnalyticsChatMetrics` Claude.ai activity metrics for a single user on a given day. - `connectors_used_count: number` Number of MCP connector invocations. - `distinct_artifacts_created_count: number` Number of distinct artifacts created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it. - `distinct_connectors_used_count: number or null` Distinct claude.ai connectors this user used. Excludes calls whose connector could not be identified and all calls from organizations with zero data retention. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_conversation_count: number or null` Number of distinct conversations the user participated in. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_files_uploaded_count: number or null` Number of distinct files uploaded. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_projects_created_count: number` Number of distinct projects created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it. - `distinct_projects_used_count: number or null` Number of distinct projects used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_shared_artifacts_viewed_count: number or null` Number of distinct shared artifacts the user viewed. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_skills_used_count: number or null` Number of distinct skills used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `message_count: number` Number of messages sent - `shared_conversations_viewed_count: number` Number of times the user opened a shared conversation in a project - `thinking_message_count: number` Number of messages that used extended thinking - `claude_code_metrics: BetaAnalyticsClaudeCodeMetrics` Claude Code activity metrics for a single user on a given day. - `core_metrics: BetaAnalyticsCoreCodeMetrics` Core Claude Code activity metrics for a single user on a given day. - `artifacts_created_count: number` Number of artifacts created in Claude Code sessions: an artifact counts once, on the day a session first saves it. Counted from 2026-08-17; 0 on earlier days. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it. - `commit_count: number` Number of commits made via Claude Code - `distinct_session_count: number or null` Number of distinct Claude Code sessions. On aggregated rows and in date-range mode: summed per-day distinct counts. A session essentially never spans a UTC day, so the sum is in practice the true distinct count. - `lines_of_code: BetaAnalyticsLinesOfCode` Lines of code added and removed via Claude Code. - `added_count: number` Lines of code added - `removed_count: number` Lines of code removed - `pull_request_count: number` Number of pull requests created via Claude Code - `tool_actions: BetaAnalyticsToolActions` Per-tool accepted/rejected counts for Claude Code file modification tools. - `edit_tool: BetaAnalyticsToolActionCounts` Accepted/rejected counts for a single Claude Code tool type. - `accepted_count: number` Number of tool proposals accepted - `rejected_count: number` Number of tool proposals rejected - `multi_edit_tool: BetaAnalyticsToolActionCounts` Accepted/rejected counts for a single Claude Code tool type. - `notebook_edit_tool: BetaAnalyticsToolActionCounts` Accepted/rejected counts for a single Claude Code tool type. - `write_tool: BetaAnalyticsToolActionCounts` Accepted/rejected counts for a single Claude Code tool type. - `cowork_metrics: BetaAnalyticsCoworkMetrics` Cowork activity metrics for a single user on a given day. - `action_count: number` Number of tool actions completed in Cowork sessions - `artifacts_created_count: number` Number of artifacts created in Cowork sessions: an artifact counts once, on the day a session first saves it. Counted from 2026-08-17; 0 on earlier days. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it. - `connectors_used_count: number` Total number of connector invocations in Cowork sessions - `dispatch_turn_count: number` Number of Dispatch (background agent) turns completed - `distinct_connectors_used_count: number or null` Number of distinct connectors used in Cowork sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_session_count: number or null` Number of distinct Cowork sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_skills_used_count: number or null` Number of distinct skills used in Cowork sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `message_count: number` Number of messages sent in Cowork sessions - `skills_used_count: number` Total number of skill invocations in Cowork sessions - `distinct_plugins_used_count: optional number or null` Number of distinct plugins used in Cowork sessions. Null while Cowork plugin-use metrics are not enabled for this organization. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `edit_tool_count: optional number or null` Number of successful Edit tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization. - `file_edit_count: optional number or null` Number of successful file-edit tool calls (Edit, MultiEdit, Write, NotebookEdit) in Cowork sessions. Null, never 0, while the file-edit metrics are not enabled for this organization. - `multi_edit_tool_count: optional number or null` Number of successful MultiEdit tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization. - `notebook_edit_tool_count: optional number or null` Number of successful NotebookEdit tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization. - `plugins_used_count: optional number or null` Total number of plugin invocations in Cowork sessions. Null while Cowork plugin-use metrics are not enabled for this organization. - `sessions_with_file_edits_count: optional number or null` Number of distinct Cowork sessions with at least one successful file-edit tool call. Null while the file-edit metrics are not enabled for this organization. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `write_tool_count: optional number or null` Number of successful Write tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization. - `design_metrics: BetaAnalyticsDesignMetrics` Claude Design activity metrics for a single user on a given day. - `distinct_projects_created_count: number` Number of distinct Claude Design projects created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it. - `distinct_projects_used_count: number or null` Number of distinct Claude Design projects the user worked in. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_session_count: number or null` Number of distinct Claude Design sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `message_count: number` Number of messages sent in Claude Design sessions - `office_metrics: BetaAnalyticsOfficeMetrics` Office Agent activity metrics for a single user on a given day, broken out by Office product. - `excel: BetaAnalyticsOfficeProductMetrics` Office Agent activity metrics for a single user on a given day within one Office product. - `connectors_used_count: number` Number of MCP connector invocations - `distinct_connectors_used_count: number or null` Number of distinct MCP connectors used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_session_count: number or null` Number of distinct Office Agent sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_skills_used_count: number or null` Number of distinct skills used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `message_count: number` Number of messages sent - `skills_used_count: number` Number of skill invocations - `outlook: BetaAnalyticsOfficeProductMetrics` Office Agent activity metrics for a single user on a given day within one Office product. - `powerpoint: BetaAnalyticsOfficeProductMetrics` Office Agent activity metrics for a single user on a given day within one Office product. - `word: BetaAnalyticsOfficeProductMetrics` Office Agent activity metrics for a single user on a given day within one Office product. - `science_metrics: BetaAnalyticsScienceMetrics` Claude Science activity metrics for a single user on a given day. - `delegation_count: number` Number of delegations (handoffs to a specialized agent) in Claude Science sessions - `distinct_session_count: number or null` Number of distinct Claude Science sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `message_count: number` Number of messages sent in Claude Science sessions - `remote_compute_job_count: number` Number of remote compute jobs launched from Claude Science sessions - `skills_used_count: number` Total number of skill invocations in Claude Science sessions - `web_search_count: number` Number of web searches performed - `chat_cowork_unified_metrics: optional object or null` Activity recorded while the member had Chat and Cowork unified (Cowork's features inside claude.ai chat) turned on, split into `chat` (chat activity) and `sessions` (Cowork activity). Omitted from the response on deployments that do not offer Chat and Cowork unified. - `chat: BetaAnalyticsChatCoworkUnifiedChatMetrics` Chat activity recorded while members had Chat and Cowork unified turned on. - `connectors_used_count: number` Same measure as `chat_metrics.connectors_used_count`, for activity recorded while members had Chat and Cowork unified turned on. - `distinct_artifacts_created_count: number` Same measure as `chat_metrics.distinct_artifacts_created_count`, for activity recorded while members had Chat and Cowork unified turned on. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it. - `distinct_connectors_used_count: number or null` Same measure as `chat_metrics.distinct_connectors_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_conversation_count: number or null` Same measure as `chat_metrics.distinct_conversation_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_files_uploaded_count: number or null` Same measure as `chat_metrics.distinct_files_uploaded_count`, for activity recorded while members had Chat and Cowork unified turned on. It counts uploaded files as well as files Claude created and images returned by Claude's tools, such as screenshots. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_projects_created_count: number` Same measure as `chat_metrics.distinct_projects_created_count`, for activity recorded while members had Chat and Cowork unified turned on. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it. - `distinct_projects_used_count: number or null` Same measure as `chat_metrics.distinct_projects_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_shared_artifacts_viewed_count: number or null` Always null: shared-artifact views are not currently measured. - `distinct_skills_used_count: number or null` Same measure as `chat_metrics.distinct_skills_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `message_count: number` Same measure as `chat_metrics.message_count`, for activity recorded while members had Chat and Cowork unified turned on. - `shared_conversations_viewed_count: number` Same measure as `chat_metrics.shared_conversations_viewed_count`, for activity recorded while members had Chat and Cowork unified turned on. - `thinking_message_count: number` Same measure as `chat_metrics.thinking_message_count`, for activity recorded while members had Chat and Cowork unified turned on. - `sessions: BetaAnalyticsChatCoworkUnifiedSessionsMetrics` Cowork session activity recorded while members had Chat and Cowork unified turned on. - `action_count: number` Same measure as `cowork_metrics.action_count`, for activity recorded while members had Chat and Cowork unified turned on. - `artifacts_created_count: number` Same measure as `cowork_metrics.artifacts_created_count`, for activity recorded while members had Chat and Cowork unified turned on. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it. - `connectors_used_count: number` Same measure as `cowork_metrics.connectors_used_count`, for activity recorded while members had Chat and Cowork unified turned on. - `dispatch_turn_count: number` Same measure as `cowork_metrics.dispatch_turn_count`, for activity recorded while members had Chat and Cowork unified turned on. - `distinct_connectors_used_count: number or null` Same measure as `cowork_metrics.distinct_connectors_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_plugins_used_count: number or null` Same measure as `cowork_metrics.distinct_plugins_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_session_count: number or null` Same measure as `cowork_metrics.distinct_session_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_skills_used_count: number or null` Same measure as `cowork_metrics.distinct_skills_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `edit_tool_count: number or null` Same measure as `cowork_metrics.edit_tool_count`, for activity recorded while members had Chat and Cowork unified turned on. - `file_edit_count: number or null` Same measure as `cowork_metrics.file_edit_count`, for activity recorded while members had Chat and Cowork unified turned on. - `message_count: number` Same measure as `cowork_metrics.message_count`, for activity recorded while members had Chat and Cowork unified turned on. - `multi_edit_tool_count: number or null` Same measure as `cowork_metrics.multi_edit_tool_count`, for activity recorded while members had Chat and Cowork unified turned on. Claude no longer has a multi-edit tool, so expect 0 when not null; each edit is now a separate Edit tool call, counted in `edit_tool_count` and `file_edit_count`. - `notebook_edit_tool_count: number or null` Same measure as `cowork_metrics.notebook_edit_tool_count`, for activity recorded while members had Chat and Cowork unified turned on. - `plugins_used_count: number or null` Same measure as `cowork_metrics.plugins_used_count`, for activity recorded while members had Chat and Cowork unified turned on. - `sessions_with_file_edits_count: number or null` Same measure as `cowork_metrics.sessions_with_file_edits_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `skills_used_count: number` Same measure as `cowork_metrics.skills_used_count`, for activity recorded while members had Chat and Cowork unified turned on. - `write_tool_count: number or null` Same measure as `cowork_metrics.write_tool_count`, for activity recorded while members had Chat and Cowork unified turned on. - `distinct_user_count: optional number or null` Number of distinct active users represented by this row. Only set for grouped rollups (`group_by[]`); null for per-user rows. In date-range mode, recomputed as an exact distinct count of the group's active members over the requested window, never a sum of per-day values. - `last_activity_date: optional string or null` Most recent UTC day (YYYY-MM-DD) on which the user had any counted activity, within the requested window: equal to the requested `date` in single-day mode, and to the latest active day from `starting_date` (inclusive) to `ending_date` (exclusive) in date-range rollup mode — never a day earlier than the window start. On filtered requests (`filter[]`) only days matching the filter count: with `filter[]=rbac_group_id:{id}` it is the last day the user was active while a member of that group, consistent with the row's other metrics. On grouped (`group_by[]`) rows it is the latest day any member of the group was active (the requested `date` in single-day mode). Omitted from the response while last-activity reporting is not enabled for this organization. format: date - `rbac_group_id: optional string or null` Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`. - `rbac_group_name: optional string or null` Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key. - `user: optional BetaAnalyticsUser or null` The user this row describes. Null on rows aggregated across users. - `type: "user"` Object type. Always `user`. default: user - `id: string` Tagged user identifier (e.g. `user_...`) - `email_address: string` Email address of the user - `next_page: string or null` Opaque cursor for the next page, or null if no more results #### Example ```bash curl https://api.anthropic.com/v1/organizations/analytics/users \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "chat_metrics": { "connectors_used_count": 0, "distinct_artifacts_created_count": 0, "distinct_connectors_used_count": 0, "distinct_conversation_count": 0, "distinct_files_uploaded_count": 0, "distinct_projects_created_count": 0, "distinct_projects_used_count": 0, "distinct_shared_artifacts_viewed_count": 0, "distinct_skills_used_count": 0, "message_count": 0, "shared_conversations_viewed_count": 0, "thinking_message_count": 0 }, "claude_code_metrics": { "core_metrics": { "artifacts_created_count": 0, "commit_count": 0, "distinct_session_count": 0, "lines_of_code": { "added_count": 0, "removed_count": 0 }, "pull_request_count": 0 }, "tool_actions": { "edit_tool": { "accepted_count": 0, "rejected_count": 0 }, "multi_edit_tool": { "accepted_count": 0, "rejected_count": 0 }, "notebook_edit_tool": { "accepted_count": 0, "rejected_count": 0 }, "write_tool": { "accepted_count": 0, "rejected_count": 0 } } }, "cowork_metrics": { "action_count": 0, "artifacts_created_count": 0, "connectors_used_count": 0, "dispatch_turn_count": 0, "distinct_connectors_used_count": 0, "distinct_session_count": 0, "distinct_skills_used_count": 0, "message_count": 0, "skills_used_count": 0, "distinct_plugins_used_count": 0, "edit_tool_count": 0, "file_edit_count": 0, "multi_edit_tool_count": 0, "notebook_edit_tool_count": 0, "plugins_used_count": 0, "sessions_with_file_edits_count": 0, "write_tool_count": 0 }, "design_metrics": { "distinct_projects_created_count": 0, "distinct_projects_used_count": 0, "distinct_session_count": 0, "message_count": 0 }, "office_metrics": { "excel": { "connectors_used_count": 0, "distinct_connectors_used_count": 0, "distinct_session_count": 0, "distinct_skills_used_count": 0, "message_count": 0, "skills_used_count": 0 }, "outlook": { "connectors_used_count": 0, "distinct_connectors_used_count": 0, "distinct_session_count": 0, "distinct_skills_used_count": 0, "message_count": 0, "skills_used_count": 0 }, "powerpoint": { "connectors_used_count": 0, "distinct_connectors_used_count": 0, "distinct_session_count": 0, "distinct_skills_used_count": 0, "message_count": 0, "skills_used_count": 0 }, "word": { "connectors_used_count": 0, "distinct_connectors_used_count": 0, "distinct_session_count": 0, "distinct_skills_used_count": 0, "message_count": 0, "skills_used_count": 0 } }, "science_metrics": { "delegation_count": 0, "distinct_session_count": 0, "message_count": 0, "remote_compute_job_count": 0, "skills_used_count": 0 }, "web_search_count": 0, "chat_cowork_unified_metrics": { "chat": { "connectors_used_count": 0, "distinct_artifacts_created_count": 0, "distinct_connectors_used_count": 0, "distinct_conversation_count": 0, "distinct_files_uploaded_count": 0, "distinct_projects_created_count": 0, "distinct_projects_used_count": 0, "distinct_shared_artifacts_viewed_count": 0, "distinct_skills_used_count": 0, "message_count": 0, "shared_conversations_viewed_count": 0, "thinking_message_count": 0 }, "sessions": { "action_count": 0, "artifacts_created_count": 0, "connectors_used_count": 0, "dispatch_turn_count": 0, "distinct_connectors_used_count": 0, "distinct_plugins_used_count": 0, "distinct_session_count": 0, "distinct_skills_used_count": 0, "edit_tool_count": 0, "file_edit_count": 0, "message_count": 0, "multi_edit_tool_count": 0, "notebook_edit_tool_count": 0, "plugins_used_count": 0, "sessions_with_file_edits_count": 0, "skills_used_count": 0, "write_tool_count": 0 } }, "distinct_user_count": 0, "last_activity_date": "2019-12-27", "rbac_group_id": "rbac_group_id", "rbac_group_name": "rbac_group_name", "user": { "id": "id", "email_address": "email_address", "type": "user" } } ], "next_page": "next_page" } ``` ## Beta › Organization › Analytics › Apps › Chat › Projects ### Get Chat Project Usage **GET** `/v1/organizations/analytics/apps/chat/projects` Get per-project activity for a given day, with cursor-based pagination. Returns activity metrics for each project in the organization, sorted by project ID. Use `group_by[]` to break projects out per member or per RBAC group, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope. #### Query parameters - `date: optional string` UTC date in YYYY-MM-DD format. The day to get project activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01. format: date - `ending_date: optional string` UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`. format: date - `filter: optional array of string` Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `project_id`, `rbac_group_id`, `user_id`. Value forms: `project_id` takes a tagged project id (`claude_proj_...`); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries. maxItems: 100 - `group_by: optional array of "rbac_group_id" or "user_id"` Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries. maxItems: 100 - `"rbac_group_id"` - `"user_id"` - `limit: optional number` Number of results per page (1-1000, default 100). minimum: 1, maximum: 1000 - `order: optional "asc" or "desc"` Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted. - `"asc"` - `"desc"` - `order_by: optional string` Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set). - `page: optional string` Opaque cursor from a previous response's `next_page` field. - `starting_date: optional string` UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01. format: date #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaAnalyticsProjectActivity` - `distinct_user_count: number` Number of distinct users who used the project on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values. - `message_count: number` Number of messages sent in the project on the requested day - `project_id: string` Tagged project identifier (e.g. `claude_proj_...`) - `project_name: string` Name of the project - `created_at: optional string or null` Project creation timestamp in RFC 3339 format. Null if the project was deleted before attribution was recorded. format: date-time - `created_by: optional BetaAnalyticsUser or null` User who created the project. Null if the project was deleted before attribution was recorded, or if the creator's account no longer exists. - `type: "user"` Object type. Always `user`. default: user - `id: string` Tagged user identifier (e.g. `user_...`) - `email_address: string` Email address of the user - `distinct_conversation_count: optional number or null` Number of distinct conversations in the project. Null on aggregated rows where a distinct count cannot be computed. - `product: optional string or null` Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, `office_agent`, or `chat_cowork_unified` (Chat and Cowork unified). These are the canonical Cost & Usage product names; an `office_agent` row's per-surface breakdown is in its `office_metrics`. On `/plugins` only `cowork`, `claude_code` and `chat_cowork_unified` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, `cowork` and `chat_cowork_unified` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`. - `rbac_group_id: optional string or null` Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`. - `rbac_group_name: optional string or null` Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key. - `user_id: optional string or null` Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`. - `next_page: string or null` Opaque cursor for the next page, or null if no more results #### Example ```bash curl https://api.anthropic.com/v1/organizations/analytics/apps/chat/projects \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "distinct_user_count": 0, "message_count": 0, "project_id": "project_id", "project_name": "project_name", "created_at": "2019-12-27T18:11:19.117Z", "created_by": { "id": "id", "email_address": "email_address", "type": "user" }, "distinct_conversation_count": 0, "product": "product", "rbac_group_id": "rbac_group_id", "rbac_group_name": "rbac_group_name", "user_id": "user_id" } ], "next_page": "next_page" } ``` ## Beta › Organization › Analytics › Connectors ### Get Connector Usage **GET** `/v1/organizations/analytics/connectors` Get per-connector usage for a given day, with cursor-based pagination. Returns connector usage metrics for the organization, sorted by connector name. Connector names are normalized from their various sources — for example, "Atlassian MCP server" and "mcp-atlassian" both appear as "atlassian". Use `group_by[]` to break usage out per member, per RBAC group, or per product surface, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope. #### Query parameters - `date: optional string` UTC date in YYYY-MM-DD format. The day to get connector usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01. format: date - `ending_date: optional string` UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`. format: date - `filter: optional array of string` Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `connector_name`, `product`, `rbac_group_id`, `user_id`. Value forms: `connector_name` matches case-insensitively, a display name such as 'GitHub MCP' also matches its normalized stored form ('github'), and for rows whose `connector_name` is an opaque connector id the connector's display name (`connector_display_name`) also matches; `product` is one of `chat_cowork_unified`, `chat`, `claude_code`, `cowork`, or `office_agent`; `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries. `chat_cowork_unified` is accepted as a `product` value only on deployments that offer Chat and Cowork unified. maxItems: 100 - `group_by: optional array of "product" or "rbac_group_id" or "user_id"` Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries. maxItems: 100 - `"product"` - `"rbac_group_id"` - `"user_id"` - `limit: optional number` Number of results per page (1-1000, default 100). minimum: 1, maximum: 1000 - `order: optional "asc" or "desc"` Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted. - `"asc"` - `"desc"` - `order_by: optional string` Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set). - `page: optional string` Opaque cursor from a previous response's `next_page` field. - `starting_date: optional string` UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01. format: date #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaAnalyticsConnectorActivity` - `chat_metrics: BetaAnalyticsConnectorChatMetrics` Claude.ai activity metrics for a single connector on a given day. - `distinct_conversation_connector_used_count: number or null` Number of distinct conversations in which the connector was used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `claude_code_metrics: BetaAnalyticsConnectorClaudeCodeMetrics` Claude Code activity metrics for a single connector on a given day. - `distinct_session_connector_used_count: number or null` Number of distinct Claude Code sessions in which the connector was used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `connector_name: string` Name of the connector. Some rows carry an opaque connector id here instead of a readable name; `connector_display_name` holds the resolved name for those rows. - `cowork_metrics: BetaAnalyticsConnectorCoworkMetrics` Cowork activity metrics for a single connector on a given day. - `distinct_session_connector_used_count: number or null` Number of distinct Cowork sessions in which the connector was used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_user_count: number` Number of distinct users who used the connector on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values. - `office_metrics: BetaAnalyticsConnectorOfficeMetrics` Office Agent activity metrics for a single connector on a given day, broken out by Office product. - `excel: BetaAnalyticsConnectorOfficeProductMetrics` Office Agent activity metrics for a single connector on a given day within one Office product. - `distinct_session_connector_used_count: number or null` Number of distinct Office Agent sessions in which the connector was used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `outlook: BetaAnalyticsConnectorOfficeProductMetrics` Office Agent activity metrics for a single connector on a given day within one Office product. - `powerpoint: BetaAnalyticsConnectorOfficeProductMetrics` Office Agent activity metrics for a single connector on a given day within one Office product. - `word: BetaAnalyticsConnectorOfficeProductMetrics` Office Agent activity metrics for a single connector on a given day within one Office product. - `chat_cowork_unified_metrics: optional object or null` Connector use recorded while members had Chat and Cowork unified (Cowork's features inside claude.ai chat) turned on, split into chat conversations and Cowork sessions. A count is null in date-range mode where it cannot be computed. Omitted from the response on deployments that do not offer Chat and Cowork unified. - `chat: BetaAnalyticsConnectorChatCoworkUnifiedChatMetrics` A connector's use in chat conversations recorded while members had Chat and Cowork unified turned on. - `distinct_conversation_connector_used_count: number or null` Same measure as `chat_metrics.distinct_conversation_connector_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `sessions: BetaAnalyticsConnectorChatCoworkUnifiedSessionsMetrics` A connector's use in Cowork sessions recorded while members had Chat and Cowork unified turned on. - `distinct_session_connector_used_count: number or null` Same measure as `cowork_metrics.distinct_session_connector_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `connector_display_name: optional string or null` Human-readable display name for rows whose `connector_name` is an opaque connector id rather than a readable name, resolved at request time from the organization's connectors (including connectors that have since been removed). `connector_name` remains the row's stable key for sorting and pagination, and `filter[]=connector_name:{value}` also matches these rows by display name. Display names are not unique, and the same connector's claude.ai usage can appear under a separate row with a readable `connector_name`. Null when `connector_name` is already a readable name, when the id cannot be resolved to one of the organization's connectors, or when display-name resolution is not enabled for this organization. - `individual_auth_distinct_user_count: optional number or null` Number of distinct users whose use of this connector on the requested day ran on their own individual credential, connected through their own consent flow. Companion bucket to `managed_auth_distinct_user_count`, which carries the measurement, attribution, and null rules. Users whose requests used no stored credential count in neither bucket. - `managed_auth_distinct_user_count: optional number or null` Number of distinct users whose use of this connector on the requested day ran on Enterprise Managed Auth (an organization-managed credential provisioned through the organization's identity provider), read from the token record each request used. Null, never 0, when managed-auth reporting is not enabled for the organization, the value cannot be attributed to the row, no credentialed requests and no managed-token mint events (a managed credential being provisioned for a user's use of the connector) were observed that day, or the day predates 2026-07-01, the first day the backing data exists (forward-only data, no backfill). When credentialed requests or mint events were observed and attributed, both managed-auth fields populate, reporting 0 for a bucket with no users; the two counts are independent, not a partition — a user whose requests that day used both kinds of credential counts in both. Mint events carry user but not surface attribution, so they count as observed auth activity on `user_id` and `rbac_group_id` cuts — attributed to the user the credential was provisioned for — but never on a cut that references `product` (group or filter). Date-range rollup mode (`starting_date`/`ending_date`) computes both fields exactly over the window — distinct users with at least one qualifying day — when the whole window starts on or after 2026-07-01, with the null-versus-0 and mint-event rules applying with the window in place of the day; a range starting earlier reports every managed-auth field as null, never a partial-window value. - `product: optional string or null` Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, `office_agent`, or `chat_cowork_unified` (Chat and Cowork unified). These are the canonical Cost & Usage product names; an `office_agent` row's per-surface breakdown is in its `office_metrics`. On `/plugins` only `cowork`, `claude_code` and `chat_cowork_unified` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, `cowork` and `chat_cowork_unified` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`. - `rbac_group_id: optional string or null` Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`. - `rbac_group_name: optional string or null` Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key. - `read_call_count: optional number or null` Number of connector tool calls on the requested day whose trusted read-only annotation marked them read-only. Call count, not distinct users. Every call recorded on a classified surface lands in exactly one of `read_call_count`, `write_call_count`, or `unclassified_call_count`, so the three sum to the day's classified calls. Classification is forward-only per surface: claude.ai from 2026-06-01, Claude Code from 2026-05-30, Claude in Office from 2026-05-29, Cowork from 2026-06-02 (Cowork clients predating annotation forwarding land in `unclassified_call_count`). Null, never 0, when the value cannot be stated: the read/write split is not enabled for this organization, or the day predates 2026-05-29. For a date-range total, sum the per-day values, but treat a window that extends before 2026-05-29 as null rather than summing only its covered days — date-range rollup mode (`starting_date`/`ending_date`) applies both rules server-side. - `unclassified_call_count: optional number or null` Number of connector tool calls on the requested day with no trusted read-only annotation — the annotation is optional in the MCP spec and is discarded when connector access controls are active, so unclassified calls are common. This field shows how much of the day's classified activity the read/write split actually covers. Call count, not distinct users. One of the three call-classification buckets; see `read_call_count` for the per-surface data-start dates, null conditions, and date-range guidance. - `user_id: optional string or null` Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`. - `write_call_count: optional number or null` Number of connector tool calls on the requested day whose trusted read-only annotation marked them not read-only. Call count, not distinct users. One of the three call-classification buckets; see `read_call_count` for the per-surface data-start dates, null conditions, and date-range guidance. - `next_page: string or null` Opaque cursor for the next page, or null if no more results #### Example ```bash curl https://api.anthropic.com/v1/organizations/analytics/connectors \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "chat_metrics": { "distinct_conversation_connector_used_count": 0 }, "claude_code_metrics": { "distinct_session_connector_used_count": 0 }, "connector_name": "connector_name", "cowork_metrics": { "distinct_session_connector_used_count": 0 }, "distinct_user_count": 0, "office_metrics": { "excel": { "distinct_session_connector_used_count": 0 }, "outlook": { "distinct_session_connector_used_count": 0 }, "powerpoint": { "distinct_session_connector_used_count": 0 }, "word": { "distinct_session_connector_used_count": 0 } }, "chat_cowork_unified_metrics": { "chat": { "distinct_conversation_connector_used_count": 0 }, "sessions": { "distinct_session_connector_used_count": 0 } }, "connector_display_name": "connector_display_name", "individual_auth_distinct_user_count": 0, "managed_auth_distinct_user_count": 0, "product": "product", "rbac_group_id": "rbac_group_id", "rbac_group_name": "rbac_group_name", "read_call_count": 0, "unclassified_call_count": 0, "user_id": "user_id", "write_call_count": 0 } ], "next_page": "next_page" } ``` ## Beta › Organization › Analytics › Plugins ### Get Plugin Usage **GET** `/v1/organizations/analytics/plugins` Get per-plugin install + invocation usage for a given day, with pagination. Returns plugin usage metrics for the organization across Cowork and Claude Code, sorted by plugin name. The `plugin_name` value `third-party` is an aggregate bucket, not a plugin: it collects plugin activity, from either surface, for which the reporting client did not provide a plugin name — so an organization's own plugins can contribute both to their own named rows and to this bucket. Use `group_by[]` to break usage out per member, per RBAC group, or per product surface (Cowork / Claude Code), and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Requires an API key with the `read:analytics` scope. `starting_date` / `ending_date` select range-rollup mode like `/skills`. #### Query parameters - `date: optional string` UTC date in YYYY-MM-DD format. The day to get plugin usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01. format: date - `ending_date: optional string` UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`. format: date - `filter: optional array of string` Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `plugin_name`, `product`, `rbac_group_id`, `user_id`. Value forms: `plugin_name` matches case-insensitively; `product` is `chat_cowork_unified`, `claude_code`, or `cowork` (the only surfaces with plugin attribution); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries. `chat_cowork_unified` is accepted as a `product` value only on deployments that offer Chat and Cowork unified. maxItems: 100 - `group_by: optional array of "product" or "rbac_group_id" or "user_id"` Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. On this endpoint `product` takes the values `chat_cowork_unified`, `claude_code`, or `cowork` only (the surfaces with plugin attribution). Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries. maxItems: 100 - `"product"` - `"rbac_group_id"` - `"user_id"` - `limit: optional number` Number of results per page (1-1000, default 100). minimum: 1, maximum: 1000 - `order: optional "asc" or "desc"` Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted. - `"asc"` - `"desc"` - `order_by: optional string` Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set). - `page: optional string` Opaque cursor from a previous response's `next_page` field. - `starting_date: optional string` UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01. format: date #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaAnalyticsPluginActivity` - `claude_code_metrics: BetaAnalyticsPluginClaudeCodeMetrics` Claude Code activity metrics for a single plugin on a given day. - `distinct_session_plugin_used_count: number or null` Number of distinct Claude Code sessions in which the plugin was invoked. Null on aggregated rows where a distinct count cannot be computed. - `cowork_metrics: BetaAnalyticsPluginCoworkMetrics` Cowork activity metrics for a single plugin on a given day. - `distinct_session_plugin_used_count: number or null` Number of distinct Cowork sessions in which the plugin was invoked. Null on aggregated rows where a distinct count cannot be computed. - `distinct_user_count: number` Number of distinct users with recorded install or invocation activity for the plugin on the requested day (install-only users count), or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values. - `install_count: number or null` Number of distinct users who installed the plugin on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values. - `invocation_count: number` Number of plugin invocations on the requested day - `plugin_name: string` Name of the plugin - `chat_cowork_unified_metrics: optional object or null` Plugin use recorded while members had Chat and Cowork unified (Cowork's features inside claude.ai chat) turned on. A count is null in date-range mode where it cannot be computed. Omitted from the response on deployments that do not offer Chat and Cowork unified. - `distinct_session_plugin_used_count: number or null` Same measure as `cowork_metrics.distinct_session_plugin_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Null on aggregated rows where a distinct count cannot be computed. - `plugin_id: optional string or null` Stable plugin identifier when available (e.g. `serena@claude-plugins-official`). Null for third-party Claude Code plugins (redacted at the source) and Cowork slash commands that carry only a hashed id. - `product: optional string or null` Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, `office_agent`, or `chat_cowork_unified` (Chat and Cowork unified). These are the canonical Cost & Usage product names; an `office_agent` row's per-surface breakdown is in its `office_metrics`. On `/plugins` only `cowork`, `claude_code` and `chat_cowork_unified` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, `cowork` and `chat_cowork_unified` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`. - `rbac_group_id: optional string or null` Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`. - `rbac_group_name: optional string or null` Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key. - `user_id: optional string or null` Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`. - `next_page: string or null` Opaque cursor for the next page, or null if no more results #### Example ```bash curl https://api.anthropic.com/v1/organizations/analytics/plugins \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "claude_code_metrics": { "distinct_session_plugin_used_count": 0 }, "cowork_metrics": { "distinct_session_plugin_used_count": 0 }, "distinct_user_count": 0, "install_count": 0, "invocation_count": 0, "plugin_name": "plugin_name", "chat_cowork_unified_metrics": { "distinct_session_plugin_used_count": 0 }, "plugin_id": "plugin_id", "product": "product", "rbac_group_id": "rbac_group_id", "rbac_group_name": "rbac_group_name", "user_id": "user_id" } ], "next_page": "next_page" } ``` ## Beta › Organization › Analytics › Skills ### Get Skill Usage **GET** `/v1/organizations/analytics/skills` Get per-skill usage for a given day, with cursor-based pagination. Returns skill usage metrics for the organization, sorted by skill name. Use `group_by[]` to break usage out per member, per RBAC group, or per product surface, and `filter[]` to scope results; the parameter descriptions list the supported dimensions. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope. #### Query parameters - `date: optional string` UTC date in YYYY-MM-DD format. The day to get skill usage for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01. format: date - `ending_date: optional string` UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`. format: date - `filter: optional array of string` Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `product`, `rbac_group_id`, `share_status`, `skill_name`, `user_id`. Value forms: `product` is one of `chat_cowork_unified`, `chat`, `claude_code`, `cowork`, or `office_agent`; `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `share_status` is one of `organization`, `private`, or `public`; `skill_name` matches case-insensitively; `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries. `chat_cowork_unified` is accepted as a `product` value only on deployments that offer Chat and Cowork unified. maxItems: 100 - `group_by: optional array of "product" or "rbac_group_id" or "user_id"` Dimensions to break results out by (e.g. `group_by[]=user_id`). Supported on this endpoint: `product`, `rbac_group_id`, `user_id`. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries. maxItems: 100 - `"product"` - `"rbac_group_id"` - `"user_id"` - `limit: optional number` Number of results per page (1-1000, default 100). minimum: 1, maximum: 1000 - `order: optional "asc" or "desc"` Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted. - `"asc"` - `"desc"` - `order_by: optional string` Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set). - `page: optional string` Opaque cursor from a previous response's `next_page` field. - `starting_date: optional string` UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01. format: date #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaAnalyticsSkillActivity` - `chat_metrics: BetaAnalyticsSkillChatMetrics` Claude.ai activity metrics for a single skill on a given day. - `distinct_conversation_skill_used_count: number or null` Number of distinct conversations in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `claude_code_metrics: BetaAnalyticsSkillClaudeCodeMetrics` Claude Code activity metrics for a single skill on a given day. - `distinct_session_skill_used_count: number or null` Number of distinct Claude Code sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `cowork_metrics: BetaAnalyticsSkillCoworkMetrics` Cowork activity metrics for a single skill on a given day. - `distinct_session_skill_used_count: number or null` Number of distinct Cowork sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `distinct_user_count: number` Number of distinct users who used the skill on the requested day, or, in date-range mode, over the requested window — recomputed as an exact distinct count over the window's per-member daily rows, never a sum of per-day values. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. - `office_metrics: BetaAnalyticsSkillOfficeMetrics` Office Agent activity metrics for a single skill on a given day, broken out by Office product. - `excel: BetaAnalyticsSkillOfficeProductMetrics` Office Agent activity metrics for a single skill on a given day within one Office product. - `distinct_session_skill_used_count: number or null` Number of distinct Office Agent sessions in which the skill was used. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `outlook: BetaAnalyticsSkillOfficeProductMetrics` Office Agent activity metrics for a single skill on a given day within one Office product. - `powerpoint: BetaAnalyticsSkillOfficeProductMetrics` Office Agent activity metrics for a single skill on a given day within one Office product. - `word: BetaAnalyticsSkillOfficeProductMetrics` Office Agent activity metrics for a single skill on a given day within one Office product. - `skill_name: string` Name of the skill - `attributed_list_price: optional string or null` List-price (rate-card) value of the member requests attributed to this skill, as a decimal string in the minor unit of `currency` (cents for USD), from Claude Code, Cowork, and Office Agent request-level attribution — the value of requests that involved the skill, not the skill's incremental cost. Unlike `estimated_overage_spend` this reflects usage value regardless of how it was funded — seat-covered usage counts — but it is undiscounted and does not tie to billed spend or the organization's spend reporting. claude.ai chat usage carries no request-level attribution and contributes nothing: the field is null on `chat` product rows and on `office_agent` product cuts dated before 2026-06-18 (the Office Agent attribution data-start), and on ungrouped rows it covers the Claude Code + Cowork + Office Agent share only (null when no attributable usage exists). Also null under the same conditions as `estimated_overage_spend` (spend reporting not enabled for this organization, `office_agent` product cuts before the 2026-06-18 data-start). "0" means attributable usage existed but none was attributed to this skill. Addable across days: date-range rollup mode returns the window's sum. On `group_by[]` and `filter[]` shapes both amounts can total below the ungrouped value for the same skill over the same date or range: spend attributed to a member–skill pair with no counted usage on that day is excluded from those cuts. - `chat_cowork_unified_metrics: optional object or null` Skill use recorded while members had Chat and Cowork unified (Cowork's features inside claude.ai chat) turned on, split into chat conversations and Cowork sessions. A count is null in date-range mode where it cannot be computed. Omitted from the response on deployments that do not offer Chat and Cowork unified. - `chat: BetaAnalyticsSkillChatCoworkUnifiedChatMetrics` A skill's use in chat conversations recorded while members had Chat and Cowork unified turned on. - `distinct_conversation_skill_used_count: number or null` Same measure as `chat_metrics.distinct_conversation_skill_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `sessions: BetaAnalyticsSkillChatCoworkUnifiedSessionsMetrics` A skill's use in Cowork sessions recorded while members had Chat and Cowork unified turned on. - `distinct_session_skill_used_count: number or null` Same measure as `cowork_metrics.distinct_session_skill_used_count`, for activity recorded while members had Chat and Cowork unified turned on. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed. - `currency: optional string or null` Currency for this row's monetary fields (`estimated_overage_spend` and `attributed_list_price`), as an uppercase ISO-4217 code. Always "USD" when either amount is populated; null whenever both amounts are null. - `enable_count: optional number or null` Distinct accounts that enabled this skill on the requested day (claude.ai only — the skill analog of plugin `install_count`). The count is org-wide: null when enable reporting is not enabled for this organization, or when the request scopes to `user_id` / `rbac_group_id` / `product` via `group_by[]` or `filter[]` (an org-wide count would be misleading on per-cut rows). A distinct count, not an event count: summing across days double-counts members who enable the skill on more than one day, so it is also null in date-range rollup mode (`starting_date`/`ending_date`). - `estimated_overage_spend: optional string or null` Estimated overage spend attributed to this skill, as a decimal string in the minor unit of `currency` (cents for USD; "1250" is $12.50, fractional cents possible) — an allocation of each member's daily post-discount, pre-credit metered overage spend (the same cost basis as the organization's spend reporting and the Cost & Usage API, so per-skill figures are directly comparable; spend with no skill attribution — including any member-day without skill invocations — is not represented, so skill rows sum to at most those totals) across the skills the member used. Overage only: usage covered by included seat allowances bills nothing and allocates $0 here — see `attributed_list_price` for the funding-independent usage-value companion. Claude Code, Cowork, and Office Agent spend use request-level skill attribution; claude.ai chat spend is approximated proportionally to skill-invoking messages. An estimate, not a billing number — and the cost of the requests/messages that involved the skill, not the skill's incremental cost (the same request would still have cost something without the skill active). "0" means no overage spend was attributed; null when spend reporting is not enabled for this organization, on `office_agent` product cuts dated before 2026-06-18 (the Office Agent attribution data-start). Addable across days: date-range rollup mode (`starting_date`/`ending_date`) returns the window's sum. With `group_by[]=user_id` each row carries the user's own attributed spend. On `group_by[]` and `filter[]` shapes both amounts can total below the ungrouped value for the same skill over the same date or range: spend attributed to a member–skill pair with no counted usage on that day is excluded from those cuts. - `invocation_count: optional number or null` Total number of times this skill was invoked on the requested day (the skill analog of plugin `invocation_count`). Unlike `distinct_user_count` — which answers '\# of users' — this is the true '# of uses'. A skill counts as used only when it is explicitly activated — the model (or the user, via the skill's slash command) invokes it, reading its instructions into context as part of that activation. Skills that are merely installed or listed as available, or whose content reaches the context without an activation (preloaded, hook-injected, or read as a plain file), are not counted. Null when invocation reporting is not enabled for this organization. Sum across a date range for total uses in the window — date-range rollup mode (`starting_date`/`ending_date`) returns this sum directly. - `product: optional string or null` Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, `office_agent`, or `chat_cowork_unified` (Chat and Cowork unified). These are the canonical Cost & Usage product names; an `office_agent` row's per-surface breakdown is in its `office_metrics`. On `/plugins` only `cowork`, `claude_code` and `chat_cowork_unified` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, `cowork` and `chat_cowork_unified` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`. - `rbac_group_id: optional string or null` Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`. - `rbac_group_name: optional string or null` Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key. - `share_status: optional "organization" or "private" or "public" or null` Skill share status (claude.ai only): one of `private`, `organization`, or `public`. Null for skills used only in Claude Code or Office (no per-skill share-status concept) and when share-status reporting is not yet available for the organization. Filterable via `filter[]=share_status:{value}`. - `"organization"` - `"private"` - `"public"` - `skill_display_name: optional string or null` Human-readable display name for rows whose `skill_name` is an opaque skill id (user/organization skill types and plugin-delivered skills, whose user-defined names usage reports generally withhold). Organization-shared skills and skills delivered by the organization's own plugins (its plugin marketplaces and its library) resolve; plugin skill names are shown without their 'plugin:' prefix. The literal 'unknown' bucket row gets a fixed 'Unknown skill' label. For a member's own skill (private or personal-plugin) it is null, except when the skill's owner used it from Claude Code or Cowork in the requested period: then it shows the name that client reported at the time. Apart from that, the names of members' own skills are not disclosed to analytics-key holders. Also null for Anthropic-provided plugin skills (not resolved), for an organization skill or plugin whose name can no longer be found (for example, one since deleted), when `skill_name` is already a display name, or when display-name resolution is not enabled for this organization. - `user_id: optional string or null` Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`. - `next_page: string or null` Opaque cursor for the next page, or null if no more results #### Example ```bash curl https://api.anthropic.com/v1/organizations/analytics/skills \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "chat_metrics": { "distinct_conversation_skill_used_count": 0 }, "claude_code_metrics": { "distinct_session_skill_used_count": 0 }, "cowork_metrics": { "distinct_session_skill_used_count": 0 }, "distinct_user_count": 0, "office_metrics": { "excel": { "distinct_session_skill_used_count": 0 }, "outlook": { "distinct_session_skill_used_count": 0 }, "powerpoint": { "distinct_session_skill_used_count": 0 }, "word": { "distinct_session_skill_used_count": 0 } }, "skill_name": "skill_name", "attributed_list_price": "attributed_list_price", "chat_cowork_unified_metrics": { "chat": { "distinct_conversation_skill_used_count": 0 }, "sessions": { "distinct_session_skill_used_count": 0 } }, "currency": "currency", "enable_count": 0, "estimated_overage_spend": "estimated_overage_spend", "invocation_count": 0, "product": "product", "rbac_group_id": "rbac_group_id", "rbac_group_name": "rbac_group_name", "share_status": "organization", "skill_display_name": "skill_display_name", "user_id": "user_id" } ], "next_page": "next_page" } ``` ## Beta › Organization › Analytics › Artifacts ### Get Artifact Activity **GET** `/v1/organizations/analytics/artifacts` Get artifact-creation activity for a given day, broken out by MIME type. Returns the full (`artifact_type`, `is_shared`) cube for the organization; `next_page` is null except for grouped queries, which paginate. The cube can be broken out per product, per member, or per RBAC group via `group_by[]`, and scoped via `filter[]`. Requires an API key with the `read:analytics` scope. #### Query parameters - `date: string` UTC date in YYYY-MM-DD format. The day to get artifact activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01. format: date - `filter: optional array of string` Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `artifact_type`, `is_shared`, `product`, `rbac_group_id`, `user_id`. Value forms: `artifact_type` is a canonical artifact MIME type (e.g. `text/markdown`) or `other`; `is_shared` is `true` or `false`; `product` is `chat_cowork_unified`, `chat`, `claude_code`, or `cowork` (the surfaces that create artifacts); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries. `chat_cowork_unified` is accepted as a `product` value only on deployments that offer Chat and Cowork unified. maxItems: 100 - `group_by: optional array of "product" or "rbac_group_id" or "user_id"` Dimensions to break results out by: `product`, `user_id` and/or `rbac_group_id`. The ungrouped artifact-type cube is finite and returned in full; grouped queries multiply the cube and paginate via `next_page`. `product` takes the values `chat_cowork_unified`, `chat`, `claude_code`, or `cowork` (the surfaces that create artifacts). `rbac_group_id` attributes a user to every group they held at any point during the requested UTC day, so grouped rows are not an exclusive partition. At most 100 entries. maxItems: 100 - `"product"` - `"rbac_group_id"` - `"user_id"` - `limit: optional number` Maximum rows to return (1-1000, default 100). The ungrouped artifact-type cube is finite and returned in full; `limit` is the page size only when `group_by[]` multiplies the cube. minimum: 1, maximum: 1000 - `page: optional string` Opaque cursor from a previous response's `next_page` field. Only valid with `group_by[]` — the ungrouped cube is never paginated. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaAnalyticsArtifactActivity` - `artifact_type: string` Canonical artifact MIME type (e.g. `text/markdown`, `application/vnd.ant.react`, `image/svg+xml`), or `other`. Claude Code and Cowork artifacts report as `text/html`. - `artifacts_created_count: number` Number of artifacts created in this bucket on the requested day - `distinct_user_count: number` Number of distinct users who created artifacts in this bucket on the requested day - `is_shared: boolean` Whether the artifacts in this bucket have ever been shared (a Claude Code / Cowork artifact is shared once anyone beyond its creator may open it: named members, the whole organization, or anyone with the link). - `published_artifacts_created_count: number` Number of those artifacts that have been published (for Claude Code / Cowork artifacts: open to anyone with the link); never exceeds `artifacts_created_count` - `product: optional string or null` Product that produced this row's activity: one of `chat`, `claude_code`, `cowork`, `office_agent`, or `chat_cowork_unified` (Chat and Cowork unified). These are the canonical Cost & Usage product names; an `office_agent` row's per-surface breakdown is in its `office_metrics`. On `/plugins` only `cowork`, `claude_code` and `chat_cowork_unified` occur (the only surfaces with plugin attribution); on `/artifacts` only `chat`, `claude_code`, `cowork` and `chat_cowork_unified` occur (the surfaces that create artifacts); `/apps/chat/projects` does not support the product dimension (a `product` entry in `group_by[]` or `filter[]` there is rejected). Present only when the request grouped by `product`. - `rbac_group_id: optional string or null` Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`. - `rbac_group_name: optional string or null` Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key. - `user_id: optional string or null` Tagged user identifier (e.g. `user_...`). Present only when the request grouped by `user_id`. - `next_page: string or null` Cursor for the next page of a grouped query; always null for the ungrouped artifact-type cube, which is returned in full. #### Example ```bash curl https://api.anthropic.com/v1/organizations/analytics/artifacts \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "artifact_type": "artifact_type", "artifacts_created_count": 0, "distinct_user_count": 0, "is_shared": true, "published_artifacts_created_count": 0, "product": "product", "rbac_group_id": "rbac_group_id", "rbac_group_name": "rbac_group_name", "user_id": "user_id" } ], "next_page": "next_page" } ``` ## Beta › Organization › Analytics › Usage Report ### Get Token Usage Over Time **GET** `/v1/organizations/analytics/usage_report` Get token usage over time across a date range. Returns token usage bucketed by minute, hour, or day, optionally broken down by product, model, context window, inference region, or speed. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope. #### Query parameters - `starting_at: string` Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z. format: date-time - `bucket_width: optional "1d" or "1h" or "1m"` Time bucket granularity. default: 1d - `"1d"` - `"1h"` - `"1m"` - `claude_tag_categories: optional array of BetaAnalyticsClaudeTagCategory` Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values. maxItems: 100 - `"dm"` - `"engaged"` - `"monitoring"` - `"proactive"` - `"scheduled"` - `claude_tag_user_ids: optional array of string` Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values. maxItems: 100 - `context_windows: optional array of BetaAnalyticsContextWindow` Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values. maxItems: 100 - `"0-200k"` - `"200k-1M"` - `ending_at: optional string` End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days. format: date-time - `group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 6 more` Dimensions to break each time bucket out by. Defaults to no grouping (one total per bucket). Each bucket reports at most its top 100 groups; a group beyond that cap has no row in that bucket (there is no remainder row), so grouped buckets are not exhaustive when a dimension has more than 100 distinct values. maxItems: 100 - `"claude_tag_category"` - `"claude_tag_user_id"` - `"context_window"` - `"inference_geo"` - `"model"` - `"product"` - `"rbac_group_id"` - `"slack_channel_id"` - `"speed"` - `inference_geos: optional array of BetaAnalyticsInferenceGeoFilter` Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values. maxItems: 100 - `"global"` - `"not_available"` - `"us"` - `limit: optional number` Maximum number of time buckets per page. Defaults and caps vary by `bucket_width` (`1d`: default 7, max 31; `1h`: default 24, max 168; `1m`: default 60, max 256). minimum: 1 - `models: optional array of string` Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values. maxItems: 100 - `page: optional string` Opaque cursor from a previous response's `next_page` field. - `products: optional array of BetaAnalyticsProductFilter` Product surfaces to include. Defaults to all products. Use `group_by[]=product` to break out per-product values. maxItems: 100 - `"chat"` - `"chat_cowork_unified"` - `"claude-tag"` - `"claude_code"` - `"claude_design"` - `"claude_in_chrome"` - `"cowork"` - `"office_agent"` - `rbac_group_ids: optional array of string` Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches. maxItems: 100 - `slack_channel_ids: optional array of string` Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values. maxItems: 100 - `speeds: optional array of "fast" or "standard"` Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values. maxItems: 100 - `"fast"` - `"standard"` - `user_ids: optional array of string` Filter to specific users by tagged user ID. maxItems: 100 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaAnalyticsUsageReportTimeBucket` Time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no data (their `results` list is empty). A page holds at most `limit` buckets. - `ending_at: string` End of the time bucket (exclusive) in RFC 3339 format. format: date-time - `results: array of BetaAnalyticsUsageBucketedResult` Rows for this time bucket. Empty when the bucket has no data; otherwise a single combined row when `group_by[]` is omitted, or one row per group (subject to the per-bucket group cap described on the `group_by[]` parameter). - `cache_creation: BetaCacheCreation` The number of input tokens for cache creation. - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null` Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time. - `"dm"` - `"engaged"` - `"monitoring"` - `"proactive"` - `"scheduled"` - `claude_tag_user_id: string or null` Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter. - `context_window: BetaAnalyticsContextWindow or null` Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution. - `"0-200k"` - `"200k-1M"` - `inference_geo: "global" or "us" or null` Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches). - `"global"` - `"us"` - `model: string or null` Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution. - `output_tokens: number` The number of output tokens generated. - `product: string or null` Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, `claude-tag`, and `chat_cowork_unified`. `claude-tag` is Claude Tag, the Claude product in Slack. `chat_cowork_unified` is Chat and Cowork unified, Cowork's features inside claude.ai chat: chat and Cowork usage by a member who has it turned on is reported under this value instead of `chat` or `cowork`. It is accepted as a filter only on deployments that offer Chat and Cowork unified. Some unattributed usage is reported as "other". - `rbac_group_id: string or null` RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`. - `requests: number or null` Number of API requests in this row's scope. For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`). - `server_tool_use: BetaAnalyticsServerToolUse` Server-side tool usage metrics. - `web_search_requests: number` The number of web search requests made. - `slack_channel_id: string or null` Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled). - `speed: "fast" or "standard" or null` Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`. - `"fast"` - `"standard"` - `uncached_input_tokens: number` The number of uncached input tokens processed. - `starting_at: string` Start of the time bucket (inclusive) in RFC 3339 format. format: date-time - `data_refreshed_at: string or null` RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case every bucket's `results` list is empty. Buckets beyond this watermark are incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours. Values can be revised as late events arrive and reconciliation runs, until about 7 days after the end of the calendar month the usage falls in; for example, values for October 1 can change until about November 7. format: date-time - `has_more: boolean` Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it. - `next_page: string or null` Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page. - `organization_id: string` ID of the Organization. #### Example ```bash curl https://api.anthropic.com/v1/organizations/analytics/usage_report \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "ending_at": "2019-12-27T18:11:19.117Z", "results": [ { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "claude_tag_category": "dm", "claude_tag_user_id": "U0123ABCDEF", "context_window": "0-200k", "inference_geo": "global", "model": "claude-opus-5-5", "output_tokens": 0, "product": "chat", "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "requests": 0, "server_tool_use": { "web_search_requests": 10 }, "slack_channel_id": "C0123ABCDEF", "speed": "fast", "uncached_input_tokens": 0 } ], "starting_at": "2019-12-27T18:11:19.117Z" } ], "data_refreshed_at": "2019-12-27T18:11:19.117Z", "has_more": true, "next_page": "next_page", "organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF" } ``` ## Beta › Organization › Analytics › User Usage Report ### Get Per-User Token Usage **GET** `/v1/organizations/analytics/user_usage_report` Get per-user token usage across a date range. Returns one row per user, ranked by the chosen token metric. Use this to see which users consume the most tokens. Only usage attributable to a seat user is included; for organization-wide totals including direct API-key and automation traffic, use the bucketed `/v1/organizations/analytics/usage_report` endpoint. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope. #### Query parameters - `starting_at: string` Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z. format: date-time - `bucket_width: optional "1d" or "1h" or "1m"` Time-bucket granularity. When set, each row's `starting_at` and `ending_at` are populated and one actor may span several rows (one per time bucket with usage). The time bucket counts toward `limit`, so one page can return multiple rows for the same actor. `ending_at` is required when `bucket_width` is set, and with `bucket_width="1m"` the range may span at most 24 hours. When omitted, each row aggregates the full `[starting_at, ending_at)` range. - `"1d"` - `"1h"` - `"1m"` - `claude_tag_categories: optional array of BetaAnalyticsClaudeTagCategory` Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values. maxItems: 100 - `"dm"` - `"engaged"` - `"monitoring"` - `"proactive"` - `"scheduled"` - `claude_tag_user_ids: optional array of string` Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values. maxItems: 100 - `context_windows: optional array of BetaAnalyticsContextWindow` Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values. maxItems: 100 - `"0-200k"` - `"200k-1M"` - `ending_at: optional string` End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days. format: date-time - `exclude_deleted_users: optional boolean` If true, omit rows for users who are deleted (`deleted: true`). A page may contain fewer than `limit` rows; use `has_more` and `next_page` to paginate as usual. default: false - `group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 6 more` Break each actor's row out by the given dimensions. Accepts the same values as the bucketed `/usage_report` endpoint. `limit` bounds (actor × time bucket × dimension) rows — with dimensions or `bucket_width` present, one actor may span several rows. maxItems: 100 - `"claude_tag_category"` - `"claude_tag_user_id"` - `"context_window"` - `"inference_geo"` - `"model"` - `"product"` - `"rbac_group_id"` - `"slack_channel_id"` - `"speed"` - `inference_geos: optional array of BetaAnalyticsInferenceGeoFilter` Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values. maxItems: 100 - `"global"` - `"not_available"` - `"us"` - `limit: optional number` Number of rows per page (1-1000, default 20). One row per actor unless `group_by[]` or `bucket_width` splits an actor across rows; `cost_type`/`token_type` fan-out rows (cost endpoint only) are the exception — they do not count toward this limit, so `data` can exceed it. default: 20, minimum: 1, maximum: 1000 - `models: optional array of string` Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values. maxItems: 100 - `order: optional "asc" or "desc"` Sort direction. Defaults to `desc`. default: desc - `"asc"` - `"desc"` - `order_by: optional "output_tokens" or "requests" or "total_tokens" or "uncached_input_tokens"` Metric to rank actors by. Defaults to `total_tokens`. default: total_tokens - `"output_tokens"` - `"requests"` - `"total_tokens"` - `"uncached_input_tokens"` - `page: optional string` Opaque cursor from a previous response's `next_page` field. - `products: optional array of BetaAnalyticsProductFilter` Product surfaces to include. Defaults to all products. maxItems: 100 - `"chat"` - `"chat_cowork_unified"` - `"claude-tag"` - `"claude_code"` - `"claude_design"` - `"claude_in_chrome"` - `"cowork"` - `"office_agent"` - `rbac_group_ids: optional array of string` Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches. maxItems: 100 - `slack_channel_ids: optional array of string` Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values. maxItems: 100 - `speeds: optional array of "fast" or "standard"` Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values. maxItems: 100 - `"fast"` - `"standard"` - `user_ids: optional array of string` Filter to specific users by tagged user ID. maxItems: 100 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaAnalyticsUsageUsersItem` Rows for this page, ranked by `order_by` in the `order` direction. One row per user, or several per user when `group_by[]` or `bucket_width` breaks that user's usage or cost out across rows. Rows split out by `cost_type` or `token_type` (cost endpoint only) stay adjacent and are ranked as one unit. - `actor: BetaAnalyticsUserActor` The user this row's usage or cost is attributed to. Always a `user_actor`. - `type: "user_actor"` Actor type. Always `"user_actor"`. - `deleted: boolean` True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation. - `email_address: string or null` The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`). - `name: string or null` The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"` for usage by Anthropic's security-patching service) or null. - `user_id: string` Tagged user ID. - `email: string or null` **Deprecated** Deprecated: use `email_address`, which carries the same value. - `cache_creation: BetaCacheCreation` The number of input tokens for cache creation. - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null` Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time. - `"dm"` - `"engaged"` - `"monitoring"` - `"proactive"` - `"scheduled"` - `claude_tag_user_id: string or null` Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter. - `context_window: BetaAnalyticsContextWindow or null` Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution. - `"0-200k"` - `"200k-1M"` - `ending_at: string or null` End of the row's UTC time bucket (exclusive), as an RFC 3339 timestamp; equal to `starting_at` plus one `bucket_width`. Null unless `bucket_width` is set. format: date-time - `inference_geo: "global" or "us" or null` Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches). - `"global"` - `"us"` - `model: string or null` Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution. - `output_tokens: number` The number of output tokens generated. - `product: string or null` Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, `claude-tag`, and `chat_cowork_unified`. `claude-tag` is Claude Tag, the Claude product in Slack. `chat_cowork_unified` is Chat and Cowork unified, Cowork's features inside claude.ai chat: chat and Cowork usage by a member who has it turned on is reported under this value instead of `chat` or `cowork`. It is accepted as a filter only on deployments that offer Chat and Cowork unified. Some unattributed usage is reported as "other". - `rbac_group_id: string or null` RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`. - `requests: number or null` Number of API requests in this row's scope. For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`). - `server_tool_use: BetaAnalyticsServerToolUse` Server-side tool usage metrics. - `web_search_requests: number` The number of web search requests made. - `slack_channel_id: string or null` Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled). - `speed: "fast" or "standard" or null` Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`. - `"fast"` - `"standard"` - `starting_at: string or null` Start of the row's UTC time bucket (inclusive), as an RFC 3339 timestamp. Null unless `bucket_width` is set; without `bucket_width`, each row aggregates the full requested range. format: date-time - `total_tokens: number` Total token count across all token types. This is the value the default `order_by` (`total_tokens`) sorts on. - `uncached_input_tokens: number` The number of uncached input tokens processed. - `data_refreshed_at: string or null` RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case `data` is empty. Data beyond this watermark is incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours. Values can be revised as late events arrive and reconciliation runs, until about 7 days after the end of the calendar month the usage falls in; for example, values for October 1 can change until about November 7. format: date-time - `has_more: boolean` Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it. - `next_page: string or null` Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page. - `organization_id: string` ID of the Organization. #### Example ```bash curl https://api.anthropic.com/v1/organizations/analytics/user_usage_report \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "actor": { "deleted": true, "email": "jane@example.com", "email_address": "jane@example.com", "name": "Jane Smith", "type": "user_actor", "user_id": "user_01AbCdEfGhIjKlMnOpQrSt" }, "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 3200000, "claude_tag_category": "dm", "claude_tag_user_id": "U0123ABCDEF", "context_window": "0-200k", "ending_at": "2019-12-27T18:11:19.117Z", "inference_geo": "global", "model": "claude-opus-5-5", "output_tokens": 891000, "product": "chat", "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "requests": 128, "server_tool_use": { "web_search_requests": 10 }, "slack_channel_id": "C0123ABCDEF", "speed": "fast", "starting_at": "2019-12-27T18:11:19.117Z", "total_tokens": 5377000, "uncached_input_tokens": 1284500 } ], "data_refreshed_at": "2019-12-27T18:11:19.117Z", "has_more": true, "next_page": "next_page", "organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF" } ``` ## Beta › Organization › Analytics › Cost Report ### Get Cost Over Time **GET** `/v1/organizations/analytics/cost_report` Get cost in USD over time across a date range. Returns cost bucketed by minute, hour, or day, optionally broken down by product, model, context window, inference region, speed, cost type, or token type. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope. #### Query parameters - `starting_at: string` Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z. format: date-time - `bucket_width: optional "1d" or "1h" or "1m"` Time bucket granularity. default: 1d - `"1d"` - `"1h"` - `"1m"` - `claude_tag_categories: optional array of BetaAnalyticsClaudeTagCategory` Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values. maxItems: 100 - `"dm"` - `"engaged"` - `"monitoring"` - `"proactive"` - `"scheduled"` - `claude_tag_user_ids: optional array of string` Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values. maxItems: 100 - `context_windows: optional array of BetaAnalyticsContextWindow` Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values. maxItems: 100 - `"0-200k"` - `"200k-1M"` - `ending_at: optional string` End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days. format: date-time - `group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 8 more` Dimensions to break each time bucket out by. Defaults to no grouping (one total per bucket). Each bucket reports at most its top 100 groups; a group beyond that cap has no row in that bucket (there is no remainder row), so grouped buckets are not exhaustive when a dimension has more than 100 distinct values. maxItems: 100 - `"claude_tag_category"` - `"claude_tag_user_id"` - `"context_window"` - `"cost_type"` - `"inference_geo"` - `"model"` - `"product"` - `"rbac_group_id"` - `"slack_channel_id"` - `"speed"` - `"token_type"` - `inference_geos: optional array of BetaAnalyticsInferenceGeoFilter` Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values. maxItems: 100 - `"global"` - `"not_available"` - `"us"` - `limit: optional number` Maximum number of time buckets per page. Defaults and caps vary by `bucket_width` (`1d`: default 7, max 31; `1h`: default 24, max 168; `1m`: default 60, max 256). minimum: 1 - `models: optional array of string` Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values. maxItems: 100 - `page: optional string` Opaque cursor from a previous response's `next_page` field. - `products: optional array of BetaAnalyticsProductFilter` Product surfaces to include. Defaults to all products. Use `group_by[]=product` to break out per-product values. maxItems: 100 - `"chat"` - `"chat_cowork_unified"` - `"claude-tag"` - `"claude_code"` - `"claude_design"` - `"claude_in_chrome"` - `"cowork"` - `"office_agent"` - `rbac_group_ids: optional array of string` Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches. maxItems: 100 - `slack_channel_ids: optional array of string` Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values. maxItems: 100 - `speeds: optional array of "fast" or "standard"` Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values. maxItems: 100 - `"fast"` - `"standard"` - `user_ids: optional array of string` Filter to specific users by tagged user ID. maxItems: 100 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaAnalyticsCostReportTimeBucket` Time buckets for this page, oldest first: one per `bucket_width` interval, including intervals with no data (their `results` list is empty). A page holds at most `limit` buckets. - `ending_at: string` End of the time bucket (exclusive) in RFC 3339 format. format: date-time - `results: array of BetaAnalyticsCostBucketedResult` Rows for this time bucket. Empty when the bucket has no data; otherwise a single combined row when `group_by[]` is omitted, or one row per group (subject to the per-bucket group cap described on the `group_by[]` parameter). - `amount: string` Amount (post-discount, pre-credit) in fractional cents. - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null` Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time. - `"dm"` - `"engaged"` - `"monitoring"` - `"proactive"` - `"scheduled"` - `claude_tag_user_id: string or null` Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter. - `context_window: BetaAnalyticsContextWindow or null` Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution. - `"0-200k"` - `"200k-1M"` - `cost_type: BetaAnalyticsCostType or null` Cost component when `group_by[]=cost_type`; null otherwise (amount is the combined total). - `"code_execution"` - `"tokens"` - `"web_search"` - `currency: string` Currency code for the cost amount. Currently always `"USD"`. default: USD - `inference_geo: "global" or "us" or null` Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches). - `"global"` - `"us"` - `list_amount: string` List-price amount (pre-discount) in fractional cents. - `model: string or null` Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution. - `product: string or null` Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, `claude-tag`, and `chat_cowork_unified`. `claude-tag` is Claude Tag, the Claude product in Slack. `chat_cowork_unified` is Chat and Cowork unified, Cowork's features inside claude.ai chat: chat and Cowork usage by a member who has it turned on is reported under this value instead of `chat` or `cowork`. It is accepted as a filter only on deployments that offer Chat and Cowork unified. Some unattributed usage is reported as "other". - `rbac_group_id: string or null` RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`. - `requests: number or null` Number of API requests in this row's scope. Null when `group_by` includes `cost_type` or `token_type` (the count has no per-component attribution; read it from the ungrouped response). For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`). - `slack_channel_id: string or null` Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled). - `speed: "fast" or "standard" or null` Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`. - `"fast"` - `"standard"` - `token_type: BetaAnalyticsTokenType or null` Token type when `group_by[]=token_type` and `cost_type=tokens`; null otherwise. - `"cache_creation.ephemeral_1h_input_tokens"` - `"cache_creation.ephemeral_5m_input_tokens"` - `"cache_read_input_tokens"` - `"output_tokens"` - `"uncached_input_tokens"` - `starting_at: string` Start of the time bucket (inclusive) in RFC 3339 format. format: date-time - `data_refreshed_at: string or null` RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case every bucket's `results` list is empty. Buckets beyond this watermark are incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours. Values can be revised as late events arrive and reconciliation runs, until about 7 days after the end of the calendar month the usage falls in; for example, values for October 1 can change until about November 7. format: date-time - `has_more: boolean` Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it. - `next_page: string or null` Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page. - `organization_id: string` ID of the Organization. #### Example ```bash curl https://api.anthropic.com/v1/organizations/analytics/cost_report \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "ending_at": "2019-12-27T18:11:19.117Z", "results": [ { "amount": "amount", "claude_tag_category": "dm", "claude_tag_user_id": "U0123ABCDEF", "context_window": "0-200k", "cost_type": "code_execution", "currency": "USD", "inference_geo": "global", "list_amount": "list_amount", "model": "claude-opus-5-5", "product": "chat", "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "requests": 0, "slack_channel_id": "C0123ABCDEF", "speed": "fast", "token_type": "cache_creation.ephemeral_1h_input_tokens" } ], "starting_at": "2019-12-27T18:11:19.117Z" } ], "data_refreshed_at": "2019-12-27T18:11:19.117Z", "has_more": true, "next_page": "next_page", "organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF" } ``` ## Beta › Organization › Analytics › User Cost Report ### Get Per-User Cost **GET** `/v1/organizations/analytics/user_cost_report` Get per-user cost in USD across a date range. Returns one row per user, ranked by spend. Use this to see which users account for the most cost. Only cost attributable to a seat user is included; for organization-wide totals including direct API-key and automation traffic, use the bucketed `/v1/organizations/analytics/cost_report` endpoint. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope. #### Query parameters - `starting_at: string` Start of range, inclusive. RFC 3339 tz-aware. Must be within the last 365 days and no earlier than 2026-01-01T00:00:00Z. format: date-time - `bucket_width: optional "1d" or "1h" or "1m"` Time-bucket granularity. When set, each row's `starting_at` and `ending_at` are populated and one actor may span several rows (one per time bucket with usage). The time bucket counts toward `limit`, so one page can return multiple rows for the same actor. `ending_at` is required when `bucket_width` is set, and with `bucket_width="1m"` the range may span at most 24 hours. When omitted, each row aggregates the full `[starting_at, ending_at)` range. - `"1d"` - `"1h"` - `"1m"` - `claude_tag_categories: optional array of BetaAnalyticsClaudeTagCategory` Filter to Claude Tag (Claude in Slack) usage in specific spend categories. Usage with no category never matches. `dm` usage is reported under the user's product rather than `claude-tag`, so combining this filter with `products[]=claude-tag` excludes it. Use `group_by[]=claude_tag_category` to break out per-category values. maxItems: 100 - `"dm"` - `"engaged"` - `"monitoring"` - `"proactive"` - `"scheduled"` - `claude_tag_user_ids: optional array of string` Filter to Claude Tag (Claude in Slack) usage attributed to specific Slack users, by Slack user ID (for example `U0123ABCDEF`), not claude.ai user ID. Usage that is not Claude Tag, and Claude Tag usage not attributed to a single user, never matches. Use `group_by[]=claude_tag_user_id` to break out per-user values. maxItems: 100 - `context_windows: optional array of BetaAnalyticsContextWindow` Filter to specific context-window pricing tiers. Use `group_by[]=context_window` to break out per-tier values. maxItems: 100 - `"0-200k"` - `"200k-1M"` - `ending_at: optional string` End of range, exclusive. When omitted, defaults to the earlier of now and `starting_at` + 31 days. The range may span at most 31 days. format: date-time - `exclude_deleted_users: optional boolean` If true, omit rows for users who are deleted (`deleted: true`). A page may contain fewer than `limit` rows; use `has_more` and `next_page` to paginate as usual. default: false - `group_by: optional array of "claude_tag_category" or "claude_tag_user_id" or "context_window" or 8 more` Break each actor's row out by the given dimensions. Accepts the same values as the bucketed `/cost_report` endpoint. The `product`, `model`, `context_window`, `inference_geo`, and `speed` dimensions — and the time bucket, when `bucket_width` is set — count toward `limit`. `cost_type` and `token_type` do not: `cost_type` returns one row per cost component (tokens, web search, code execution); `token_type` returns one row per token type, each with `cost_type: "tokens"`; combining both returns the per-token-type rows plus the web-search and code-execution rows. A page can therefore contain more rows than `limit` when `cost_type` or `token_type` is requested. maxItems: 100 - `"claude_tag_category"` - `"claude_tag_user_id"` - `"context_window"` - `"cost_type"` - `"inference_geo"` - `"model"` - `"product"` - `"rbac_group_id"` - `"slack_channel_id"` - `"speed"` - `"token_type"` - `inference_geos: optional array of BetaAnalyticsInferenceGeoFilter` Filter to specific inference regions. `not_available` matches rows where the region is unset. Use `group_by[]=inference_geo` to break out per-region values. maxItems: 100 - `"global"` - `"not_available"` - `"us"` - `limit: optional number` Number of rows per page (1-1000, default 20). One row per actor unless `group_by[]` or `bucket_width` splits an actor across rows; `cost_type`/`token_type` fan-out rows (cost endpoint only) are the exception — they do not count toward this limit, so `data` can exceed it. default: 20, minimum: 1, maximum: 1000 - `models: optional array of string` Models to include. Defaults to all models. Use `group_by[]=model` to break out per-model values. maxItems: 100 - `order: optional "asc" or "desc"` Sort direction. Defaults to `desc`. default: desc - `"asc"` - `"desc"` - `order_by: optional "amount" or "list_amount"` Metric to rank actors by. Defaults to `amount`. default: amount - `"amount"` - `"list_amount"` - `page: optional string` Opaque cursor from a previous response's `next_page` field. - `products: optional array of BetaAnalyticsProductFilter` Product surfaces to include. Defaults to all products. maxItems: 100 - `"chat"` - `"chat_cowork_unified"` - `"claude-tag"` - `"claude_code"` - `"claude_design"` - `"claude_in_chrome"` - `"cowork"` - `"office_agent"` - `rbac_group_ids: optional array of string` Filter to usage attributed to specific RBAC groups. Accepts tagged RBAC group IDs (`rbac_group_...`) or bare group UUIDs. A row matches when the user belonged to any of the listed groups on the (UTC) day the usage occurred; usage with no group attribution never matches. maxItems: 100 - `slack_channel_ids: optional array of string` Filter to usage originating from specific Slack channels. Use `group_by[]=slack_channel_id` to break out per-channel values. maxItems: 100 - `speeds: optional array of "fast" or "standard"` Filter to fast or standard inference mode. Use `group_by[]=speed` to break out per-mode values. maxItems: 100 - `"fast"` - `"standard"` - `user_ids: optional array of string` Filter to specific users by tagged user ID. maxItems: 100 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaAnalyticsCostUsersItem` Rows for this page, ranked by `order_by` in the `order` direction. One row per user, or several per user when `group_by[]` or `bucket_width` breaks that user's usage or cost out across rows. Rows split out by `cost_type` or `token_type` (cost endpoint only) stay adjacent and are ranked as one unit. - `actor: BetaAnalyticsUserActor` The user this row's usage or cost is attributed to. Always a `user_actor`. - `type: "user_actor"` Actor type. Always `"user_actor"`. - `deleted: boolean` True when the account has been deleted, or when the user is no longer a member of the organization or its associated organizations (for example, their membership was removed or they were deprovisioned via your identity provider). `email_address` stays populated for removed users and is null when the account has been deleted. `name` follows the rules described on that field. The `user_id` is still populated for reconciliation. - `email_address: string or null` The user's email address, including for users who are no longer members of the organization or its associated organizations. Null when the account has been deleted (check `deleted`) and for system-minted service accounts, which have no person's mailbox behind them (check `name`). - `name: string or null` The user's full name. Null when the user has not set a name. Returns `"Deleted User"` when the account itself has been deleted, or when the user is no longer a member of the organization or its associated organizations and the organization has chosen to hide the names of removed users. Otherwise, the name stays populated for removed users. Rows for system-minted service accounts render the service name (for example, `"Claude Security"` for usage by Anthropic's security-patching service) or null. - `user_id: string` Tagged user ID. - `email: string or null` **Deprecated** Deprecated: use `email_address`, which carries the same value. - `amount: string` Amount (post-discount, pre-credit) in fractional cents (minor units). - `claude_tag_category: BetaAnalyticsClaudeTagCategory or null` Claude Tag (Claude in Slack) spend category: `engaged` (a person addressed Claude in a channel or thread), `proactive` (Claude responded without being addressed), `scheduled` (a scheduled routine ran), `monitoring` (Claude watching a channel it was asked to monitor), or `dm` (direct messages with Claude). Populated only when `claude_tag_category` is in `group_by[]`; null for usage that is not Claude Tag. Direct-message usage is billed to the individual user and is reported under that user's product, not under `claude-tag`. New categories may be added over time. - `"dm"` - `"engaged"` - `"monitoring"` - `"proactive"` - `"scheduled"` - `claude_tag_user_id: string or null` Slack user ID (for example `U0123ABCDEF`) of the member the Claude Tag (Claude in Slack) usage is attributed to, not a claude.ai user ID. Populated only when `claude_tag_user_id` is in `group_by[]`; null for usage that is not Claude Tag and for Claude Tag usage that is not attributed to a single user (for example `monitoring`, and `proactive` usage Claude initiated), so per-user rows can sum to less than the Claude Tag total. Cannot be combined with `group_by[]=rbac_group_id` or the `rbac_group_ids[]` filter. - `context_window: BetaAnalyticsContextWindow or null` Context-window pricing tier of the usage or cost. Null unless `context_window` is in `group_by[]`; it can also be null on grouped rows with no context-window tier, such as code execution. - `"0-200k"` - `"200k-1M"` - `cost_type: BetaAnalyticsCostType or null` Cost component breakdown; null when returning the combined total. - `"code_execution"` - `"tokens"` - `"web_search"` - `currency: string` Currency code for the cost amount. Currently always `"USD"`. default: USD - `ending_at: string or null` End of the row's UTC time bucket (exclusive), as an RFC 3339 timestamp; equal to `starting_at` plus one `bucket_width`. Null unless `bucket_width` is set. format: date-time - `inference_geo: "global" or "us" or null` Inference region of the usage or cost. Null unless `inference_geo` is in `group_by[]`; it can also be null on grouped rows where the region is not set (the rows that `inference_geos[]=not_available` matches). - `"global"` - `"us"` - `list_amount: string` List-price amount (pre-discount) in fractional cents. - `model: string or null` Model that produced the usage or cost, as a model name in the form the `models[]` filter accepts (for example, `claude-opus-5-5`). Null unless `model` is in `group_by[]`; it can also be null on grouped rows whose usage or cost is not attributed to a specific model, such as code execution. - `product: string or null` Product surface that produced the usage or cost. Null unless product is in `group_by[]`; it can also be null on grouped rows whose usage cannot be attributed to a known surface. Values include `chat`, `claude_code`, `cowork`, `office_agent`, `claude_in_chrome`, `claude_design`, `claude-tag`, and `chat_cowork_unified`. `claude-tag` is Claude Tag, the Claude product in Slack. `chat_cowork_unified` is Chat and Cowork unified, Cowork's features inside claude.ai chat: chat and Cowork usage by a member who has it turned on is reported under this value instead of `chat` or `cowork`. It is accepted as a filter only on deployments that offer Chat and Cowork unified. Some unattributed usage is reported as "other". - `rbac_group_id: string or null` RBAC group (team) the usage is attributed to, in the public tagged `rbac_group_...` spelling — the same spelling the activity resources use for this key, so the same team has one id across resources and it round-trips as an `rbac_group_ids[]` filter value. Populated only when `rbac_group_id` is in `group_by[]`. Any-membership semantics: a user in several groups contributes their full usage to each of those groups' rows, so the named-group rows overlap and their sum can exceed the org total. A null value is the single unassigned row: users in no group on that (UTC) day. For the true org total, run the same query without `group_by[]`. - `requests: number or null` Number of API requests in this row's scope. Null when `group_by` includes `cost_type` or `token_type` (the count has no per-component attribution; read it from the ungrouped response). For sandbox / code-execution events, this counts execution spans rather than HTTP requests (these rows surface with `product: null`). - `slack_channel_id: string or null` Slack channel the usage originated from. Populated only when `slack_channel_id` is in `group_by[]`; null for usage outside Slack (and for rows recorded before channel attribution was enabled). - `speed: "fast" or "standard" or null` Inference speed mode of the usage or cost: `fast` or `standard`. Null unless `speed` is in `group_by[]`. - `"fast"` - `"standard"` - `starting_at: string or null` Start of the row's UTC time bucket (inclusive), as an RFC 3339 timestamp. Null unless `bucket_width` is set; without `bucket_width`, each row aggregates the full requested range. format: date-time - `token_type: BetaAnalyticsTokenType or null` Token type when `cost_type` is `tokens`; null otherwise. - `"cache_creation.ephemeral_1h_input_tokens"` - `"cache_creation.ephemeral_5m_input_tokens"` - `"cache_read_input_tokens"` - `"output_tokens"` - `"uncached_input_tokens"` - `data_refreshed_at: string or null` RFC 3339 timestamp of the export this response was served from. Null when no export yet covers any part of the requested range, in which case `data` is empty. Data beyond this watermark is incomplete; for stable results, set `ending_at` to this value or earlier. Data is typically refreshed every 4 hours. Values can be revised as late events arrive and reconciliation runs, until about 7 days after the end of the calendar month the usage falls in; for example, values for October 1 can change until about November 7. format: date-time - `has_more: boolean` Whether another page is available. When true, pass `next_page` as the `page` parameter to fetch it. - `next_page: string or null` Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter, keeping the other parameters unchanged. A cursor can expire after the underlying data refreshes; the request then returns HTTP 410 and pagination must restart from the first page. - `organization_id: string` ID of the Organization. #### Example ```bash curl https://api.anthropic.com/v1/organizations/analytics/user_cost_report \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "actor": { "deleted": true, "email": "jane@example.com", "email_address": "jane@example.com", "name": "Jane Smith", "type": "user_actor", "user_id": "user_01AbCdEfGhIjKlMnOpQrSt" }, "amount": "41280.000000", "claude_tag_category": "dm", "claude_tag_user_id": "U0123ABCDEF", "context_window": "0-200k", "cost_type": "code_execution", "currency": "USD", "ending_at": "2019-12-27T18:11:19.117Z", "inference_geo": "global", "list_amount": "51600.000000", "model": "claude-opus-5-5", "product": "chat", "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "requests": 128, "slack_channel_id": "C0123ABCDEF", "speed": "fast", "starting_at": "2019-12-27T18:11:19.117Z", "token_type": "cache_creation.ephemeral_1h_input_tokens" } ], "data_refreshed_at": "2019-12-27T18:11:19.117Z", "has_more": true, "next_page": "next_page", "organization_id": "org_013FP9SaFPBg7Kw7fetjn6cF" } ``` ## Beta › Organization › Spend Limits ### Set Spend Limit **POST** `/v1/organizations/spend_limits` Set a spend limit. Upsert keyed on (scope, period): setting a limit that already exists overwrites it in place. A Claude Enterprise organization sets `user` limits. Its seat-tier, group, and organization-level defaults are configured in claude.ai. A Claude Console organization sets `organization` and `workspace` limits, which are monthly and always carry an amount. Setting those limits is in an early access preview. To request access, contact your Anthropic account team. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `amount: string or null` Limit amount as a non-negative integer decimal string in the minor unit of the organization's billing currency (cents for USD): "50000" is $500.00. `null` sets an explicit no-limit override for this scope and `period` only — each period resolves independently, so caps for other periods still apply. - `scope: BetaSpendLimitUserScope or BetaSpendLimitOrganizationScope or BetaSpendLimitWorkspaceScope` What the limit applies to. Claude Enterprise organizations set `user` limits. Claude Console organizations set `organization` and `workspace` limits. Any other combination returns 400. Setting `organization` and `workspace` limits through the API is in an early access preview. To request access, contact your Anthropic account team. - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `type: "user"` Scope type. Always `user` for this scope. default: user - `user_id: string` Tagged ID of the member the spend limit applies to. - `BetaSpendLimitOrganizationScope object` - `type: "organization"` default: organization - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `type: "workspace"` Scope type. Always `workspace` for this scope. default: workspace - `workspace_id: string` Tagged ID of the workspace the spend limit applies to. - `period: optional BetaSpendLimitPeriod` - `"daily"` - `"monthly"` - `"weekly"` #### Returns - `BetaSpendLimit object` A configured spend limit: a cap on metered spend for one scope and period. - `type: "spend_limit"` Object type. Always `spend_limit`. default: spend_limit - `id: string` Unique tagged ID of the spend limit (`spl_...`). - `amount: string or null` Limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD): "50000" is $500.00. `null` means no numeric cap is configured at this scope — see the effective report for whether a limit applies. - `created_at: string` RFC 3339 datetime at which the spend limit was created. format: date-time - `currency: string` ISO 4217 code of the organization's billing currency; the unit for `amount`. - `is_enabled: boolean` Read-only. `false` when extra usage is switched off for this organization (`organization` limit); `amount` is kept and applies again when it's switched back on. Always `true` for other limits. - `period: BetaSpendLimitPeriod` Length of the window the limit resets over. `amount` caps spend within each period. - `"daily"` - `"monthly"` - `"weekly"` - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more` What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope. - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `type: "user"` Scope type. Always `user` for this scope. default: user - `user_id: string` Tagged ID of the member the spend limit applies to. - `BetaSpendLimitSeatTierScope object` - `type: "seat_tier"` default: seat_tier - `seat_tier: string` - `BetaSpendLimitRBACGroupScope object` - `type: "rbac_group"` default: rbac_group - `rbac_group_id: string` - `BetaSpendLimitOrganizationServiceScope object` - `type: "organization_service"` default: organization_service - `service: string` - `BetaSpendLimitOrganizationScope object` - `type: "organization"` default: organization - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `type: "workspace"` Scope type. Always `workspace` for this scope. default: workspace - `workspace_id: string` Tagged ID of the workspace the spend limit applies to. - `BetaSpendLimitUsageTierScope object` Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same. - `type: "usage_tier"` Scope type. Always `usage_tier` for this scope. default: usage_tier - `updated_at: string` RFC 3339 datetime at which the spend limit was last modified. format: date-time #### Example ```bash curl https://api.anthropic.com/v1/organizations/spend_limits \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "amount": "50000", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "period": "monthly" }' ``` ##### Response (200) ```json { "id": "id", "amount": "50000", "created_at": "2019-12-27T18:11:19.117Z", "currency": "USD", "is_enabled": true, "period": "daily", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "type": "spend_limit", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ### Get Spend Limit **GET** `/v1/organizations/spend_limits/{spend_limit_id}` Retrieve a spend limit by ID. #### Path parameters - `spend_limit_id: string` ID of the Spend Limit. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `BetaSpendLimit object` A configured spend limit: a cap on metered spend for one scope and period. - `type: "spend_limit"` Object type. Always `spend_limit`. default: spend_limit - `id: string` Unique tagged ID of the spend limit (`spl_...`). - `amount: string or null` Limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD): "50000" is $500.00. `null` means no numeric cap is configured at this scope — see the effective report for whether a limit applies. - `created_at: string` RFC 3339 datetime at which the spend limit was created. format: date-time - `currency: string` ISO 4217 code of the organization's billing currency; the unit for `amount`. - `is_enabled: boolean` Read-only. `false` when extra usage is switched off for this organization (`organization` limit); `amount` is kept and applies again when it's switched back on. Always `true` for other limits. - `period: BetaSpendLimitPeriod` Length of the window the limit resets over. `amount` caps spend within each period. - `"daily"` - `"monthly"` - `"weekly"` - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more` What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope. - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `type: "user"` Scope type. Always `user` for this scope. default: user - `user_id: string` Tagged ID of the member the spend limit applies to. - `BetaSpendLimitSeatTierScope object` - `type: "seat_tier"` default: seat_tier - `seat_tier: string` - `BetaSpendLimitRBACGroupScope object` - `type: "rbac_group"` default: rbac_group - `rbac_group_id: string` - `BetaSpendLimitOrganizationServiceScope object` - `type: "organization_service"` default: organization_service - `service: string` - `BetaSpendLimitOrganizationScope object` - `type: "organization"` default: organization - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `type: "workspace"` Scope type. Always `workspace` for this scope. default: workspace - `workspace_id: string` Tagged ID of the workspace the spend limit applies to. - `BetaSpendLimitUsageTierScope object` Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same. - `type: "usage_tier"` Scope type. Always `usage_tier` for this scope. default: usage_tier - `updated_at: string` RFC 3339 datetime at which the spend limit was last modified. format: date-time #### Example ```bash curl https://api.anthropic.com/v1/organizations/spend_limits/$SPEND_LIMIT_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "amount": "50000", "created_at": "2019-12-27T18:11:19.117Z", "currency": "USD", "is_enabled": true, "period": "daily", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "type": "spend_limit", "updated_at": "2019-12-27T18:11:19.117Z" } ``` ### Delete Spend Limit **DELETE** `/v1/organizations/spend_limits/{spend_limit_id}` Delete a spend limit. For a Claude Enterprise organization, this deletes a per-user override, and the member falls back to any inherited spend limit at that period. Its seat-tier, group, and organization-level rows cannot be deleted via this endpoint. A Claude Console organization deletes its organization and workspace limits, but not its `usage_tier` limit. Deleting organization and workspace limits through the API is in an early access preview. #### Path parameters - `spend_limit_id: string` ID of the Spend Limit. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `type: "spend_limit_deleted"` default: spend_limit_deleted - `id: string` #### Example ```bash curl https://api.anthropic.com/v1/organizations/spend_limits/$SPEND_LIMIT_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "type": "spend_limit_deleted" } ``` ### List Spend Limits **GET** `/v1/organizations/spend_limits` List the organization's spend limits. Limits are grouped by scope type, in the order `organization`, `seat_tier`, `rbac_group`, `organization_service`, `user`; within a type they come in a fixed order that is not creation order. Supported for Claude Enterprise organizations only, not for Claude Console organizations. #### Query parameters - `limit: optional number` Maximum number of limits per page. Defaults to `20`. default: 20, minimum: 1, maximum: 1000 - `page: optional string` Opaque cursor from a previous response's `next_page` field. - `scope_type: optional array of "organization" or "organization_service" or "rbac_group" or 3 more` Return only limits with these scope types. Omit for all. maxItems: 100 - `"organization"` - `"organization_service"` - `"rbac_group"` - `"seat_tier"` - `"user"` - `"workspace"` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `spend-limit-reads-2026-09-26` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaSpendLimit` - `type: "spend_limit"` Object type. Always `spend_limit`. default: spend_limit - `id: string` Unique tagged ID of the spend limit (`spl_...`). - `amount: string or null` Limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD): "50000" is $500.00. `null` means no numeric cap is configured at this scope — see the effective report for whether a limit applies. - `created_at: string` RFC 3339 datetime at which the spend limit was created. format: date-time - `currency: string` ISO 4217 code of the organization's billing currency; the unit for `amount`. - `is_enabled: boolean` Read-only. `false` when extra usage is switched off for this organization (`organization` limit); `amount` is kept and applies again when it's switched back on. Always `true` for other limits. - `period: BetaSpendLimitPeriod` Length of the window the limit resets over. `amount` caps spend within each period. - `"daily"` - `"monthly"` - `"weekly"` - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more` What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope. - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `type: "user"` Scope type. Always `user` for this scope. default: user - `user_id: string` Tagged ID of the member the spend limit applies to. - `BetaSpendLimitSeatTierScope object` - `type: "seat_tier"` default: seat_tier - `seat_tier: string` - `BetaSpendLimitRBACGroupScope object` - `type: "rbac_group"` default: rbac_group - `rbac_group_id: string` - `BetaSpendLimitOrganizationServiceScope object` - `type: "organization_service"` default: organization_service - `service: string` - `BetaSpendLimitOrganizationScope object` - `type: "organization"` default: organization - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `type: "workspace"` Scope type. Always `workspace` for this scope. default: workspace - `workspace_id: string` Tagged ID of the workspace the spend limit applies to. - `BetaSpendLimitUsageTierScope object` Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same. - `type: "usage_tier"` Scope type. Always `usage_tier` for this scope. default: usage_tier - `updated_at: string` RFC 3339 datetime at which the spend limit was last modified. format: date-time - `next_page: string or null` #### Example ```bash curl https://api.anthropic.com/v1/organizations/spend_limits \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: spend-limit-reads-2026-09-26' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "id", "amount": "50000", "created_at": "2019-12-27T18:11:19.117Z", "currency": "USD", "is_enabled": true, "period": "daily", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "type": "spend_limit", "updated_at": "2019-12-27T18:11:19.117Z" } ], "next_page": "next_page" } ``` ## Beta › Organization › Spend Limits › Effective ### List Effective Spend Limits **GET** `/v1/organizations/spend_limits/effective` List each member's effective spend limit and period-to-date spend. Returns one row per (member, period) the member resolves a spend limit for, with the `source` scope the spend limit was inherited from. Paginates by member, so a member's periods never split across pages. Supported for Claude Enterprise organizations only, not for Claude Console organizations. #### Query parameters - `limit: optional number` Maximum number of members per page. A member's period rows never split across pages, so a page may carry more rows than this. Defaults to `20`. default: 20, minimum: 1, maximum: 1000 - `page: optional string` Opaque cursor from a previous response's `next_page` field. - `period: optional array of "daily" or "monthly" or "weekly"` Restrict the report to these limit periods. Omit to return one row per period each member resolves a spend limit for. maxItems: 3 - `"daily"` - `"monthly"` - `"weekly"` - `user_ids: optional array of string` Restrict the report to these members, by tagged user ID (`user_...`). At most 100 entries. maxItems: 100 #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaSpendSummary` - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor` - `BetaSpendLimitUserActor object` A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts. - `type: "user_actor"` Actor type. Always `user_actor`. default: user_actor - `deleted: boolean` True only when the underlying account has been deleted. default: false - `email_address: string or null` The user's email address. Null when the account is unavailable or has been deleted. - `name: string or null` The user's current display name. Null when the account is unavailable, has been deleted, or has no name set. - `user_id: string` Tagged ID of the user. - `BetaSpendLimitScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization. - `type: "scoped_api_key_actor"` default: scoped_api_key_actor - `scoped_api_key_id: string` - `amount: string or null` Effective limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD). `null` means no limit applies for this row's `period` — each period resolves independently, so another period may still cap this member. - `currency: string` ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`. - `period: BetaSpendLimitPeriod` Period this row's effective limit and spend are reported for. - `"daily"` - `"monthly"` - `"weekly"` - `period_to_date_spend: string` The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable. - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more` - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `type: "user"` Scope type. Always `user` for this scope. default: user - `user_id: string` Tagged ID of the member the spend limit applies to. - `BetaSpendLimitSeatTierScope object` - `type: "seat_tier"` default: seat_tier - `seat_tier: string` - `BetaSpendLimitRBACGroupScope object` - `type: "rbac_group"` default: rbac_group - `rbac_group_id: string` - `BetaSpendLimitOrganizationServiceScope object` - `type: "organization_service"` default: organization_service - `service: string` - `BetaSpendLimitOrganizationScope object` - `type: "organization"` default: organization - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `type: "workspace"` Scope type. Always `workspace` for this scope. default: workspace - `workspace_id: string` Tagged ID of the workspace the spend limit applies to. - `BetaSpendLimitUsageTierScope object` Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same. - `type: "usage_tier"` Scope type. Always `usage_tier` for this scope. default: usage_tier - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more` - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `BetaSpendLimitSeatTierScope object` - `BetaSpendLimitRBACGroupScope object` - `BetaSpendLimitOrganizationServiceScope object` - `BetaSpendLimitOrganizationScope object` - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `BetaSpendLimitUsageTierScope object` Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same. - `spend_limit_id: string` - `next_page: string or null` #### Example ```bash curl https://api.anthropic.com/v1/organizations/spend_limits/effective \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD", "period": "daily", "period_to_date_spend": "12050.5", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "source": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit_id": "spend_limit_id" } ], "next_page": "next_page" } ``` ## Beta › Organization › Spend Limits › Increase Requests ### List Spend Limit Increase Requests **GET** `/v1/organizations/spend_limit_increase_requests` List spend limit increase requests, most recent first. Pending requests include a live `spend_summary` for the requester. Requests whose requester is no longer a member are excluded. #### Query parameters - `actor_ids: optional array of string` Filter by requester, as `user_...` tagged IDs. - `limit: optional number` default: 20, minimum: 1, maximum: 1000 - `page: optional string` Opaque cursor from a previous response's `next_page`. - `status: optional array of BetaSpendLimitIncreaseRequestStatus` Filter by status. Omit to return all. - `"approved"` - `"denied"` - `"pending"` #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaSpendLimitIncreaseRequest` - `type: "spend_limit_increase_request"` default: spend_limit_increase_request - `id: string` - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor` - `BetaSpendLimitUserActor object` A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts. - `type: "user_actor"` Actor type. Always `user_actor`. default: user_actor - `deleted: boolean` True only when the underlying account has been deleted. default: false - `email_address: string or null` The user's email address. Null when the account is unavailable or has been deleted. - `name: string or null` The user's current display name. Null when the account is unavailable, has been deleted, or has no name set. - `user_id: string` Tagged ID of the user. - `BetaSpendLimitScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization. - `type: "scoped_api_key_actor"` default: scoped_api_key_actor - `scoped_api_key_id: string` - `created_at: string` format: date-time - `period: BetaSpendLimitPeriod` - `"daily"` - `"monthly"` - `"weekly"` - `resolved_at: string or null` format: date-time - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null` - `BetaSpendLimitUserActor object` A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts. - `BetaSpendLimitScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization. - `spend_summary: BetaSpendSummary or null` Per-member effective-limit report row (`GET /spend_limits/effective`). - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor` - `BetaSpendLimitUserActor object` A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts. - `BetaSpendLimitScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization. - `amount: string or null` Effective limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD). `null` means no limit applies for this row's `period` — each period resolves independently, so another period may still cap this member. - `currency: string` ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`. - `period: BetaSpendLimitPeriod` Period this row's effective limit and spend are reported for. - `period_to_date_spend: string` The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable. - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more` - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `type: "user"` Scope type. Always `user` for this scope. default: user - `user_id: string` Tagged ID of the member the spend limit applies to. - `BetaSpendLimitSeatTierScope object` - `type: "seat_tier"` default: seat_tier - `seat_tier: string` - `BetaSpendLimitRBACGroupScope object` - `type: "rbac_group"` default: rbac_group - `rbac_group_id: string` - `BetaSpendLimitOrganizationServiceScope object` - `type: "organization_service"` default: organization_service - `service: string` - `BetaSpendLimitOrganizationScope object` - `type: "organization"` default: organization - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `type: "workspace"` Scope type. Always `workspace` for this scope. default: workspace - `workspace_id: string` Tagged ID of the workspace the spend limit applies to. - `BetaSpendLimitUsageTierScope object` Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same. - `type: "usage_tier"` Scope type. Always `usage_tier` for this scope. default: usage_tier - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more` - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `BetaSpendLimitSeatTierScope object` - `BetaSpendLimitRBACGroupScope object` - `BetaSpendLimitOrganizationServiceScope object` - `BetaSpendLimitOrganizationScope object` - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `BetaSpendLimitUsageTierScope object` Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same. - `spend_limit_id: string` - `status: BetaSpendLimitIncreaseRequestStatus` - `"approved"` - `"denied"` - `"pending"` - `next_page: string or null` #### Example ```bash curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "id", "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "daily", "resolved_at": "2019-12-27T18:11:19.117Z", "resolved_by": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_summary": { "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD", "period": "daily", "period_to_date_spend": "12050.5", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "source": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit_id": "spend_limit_id" }, "status": "approved", "type": "spend_limit_increase_request" } ], "next_page": "next_page" } ``` ### Get Spend Limit Increase Request **GET** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}` Retrieve a spend limit increase request. While `pending`, the response includes a live `spend_summary` for the requester at the request's period. #### Path parameters - `spend_limit_increase_request_id: string` ID of the spend limit increase request. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `BetaSpendLimitIncreaseRequest object` - `type: "spend_limit_increase_request"` default: spend_limit_increase_request - `id: string` - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor` - `BetaSpendLimitUserActor object` A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts. - `type: "user_actor"` Actor type. Always `user_actor`. default: user_actor - `deleted: boolean` True only when the underlying account has been deleted. default: false - `email_address: string or null` The user's email address. Null when the account is unavailable or has been deleted. - `name: string or null` The user's current display name. Null when the account is unavailable, has been deleted, or has no name set. - `user_id: string` Tagged ID of the user. - `BetaSpendLimitScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization. - `type: "scoped_api_key_actor"` default: scoped_api_key_actor - `scoped_api_key_id: string` - `created_at: string` format: date-time - `period: BetaSpendLimitPeriod` - `"daily"` - `"monthly"` - `"weekly"` - `resolved_at: string or null` format: date-time - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null` - `BetaSpendLimitUserActor object` A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts. - `BetaSpendLimitScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization. - `spend_summary: BetaSpendSummary or null` Per-member effective-limit report row (`GET /spend_limits/effective`). - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor` - `BetaSpendLimitUserActor object` A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts. - `BetaSpendLimitScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization. - `amount: string or null` Effective limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD). `null` means no limit applies for this row's `period` — each period resolves independently, so another period may still cap this member. - `currency: string` ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`. - `period: BetaSpendLimitPeriod` Period this row's effective limit and spend are reported for. - `period_to_date_spend: string` The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable. - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more` - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `type: "user"` Scope type. Always `user` for this scope. default: user - `user_id: string` Tagged ID of the member the spend limit applies to. - `BetaSpendLimitSeatTierScope object` - `type: "seat_tier"` default: seat_tier - `seat_tier: string` - `BetaSpendLimitRBACGroupScope object` - `type: "rbac_group"` default: rbac_group - `rbac_group_id: string` - `BetaSpendLimitOrganizationServiceScope object` - `type: "organization_service"` default: organization_service - `service: string` - `BetaSpendLimitOrganizationScope object` - `type: "organization"` default: organization - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `type: "workspace"` Scope type. Always `workspace` for this scope. default: workspace - `workspace_id: string` Tagged ID of the workspace the spend limit applies to. - `BetaSpendLimitUsageTierScope object` Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same. - `type: "usage_tier"` Scope type. Always `usage_tier` for this scope. default: usage_tier - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more` - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `BetaSpendLimitSeatTierScope object` - `BetaSpendLimitRBACGroupScope object` - `BetaSpendLimitOrganizationServiceScope object` - `BetaSpendLimitOrganizationScope object` - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `BetaSpendLimitUsageTierScope object` Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same. - `spend_limit_id: string` - `status: BetaSpendLimitIncreaseRequestStatus` - `"approved"` - `"denied"` - `"pending"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "daily", "resolved_at": "2019-12-27T18:11:19.117Z", "resolved_by": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_summary": { "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD", "period": "daily", "period_to_date_spend": "12050.5", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "source": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit_id": "spend_limit_id" }, "status": "approved", "type": "spend_limit_increase_request" } ``` ### Approve Spend Limit Increase Request **POST** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve` Approve a pending spend limit increase request. Writes a per-user spend limit at `amount` for the requester and transitions the request to `approved`. `period` defaults to the period the member was blocked on. Anthropic emails the requester unless `suppress_notification` is set. #### Path parameters - `spend_limit_increase_request_id: string` ID of the spend limit increase request. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Body parameters - `amount: string` New per-user spend limit as a non-negative integer decimal string (minor units). - `period: optional BetaSpendLimitPeriod or null` - `"daily"` - `"monthly"` - `"weekly"` - `suppress_notification: optional boolean` #### Returns - `type: "spend_limit_increase_request"` default: spend_limit_increase_request - `id: string` - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor` - `BetaSpendLimitUserActor object` A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts. - `type: "user_actor"` Actor type. Always `user_actor`. default: user_actor - `deleted: boolean` True only when the underlying account has been deleted. default: false - `email_address: string or null` The user's email address. Null when the account is unavailable or has been deleted. - `name: string or null` The user's current display name. Null when the account is unavailable, has been deleted, or has no name set. - `user_id: string` Tagged ID of the user. - `BetaSpendLimitScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization. - `type: "scoped_api_key_actor"` default: scoped_api_key_actor - `scoped_api_key_id: string` - `created_at: string` format: date-time - `period: BetaSpendLimitPeriod` - `"daily"` - `"monthly"` - `"weekly"` - `resolved_at: string or null` format: date-time - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null` - `BetaSpendLimitUserActor object` A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts. - `BetaSpendLimitScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization. - `spend_limit: BetaSpendLimit` A configured spend limit: a cap on metered spend for one scope and period. - `type: "spend_limit"` Object type. Always `spend_limit`. default: spend_limit - `id: string` Unique tagged ID of the spend limit (`spl_...`). - `amount: string or null` Limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD): "50000" is $500.00. `null` means no numeric cap is configured at this scope — see the effective report for whether a limit applies. - `created_at: string` RFC 3339 datetime at which the spend limit was created. format: date-time - `currency: string` ISO 4217 code of the organization's billing currency; the unit for `amount`. - `is_enabled: boolean` Read-only. `false` when extra usage is switched off for this organization (`organization` limit); `amount` is kept and applies again when it's switched back on. Always `true` for other limits. - `period: BetaSpendLimitPeriod` Length of the window the limit resets over. `amount` caps spend within each period. - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more` What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope. - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `type: "user"` Scope type. Always `user` for this scope. default: user - `user_id: string` Tagged ID of the member the spend limit applies to. - `BetaSpendLimitSeatTierScope object` - `type: "seat_tier"` default: seat_tier - `seat_tier: string` - `BetaSpendLimitRBACGroupScope object` - `type: "rbac_group"` default: rbac_group - `rbac_group_id: string` - `BetaSpendLimitOrganizationServiceScope object` - `type: "organization_service"` default: organization_service - `service: string` - `BetaSpendLimitOrganizationScope object` - `type: "organization"` default: organization - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `type: "workspace"` Scope type. Always `workspace` for this scope. default: workspace - `workspace_id: string` Tagged ID of the workspace the spend limit applies to. - `BetaSpendLimitUsageTierScope object` Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same. - `type: "usage_tier"` Scope type. Always `usage_tier` for this scope. default: usage_tier - `updated_at: string` RFC 3339 datetime at which the spend limit was last modified. format: date-time - `spend_summary: BetaSpendSummary or null` Per-member effective-limit report row (`GET /spend_limits/effective`). - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor` - `BetaSpendLimitUserActor object` A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts. - `BetaSpendLimitScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization. - `amount: string or null` Effective limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD). `null` means no limit applies for this row's `period` — each period resolves independently, so another period may still cap this member. - `currency: string` ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`. - `period: BetaSpendLimitPeriod` Period this row's effective limit and spend are reported for. - `period_to_date_spend: string` The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable. - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more` - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `BetaSpendLimitSeatTierScope object` - `BetaSpendLimitRBACGroupScope object` - `BetaSpendLimitOrganizationServiceScope object` - `BetaSpendLimitOrganizationScope object` - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `BetaSpendLimitUsageTierScope object` Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same. - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more` - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `BetaSpendLimitSeatTierScope object` - `BetaSpendLimitRBACGroupScope object` - `BetaSpendLimitOrganizationServiceScope object` - `BetaSpendLimitOrganizationScope object` - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `BetaSpendLimitUsageTierScope object` Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same. - `spend_limit_id: string` - `status: BetaSpendLimitIncreaseRequestStatus` - `"approved"` - `"denied"` - `"pending"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/approve \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "amount": "50000", "period": "monthly" }' ``` ##### Response (200) ```json { "id": "id", "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "daily", "resolved_at": "2019-12-27T18:11:19.117Z", "resolved_by": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit": { "id": "id", "amount": "50000", "created_at": "2019-12-27T18:11:19.117Z", "currency": "USD", "is_enabled": true, "period": "daily", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "type": "spend_limit", "updated_at": "2019-12-27T18:11:19.117Z" }, "spend_summary": { "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD", "period": "daily", "period_to_date_spend": "12050.5", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "source": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit_id": "spend_limit_id" }, "status": "approved", "type": "spend_limit_increase_request" } ``` ### Deny Spend Limit Increase Request **POST** `/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny` Deny a pending spend limit increase request. Idempotent on `denied`; denying an already-`approved` request returns 400. Anthropic emails the requester unless `suppress_notification` is set. #### Path parameters - `spend_limit_increase_request_id: string` ID of the spend limit increase request. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Body parameters - `suppress_notification: optional boolean` #### Returns - `BetaSpendLimitIncreaseRequest object` - `type: "spend_limit_increase_request"` default: spend_limit_increase_request - `id: string` - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor` - `BetaSpendLimitUserActor object` A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts. - `type: "user_actor"` Actor type. Always `user_actor`. default: user_actor - `deleted: boolean` True only when the underlying account has been deleted. default: false - `email_address: string or null` The user's email address. Null when the account is unavailable or has been deleted. - `name: string or null` The user's current display name. Null when the account is unavailable, has been deleted, or has no name set. - `user_id: string` Tagged ID of the user. - `BetaSpendLimitScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization. - `type: "scoped_api_key_actor"` default: scoped_api_key_actor - `scoped_api_key_id: string` - `created_at: string` format: date-time - `period: BetaSpendLimitPeriod` - `"daily"` - `"monthly"` - `"weekly"` - `resolved_at: string or null` format: date-time - `resolved_by: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor or null` - `BetaSpendLimitUserActor object` A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts. - `BetaSpendLimitScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization. - `spend_summary: BetaSpendSummary or null` Per-member effective-limit report row (`GET /spend_limits/effective`). - `actor: BetaSpendLimitUserActor or BetaSpendLimitScopedAPIKeyActor` - `BetaSpendLimitUserActor object` A user within the organization. `name` and `email_address` are null when the underlying account is unavailable or has been deleted; `deleted` is true only for deleted accounts. - `BetaSpendLimitScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization. - `amount: string or null` Effective limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD). `null` means no limit applies for this row's `period` — each period resolves independently, so another period may still cap this member. - `currency: string` ISO 4217 code of the organization's billing currency; the unit for `amount` and `period_to_date_spend`. - `period: BetaSpendLimitPeriod` Period this row's effective limit and spend are reported for. - `period_to_date_spend: string` The member's spend so far in the current period, as a non-negative decimal string in the minor unit of `currency` (cents for USD). May carry fractional minor units up to three decimal places (e.g. `"12050.5"`) — metered usage is not rounded to whole cents. Reads as `"0"` when the spend reading is temporarily unavailable. - `scope: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more` - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `type: "user"` Scope type. Always `user` for this scope. default: user - `user_id: string` Tagged ID of the member the spend limit applies to. - `BetaSpendLimitSeatTierScope object` - `type: "seat_tier"` default: seat_tier - `seat_tier: string` - `BetaSpendLimitRBACGroupScope object` - `type: "rbac_group"` default: rbac_group - `rbac_group_id: string` - `BetaSpendLimitOrganizationServiceScope object` - `type: "organization_service"` default: organization_service - `service: string` - `BetaSpendLimitOrganizationScope object` - `type: "organization"` default: organization - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `type: "workspace"` Scope type. Always `workspace` for this scope. default: workspace - `workspace_id: string` Tagged ID of the workspace the spend limit applies to. - `BetaSpendLimitUsageTierScope object` Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same. - `type: "usage_tier"` Scope type. Always `usage_tier` for this scope. default: usage_tier - `source: BetaSpendLimitUserScope or BetaSpendLimitSeatTierScope or BetaSpendLimitRBACGroupScope or 4 more` - `BetaSpendLimitUserScope object` Scope selecting a single member of the organization. - `BetaSpendLimitSeatTierScope object` - `BetaSpendLimitRBACGroupScope object` - `BetaSpendLimitOrganizationServiceScope object` - `BetaSpendLimitOrganizationScope object` - `BetaSpendLimitWorkspaceScope object` Scope selecting one workspace of a Claude Console organization. - `BetaSpendLimitUsageTierScope object` Scope of the monthly spend cap Anthropic sets for a Claude Console organization from its usage tier, or a higher cap Anthropic granted the organization. Read-only; its `created_at` and `updated_at` are the organization's creation time, so `amount` can change while `updated_at` stays the same. - `spend_limit_id: string` - `status: BetaSpendLimitIncreaseRequestStatus` - `"approved"` - `"denied"` - `"pending"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID/deny \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{}' ``` ##### Response (200) ```json { "id": "id", "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "daily", "resolved_at": "2019-12-27T18:11:19.117Z", "resolved_by": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_summary": { "actor": { "deleted": true, "email_address": "email_address", "name": "name", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD", "period": "daily", "period_to_date_spend": "12050.5", "scope": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "source": { "type": "user", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit_id": "spend_limit_id" }, "status": "approved", "type": "spend_limit_increase_request" } ``` ## Beta › Organization › RBAC Groups ### Create RBAC Group **POST** `/v1/organizations/rbac_groups` Create an RBAC Group in the Claude Enterprise tenant. Groups created via the API have source type `"direct"`. The RBAC Groups API is available to Claude Enterprise organizations only. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Body parameters - `name: string` Name of the RBAC Group. Not uniqueness-enforced. minLength: 1, maxLength: 255 #### Returns - `BetaRBACGroup object` - `type: "rbac_group"` Object type. For RBAC Groups, this is always `"rbac_group"`. default: rbac_group - `id: string` ID of the RBAC Group. - `created_at: string` RFC 3339 timestamp of when the RBAC Group was created. format: date-time - `name: string` Name of the RBAC Group. Not uniqueness-enforced. - `role_ids: array of string or null` RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list. - `source_type: "direct" or "scim"` How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider. - `"direct"` - `"scim"` - `updated_at: string` RFC 3339 timestamp of when the RBAC Group was last updated. format: date-time - `roles: array of string or null` **Deprecated**: Use `role_ids` instead; `roles` always has the same value. Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included. #### Example ```bash curl https://api.anthropic.com/v1/organizations/rbac_groups \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "name": "Engineering" }' ``` ##### Response (200) ```json { "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "created_at": "2024-10-30T23:58:27.427722Z", "name": "Engineering", "role_ids": [ "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s" ], "roles": [ "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s" ], "source_type": "direct", "type": "rbac_group", "updated_at": "2024-10-30T23:58:27.427722Z" } ``` ### List RBAC Groups **GET** `/v1/organizations/rbac_groups` List RBAC Groups in the Claude Enterprise tenant. The RBAC Groups API is available to Claude Enterprise organizations only. #### Query parameters - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 - `page: optional string` Optionally set to the `next_page` token from the previous response. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaRBACGroup` - `type: "rbac_group"` Object type. For RBAC Groups, this is always `"rbac_group"`. default: rbac_group - `id: string` ID of the RBAC Group. - `created_at: string` RFC 3339 timestamp of when the RBAC Group was created. format: date-time - `name: string` Name of the RBAC Group. Not uniqueness-enforced. - `role_ids: array of string or null` RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list. - `source_type: "direct" or "scim"` How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider. - `"direct"` - `"scim"` - `updated_at: string` RFC 3339 timestamp of when the RBAC Group was last updated. format: date-time - `roles: array of string or null` **Deprecated**: Use `role_ids` instead; `roles` always has the same value. Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included. - `has_more: boolean` Indicates if there are more results in the requested page direction. - `next_page: string or null` Token to provide in as `page` in the subsequent request to retrieve the next page of data. #### Example ```bash curl https://api.anthropic.com/v1/organizations/rbac_groups \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "created_at": "2024-10-30T23:58:27.427722Z", "name": "Engineering", "role_ids": [ "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s" ], "roles": [ "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s" ], "source_type": "direct", "type": "rbac_group", "updated_at": "2024-10-30T23:58:27.427722Z" } ], "has_more": false, "next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9" } ``` ### Get RBAC Group **GET** `/v1/organizations/rbac_groups/{rbac_group_id}` Retrieve an RBAC Group by ID. The RBAC Groups API is available to Claude Enterprise organizations only. #### Path parameters - `rbac_group_id: string` ID of the RBAC Group. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `BetaRBACGroup object` - `type: "rbac_group"` Object type. For RBAC Groups, this is always `"rbac_group"`. default: rbac_group - `id: string` ID of the RBAC Group. - `created_at: string` RFC 3339 timestamp of when the RBAC Group was created. format: date-time - `name: string` Name of the RBAC Group. Not uniqueness-enforced. - `role_ids: array of string or null` RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list. - `source_type: "direct" or "scim"` How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider. - `"direct"` - `"scim"` - `updated_at: string` RFC 3339 timestamp of when the RBAC Group was last updated. format: date-time - `roles: array of string or null` **Deprecated**: Use `role_ids` instead; `roles` always has the same value. Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included. #### Example ```bash curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "created_at": "2024-10-30T23:58:27.427722Z", "name": "Engineering", "role_ids": [ "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s" ], "roles": [ "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s" ], "source_type": "direct", "type": "rbac_group", "updated_at": "2024-10-30T23:58:27.427722Z" } ``` ### Update RBAC Group **POST** `/v1/organizations/rbac_groups/{rbac_group_id}` Update an RBAC Group's name. Groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning. The RBAC Groups API is available to Claude Enterprise organizations only. #### Path parameters - `rbac_group_id: string` ID of the RBAC Group. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Body parameters - `name: optional string or null` Name of the RBAC Group. Not uniqueness-enforced. minLength: 1, maxLength: 255 #### Returns - `BetaRBACGroup object` - `type: "rbac_group"` Object type. For RBAC Groups, this is always `"rbac_group"`. default: rbac_group - `id: string` ID of the RBAC Group. - `created_at: string` RFC 3339 timestamp of when the RBAC Group was created. format: date-time - `name: string` Name of the RBAC Group. Not uniqueness-enforced. - `role_ids: array of string or null` RBAC Role IDs attached to this RBAC Group. Role attachment is managed in the admin settings and is read-only on this API. `null` means role data was temporarily unavailable — retry to distinguish from an empty list. - `source_type: "direct" or "scim"` How the RBAC Group was created: `"direct"` for groups created directly (for example, in the organization's admin settings), `"scim"` for groups provisioned by the identity provider. - `"direct"` - `"scim"` - `updated_at: string` RFC 3339 timestamp of when the RBAC Group was last updated. format: date-time - `roles: array of string or null` **Deprecated**: Use `role_ids` instead; `roles` always has the same value. Deprecated: use `role_ids` instead. IDs of the RBAC Roles attached to this RBAC Group; always the same value as `role_ids`, `null` included. #### Example ```bash curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "name": "Engineering" }' ``` ##### Response (200) ```json { "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "created_at": "2024-10-30T23:58:27.427722Z", "name": "Engineering", "role_ids": [ "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s" ], "roles": [ "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s" ], "source_type": "direct", "type": "rbac_group", "updated_at": "2024-10-30T23:58:27.427722Z" } ``` ### Delete RBAC Group **DELETE** `/v1/organizations/rbac_groups/{rbac_group_id}` Delete an RBAC Group. Groups provisioned by an identity provider (source type `"scim"`) cannot be deleted via the API while an organization in the tenant uses SCIM provisioning. The RBAC Groups API is available to Claude Enterprise organizations only. #### Path parameters - `rbac_group_id: string` ID of the RBAC Group. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `type: "rbac_group_deleted"` Deleted object type. For RBAC Groups, this is always `"rbac_group_deleted"`. default: rbac_group_deleted - `id: string` ID of the RBAC Group. #### Example ```bash curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "type": "rbac_group_deleted" } ``` ## Beta › Organization › RBAC Groups › Members ### List RBAC Group Members **GET** `/v1/organizations/rbac_groups/{rbac_group_id}/members` List members of an RBAC Group. The RBAC Groups API is available to Claude Enterprise organizations only. #### Path parameters - `rbac_group_id: string` ID of the RBAC Group. #### Query parameters - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 - `page: optional string` Optionally set to the `next_page` token from the previous response. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaRBACGroupMember` - `type: "rbac_group_member"` Object type. For RBAC Group Members, this is always `"rbac_group_member"`. default: rbac_group_member - `created_at: string` RFC 3339 timestamp of when the User was added to the RBAC Group. format: date-time - `email: string` Email of the User. - `rbac_group_id: string` ID of the RBAC Group. - `user_id: string` ID of the User. - `group_id: string` **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value. Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`. - `has_more: boolean` Indicates if there are more results in the requested page direction. - `next_page: string or null` Token to provide in as `page` in the subsequent request to retrieve the next page of data. #### Example ```bash curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "created_at": "2024-10-30T23:58:27.427722Z", "email": "user@emaildomain.com", "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "type": "rbac_group_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" } ], "has_more": false, "next_page": "eyJjdXJzb3IiOiAicmJhY19ncm91cF8wMSJ9" } ``` ### Add RBAC Group Member **POST** `/v1/organizations/rbac_groups/{rbac_group_id}/members` Add a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning. The RBAC Groups API is available to Claude Enterprise organizations only. #### Path parameters - `rbac_group_id: string` ID of the RBAC Group. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Body parameters - `user_id: string` ID of the User. #### Returns - `BetaRBACGroupMember object` - `type: "rbac_group_member"` Object type. For RBAC Group Members, this is always `"rbac_group_member"`. default: rbac_group_member - `created_at: string` RFC 3339 timestamp of when the User was added to the RBAC Group. format: date-time - `email: string` Email of the User. - `rbac_group_id: string` ID of the RBAC Group. - `user_id: string` ID of the User. - `group_id: string` **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value. Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`. #### Example ```bash curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }' ``` ##### Response (200) ```json { "created_at": "2024-10-30T23:58:27.427722Z", "email": "user@emaildomain.com", "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "type": "rbac_group_member", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" } ``` ### Remove RBAC Group Member **DELETE** `/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}` Remove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type `"scim"`) cannot be modified via the API while an organization in the tenant uses SCIM provisioning. The RBAC Groups API is available to Claude Enterprise organizations only. #### Path parameters - `rbac_group_id: string` ID of the RBAC Group. - `user_id: string` ID of the User. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `type: "rbac_group_member_deleted"` Deleted object type. For RBAC Group Members, this is always `"rbac_group_member_deleted"`. default: rbac_group_member_deleted - `rbac_group_id: string` ID of the RBAC Group. - `user_id: string` ID of the User. - `group_id: string` **Deprecated**: Use `rbac_group_id` instead; `group_id` always has the same value. Deprecated: use `rbac_group_id` instead. ID of the RBAC Group; always the same value as `rbac_group_id`. #### Example ```bash curl https://api.anthropic.com/v1/organizations/rbac_groups/$RBAC_GROUP_ID/members/$USER_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "type": "rbac_group_member_deleted", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" } ``` ## Beta › Organization › RBAC Roles ### List RBAC Roles **GET** `/v1/organizations/rbac_roles` List RBAC Roles in the organization. The RBAC Roles API is available to Claude Enterprise organizations only. #### Query parameters - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 - `page: optional string` Optionally set to the `next_page` token from the previous response. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaRBACRole` - `type: "rbac_role"` Object type. For RBAC Roles, this is always `"rbac_role"`. default: rbac_role - `id: string` ID of the RBAC Role. - `created_at: string` RFC 3339 datetime string indicating when the RBAC Role was created. format: date-time - `display_name: string` Name of the RBAC Role. For a role created by Anthropic, this name can differ from the label claude.ai shows, and Anthropic may change the name. To keep a lasting reference to a role, store its `id`. - `updated_at: string` RFC 3339 datetime string indicating when the RBAC Role was last updated. format: date-time - `name: string` **Deprecated**: Use `display_name` instead; `name` always has the same value. Deprecated: use `display_name` instead. Name of the RBAC Role; always the same value as `display_name`. - `has_more: boolean` Indicates whether there are more results beyond this page. - `next_page: string or null` Opaque cursor for the next page. Pass as the `page` parameter on the next request. #### Example ```bash curl https://api.anthropic.com/v1/organizations/rbac_roles \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s", "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "Project Editor", "name": "Project Editor", "type": "rbac_role", "updated_at": "2024-10-30T23:58:27.427722Z" } ], "has_more": true, "next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0" } ``` ### Get RBAC Role **GET** `/v1/organizations/rbac_roles/{rbac_role_id}` Retrieve an RBAC Role by ID. The RBAC Roles API is available to Claude Enterprise organizations only. #### Path parameters - `rbac_role_id: string` ID of the RBAC Role. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `BetaRBACRole object` - `type: "rbac_role"` Object type. For RBAC Roles, this is always `"rbac_role"`. default: rbac_role - `id: string` ID of the RBAC Role. - `created_at: string` RFC 3339 datetime string indicating when the RBAC Role was created. format: date-time - `display_name: string` Name of the RBAC Role. For a role created by Anthropic, this name can differ from the label claude.ai shows, and Anthropic may change the name. To keep a lasting reference to a role, store its `id`. - `updated_at: string` RFC 3339 datetime string indicating when the RBAC Role was last updated. format: date-time - `name: string` **Deprecated**: Use `display_name` instead; `name` always has the same value. Deprecated: use `display_name` instead. Name of the RBAC Role; always the same value as `display_name`. #### Example ```bash curl https://api.anthropic.com/v1/organizations/rbac_roles/$RBAC_ROLE_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "rbac_role_016J8xVtKpDq3Wy9ZmN2hR4s", "created_at": "2024-10-30T23:58:27.427722Z", "display_name": "Project Editor", "name": "Project Editor", "type": "rbac_role", "updated_at": "2024-10-30T23:58:27.427722Z" } ``` ## Beta › Organization › RBAC Roles › Permissions ### List RBAC Role Permissions **GET** `/v1/organizations/rbac_roles/{rbac_role_id}/permissions` List the permissions an RBAC Role grants. The RBAC Roles API is available to Claude Enterprise organizations only. #### Path parameters - `rbac_role_id: string` ID of the RBAC Role. #### Query parameters - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 - `page: optional string` Optionally set to the `next_page` token from the previous response. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). #### Returns - `data: array of BetaRBACRolePermission` - `type: "rbac_role_permission"` Object type. For RBAC Role Permissions, this is always `"rbac_role_permission"`. default: rbac_role_permission - `action: string` Action the permission grants on the resource. The vocabulary follows the resource: an `organization` grant carries a product-feature entitlement (for example `chat`), an admin-panel permission entitlement (`permission_*`), or a blanket capability-access mode — `capability_access_all` grants every product-feature entitlement, and `capability_access_all_ga` grants the generally-available subset as it stands at permission-check time; neither mode grants model-access entitlements. A consumer enumerating a role's per-feature grants should treat a blanket row as granting every product-feature entitlement it covers, or it will under-report the role's effective access. A `connector_tool` grant carries a tool-access action (`use` or `always_allow`); a `connector_scope` grant carries the scope action `grant` (the role may receive the named OAuth scope when tokens are minted for the connector); `connector` and `all_connectors` grants carry a tool-access action, the scope action, or an authentication-method action (`interactive` or `managed`). - `resource: BetaRBACOrganizationPermissionResource or BetaRBACConnectorToolPermissionResource or BetaRBACConnectorScopePermissionResource or 2 more` What the permission applies to. A tagged union: `type` names the kind of resource and determines which identifier fields are present. - `BetaRBACOrganizationPermissionResource object` - `type: "organization"` Kind of resource the permission applies to. default: organization - `organization_id: string` UUID of the organization the permission applies to. - `BetaRBACConnectorToolPermissionResource object` - `type: "connector_tool"` Kind of resource the permission applies to. default: connector_tool - `connector_id: string` ID of the connector the permission applies to. - `tool_name: string` Published name of the connector tool the permission applies to. When the published name contains characters outside `[a-zA-Z0-9_-]` (or collides with a reserved form), it is server-encoded into a stable `{prefix}_{32-hex}` form — a shortened readable prefix of the name plus a hash — from which the published name is not recoverable. - `BetaRBACConnectorScopePermissionResource object` - `type: "connector_scope"` Kind of resource the permission applies to. default: connector_scope - `connector_id: string` ID of the connector the permission applies to. - `scope: string` OAuth scope the permission names — the role may receive this scope when tokens are minted for the connector. Subject to the same encoding rule as `tool_name`: a scope containing characters outside `[a-zA-Z0-9_-]` (or colliding with a reserved form) appears server-encoded in a stable `{prefix}_{32-hex}` form. OAuth scopes routinely contain `:` and `/`, so most appear encoded. - `BetaRBACConnectorPermissionResource object` - `type: "connector"` Kind of resource the permission applies to. default: connector - `connector_id: string` ID of the connector the permission applies to. - `BetaRBACAllConnectorsPermissionResource object` - `type: "all_connectors"` Kind of resource the permission applies to. default: all_connectors - `has_more: boolean` Indicates whether there are more results beyond this page. - `next_page: string or null` Opaque cursor for the next page. Pass as the `page` parameter on the next request. #### Example ```bash curl https://api.anthropic.com/v1/organizations/rbac_roles/$RBAC_ROLE_ID/permissions \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "action": "use", "resource": { "organization_id": "3c4f5e6d-7a8b-49c0-9d1e-2f3a4b5c6d7e", "type": "organization" }, "type": "rbac_role_permission" } ], "has_more": true, "next_page": "eyJjdXJzb3IiOiAicmJhY19yb2xlXzAxIn0" } ``` ## Beta › Organization › Plugins ### Create Plugin **POST** `/v1/organizations/plugins` Create an organization-owned Plugin and its first version by uploading the version's files. The upload is `multipart/form-data`: the version's files (`files`, each part sent as `files[]`), with an optional `marketplace_id` and `release_notes`. The manifest's `name` becomes the Plugin's `name`, and `display_name`, `description` and `manifest_version` come from the manifest too. `name` may contain lowercase letters (from any alphabet), digits, and hyphens, up to 64 characters. Uppercase letters, spaces, underscores, and other punctuation are rejected. The `name` must be unique within the marketplace: a name already taken returns a 409 with `error_code` `plugin_name_taken` and, when a Plugin holds it, that Plugin's ID in `details.plugin_id`. A Plugin going into the organization's library marketplace is also refused with a 409 when one of its skills has the name of an organization skill (a skill an administrator uploaded for the whole organization in claude.ai): `error_code` `skill_name_taken`, with that name in `details.skill_name`; rename the skill, or remove the organization skill in claude.ai. A 503 with `error_code` `registration_pending` means the Plugin and its version were stored (their IDs are in `details`) but are not yet usable in claude.ai: do not retry the create (the retry would return `plugin_name_taken`); create a version on the stored Plugin instead, which completes it. For a worked example, see [Create a plugin](https://platform.claude.com/docs/en/manage-claude/plugins-api?sdk_languages=http#create-a-plugin) in the Plugins API guide. **Accepted credentials:** an Admin API key with the `write:plugins` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters (form-data) - `files: array of string` The version's files: one part per file, the part's filename being the file's path within the Plugin (for example `skills/review-pr/SKILL.md`), or a single `.zip` or `.plugin` archive holding them all. On the wire each part is named `files[]`, and a part named plain `files` is not read; with cURL, `-F 'files[]=@SKILL.md;filename=skills/review-pr/SKILL.md'`. The files must include the manifest, `.claude-plugin/plugin.json`. - `marketplace_id: optional string` ID of the organization-owned plugin marketplace to create the Plugin in (prefixed `marketplace_`). It must be a `manual` marketplace, one whose Plugins are uploaded rather than synchronized from a repository. When omitted, the Plugin is created in the organization's library marketplace, an organization-owned `manual` marketplace created on first use. - `release_notes: optional string` Release notes stored with the version and shown in its version history in claude.ai; up to 5,000 characters. maxLength: 5000 #### Returns - `BetaPlugin object` - `type: "plugin"` Always `plugin`. default: plugin - `id: string` The Plugin's ID. - `components: array of BetaPluginComponent or null` What the served version contains; null when not enumerated. - `type: "agent" or "cli" or "command" or 3 more` The kind of component. - `"agent"` - `"cli"` - `"command"` - `"hook"` - `"mcp_server"` - `"skill"` - `description: string or null` What the component declares about itself; always null for MCP servers, hooks, and CLIs. - `name: string` The component's name: a skill's, command's or agent's name, an MCP server's key in the manifest, the event a hook runs on, or a CLI's executable. - `content_scan: BetaPluginContentScan or null` The served version's content scan; null when it has not been scanned. - `assessment: "fail" or "pass" or "unknown" or "warn" or null` The scan's verdict; set only when `status` is `completed`. - `"fail"` - `"pass"` - `"unknown"` - `"warn"` - `reason: string or null` The primary mechanism behind a `warn` or `fail`, such as `credential-exposure` or `guardrail-tampering`; a mechanism this API does not yet name reads as `other`. Null on a `pass`, whenever `assessment` is null, and when no mechanism is reported for the verdict. - `status: "completed" or "errored" or "processing"` `processing` while a scan runs, `completed` when it ran to completion, `errored` when it could not run or its outcome cannot be read. - `"completed"` - `"errored"` - `"processing"` - `created_at: string` RFC 3339. format: date-time - `created_by: BetaPluginUserActor or BetaPluginAPIActor or null` Who created the Plugin; null when no creator is recorded. - `BetaPluginUserActor object` - `type: "user_actor"` A member of the organization. default: user_actor - `email_address: string or null` The member's email address; may be null, for example when they are no longer a member of the organization. - `user_id: string` The member's User ID. - `BetaPluginAPIActor object` - `type: "api_actor"` An Admin API key, in the same form the Compliance API activity feed uses for it. default: api_actor - `api_key_id: string` The key's ID. - `description: string or null` The served version's description. - `display_name: string or null` The served version's display name. - `latest_version_id: string` The newest version. - `manifest_version: string or null` The version string the served version's manifest declares. - `marketplace_id: string` The ID of the plugin marketplace the Plugin lives in. - `name: string` Lowercase identifier, unique within its plugin marketplace. Fixed for an organization-owned Plugin's lifetime; a member-owned Plugin's changes when its owner renames it in claude.ai, while its `id` stays the same. - `organization_installation_preference: "auto_install" or "available" or "not_available" or "required" or null` Organization-owned Plugin: the organization-wide installation setting every member gets unless an RBAC Group they belong to holds its own — the Plugin's own setting, or its plugin marketplace's default. Null for a member-owned Plugin, which has shares instead. One of `required`, `auto_install`, `available`, `not_available`; a value this API does not yet name is returned as stored. - `"auto_install"` - `"available"` - `"not_available"` - `"required"` - `organization_installation_preference_inherited: boolean or null` Organization-owned Plugin: true while it has no organization-wide setting of its own and `organization_installation_preference` is its plugin marketplace's default. Null for a member-owned Plugin. - `owner: BetaPluginOwnerOrganization or BetaPluginOwnerUser` Who owns the Plugin: the organization, or the member whose personal plugin marketplace it lives in. - `BetaPluginOwnerOrganization object` - `type: "organization"` The Plugin lives in a plugin marketplace the organization owns. default: organization - `BetaPluginOwnerUser object` - `type: "user"` The Plugin lives in one member's personal plugin marketplace. default: user - `user_id: string` The member's User ID. - `reach: "contained" or "privileged" or "remote" or null` How far the served version reaches: `remote` when it declares an MCP server or a CLI, `privileged` when it declares a hook, monitor, language server or settings but nothing remote, `contained` otherwise; null when not classifiable. - `"contained"` - `"privileged"` - `"remote"` - `served_version_id: string` The version claude.ai serves to members. - `served_version_pinned: boolean` False while the served version follows each new version; true once it has been pinned to one. - `updated_at: string` RFC 3339. Moves on a new version and on a served-version change; a change to the Plugin's installation settings or shares does not move it. format: date-time #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugins \ -H 'Content-Type: multipart/form-data' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -F 'files[]=@/path/to/file' ``` ##### Response (200) ```json { "id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne", "components": [ { "description": "description", "name": "review-pr", "type": "skill" } ], "content_scan": { "assessment": "warn", "reason": "credential-exposure", "status": "completed" }, "created_at": "2026-03-14T09:26:53.589793Z", "created_by": { "email_address": "user@example.com", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "description": "Reviews pull requests against your team's conventions.", "display_name": "Code Review Helper", "latest_version_id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8", "manifest_version": "1.2.0", "marketplace_id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7", "name": "code-review-helper", "organization_installation_preference": "available", "organization_installation_preference_inherited": true, "owner": { "type": "organization" }, "reach": "contained", "served_version_id": "pluginver_01K9wPcHd4Rm2Tx8Vq6Ln3Sb", "served_version_pinned": true, "type": "plugin", "updated_at": "2026-03-14T09:26:53.589793Z" } ``` ### Get Plugin **GET** `/v1/organizations/plugins/{plugin_id}` Retrieve a Plugin by ID. **Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Path parameters - `plugin_id: string` ID of the Plugin (prefixed `plugin_`). #### Query parameters - `organization_id: optional string` For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404. #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaPlugin object` - `type: "plugin"` Always `plugin`. default: plugin - `id: string` The Plugin's ID. - `components: array of BetaPluginComponent or null` What the served version contains; null when not enumerated. - `type: "agent" or "cli" or "command" or 3 more` The kind of component. - `"agent"` - `"cli"` - `"command"` - `"hook"` - `"mcp_server"` - `"skill"` - `description: string or null` What the component declares about itself; always null for MCP servers, hooks, and CLIs. - `name: string` The component's name: a skill's, command's or agent's name, an MCP server's key in the manifest, the event a hook runs on, or a CLI's executable. - `content_scan: BetaPluginContentScan or null` The served version's content scan; null when it has not been scanned. - `assessment: "fail" or "pass" or "unknown" or "warn" or null` The scan's verdict; set only when `status` is `completed`. - `"fail"` - `"pass"` - `"unknown"` - `"warn"` - `reason: string or null` The primary mechanism behind a `warn` or `fail`, such as `credential-exposure` or `guardrail-tampering`; a mechanism this API does not yet name reads as `other`. Null on a `pass`, whenever `assessment` is null, and when no mechanism is reported for the verdict. - `status: "completed" or "errored" or "processing"` `processing` while a scan runs, `completed` when it ran to completion, `errored` when it could not run or its outcome cannot be read. - `"completed"` - `"errored"` - `"processing"` - `created_at: string` RFC 3339. format: date-time - `created_by: BetaPluginUserActor or BetaPluginAPIActor or null` Who created the Plugin; null when no creator is recorded. - `BetaPluginUserActor object` - `type: "user_actor"` A member of the organization. default: user_actor - `email_address: string or null` The member's email address; may be null, for example when they are no longer a member of the organization. - `user_id: string` The member's User ID. - `BetaPluginAPIActor object` - `type: "api_actor"` An Admin API key, in the same form the Compliance API activity feed uses for it. default: api_actor - `api_key_id: string` The key's ID. - `description: string or null` The served version's description. - `display_name: string or null` The served version's display name. - `latest_version_id: string` The newest version. - `manifest_version: string or null` The version string the served version's manifest declares. - `marketplace_id: string` The ID of the plugin marketplace the Plugin lives in. - `name: string` Lowercase identifier, unique within its plugin marketplace. Fixed for an organization-owned Plugin's lifetime; a member-owned Plugin's changes when its owner renames it in claude.ai, while its `id` stays the same. - `organization_installation_preference: "auto_install" or "available" or "not_available" or "required" or null` Organization-owned Plugin: the organization-wide installation setting every member gets unless an RBAC Group they belong to holds its own — the Plugin's own setting, or its plugin marketplace's default. Null for a member-owned Plugin, which has shares instead. One of `required`, `auto_install`, `available`, `not_available`; a value this API does not yet name is returned as stored. - `"auto_install"` - `"available"` - `"not_available"` - `"required"` - `organization_installation_preference_inherited: boolean or null` Organization-owned Plugin: true while it has no organization-wide setting of its own and `organization_installation_preference` is its plugin marketplace's default. Null for a member-owned Plugin. - `owner: BetaPluginOwnerOrganization or BetaPluginOwnerUser` Who owns the Plugin: the organization, or the member whose personal plugin marketplace it lives in. - `BetaPluginOwnerOrganization object` - `type: "organization"` The Plugin lives in a plugin marketplace the organization owns. default: organization - `BetaPluginOwnerUser object` - `type: "user"` The Plugin lives in one member's personal plugin marketplace. default: user - `user_id: string` The member's User ID. - `reach: "contained" or "privileged" or "remote" or null` How far the served version reaches: `remote` when it declares an MCP server or a CLI, `privileged` when it declares a hook, monitor, language server or settings but nothing remote, `contained` otherwise; null when not classifiable. - `"contained"` - `"privileged"` - `"remote"` - `served_version_id: string` The version claude.ai serves to members. - `served_version_pinned: boolean` False while the served version follows each new version; true once it has been pinned to one. - `updated_at: string` RFC 3339. Moves on a new version and on a served-version change; a change to the Plugin's installation settings or shares does not move it. format: date-time #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne", "components": [ { "description": "description", "name": "review-pr", "type": "skill" } ], "content_scan": { "assessment": "warn", "reason": "credential-exposure", "status": "completed" }, "created_at": "2026-03-14T09:26:53.589793Z", "created_by": { "email_address": "user@example.com", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "description": "Reviews pull requests against your team's conventions.", "display_name": "Code Review Helper", "latest_version_id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8", "manifest_version": "1.2.0", "marketplace_id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7", "name": "code-review-helper", "organization_installation_preference": "available", "organization_installation_preference_inherited": true, "owner": { "type": "organization" }, "reach": "contained", "served_version_id": "pluginver_01K9wPcHd4Rm2Tx8Vq6Ln3Sb", "served_version_pinned": true, "type": "plugin", "updated_at": "2026-03-14T09:26:53.589793Z" } ``` ### Update Plugin **POST** `/v1/organizations/plugins/{plugin_id}` Change which stored version of an organization-owned Plugin is served to members, for example to roll back to an earlier one. This pins the served version: later uploads are stored but no longer change what is served, and pinning cannot currently be undone, here or in claude.ai. Pass the version as `served_version_id`: an earlier one to roll back, a later one to start serving a version that was stored without being served, or the one already served to pin it without changing what is served. No new version is created. When the organization has content scanning enabled, a version whose scan is still running is refused with a 409 (`error_code` `scan_pending`; retry once the scan finishes) and one whose scan failed, errored or reached no verdict with a 400 (`scan_failed`; a `warn` is accepted). When the Plugin is in the organization's library marketplace, a version other than the one served is also refused with a 409 when one of its skills has a name that an organization skill (one an administrator uploaded for the whole organization in claude.ai) has since taken: `error_code` `skill_name_taken`, with that name in `details.skill_name`. A member-owned Plugin cannot be updated here (403). This endpoint does not write installation settings; they are written at `/v1/organizations/plugins/{plugin_id}/installation_settings/{target}`. **Accepted credentials:** an Admin API key with the `write:plugins` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Path parameters - `plugin_id: string` ID of the Plugin (prefixed `plugin_`). #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `served_version_id: string` Serve this version of the Plugin (prefixed `pluginver_`) and pin the served version to it; `latest` is not accepted. #### Returns - `BetaPlugin object` - `type: "plugin"` Always `plugin`. default: plugin - `id: string` The Plugin's ID. - `components: array of BetaPluginComponent or null` What the served version contains; null when not enumerated. - `type: "agent" or "cli" or "command" or 3 more` The kind of component. - `"agent"` - `"cli"` - `"command"` - `"hook"` - `"mcp_server"` - `"skill"` - `description: string or null` What the component declares about itself; always null for MCP servers, hooks, and CLIs. - `name: string` The component's name: a skill's, command's or agent's name, an MCP server's key in the manifest, the event a hook runs on, or a CLI's executable. - `content_scan: BetaPluginContentScan or null` The served version's content scan; null when it has not been scanned. - `assessment: "fail" or "pass" or "unknown" or "warn" or null` The scan's verdict; set only when `status` is `completed`. - `"fail"` - `"pass"` - `"unknown"` - `"warn"` - `reason: string or null` The primary mechanism behind a `warn` or `fail`, such as `credential-exposure` or `guardrail-tampering`; a mechanism this API does not yet name reads as `other`. Null on a `pass`, whenever `assessment` is null, and when no mechanism is reported for the verdict. - `status: "completed" or "errored" or "processing"` `processing` while a scan runs, `completed` when it ran to completion, `errored` when it could not run or its outcome cannot be read. - `"completed"` - `"errored"` - `"processing"` - `created_at: string` RFC 3339. format: date-time - `created_by: BetaPluginUserActor or BetaPluginAPIActor or null` Who created the Plugin; null when no creator is recorded. - `BetaPluginUserActor object` - `type: "user_actor"` A member of the organization. default: user_actor - `email_address: string or null` The member's email address; may be null, for example when they are no longer a member of the organization. - `user_id: string` The member's User ID. - `BetaPluginAPIActor object` - `type: "api_actor"` An Admin API key, in the same form the Compliance API activity feed uses for it. default: api_actor - `api_key_id: string` The key's ID. - `description: string or null` The served version's description. - `display_name: string or null` The served version's display name. - `latest_version_id: string` The newest version. - `manifest_version: string or null` The version string the served version's manifest declares. - `marketplace_id: string` The ID of the plugin marketplace the Plugin lives in. - `name: string` Lowercase identifier, unique within its plugin marketplace. Fixed for an organization-owned Plugin's lifetime; a member-owned Plugin's changes when its owner renames it in claude.ai, while its `id` stays the same. - `organization_installation_preference: "auto_install" or "available" or "not_available" or "required" or null` Organization-owned Plugin: the organization-wide installation setting every member gets unless an RBAC Group they belong to holds its own — the Plugin's own setting, or its plugin marketplace's default. Null for a member-owned Plugin, which has shares instead. One of `required`, `auto_install`, `available`, `not_available`; a value this API does not yet name is returned as stored. - `"auto_install"` - `"available"` - `"not_available"` - `"required"` - `organization_installation_preference_inherited: boolean or null` Organization-owned Plugin: true while it has no organization-wide setting of its own and `organization_installation_preference` is its plugin marketplace's default. Null for a member-owned Plugin. - `owner: BetaPluginOwnerOrganization or BetaPluginOwnerUser` Who owns the Plugin: the organization, or the member whose personal plugin marketplace it lives in. - `BetaPluginOwnerOrganization object` - `type: "organization"` The Plugin lives in a plugin marketplace the organization owns. default: organization - `BetaPluginOwnerUser object` - `type: "user"` The Plugin lives in one member's personal plugin marketplace. default: user - `user_id: string` The member's User ID. - `reach: "contained" or "privileged" or "remote" or null` How far the served version reaches: `remote` when it declares an MCP server or a CLI, `privileged` when it declares a hook, monitor, language server or settings but nothing remote, `contained` otherwise; null when not classifiable. - `"contained"` - `"privileged"` - `"remote"` - `served_version_id: string` The version claude.ai serves to members. - `served_version_pinned: boolean` False while the served version follows each new version; true once it has been pinned to one. - `updated_at: string` RFC 3339. Moves on a new version and on a served-version change; a change to the Plugin's installation settings or shares does not move it. format: date-time #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "served_version_id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8" }' ``` ##### Response (200) ```json { "id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne", "components": [ { "description": "description", "name": "review-pr", "type": "skill" } ], "content_scan": { "assessment": "warn", "reason": "credential-exposure", "status": "completed" }, "created_at": "2026-03-14T09:26:53.589793Z", "created_by": { "email_address": "user@example.com", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "description": "Reviews pull requests against your team's conventions.", "display_name": "Code Review Helper", "latest_version_id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8", "manifest_version": "1.2.0", "marketplace_id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7", "name": "code-review-helper", "organization_installation_preference": "available", "organization_installation_preference_inherited": true, "owner": { "type": "organization" }, "reach": "contained", "served_version_id": "pluginver_01K9wPcHd4Rm2Tx8Vq6Ln3Sb", "served_version_pinned": true, "type": "plugin", "updated_at": "2026-03-14T09:26:53.589793Z" } ``` ### List Plugins **GET** `/v1/organizations/plugins` List the Plugins created under the organization, newest first: those in the organization's own plugin marketplaces and those in members' personal plugin marketplaces. Plugins in members' personal marketplaces are listed with the same detail as the organization's own, and their files can be downloaded through the version archive endpoint, which records each such download on the Compliance API activity feed. **Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Query parameters - `"created_at[gt]": optional string` RFC 3339 timestamp bound; combine [gte], [gt], [lte], [lt]. format: date-time - `"created_at[gte]": optional string` RFC 3339 timestamp bound; combine [gte], [gt], [lte], [lt]. format: date-time - `"created_at[lt]": optional string` RFC 3339 timestamp bound; combine [gte], [gt], [lte], [lt]. format: date-time - `"created_at[lte]": optional string` RFC 3339 timestamp bound; combine [gte], [gt], [lte], [lt]. format: date-time - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `100`. default: 20, minimum: 1, maximum: 100 - `marketplace_id: optional string` Only Plugins in this plugin marketplace (prefixed `marketplace_`). - `organization_id: optional string` For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404. - `owner_type: optional "organization" or "user"` `organization` for Plugins in the organization's plugin marketplaces, `user` for Plugins in members' personal plugin marketplaces. - `"organization"` - `"user"` - `owner_user_id: optional string` Only Plugins in this member's personal plugin marketplaces (prefixed `user_`); a removed member's ID is accepted. - `page: optional string` Optionally set to the `next_page` token from the previous response. maxLength: 2048 #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaPlugin` - `type: "plugin"` Always `plugin`. default: plugin - `id: string` The Plugin's ID. - `components: array of BetaPluginComponent or null` What the served version contains; null when not enumerated. - `type: "agent" or "cli" or "command" or 3 more` The kind of component. - `"agent"` - `"cli"` - `"command"` - `"hook"` - `"mcp_server"` - `"skill"` - `description: string or null` What the component declares about itself; always null for MCP servers, hooks, and CLIs. - `name: string` The component's name: a skill's, command's or agent's name, an MCP server's key in the manifest, the event a hook runs on, or a CLI's executable. - `content_scan: BetaPluginContentScan or null` The served version's content scan; null when it has not been scanned. - `assessment: "fail" or "pass" or "unknown" or "warn" or null` The scan's verdict; set only when `status` is `completed`. - `"fail"` - `"pass"` - `"unknown"` - `"warn"` - `reason: string or null` The primary mechanism behind a `warn` or `fail`, such as `credential-exposure` or `guardrail-tampering`; a mechanism this API does not yet name reads as `other`. Null on a `pass`, whenever `assessment` is null, and when no mechanism is reported for the verdict. - `status: "completed" or "errored" or "processing"` `processing` while a scan runs, `completed` when it ran to completion, `errored` when it could not run or its outcome cannot be read. - `"completed"` - `"errored"` - `"processing"` - `created_at: string` RFC 3339. format: date-time - `created_by: BetaPluginUserActor or BetaPluginAPIActor or null` Who created the Plugin; null when no creator is recorded. - `BetaPluginUserActor object` - `type: "user_actor"` A member of the organization. default: user_actor - `email_address: string or null` The member's email address; may be null, for example when they are no longer a member of the organization. - `user_id: string` The member's User ID. - `BetaPluginAPIActor object` - `type: "api_actor"` An Admin API key, in the same form the Compliance API activity feed uses for it. default: api_actor - `api_key_id: string` The key's ID. - `description: string or null` The served version's description. - `display_name: string or null` The served version's display name. - `latest_version_id: string` The newest version. - `manifest_version: string or null` The version string the served version's manifest declares. - `marketplace_id: string` The ID of the plugin marketplace the Plugin lives in. - `name: string` Lowercase identifier, unique within its plugin marketplace. Fixed for an organization-owned Plugin's lifetime; a member-owned Plugin's changes when its owner renames it in claude.ai, while its `id` stays the same. - `organization_installation_preference: "auto_install" or "available" or "not_available" or "required" or null` Organization-owned Plugin: the organization-wide installation setting every member gets unless an RBAC Group they belong to holds its own — the Plugin's own setting, or its plugin marketplace's default. Null for a member-owned Plugin, which has shares instead. One of `required`, `auto_install`, `available`, `not_available`; a value this API does not yet name is returned as stored. - `"auto_install"` - `"available"` - `"not_available"` - `"required"` - `organization_installation_preference_inherited: boolean or null` Organization-owned Plugin: true while it has no organization-wide setting of its own and `organization_installation_preference` is its plugin marketplace's default. Null for a member-owned Plugin. - `owner: BetaPluginOwnerOrganization or BetaPluginOwnerUser` Who owns the Plugin: the organization, or the member whose personal plugin marketplace it lives in. - `BetaPluginOwnerOrganization object` - `type: "organization"` The Plugin lives in a plugin marketplace the organization owns. default: organization - `BetaPluginOwnerUser object` - `type: "user"` The Plugin lives in one member's personal plugin marketplace. default: user - `user_id: string` The member's User ID. - `reach: "contained" or "privileged" or "remote" or null` How far the served version reaches: `remote` when it declares an MCP server or a CLI, `privileged` when it declares a hook, monitor, language server or settings but nothing remote, `contained` otherwise; null when not classifiable. - `"contained"` - `"privileged"` - `"remote"` - `served_version_id: string` The version claude.ai serves to members. - `served_version_pinned: boolean` False while the served version follows each new version; true once it has been pinned to one. - `updated_at: string` RFC 3339. Moves on a new version and on a served-version change; a change to the Plugin's installation settings or shares does not move it. format: date-time - `next_page: string or null` Token to provide in as `page` in the subsequent request to retrieve the next page of data. A page may hold fewer than `limit` Plugins, even none, while this is set; keep following it until it is null. #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugins \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne", "components": [ { "description": "description", "name": "review-pr", "type": "skill" } ], "content_scan": { "assessment": "warn", "reason": "credential-exposure", "status": "completed" }, "created_at": "2026-03-14T09:26:53.589793Z", "created_by": { "email_address": "user@example.com", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "description": "Reviews pull requests against your team's conventions.", "display_name": "Code Review Helper", "latest_version_id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8", "manifest_version": "1.2.0", "marketplace_id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7", "name": "code-review-helper", "organization_installation_preference": "available", "organization_installation_preference_inherited": true, "owner": { "type": "organization" }, "reach": "contained", "served_version_id": "pluginver_01K9wPcHd4Rm2Tx8Vq6Ln3Sb", "served_version_pinned": true, "type": "plugin", "updated_at": "2026-03-14T09:26:53.589793Z" } ], "next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo" } ``` ### Delete Plugin **DELETE** `/v1/organizations/plugins/{plugin_id}` Permanently delete a Plugin and every version it holds, exactly as when an administrator deletes it in claude.ai. The Plugin may belong to the organization or to a member, including a member who has since left the organization. An organization-owned Plugin's installation settings go with it; a member-owned Plugin's shares are withdrawn and its owner no longer has it. To take an organization-owned Plugin out of use reversibly, set its organization-wide installation setting to `not_available` instead (and remove or change any group settings, which override it for their members). Only a Plugin in a `manual` marketplace can be deleted here; one synchronized from a repository is removed by removing it from the repository (400). **Accepted credentials:** an Admin API key with the `write:plugins` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Path parameters - `plugin_id: string` ID of the Plugin (prefixed `plugin_`). #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaDeletedPlugin object` - `type: "plugin_deleted"` Always `plugin_deleted`. default: plugin_deleted - `id: string` The deleted Plugin's ID. #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne", "type": "plugin_deleted" } ``` ## Beta › Organization › Plugins › Versions ### Create Plugin Version **POST** `/v1/organizations/plugins/{plugin_id}/versions` Add a version to an organization-owned Plugin by uploading the new version's files; it becomes the version served to members unless the Plugin's served version has been pinned. The upload is the same `multipart/form-data` as creating a Plugin: the version's files (`files`, each part sent as `files[]`) and optional `release_notes`. The uploaded manifest's `name` must equal the Plugin's `name`. Returns the stored version; read the Plugin back to see which version it serves. Only a Plugin in a `manual` marketplace takes uploads; a Plugin synchronized from a repository gets its versions from the repository. When the Plugin is in the organization's library marketplace, a version that adds a skill with the name of an organization skill (a skill an administrator uploaded for the whole organization in claude.ai) is refused with a 409: `error_code` `skill_name_taken`, with that name in `details.skill_name`. A 503 with `error_code` `registration_pending` means the version was stored but is not yet usable; a later version create on the Plugin completes it. For a worked example, see [Create a version](https://platform.claude.com/docs/en/manage-claude/plugins-api?sdk_languages=http#create-a-version) in the Plugins API guide. **Accepted credentials:** an Admin API key with the `write:plugins` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Path parameters - `plugin_id: string` ID of the Plugin (prefixed `plugin_`). #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters (form-data) - `files: array of string` The version's files: one part per file, the part's filename being the file's path within the Plugin (for example `skills/review-pr/SKILL.md`), or a single `.zip` or `.plugin` archive holding them all. On the wire each part is named `files[]`, and a part named plain `files` is not read; with cURL, `-F 'files[]=@SKILL.md;filename=skills/review-pr/SKILL.md'`. The files must include the manifest, `.claude-plugin/plugin.json`. - `release_notes: optional string` Release notes stored with the version and shown in its version history in claude.ai; up to 5,000 characters. maxLength: 5000 #### Returns - `BetaPluginVersion object` - `type: "plugin_version"` Always `plugin_version`. default: plugin_version - `id: string` The version's ID. - `components: array of BetaPluginComponent or null` What the version contains; null when not enumerated. - `type: "agent" or "cli" or "command" or 3 more` The kind of component. - `"agent"` - `"cli"` - `"command"` - `"hook"` - `"mcp_server"` - `"skill"` - `description: string or null` What the component declares about itself; always null for MCP servers, hooks, and CLIs. - `name: string` The component's name: a skill's, command's or agent's name, an MCP server's key in the manifest, the event a hook runs on, or a CLI's executable. - `content_scan: BetaPluginContentScan or null` This version's content scan; null when it has not been scanned. - `assessment: "fail" or "pass" or "unknown" or "warn" or null` The scan's verdict; set only when `status` is `completed`. - `"fail"` - `"pass"` - `"unknown"` - `"warn"` - `reason: string or null` The primary mechanism behind a `warn` or `fail`, such as `credential-exposure` or `guardrail-tampering`; a mechanism this API does not yet name reads as `other`. Null on a `pass`, whenever `assessment` is null, and when no mechanism is reported for the verdict. - `status: "completed" or "errored" or "processing"` `processing` while a scan runs, `completed` when it ran to completion, `errored` when it could not run or its outcome cannot be read. - `"completed"` - `"errored"` - `"processing"` - `created_at: string` RFC 3339. format: date-time - `created_by: BetaPluginUserActor or BetaPluginAPIActor or null` Who uploaded this version; null when not recorded. - `BetaPluginUserActor object` - `type: "user_actor"` A member of the organization. default: user_actor - `email_address: string or null` The member's email address; may be null, for example when they are no longer a member of the organization. - `user_id: string` The member's User ID. - `BetaPluginAPIActor object` - `type: "api_actor"` An Admin API key, in the same form the Compliance API activity feed uses for it. default: api_actor - `api_key_id: string` The key's ID. - `description: string or null` The manifest's description; null when it declares none. - `display_name: string or null` The manifest's display name; null when it declares none. - `manifest_version: string or null` The version string the manifest declares; null when it declares none. - `plugin_id: string` The Plugin's ID. - `reach: "contained" or "privileged" or "remote" or null` How far the version reaches: `remote`, `privileged` or `contained`, as on the Plugin; null when not classifiable. - `"contained"` - `"privileged"` - `"remote"` - `release_notes: string or null` As supplied with the upload; null when none were supplied. #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/versions \ -H 'Content-Type: multipart/form-data' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -F 'files[]=@/path/to/file' ``` ##### Response (200) ```json { "id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8", "components": [ { "description": "description", "name": "review-pr", "type": "skill" } ], "content_scan": { "assessment": "warn", "reason": "credential-exposure", "status": "completed" }, "created_at": "2026-03-14T09:26:53.589793Z", "created_by": { "email_address": "user@example.com", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "description": "Reviews pull requests against your team's conventions.", "display_name": "Code Review Helper", "manifest_version": "1.2.0", "plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne", "reach": "contained", "release_notes": "Adds a review checklist for database migrations.", "type": "plugin_version" } ``` ### List Plugin Versions **GET** `/v1/organizations/plugins/{plugin_id}/versions` List a Plugin's versions, newest first. The first item of the first page is the version the Plugin's `latest_version_id` refers to. **Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Path parameters - `plugin_id: string` ID of the Plugin (prefixed `plugin_`). #### Query parameters - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 - `organization_id: optional string` For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404. - `page: optional string` Optionally set to the `next_page` token from the previous response. maxLength: 2048 #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaPluginVersion` - `type: "plugin_version"` Always `plugin_version`. default: plugin_version - `id: string` The version's ID. - `components: array of BetaPluginComponent or null` What the version contains; null when not enumerated. - `type: "agent" or "cli" or "command" or 3 more` The kind of component. - `"agent"` - `"cli"` - `"command"` - `"hook"` - `"mcp_server"` - `"skill"` - `description: string or null` What the component declares about itself; always null for MCP servers, hooks, and CLIs. - `name: string` The component's name: a skill's, command's or agent's name, an MCP server's key in the manifest, the event a hook runs on, or a CLI's executable. - `content_scan: BetaPluginContentScan or null` This version's content scan; null when it has not been scanned. - `assessment: "fail" or "pass" or "unknown" or "warn" or null` The scan's verdict; set only when `status` is `completed`. - `"fail"` - `"pass"` - `"unknown"` - `"warn"` - `reason: string or null` The primary mechanism behind a `warn` or `fail`, such as `credential-exposure` or `guardrail-tampering`; a mechanism this API does not yet name reads as `other`. Null on a `pass`, whenever `assessment` is null, and when no mechanism is reported for the verdict. - `status: "completed" or "errored" or "processing"` `processing` while a scan runs, `completed` when it ran to completion, `errored` when it could not run or its outcome cannot be read. - `"completed"` - `"errored"` - `"processing"` - `created_at: string` RFC 3339. format: date-time - `created_by: BetaPluginUserActor or BetaPluginAPIActor or null` Who uploaded this version; null when not recorded. - `BetaPluginUserActor object` - `type: "user_actor"` A member of the organization. default: user_actor - `email_address: string or null` The member's email address; may be null, for example when they are no longer a member of the organization. - `user_id: string` The member's User ID. - `BetaPluginAPIActor object` - `type: "api_actor"` An Admin API key, in the same form the Compliance API activity feed uses for it. default: api_actor - `api_key_id: string` The key's ID. - `description: string or null` The manifest's description; null when it declares none. - `display_name: string or null` The manifest's display name; null when it declares none. - `manifest_version: string or null` The version string the manifest declares; null when it declares none. - `plugin_id: string` The Plugin's ID. - `reach: "contained" or "privileged" or "remote" or null` How far the version reaches: `remote`, `privileged` or `contained`, as on the Plugin; null when not classifiable. - `"contained"` - `"privileged"` - `"remote"` - `release_notes: string or null` As supplied with the upload; null when none were supplied. - `next_page: string or null` Token to provide in as `page` in the subsequent request to retrieve the next page of data. #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/versions \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8", "components": [ { "description": "description", "name": "review-pr", "type": "skill" } ], "content_scan": { "assessment": "warn", "reason": "credential-exposure", "status": "completed" }, "created_at": "2026-03-14T09:26:53.589793Z", "created_by": { "email_address": "user@example.com", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "description": "Reviews pull requests against your team's conventions.", "display_name": "Code Review Helper", "manifest_version": "1.2.0", "plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne", "reach": "contained", "release_notes": "Adds a review checklist for database migrations.", "type": "plugin_version" } ], "next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo" } ``` ### Get Plugin Version **GET** `/v1/organizations/plugins/{plugin_id}/versions/{version}` Retrieve one version of a Plugin by its ID, or the Plugin's newest version. **Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Path parameters - `plugin_id: string` ID of the Plugin (prefixed `plugin_`). - `version: string` ID of the Plugin Version (prefixed `pluginver_`), or `latest` for the newest one. #### Query parameters - `organization_id: optional string` For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404. #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaPluginVersion object` - `type: "plugin_version"` Always `plugin_version`. default: plugin_version - `id: string` The version's ID. - `components: array of BetaPluginComponent or null` What the version contains; null when not enumerated. - `type: "agent" or "cli" or "command" or 3 more` The kind of component. - `"agent"` - `"cli"` - `"command"` - `"hook"` - `"mcp_server"` - `"skill"` - `description: string or null` What the component declares about itself; always null for MCP servers, hooks, and CLIs. - `name: string` The component's name: a skill's, command's or agent's name, an MCP server's key in the manifest, the event a hook runs on, or a CLI's executable. - `content_scan: BetaPluginContentScan or null` This version's content scan; null when it has not been scanned. - `assessment: "fail" or "pass" or "unknown" or "warn" or null` The scan's verdict; set only when `status` is `completed`. - `"fail"` - `"pass"` - `"unknown"` - `"warn"` - `reason: string or null` The primary mechanism behind a `warn` or `fail`, such as `credential-exposure` or `guardrail-tampering`; a mechanism this API does not yet name reads as `other`. Null on a `pass`, whenever `assessment` is null, and when no mechanism is reported for the verdict. - `status: "completed" or "errored" or "processing"` `processing` while a scan runs, `completed` when it ran to completion, `errored` when it could not run or its outcome cannot be read. - `"completed"` - `"errored"` - `"processing"` - `created_at: string` RFC 3339. format: date-time - `created_by: BetaPluginUserActor or BetaPluginAPIActor or null` Who uploaded this version; null when not recorded. - `BetaPluginUserActor object` - `type: "user_actor"` A member of the organization. default: user_actor - `email_address: string or null` The member's email address; may be null, for example when they are no longer a member of the organization. - `user_id: string` The member's User ID. - `BetaPluginAPIActor object` - `type: "api_actor"` An Admin API key, in the same form the Compliance API activity feed uses for it. default: api_actor - `api_key_id: string` The key's ID. - `description: string or null` The manifest's description; null when it declares none. - `display_name: string or null` The manifest's display name; null when it declares none. - `manifest_version: string or null` The version string the manifest declares; null when it declares none. - `plugin_id: string` The Plugin's ID. - `reach: "contained" or "privileged" or "remote" or null` How far the version reaches: `remote`, `privileged` or `contained`, as on the Plugin; null when not classifiable. - `"contained"` - `"privileged"` - `"remote"` - `release_notes: string or null` As supplied with the upload; null when none were supplied. #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/versions/$VERSION \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "pluginver_01KaZmQpRsTuVwXyZ2b4c6d8", "components": [ { "description": "description", "name": "review-pr", "type": "skill" } ], "content_scan": { "assessment": "warn", "reason": "credential-exposure", "status": "completed" }, "created_at": "2026-03-14T09:26:53.589793Z", "created_by": { "email_address": "user@example.com", "type": "user_actor", "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "description": "Reviews pull requests against your team's conventions.", "display_name": "Code Review Helper", "manifest_version": "1.2.0", "plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne", "reach": "contained", "release_notes": "Adds a review checklist for database migrations.", "type": "plugin_version" } ``` ### Download Plugin Version Archive **GET** `/v1/organizations/plugins/{plugin_id}/versions/{version}/content` Download one version's `.zip` archive, exactly as stored. Each download of a Plugin from a member's personal plugin marketplace is recorded on the Compliance API activity feed. The response body is the archive (`Content-Type: application/zip`), sent as an attachment whose filename is derived from the Plugin's name; name saved files from the IDs in the request path, since that filename is not unique. **Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope. Every read scope above (`read:plugins`, `read:org_audit`, and `read:compliance_org_data`) can download the files of plugins in members' personal marketplaces, including files that claude.ai's admin settings do not show, and a `read:org_audit` or `read:compliance_org_data` key created for all of your parent organization's linked organizations can do this in any organization under it that has access to this API, by passing `organization_id`. Each such download records a `claude_plugin_archive_accessed` event on the Compliance API activity feed, identifying the key, the plugin, the version, and the member. Downloads of organization-owned plugins are not recorded. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Path parameters - `plugin_id: string` ID of the Plugin (prefixed `plugin_`). - `version: string` ID of the Plugin Version (prefixed `pluginver_`). `latest` is not accepted here. #### Query parameters - `organization_id: optional string` For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404. #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/versions/$VERSION/content \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ## Beta › Organization › Plugins › Installation Settings ### List Plugin Installation Settings **GET** `/v1/organizations/plugins/{plugin_id}/installation_settings` List an organization-owned Plugin's installation settings, which say which members it is for, most recently created first. The list holds the Plugin's own organization-wide setting (absent while the Plugin inherits its marketplace's default) and each RBAC Group's own setting. A member-owned Plugin has shares instead, so this path returns 404 for one. **Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Path parameters - `plugin_id: string` ID of the Plugin (prefixed `plugin_`). #### Query parameters - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `100`. default: 20, minimum: 1, maximum: 100 - `organization_id: optional string` For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404. - `page: optional string` Optionally set to the `next_page` token from the previous response. maxLength: 2048 - `target_type: optional "organization" or "rbac_group"` Only settings for this kind of target: `organization` (the organization-wide setting) or `rbac_group` (an RBAC Group's). - `"organization"` - `"rbac_group"` #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaPluginInstallationSetting` - `type: "plugin_installation_setting"` Always `plugin_installation_setting`. default: plugin_installation_setting - `created_at: string` When the target was first given a setting for this Plugin. format: date-time - `installation_preference: "auto_install" or "available" or "not_available" or "required"` The setting the target holds for this Plugin. One of `required`, `auto_install`, `available`, `not_available`; a value this API does not yet name is returned as stored. - `"auto_install"` - `"available"` - `"not_available"` - `"required"` - `plugin_id: string` The Plugin's ID. - `target: BetaPluginTargetOrganization or BetaPluginTargetRBACGroup or BetaPluginTargetOrganizationMember` Whose setting this is: `organization` (the Plugin's own organization-wide setting) or `rbac_group` (one RBAC Group's own setting); `organization_member` does not occur here. - `BetaPluginTargetOrganization object` - `type: "organization"` Every member of the organization. default: organization - `BetaPluginTargetRBACGroup object` - `type: "rbac_group"` An RBAC Group. default: rbac_group - `rbac_group_id: string` The RBAC Group's ID. - `BetaPluginTargetOrganizationMember object` - `type: "organization_member"` One member of the organization. default: organization_member - `user_id: string` The member's User ID. - `updated_at: string` When its setting last changed. format: date-time - `next_page: string or null` Token to provide in as `page` in the subsequent request to retrieve the next page of data. #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/installation_settings \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "created_at": "2026-03-14T09:26:53.589793Z", "installation_preference": "required", "plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne", "target": { "type": "organization" }, "type": "plugin_installation_setting", "updated_at": "2026-03-14T09:26:53.589793Z" } ], "next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo" } ``` ### Set Plugin Installation Setting **POST** `/v1/organizations/plugins/{plugin_id}/installation_settings/{target}` Set or change an organization-owned Plugin's installation setting for the whole organization or for one RBAC Group. Writing the value a target already holds of its own changes nothing. A member-owned Plugin has shares instead of installation settings, so this path returns 404 for one. Send a Plugin's installation-setting writes one at a time. If several writes for the same Plugin arrive at the same time, the server handles them one after another and can answer some of them with `503` instead of applying them. That `503` carries `x-should-retry: true`, and the write is safe to repeat: wait a second or two, then send it again. **Accepted credentials:** an Admin API key with the `write:plugins` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Path parameters - `plugin_id: string` ID of the Plugin (prefixed `plugin_`). - `target: string` The target whose setting is written: the literal `organization` for the Plugin's organization-wide setting, or an RBAC Group's ID (prefixed `rbac_group_`) for that group's own setting. Writing the `organization` target stops the Plugin from inheriting its marketplace's default, even when the value written equals that default. #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `installation_preference: "auto_install" or "available" or "not_available" or "required"` The installation setting the target is to hold for this Plugin: one of `required`, `auto_install`, `available`, `not_available`. - `"auto_install"` - `"available"` - `"not_available"` - `"required"` #### Returns - `BetaPluginInstallationSetting object` The installation setting an organization-owned Plugin holds for one target. It has no ID of its own: it is addressed by the Plugin's ID and the target. - `type: "plugin_installation_setting"` Always `plugin_installation_setting`. default: plugin_installation_setting - `created_at: string` When the target was first given a setting for this Plugin. format: date-time - `installation_preference: "auto_install" or "available" or "not_available" or "required"` The setting the target holds for this Plugin. One of `required`, `auto_install`, `available`, `not_available`; a value this API does not yet name is returned as stored. - `"auto_install"` - `"available"` - `"not_available"` - `"required"` - `plugin_id: string` The Plugin's ID. - `target: BetaPluginTargetOrganization or BetaPluginTargetRBACGroup or BetaPluginTargetOrganizationMember` Whose setting this is: `organization` (the Plugin's own organization-wide setting) or `rbac_group` (one RBAC Group's own setting); `organization_member` does not occur here. - `BetaPluginTargetOrganization object` - `type: "organization"` Every member of the organization. default: organization - `BetaPluginTargetRBACGroup object` - `type: "rbac_group"` An RBAC Group. default: rbac_group - `rbac_group_id: string` The RBAC Group's ID. - `BetaPluginTargetOrganizationMember object` - `type: "organization_member"` One member of the organization. default: organization_member - `user_id: string` The member's User ID. - `updated_at: string` When its setting last changed. format: date-time #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/installation_settings/$TARGET \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "installation_preference": "required" }' ``` ##### Response (200) ```json { "created_at": "2026-03-14T09:26:53.589793Z", "installation_preference": "required", "plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne", "target": { "type": "organization" }, "type": "plugin_installation_setting", "updated_at": "2026-03-14T09:26:53.589793Z" } ``` ### Remove Plugin Installation Setting **DELETE** `/v1/organizations/plugins/{plugin_id}/installation_settings/{target}` Remove an organization-owned Plugin's own installation setting for the whole organization or for one RBAC Group. Removing the `organization` target returns the Plugin to its marketplace's default installation setting and leaves the groups' settings in place. Removing a group's setting makes the group's members fall back to the Plugin's organization-wide setting or to the settings of their other groups. A target that holds no setting of its own returns 404 (a Plugin that already inherits its marketplace's default holds no `organization` setting), and so does a member-owned Plugin. A removal counts as one of the Plugin's installation-setting writes: send all of those writes one at a time. If several arrive for the same Plugin at the same time, the server handles them one after another and can answer some of them with `503` and `x-should-retry: true` instead of applying them; wait a second or two and send the removal again. A `404` on the repeat means the setting is already gone. **Accepted credentials:** an Admin API key with the `write:plugins` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Path parameters - `plugin_id: string` ID of the Plugin (prefixed `plugin_`). - `target: string` The target whose own setting is removed: the literal `organization` for the Plugin's organization-wide setting, or an RBAC Group's ID (prefixed `rbac_group_`) for that group's own setting. Removing the `organization` setting returns the Plugin to its marketplace's default. #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaDeletedPluginInstallationSetting object` Confirmation that one target's installation setting was removed, naming the Plugin and the target in place of an ID. - `type: "plugin_installation_setting_deleted"` Always `plugin_installation_setting_deleted`. default: plugin_installation_setting_deleted - `plugin_id: string` The Plugin's ID. - `target: BetaPluginTargetOrganization or BetaPluginTargetRBACGroup or BetaPluginTargetOrganizationMember` Whose setting was removed. - `BetaPluginTargetOrganization object` - `type: "organization"` Every member of the organization. default: organization - `BetaPluginTargetRBACGroup object` - `type: "rbac_group"` An RBAC Group. default: rbac_group - `rbac_group_id: string` The RBAC Group's ID. - `BetaPluginTargetOrganizationMember object` - `type: "organization_member"` One member of the organization. default: organization_member - `user_id: string` The member's User ID. #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/installation_settings/$TARGET \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne", "target": { "rbac_group_id": "rbac_group_012rppKaSVsmTo6NqRDXQXNF", "type": "rbac_group" }, "type": "plugin_installation_setting_deleted" } ``` ## Beta › Organization › Plugins › Shares ### List Plugin Shares **GET** `/v1/organizations/plugins/{plugin_id}/shares` List the shares the owner of a member-owned Plugin has given — to every member of the organization, to an RBAC Group, or to one member — most recently granted first. Shares are read-only in this API: members give and withdraw them in claude.ai, and who gave a share is recorded on the Compliance API activity feed rather than on the share. An organization-owned Plugin has installation settings instead, so this path returns 404 for one. **Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Path parameters - `plugin_id: string` ID of the Plugin (prefixed `plugin_`). #### Query parameters - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `100`. default: 20, minimum: 1, maximum: 100 - `organization_id: optional string` For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404. - `page: optional string` Optionally set to the `next_page` token from the previous response. maxLength: 2048 - `target_type: optional "organization" or "organization_member" or "rbac_group"` Only shares with this kind of target: `organization` (every member), `rbac_group` (one RBAC Group), or `organization_member` (one member). - `"organization"` - `"organization_member"` - `"rbac_group"` #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaPluginShare` - `type: "plugin_share"` Always `plugin_share`. default: plugin_share - `granted_at: string` When the share was given; a share whose role is later changed in claude.ai is re-granted and carries the time of that change. format: date-time - `plugin_id: string` The Plugin's ID. - `target: BetaPluginTargetOrganization or BetaPluginTargetRBACGroup or BetaPluginTargetOrganizationMember` Who the Plugin is shared with: `organization` (every member), `rbac_group` (one RBAC Group), or `organization_member` (one member). - `BetaPluginTargetOrganization object` - `type: "organization"` Every member of the organization. default: organization - `BetaPluginTargetRBACGroup object` - `type: "rbac_group"` An RBAC Group. default: rbac_group - `rbac_group_id: string` The RBAC Group's ID. - `BetaPluginTargetOrganizationMember object` - `type: "organization_member"` One member of the organization. default: organization_member - `user_id: string` The member's User ID. - `next_page: string or null` Token to provide in as `page` in the subsequent request to retrieve the next page of data. #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugins/$PLUGIN_ID/shares \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "granted_at": "2026-03-14T09:26:53.589793Z", "plugin_id": "plugin_01JyHfbRkZvD1gW7oTqXc3Ne", "target": { "type": "organization" }, "type": "plugin_share" } ], "next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo" } ``` ## Beta › Organization › Plugin Marketplaces ### List Plugin Marketplaces **GET** `/v1/organizations/plugin_marketplaces` List the plugin marketplaces Plugins live in, newest first: the organization's own and its members' personal ones. Plugin marketplaces are created, connected to a repository and deleted in claude.ai, not through this API. The organization's library marketplace, the organization-owned `manual` marketplace that uploads go to when no marketplace is named, is created the first time something is put in it and is listed from then on. **Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Query parameters - `limit: optional number` Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20, minimum: 1, maximum: 1000 - `organization_id: optional string` For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404. - `owner_type: optional "organization" or "user"` `organization` for the organization's plugin marketplaces, `user` for members' personal plugin marketplaces. - `"organization"` - `"user"` - `page: optional string` Optionally set to the `next_page` token from the previous response. maxLength: 2048 - `source: optional "directory" or "github" or "gitlab" or 2 more` Only plugin marketplaces with this `source`: `manual` for those whose Plugins are uploaded; `github`, `gitlab` or `public_git` for those synchronized from a Git repository. `directory` (Anthropic's catalog) is never listed here. - `"directory"` - `"github"` - `"gitlab"` - `"manual"` - `"public_git"` #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaPluginMarketplace` - `type: "plugin_marketplace"` Always `plugin_marketplace`. default: plugin_marketplace - `id: string` The plugin marketplace's ID, prefixed `marketplace_`. - `created_at: string` RFC 3339. format: date-time - `default_installation_preference: "auto_install" or "available" or "not_available" or "required" or null` Organization plugin marketplace: the organization-wide setting every Plugin in it with no setting of its own gets. Null for a member's personal plugin marketplace. One of `required`, `auto_install`, `available`, `not_available`; a value this API does not yet name is returned as stored. - `"auto_install"` - `"available"` - `"not_available"` - `"required"` - `last_sync_ended_at: string or null` RFC 3339. When the most recent synchronization attempt to finish did so, whatever its outcome; for a repository plugin marketplace no synchronization has run on yet, when it was created. Null for a plugin marketplace that is not synchronized from a repository. format: date-time - `last_sync_read_sha: string or null` The commit the last synchronization attempt that reached the repository read, whether or not its content was then accepted (see `sync_status`); an attempt that ends `failed_auth` or `failed_transient` leaves it unchanged. Null until an attempt has first read the repository, and for a plugin marketplace that is not synchronized from a repository. - `name: string` Fixed for the plugin marketplace's lifetime. - `owner: BetaPluginOwnerOrganization or BetaPluginOwnerUser` The organization, or the member whose personal plugin marketplace it is. - `BetaPluginOwnerOrganization object` - `type: "organization"` The Plugin lives in a plugin marketplace the organization owns. default: organization - `BetaPluginOwnerUser object` - `type: "user"` The Plugin lives in one member's personal plugin marketplace. default: user - `user_id: string` The member's User ID. - `source: "directory" or "github" or "gitlab" or 2 more` Where the plugin marketplace's Plugins come from: `manual` when they are uploaded; `github`, `gitlab` or `public_git` when they are synchronized from the Git repository the owner connected, into which nothing can be uploaded; `directory` is Anthropic's own catalog, which this API does not list. A value this API does not yet name is returned as stored. - `"directory"` - `"github"` - `"gitlab"` - `"manual"` - `"public_git"` - `sync_status: "failed_auth" or "failed_content" or "failed_limits" or 3 more or null` Outcome of the plugin marketplace's most recent synchronization: one of `success`, `in_progress`, `failed_content`, `failed_transient`, `failed_auth`, `failed_limits`; a value this API does not yet name is returned as stored. Null until a synchronization is first attempted — so always for a `manual` plugin marketplace. - `"failed_auth"` - `"failed_content"` - `"failed_limits"` - `"failed_transient"` - `"in_progress"` - `"success"` - `next_page: string or null` Token to provide in as `page` in the subsequent request to retrieve the next page of data. #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugin_marketplaces \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7", "created_at": "2026-03-14T09:26:53.589793Z", "default_installation_preference": "available", "last_sync_ended_at": "2026-03-14T09:26:53.589793Z", "last_sync_read_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8", "name": "engineering-tools", "owner": { "type": "organization" }, "source": "github", "sync_status": "success", "type": "plugin_marketplace" } ], "next_page": "page_MjAyNi0wOS0xNlQxNDowNTowOVo" } ``` ### Get Plugin Marketplace **GET** `/v1/organizations/plugin_marketplaces/{marketplace_id}` Retrieve a plugin marketplace by ID. **Accepted credentials:** an Admin API key with the `read:plugins` or `read:org_audit` scope, or a Compliance Access Key with the `read:compliance_org_data` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Path parameters - `marketplace_id: string` ID of the plugin marketplace (prefixed `marketplace_`). #### Query parameters - `organization_id: optional string` For a `read:org_audit` or `read:compliance_org_data` key created for all of a parent organization's linked organizations: a child organization of that parent to read instead of the organization the key was created in, given as the organization's UUID or its `org_`-prefixed ID. A value that is neither returns a 400; an organization that is not a child of the key's parent, or where the Plugins API is not available, returns a 404. Any other key may pass only its own organization's ID here; another organization returns a 404. #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaPluginMarketplace object` - `type: "plugin_marketplace"` Always `plugin_marketplace`. default: plugin_marketplace - `id: string` The plugin marketplace's ID, prefixed `marketplace_`. - `created_at: string` RFC 3339. format: date-time - `default_installation_preference: "auto_install" or "available" or "not_available" or "required" or null` Organization plugin marketplace: the organization-wide setting every Plugin in it with no setting of its own gets. Null for a member's personal plugin marketplace. One of `required`, `auto_install`, `available`, `not_available`; a value this API does not yet name is returned as stored. - `"auto_install"` - `"available"` - `"not_available"` - `"required"` - `last_sync_ended_at: string or null` RFC 3339. When the most recent synchronization attempt to finish did so, whatever its outcome; for a repository plugin marketplace no synchronization has run on yet, when it was created. Null for a plugin marketplace that is not synchronized from a repository. format: date-time - `last_sync_read_sha: string or null` The commit the last synchronization attempt that reached the repository read, whether or not its content was then accepted (see `sync_status`); an attempt that ends `failed_auth` or `failed_transient` leaves it unchanged. Null until an attempt has first read the repository, and for a plugin marketplace that is not synchronized from a repository. - `name: string` Fixed for the plugin marketplace's lifetime. - `owner: BetaPluginOwnerOrganization or BetaPluginOwnerUser` The organization, or the member whose personal plugin marketplace it is. - `BetaPluginOwnerOrganization object` - `type: "organization"` The Plugin lives in a plugin marketplace the organization owns. default: organization - `BetaPluginOwnerUser object` - `type: "user"` The Plugin lives in one member's personal plugin marketplace. default: user - `user_id: string` The member's User ID. - `source: "directory" or "github" or "gitlab" or 2 more` Where the plugin marketplace's Plugins come from: `manual` when they are uploaded; `github`, `gitlab` or `public_git` when they are synchronized from the Git repository the owner connected, into which nothing can be uploaded; `directory` is Anthropic's own catalog, which this API does not list. A value this API does not yet name is returned as stored. - `"directory"` - `"github"` - `"gitlab"` - `"manual"` - `"public_git"` - `sync_status: "failed_auth" or "failed_content" or "failed_limits" or 3 more or null` Outcome of the plugin marketplace's most recent synchronization: one of `success`, `in_progress`, `failed_content`, `failed_transient`, `failed_auth`, `failed_limits`; a value this API does not yet name is returned as stored. Null until a synchronization is first attempted — so always for a `manual` plugin marketplace. - `"failed_auth"` - `"failed_content"` - `"failed_limits"` - `"failed_transient"` - `"in_progress"` - `"success"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugin_marketplaces/$MARKETPLACE_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7", "created_at": "2026-03-14T09:26:53.589793Z", "default_installation_preference": "available", "last_sync_ended_at": "2026-03-14T09:26:53.589793Z", "last_sync_read_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8", "name": "engineering-tools", "owner": { "type": "organization" }, "source": "github", "sync_status": "success", "type": "plugin_marketplace" } ``` ### Update Plugin Marketplace **POST** `/v1/organizations/plugin_marketplaces/{marketplace_id}` Set the default installation setting of one of the organization's own plugin marketplaces. Every Plugin in it without a setting of its own gets this default as its organization-wide setting, including Plugins added later. Pass it as `default_installation_preference`. A member's personal marketplace cannot be updated here (403). **Accepted credentials:** an Admin API key with the `write:plugins` scope. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Path parameters - `marketplace_id: string` ID of the plugin marketplace (prefixed `marketplace_`). #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `default_installation_preference: "auto_install" or "available" or "not_available" or "required"` The organization-wide installation setting every Plugin in the marketplace without one of its own gets: one of `required`, `auto_install`, `available`, `not_available`. Once set it can be changed but not removed. - `"auto_install"` - `"available"` - `"not_available"` - `"required"` #### Returns - `BetaPluginMarketplace object` - `type: "plugin_marketplace"` Always `plugin_marketplace`. default: plugin_marketplace - `id: string` The plugin marketplace's ID, prefixed `marketplace_`. - `created_at: string` RFC 3339. format: date-time - `default_installation_preference: "auto_install" or "available" or "not_available" or "required" or null` Organization plugin marketplace: the organization-wide setting every Plugin in it with no setting of its own gets. Null for a member's personal plugin marketplace. One of `required`, `auto_install`, `available`, `not_available`; a value this API does not yet name is returned as stored. - `"auto_install"` - `"available"` - `"not_available"` - `"required"` - `last_sync_ended_at: string or null` RFC 3339. When the most recent synchronization attempt to finish did so, whatever its outcome; for a repository plugin marketplace no synchronization has run on yet, when it was created. Null for a plugin marketplace that is not synchronized from a repository. format: date-time - `last_sync_read_sha: string or null` The commit the last synchronization attempt that reached the repository read, whether or not its content was then accepted (see `sync_status`); an attempt that ends `failed_auth` or `failed_transient` leaves it unchanged. Null until an attempt has first read the repository, and for a plugin marketplace that is not synchronized from a repository. - `name: string` Fixed for the plugin marketplace's lifetime. - `owner: BetaPluginOwnerOrganization or BetaPluginOwnerUser` The organization, or the member whose personal plugin marketplace it is. - `BetaPluginOwnerOrganization object` - `type: "organization"` The Plugin lives in a plugin marketplace the organization owns. default: organization - `BetaPluginOwnerUser object` - `type: "user"` The Plugin lives in one member's personal plugin marketplace. default: user - `user_id: string` The member's User ID. - `source: "directory" or "github" or "gitlab" or 2 more` Where the plugin marketplace's Plugins come from: `manual` when they are uploaded; `github`, `gitlab` or `public_git` when they are synchronized from the Git repository the owner connected, into which nothing can be uploaded; `directory` is Anthropic's own catalog, which this API does not list. A value this API does not yet name is returned as stored. - `"directory"` - `"github"` - `"gitlab"` - `"manual"` - `"public_git"` - `sync_status: "failed_auth" or "failed_content" or "failed_limits" or 3 more or null` Outcome of the plugin marketplace's most recent synchronization: one of `success`, `in_progress`, `failed_content`, `failed_transient`, `failed_auth`, `failed_limits`; a value this API does not yet name is returned as stored. Null until a synchronization is first attempted — so always for a `manual` plugin marketplace. - `"failed_auth"` - `"failed_content"` - `"failed_limits"` - `"failed_transient"` - `"in_progress"` - `"success"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugin_marketplaces/$MARKETPLACE_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "default_installation_preference": "available" }' ``` ##### Response (200) ```json { "id": "marketplace_01HxQ3v9KpZ2mTn8RwLc4Ys7", "created_at": "2026-03-14T09:26:53.589793Z", "default_installation_preference": "available", "last_sync_ended_at": "2026-03-14T09:26:53.589793Z", "last_sync_read_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8", "name": "engineering-tools", "owner": { "type": "organization" }, "source": "github", "sync_status": "success", "type": "plugin_marketplace" } ``` ### Validate Plugin Marketplace Repository **POST** `/v1/organizations/plugin_marketplaces/validate_repository` Check whether a plugin marketplace held in a public GitHub repository would synchronize into claude.ai, without connecting or storing it. To check a `.zip` of the marketplace directory instead, use Validate Plugin Marketplace Archive. The report says whether `marketplace.json` is well-formed, which plugins a synchronization would skip and why, and which plugins would synchronize only in part, with some files left out. A repository that is missing, private, or has no such branch or commit is reported, not refused: the response is a report with `valid: false`. Plugin sources outside the marketplace are fetched anonymously from GitHub, so a private one is reported as not found; a source on any other host is not fetched here, and the report notes that it will be checked when the marketplace actually synchronizes. Nothing is recorded on the Compliance API activity feed. For a worked example, see [Validate marketplace content](https://platform.claude.com/docs/en/manage-claude/plugins-api?sdk_languages=http#validate-marketplace-content) in the Plugins API guide. **Accepted credentials:** an Admin API key with the `read:plugins` or `write:plugins` scope; `read:org_audit` and `read:compliance_org_data` do not grant it. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `repository_url: string` The `https://` URL of a public repository on github.com that holds the marketplace. Any other host, a URL with credentials in it, or one that does not name a repository is a 400. minLength: 1 - `ref: optional string or null` The branch to validate the tip of, or the full 40-character SHA of the commit to validate. When omitted, the branch a synchronization would read (usually the repository's default branch); if that is not the default branch, the report's `ref` says which branch was read. An empty string, or a value that is neither a branch name nor a 40-character SHA, is a 400. minLength: 1 #### Returns - `BetaPluginMarketplaceValidationReport object` The outcome of validating plugin marketplace content: a report, not a stored object, so nothing in it can be retrieved afterwards. - `type: "plugin_marketplace_validation_report"` Always `plugin_marketplace_validation_report`. default: plugin_marketplace_validation_report - `commit_sha: string or null` The full SHA of the commit that was validated: for a repository, the commit that was read; for an uploaded archive, the commit recorded in the archive's comment (as a Git host's download writes it; not verified), else null. - `manifest_error: string or null` Set when nothing could be validated: the repository or archive could not be read, or marketplace.json is missing, malformed or over a limit. Null otherwise. - `manifest_error_code: string or null` A stable identifier for `manifest_error`; null when that is. - `plugin_errors: array of BetaPluginMarketplaceValidationPluginError` One entry per plugin a synchronization would skip entirely, keyed by the plugin's name in marketplace.json. - `error: string` Why the plugin would be skipped by a synchronization. - `error_code: string` A stable identifier for the reason — the value to branch on. - `name: string` The plugin's name, as its entry in marketplace.json declares it. - `plugin_warnings: array of BetaPluginMarketplaceValidationPluginWarnings` One entry per plugin that would synchronize with some of its contents left out, keyed by the plugin's name in marketplace.json. - `name: string` The plugin's name, as its entry in marketplace.json declares it. - `warnings: array of BetaPluginMarketplaceValidationPluginWarning` The parts of the plugin a synchronization would leave out. - `error_code: string` A stable identifier for the kind of warning. - `message: string` What would be left out, and why. - `ref: string or null` For a repository, the branch that was read by name: the one requested, or else the branch a synchronization of this repository is set to read. Null when no branch is named or set and the repository's default branch was read, for a request by commit SHA, and for an uploaded archive. - `total_plugin_count: number` How many plugins marketplace.json declares; 0 when it could not be read. - `valid: boolean` True when marketplace.json is well-formed and no plugin would be skipped; warnings never make it false. #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugin_marketplaces/validate_repository \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "repository_url": "https://github.com/example-org/example-marketplace", "ref": "main" }' ``` ##### Response (200) ```json { "commit_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8", "manifest_error": "manifest_error", "manifest_error_code": "marketplace_sync_manifest_not_found", "plugin_errors": [ { "error": "error", "error_code": "marketplace_sync_plugin_missing_manifest", "name": "name" } ], "plugin_warnings": [ { "name": "name", "warnings": [ { "error_code": "marketplace_sync_zipball_symlink_dangling", "message": "message" } ] } ], "ref": "main", "total_plugin_count": 0, "type": "plugin_marketplace_validation_report", "valid": false } ``` ### Validate Plugin Marketplace Archive **POST** `/v1/organizations/plugin_marketplaces/validate_archive` Check whether a plugin marketplace, uploaded as a `.zip` of the marketplace directory, would synchronize into claude.ai, without connecting or storing it. To check a public GitHub repository instead, use Validate Plugin Marketplace Repository. The report says whether `marketplace.json` is well-formed, which plugins a synchronization would skip and why, and which plugins would synchronize only in part, with some files left out. An archive that cannot be read as a marketplace is reported, not refused: the response is a report with `valid: false`. Plugin sources outside the marketplace are fetched anonymously from GitHub, so a private one is reported as not found; a source on any other host is not fetched here, and the report notes that it will be checked when the marketplace actually synchronizes. Nothing is recorded on the Compliance API activity feed. For a worked example, see [Validate marketplace content](https://platform.claude.com/docs/en/manage-claude/plugins-api?sdk_languages=http#validate-marketplace-content) in the Plugins API guide. **Accepted credentials:** an Admin API key with the `read:plugins` or `write:plugins` scope; `read:org_audit` and `read:compliance_org_data` do not grant it. Every request must include the beta header `anthropic-beta: ce-plugins-2026-09-01`. A request without it returns `404`, exactly as if the endpoint did not exist. The Plugins API is in beta and is available to Claude Enterprise organizations only. It is not available to Claude Platform (Claude Console) organizations, or to organizations with HIPAA readiness enabled. #### Headers - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `ce-plugins-2026-09-01` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters (form-data) - `archive: string` A .zip of the marketplace directory (its contents at the root, or wrapped in one folder as a Git host's download produces), sent as a file part with a filename; DEFLATE- or STORE-compressed, at most 32 MB. A part sent without a filename, a second archive part, or any other form field is a 400; a larger archive is a 413. format: binary #### Returns - `BetaPluginMarketplaceValidationReport object` The outcome of validating plugin marketplace content: a report, not a stored object, so nothing in it can be retrieved afterwards. - `type: "plugin_marketplace_validation_report"` Always `plugin_marketplace_validation_report`. default: plugin_marketplace_validation_report - `commit_sha: string or null` The full SHA of the commit that was validated: for a repository, the commit that was read; for an uploaded archive, the commit recorded in the archive's comment (as a Git host's download writes it; not verified), else null. - `manifest_error: string or null` Set when nothing could be validated: the repository or archive could not be read, or marketplace.json is missing, malformed or over a limit. Null otherwise. - `manifest_error_code: string or null` A stable identifier for `manifest_error`; null when that is. - `plugin_errors: array of BetaPluginMarketplaceValidationPluginError` One entry per plugin a synchronization would skip entirely, keyed by the plugin's name in marketplace.json. - `error: string` Why the plugin would be skipped by a synchronization. - `error_code: string` A stable identifier for the reason — the value to branch on. - `name: string` The plugin's name, as its entry in marketplace.json declares it. - `plugin_warnings: array of BetaPluginMarketplaceValidationPluginWarnings` One entry per plugin that would synchronize with some of its contents left out, keyed by the plugin's name in marketplace.json. - `name: string` The plugin's name, as its entry in marketplace.json declares it. - `warnings: array of BetaPluginMarketplaceValidationPluginWarning` The parts of the plugin a synchronization would leave out. - `error_code: string` A stable identifier for the kind of warning. - `message: string` What would be left out, and why. - `ref: string or null` For a repository, the branch that was read by name: the one requested, or else the branch a synchronization of this repository is set to read. Null when no branch is named or set and the repository's default branch was read, for a request by commit SHA, and for an uploaded archive. - `total_plugin_count: number` How many plugins marketplace.json declares; 0 when it could not be read. - `valid: boolean` True when marketplace.json is well-formed and no plugin would be skipped; warnings never make it false. #### Example ```bash curl https://api.anthropic.com/v1/organizations/plugin_marketplaces/validate_archive \ -H 'Content-Type: multipart/form-data' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: ce-plugins-2026-09-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -F 'archive=@/path/to/archive' ``` ##### Response (200) ```json { "commit_sha": "9fceb02d0ae598e95dc970b74767f19372d61af8", "manifest_error": "manifest_error", "manifest_error_code": "marketplace_sync_manifest_not_found", "plugin_errors": [ { "error": "error", "error_code": "marketplace_sync_plugin_missing_manifest", "name": "name" } ], "plugin_warnings": [ { "name": "name", "warnings": [ { "error_code": "marketplace_sync_zipball_symlink_dangling", "message": "message" } ] } ], "ref": "main", "total_plugin_count": 0, "type": "plugin_marketplace_validation_report", "valid": false } ``` ## Beta › Organization › Telemetry Destinations ### Create a Telemetry Destination **POST** `/v1/organizations/telemetry_destinations` Register an OpenTelemetry destination for the organization. The destination starts in state `enabled`. An organization can have at most 10 destinations, including disabled ones. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=http#add-a-destination) to learn more about adding a destination. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `endpoint_url: string` The base URL of your collector's OTLP/HTTP endpoint, for example `https://gateway.example.com`. The URL must use `https` and a hostname, not an IP address. The port, if given, must be 443. The URL must not contain a query string, a fragment, or a username and password. At most 2,048 characters. A path prefix, such as `/otlp`, is allowed. Don't include the per-signal path (`/v1/traces`), because the API appends it on delivery. If your collector takes traces on another path, also set `traces.endpoint_url`. minLength: 1, maxLength: 2048 - `workspaces: BetaTelemetryDestinationWorkspacesParams` Which of the organization's workspaces the destination covers. - `BetaTelemetryDestinationWorkspacesAllParams object` Cover every workspace of the organization. Doesn't take `workspace_ids`. An update that sets `all` empties the destination's workspace list. - `type: "all"` - `BetaTelemetryDestinationWorkspacesIncludeParams object` Cover only the workspaces on the list. - `type: "include"` - `workspace_ids: optional array of string` The IDs of the workspaces on the destination's list (`wrkspc_...`). At most 100 per request. On create, these workspaces become the destination's list. If you leave `workspace_ids` out, the list starts empty. If the API refuses one of the IDs, it doesn't create the destination. On update, `workspace_ids` replaces the whole list. A workspace that stays on the list keeps its entry and its `created_at`. An empty array empties the list. If you leave `workspace_ids` out and the type stays the same, the list doesn't change. If you leave it out and the type changes, the new list starts empty. After a change to `include` without `workspace_ids`, the destination doesn't cover any workspace until one is added. After a change to `exclude` without `workspace_ids`, it covers every workspace. An ID sent more than once is added once. An archived workspace can't be added to a list. An update can keep an archived workspace that is already on the list. - `BetaTelemetryDestinationWorkspacesExcludeParams object` Cover every workspace of the organization except the workspaces on the list. - `type: "exclude"` - `workspace_ids: optional array of string` The IDs of the workspaces on the destination's list (`wrkspc_...`). At most 100 per request. On create, these workspaces become the destination's list. If you leave `workspace_ids` out, the list starts empty. If the API refuses one of the IDs, it doesn't create the destination. On update, `workspace_ids` replaces the whole list. A workspace that stays on the list keeps its entry and its `created_at`. An empty array empties the list. If you leave `workspace_ids` out and the type stays the same, the list doesn't change. If you leave it out and the type changes, the new list starts empty. After a change to `include` without `workspace_ids`, the destination doesn't cover any workspace until one is added. After a change to `exclude` without `workspace_ids`, it covers every workspace. An ID sent more than once is added once. An archived workspace can't be added to a list. An update can keep an archived workspace that is already on the list. - `display_name: optional string or null` Human-readable name for the destination. Optional. 1 to 255 characters. - `headers: optional map[string]` Request headers that the API sends with every delivery, typically your collector's authentication header (for example `authorization`). The API stores the values encrypted and never returns them. Reads show only `header_names`. At most 20 headers. Names are at most 128 characters. Two names can't differ only in case. Values are printable ASCII, at most 4,096 characters, and can't begin or end with a space. Names and values together are at most 16,384 bytes. Reserved names are rejected, for example `host`, `cookie`, `user-agent`, and names that start with `content-`, `proxy-`, `x-forwarded-`, or `anthropic-`. For this check, `_` in a name counts as `-`. - `traces: optional BetaTelemetryDestinationTracesParams` The settings for the traces that the destination receives. If you leave it out, every setting takes its default. - `content_mode: optional BetaTelemetryDestinationContentMode or null` What the exported spans contain. Defaults to `metadata_only` on create. On update, `null` sets `metadata_only`. - `"metadata_only"` The spans contain identifiers, timing, status, token counts, and similar metadata. They don't contain prompt text, completion text, or tool inputs and outputs. - `"content"` The spans contain the same metadata as `metadata_only`, plus message and tool content. An organization with a data-handling restriction, such as under HIPAA, can't choose this mode. The API exports only metadata for such an organization, even to a destination that already has `content`. - `enabled: optional boolean` Whether the destination receives traces. Defaults to true on create. It cannot be null. - `endpoint_url: optional string or null` The full URL of your collector's traces endpoint, for a collector that takes traces on a path other than `/v1/traces`. The API posts traces to it exactly as given and appends nothing. The same rules as for `endpoint_url` apply, except that any path is allowed. It must have the same scheme, host, and port as `endpoint_url`. At most 2,048 characters. On create, `null` is the same as leaving it out. On update, `null` removes it. The API then posts traces to `endpoint_url` with `/v1/traces` appended. A change of this URL alone keeps the registered headers. maxLength: 2048 - `max_content_bytes: optional number or null` The most bytes of content that one exported span can contain, from 1 up to the API's maximum. `null` sets no bound, so only the API's maximum applies. On create, leaving it out is the same as `null`. The error for a value above the maximum states the maximum. format: int32 #### Returns - `BetaTelemetryDestination object` An OpenTelemetry destination: an OTLP/HTTP endpoint, the request headers sent with every delivery to it, what the exported spans contain, and which workspaces it covers. A destination belongs to an organization. A workspace's spans go to every enabled destination that covers it. - `type: "telemetry_destination"` - `id: string` The unique ID of the destination (`tdst_...`). - `created_at: string` Time the destination was created. format: date-time - `delivery_health: BetaTelemetryDestinationDeliveryHealth` The most recent delivery results for this destination. - `last_error: string or null` A message that describes the most recent failed delivery to the destination, or `null` if no delivery has failed yet. Examples are `temporary DNS failure`, `TLS failure`, `timeout`, `connection failure`, `invalid address`, `HTTP error (status 503)`, and `redirect (status 301)`. The message is `invalid address` both for a hostname that doesn't exist and for an address that isn't publicly routable. It never contains the endpoint's response body, a header value, a network address, or TLS details. `last_error` and `last_error_at` always change together. A later successful delivery doesn't clear them. If `last_success_at` is later than `last_error_at`, a delivery has succeeded since this failure. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=http#delivery-errors) to learn the likely cause of each error. - `last_error_at: string or null` Time of the failure that `last_error` describes. Changes together with `last_error`. Null until a delivery first fails. format: date-time - `last_success_at: string or null` Time of the most recent successful delivery to the destination, or `null` if no delivery has succeeded yet. format: date-time - `display_name: string or null` Human-readable name for the destination. Null when none was set. - `endpoint_url: string` The base URL of the destination's OTLP/HTTP endpoint, exactly as registered. The API appends the per-signal path, such as `/v1/traces`, on delivery, unless `traces.endpoint_url` is set. - `header_names: array of string` Names of the registered request headers. Header values are write-only and are never returned. - `state: BetaTelemetryDestinationState` Whether the destination receives deliveries. - `BetaTelemetryDestinationStateEnabled object` The telemetry destination receives the spans of the workspaces that it covers. - `type: "enabled"` - `BetaTelemetryDestinationStateDisabled object` The API doesn't deliver anything to the telemetry destination. Spans produced while it is disabled aren't delivered later. - `type: "disabled"` - `reason: BetaTelemetryDestinationDisabledReason` Whether a caller or the API disabled the destination and, when the API did, why. Read-only. - `BetaTelemetryDestinationDisabledReasonCaller object` A caller disabled the destination with an update that set `state` to `disabled`. - `type: "caller"` - `BetaTelemetryDestinationDisabledReasonSustainedFailure object` The API disabled the destination because deliveries to it failed, with no successful delivery in between, for longer than a threshold that Anthropic configures and that is not part of this contract. The reason is `invalid_address` instead when the most recent failed delivery failed with an invalid address. - `type: "sustained_failure"` - `BetaTelemetryDestinationDisabledReasonInvalidAddress object` The API disabled the destination because deliveries to it failed for longer than the same threshold as for `sustained_failure`, and the most recent failed delivery failed with an invalid address: the DNS answer says that the endpoint's hostname doesn't exist or doesn't have an address, or the address that the API would connect to isn't publicly routable or is reserved, for example a loopback, link-local, private-network, or cloud-metadata address. The API doesn't connect to such an address, and retries the delivery a bounded number of times as it does after a timeout. A timeout or a server failure of the DNS lookup is a temporary DNS failure instead, not an invalid address. - `type: "invalid_address"` - `BetaTelemetryDestinationDisabledReasonRedirect object` The API disabled the destination because the endpoint answered a delivery with a 3xx status. Redirects are never followed, and one such answer disables the destination at once. - `type: "redirect"` - `traces: BetaTelemetryDestinationTraces` The destination's settings for the traces it receives. - `content_mode: BetaTelemetryDestinationContentMode` What the exported spans contain. - `"metadata_only"` The spans contain identifiers, timing, status, token counts, and similar metadata. They don't contain prompt text, completion text, or tool inputs and outputs. - `"content"` The spans contain the same metadata as `metadata_only`, plus message and tool content. An organization with a data-handling restriction, such as under HIPAA, can't choose this mode. The API exports only metadata for such an organization, even to a destination that already has `content`. - `enabled: boolean` Whether the destination receives traces. A destination whose `enabled` is false keeps its other settings. - `endpoint_url: string or null` The full URL that the API posts traces to, exactly as registered, or `null` if the destination doesn't have one. When it is `null`, the API posts traces to `endpoint_url` with `/v1/traces` appended. - `max_content_bytes: number or null` The most bytes of content that one exported span can contain, or `null` if only the API's maximum applies. Content means model prompts and responses, and tool inputs and outputs. The API shortens longer content to this size before it delivers the span. A destination whose `content_mode` is `metadata_only` keeps this value. It applies once `content_mode` is `content`. format: int32 - `updated_at: string` Time of the last change to the destination's configuration or state. Changes to `delivery_health` don't change it. An update that sets a header value always changes it, even when the value is the same as before. Adding or removing a single workspace on the destination's list doesn't change it. An update that changes the list does. format: date-time - `workspaces: BetaTelemetryDestinationWorkspaces` Which of the organization's workspaces the destination covers. - `BetaTelemetryDestinationWorkspacesAll object` The destination covers every workspace of the organization, including the default workspace, archived workspaces, and workspaces created later. It doesn't have a list. - `type: "all"` - `BetaTelemetryDestinationWorkspacesInclude object` The destination covers the workspaces on its list, and no others. - `type: "include"` - `BetaTelemetryDestinationWorkspacesExclude object` The destination covers every workspace of the organization except the workspaces on its list. A workspace created later is covered until it is added to the list. - `type: "exclude"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/telemetry_destinations \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: telemetry-destinations-2026-08-11' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{ "endpoint_url": "x", "workspaces": { "type": "all" } }' ``` ##### Response (200) ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "delivery_health": { "last_error": "last_error", "last_error_at": "2019-12-27T18:11:19.117Z", "last_success_at": "2019-12-27T18:11:19.117Z" }, "display_name": "display_name", "endpoint_url": "endpoint_url", "header_names": [ "string" ], "state": { "type": "enabled" }, "traces": { "content_mode": "metadata_only", "enabled": true, "endpoint_url": "endpoint_url", "max_content_bytes": 0 }, "type": "telemetry_destination", "updated_at": "2019-12-27T18:11:19.117Z", "workspaces": { "type": "all" } } ``` ### List Telemetry Destinations **GET** `/v1/organizations/telemetry_destinations` List the organization's destinations, newest first, optionally only those that cover given workspaces. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=http#set-up-api-tracing) to learn more about destinations. #### Query parameters - `limit: optional number` Number of destinations to return per page, between 1 and 1,000. Defaults to 20. format: int32 - `page: optional string` Opaque cursor from a previous response's `next_page`. Leave it out to get the first page. - `workspace_ids: optional array of string` Return only the destinations that cover at least one of these workspaces (`wrkspc_...`). Send at most 100 IDs, as `workspace_ids[]`. A destination covers a workspace when its `workspaces.type` is `all`, when its `include` list has the workspace, or when its `exclude` list doesn't have it. Destinations in either state can match. An ID that isn't the ID of one of the organization's workspaces doesn't match any destination, not even one whose type is `all`. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaTelemetryDestination` Destinations on this page, newest first. - `type: "telemetry_destination"` - `id: string` The unique ID of the destination (`tdst_...`). - `created_at: string` Time the destination was created. format: date-time - `delivery_health: BetaTelemetryDestinationDeliveryHealth` The most recent delivery results for this destination. - `last_error: string or null` A message that describes the most recent failed delivery to the destination, or `null` if no delivery has failed yet. Examples are `temporary DNS failure`, `TLS failure`, `timeout`, `connection failure`, `invalid address`, `HTTP error (status 503)`, and `redirect (status 301)`. The message is `invalid address` both for a hostname that doesn't exist and for an address that isn't publicly routable. It never contains the endpoint's response body, a header value, a network address, or TLS details. `last_error` and `last_error_at` always change together. A later successful delivery doesn't clear them. If `last_success_at` is later than `last_error_at`, a delivery has succeeded since this failure. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=http#delivery-errors) to learn the likely cause of each error. - `last_error_at: string or null` Time of the failure that `last_error` describes. Changes together with `last_error`. Null until a delivery first fails. format: date-time - `last_success_at: string or null` Time of the most recent successful delivery to the destination, or `null` if no delivery has succeeded yet. format: date-time - `display_name: string or null` Human-readable name for the destination. Null when none was set. - `endpoint_url: string` The base URL of the destination's OTLP/HTTP endpoint, exactly as registered. The API appends the per-signal path, such as `/v1/traces`, on delivery, unless `traces.endpoint_url` is set. - `header_names: array of string` Names of the registered request headers. Header values are write-only and are never returned. - `state: BetaTelemetryDestinationState` Whether the destination receives deliveries. - `BetaTelemetryDestinationStateEnabled object` The telemetry destination receives the spans of the workspaces that it covers. - `type: "enabled"` - `BetaTelemetryDestinationStateDisabled object` The API doesn't deliver anything to the telemetry destination. Spans produced while it is disabled aren't delivered later. - `type: "disabled"` - `reason: BetaTelemetryDestinationDisabledReason` Whether a caller or the API disabled the destination and, when the API did, why. Read-only. - `BetaTelemetryDestinationDisabledReasonCaller object` A caller disabled the destination with an update that set `state` to `disabled`. - `type: "caller"` - `BetaTelemetryDestinationDisabledReasonSustainedFailure object` The API disabled the destination because deliveries to it failed, with no successful delivery in between, for longer than a threshold that Anthropic configures and that is not part of this contract. The reason is `invalid_address` instead when the most recent failed delivery failed with an invalid address. - `type: "sustained_failure"` - `BetaTelemetryDestinationDisabledReasonInvalidAddress object` The API disabled the destination because deliveries to it failed for longer than the same threshold as for `sustained_failure`, and the most recent failed delivery failed with an invalid address: the DNS answer says that the endpoint's hostname doesn't exist or doesn't have an address, or the address that the API would connect to isn't publicly routable or is reserved, for example a loopback, link-local, private-network, or cloud-metadata address. The API doesn't connect to such an address, and retries the delivery a bounded number of times as it does after a timeout. A timeout or a server failure of the DNS lookup is a temporary DNS failure instead, not an invalid address. - `type: "invalid_address"` - `BetaTelemetryDestinationDisabledReasonRedirect object` The API disabled the destination because the endpoint answered a delivery with a 3xx status. Redirects are never followed, and one such answer disables the destination at once. - `type: "redirect"` - `traces: BetaTelemetryDestinationTraces` The destination's settings for the traces it receives. - `content_mode: BetaTelemetryDestinationContentMode` What the exported spans contain. - `"metadata_only"` The spans contain identifiers, timing, status, token counts, and similar metadata. They don't contain prompt text, completion text, or tool inputs and outputs. - `"content"` The spans contain the same metadata as `metadata_only`, plus message and tool content. An organization with a data-handling restriction, such as under HIPAA, can't choose this mode. The API exports only metadata for such an organization, even to a destination that already has `content`. - `enabled: boolean` Whether the destination receives traces. A destination whose `enabled` is false keeps its other settings. - `endpoint_url: string or null` The full URL that the API posts traces to, exactly as registered, or `null` if the destination doesn't have one. When it is `null`, the API posts traces to `endpoint_url` with `/v1/traces` appended. - `max_content_bytes: number or null` The most bytes of content that one exported span can contain, or `null` if only the API's maximum applies. Content means model prompts and responses, and tool inputs and outputs. The API shortens longer content to this size before it delivers the span. A destination whose `content_mode` is `metadata_only` keeps this value. It applies once `content_mode` is `content`. format: int32 - `updated_at: string` Time of the last change to the destination's configuration or state. Changes to `delivery_health` don't change it. An update that sets a header value always changes it, even when the value is the same as before. Adding or removing a single workspace on the destination's list doesn't change it. An update that changes the list does. format: date-time - `workspaces: BetaTelemetryDestinationWorkspaces` Which of the organization's workspaces the destination covers. - `BetaTelemetryDestinationWorkspacesAll object` The destination covers every workspace of the organization, including the default workspace, archived workspaces, and workspaces created later. It doesn't have a list. - `type: "all"` - `BetaTelemetryDestinationWorkspacesInclude object` The destination covers the workspaces on its list, and no others. - `type: "include"` - `BetaTelemetryDestinationWorkspacesExclude object` The destination covers every workspace of the organization except the workspaces on its list. A workspace created later is covered until it is added to the list. - `type: "exclude"` - `next_page: string or null` Cursor for the next page. Null on the last page. #### Example ```bash curl https://api.anthropic.com/v1/organizations/telemetry_destinations \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: telemetry-destinations-2026-08-11' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "delivery_health": { "last_error": "last_error", "last_error_at": "2019-12-27T18:11:19.117Z", "last_success_at": "2019-12-27T18:11:19.117Z" }, "display_name": "display_name", "endpoint_url": "endpoint_url", "header_names": [ "string" ], "state": { "type": "enabled" }, "traces": { "content_mode": "metadata_only", "enabled": true, "endpoint_url": "endpoint_url", "max_content_bytes": 0 }, "type": "telemetry_destination", "updated_at": "2019-12-27T18:11:19.117Z", "workspaces": { "type": "all" } } ], "next_page": "next_page" } ``` ### Retrieve a Telemetry Destination **GET** `/v1/organizations/telemetry_destinations/{destination_id}` Read a destination's configuration, state, and most recent delivery results. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=http#delivery-and-health) to learn how the API delivers spans and when it disables a destination. #### Path parameters - `destination_id: string` ID of the destination (`tdst_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaTelemetryDestination object` An OpenTelemetry destination: an OTLP/HTTP endpoint, the request headers sent with every delivery to it, what the exported spans contain, and which workspaces it covers. A destination belongs to an organization. A workspace's spans go to every enabled destination that covers it. - `type: "telemetry_destination"` - `id: string` The unique ID of the destination (`tdst_...`). - `created_at: string` Time the destination was created. format: date-time - `delivery_health: BetaTelemetryDestinationDeliveryHealth` The most recent delivery results for this destination. - `last_error: string or null` A message that describes the most recent failed delivery to the destination, or `null` if no delivery has failed yet. Examples are `temporary DNS failure`, `TLS failure`, `timeout`, `connection failure`, `invalid address`, `HTTP error (status 503)`, and `redirect (status 301)`. The message is `invalid address` both for a hostname that doesn't exist and for an address that isn't publicly routable. It never contains the endpoint's response body, a header value, a network address, or TLS details. `last_error` and `last_error_at` always change together. A later successful delivery doesn't clear them. If `last_success_at` is later than `last_error_at`, a delivery has succeeded since this failure. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=http#delivery-errors) to learn the likely cause of each error. - `last_error_at: string or null` Time of the failure that `last_error` describes. Changes together with `last_error`. Null until a delivery first fails. format: date-time - `last_success_at: string or null` Time of the most recent successful delivery to the destination, or `null` if no delivery has succeeded yet. format: date-time - `display_name: string or null` Human-readable name for the destination. Null when none was set. - `endpoint_url: string` The base URL of the destination's OTLP/HTTP endpoint, exactly as registered. The API appends the per-signal path, such as `/v1/traces`, on delivery, unless `traces.endpoint_url` is set. - `header_names: array of string` Names of the registered request headers. Header values are write-only and are never returned. - `state: BetaTelemetryDestinationState` Whether the destination receives deliveries. - `BetaTelemetryDestinationStateEnabled object` The telemetry destination receives the spans of the workspaces that it covers. - `type: "enabled"` - `BetaTelemetryDestinationStateDisabled object` The API doesn't deliver anything to the telemetry destination. Spans produced while it is disabled aren't delivered later. - `type: "disabled"` - `reason: BetaTelemetryDestinationDisabledReason` Whether a caller or the API disabled the destination and, when the API did, why. Read-only. - `BetaTelemetryDestinationDisabledReasonCaller object` A caller disabled the destination with an update that set `state` to `disabled`. - `type: "caller"` - `BetaTelemetryDestinationDisabledReasonSustainedFailure object` The API disabled the destination because deliveries to it failed, with no successful delivery in between, for longer than a threshold that Anthropic configures and that is not part of this contract. The reason is `invalid_address` instead when the most recent failed delivery failed with an invalid address. - `type: "sustained_failure"` - `BetaTelemetryDestinationDisabledReasonInvalidAddress object` The API disabled the destination because deliveries to it failed for longer than the same threshold as for `sustained_failure`, and the most recent failed delivery failed with an invalid address: the DNS answer says that the endpoint's hostname doesn't exist or doesn't have an address, or the address that the API would connect to isn't publicly routable or is reserved, for example a loopback, link-local, private-network, or cloud-metadata address. The API doesn't connect to such an address, and retries the delivery a bounded number of times as it does after a timeout. A timeout or a server failure of the DNS lookup is a temporary DNS failure instead, not an invalid address. - `type: "invalid_address"` - `BetaTelemetryDestinationDisabledReasonRedirect object` The API disabled the destination because the endpoint answered a delivery with a 3xx status. Redirects are never followed, and one such answer disables the destination at once. - `type: "redirect"` - `traces: BetaTelemetryDestinationTraces` The destination's settings for the traces it receives. - `content_mode: BetaTelemetryDestinationContentMode` What the exported spans contain. - `"metadata_only"` The spans contain identifiers, timing, status, token counts, and similar metadata. They don't contain prompt text, completion text, or tool inputs and outputs. - `"content"` The spans contain the same metadata as `metadata_only`, plus message and tool content. An organization with a data-handling restriction, such as under HIPAA, can't choose this mode. The API exports only metadata for such an organization, even to a destination that already has `content`. - `enabled: boolean` Whether the destination receives traces. A destination whose `enabled` is false keeps its other settings. - `endpoint_url: string or null` The full URL that the API posts traces to, exactly as registered, or `null` if the destination doesn't have one. When it is `null`, the API posts traces to `endpoint_url` with `/v1/traces` appended. - `max_content_bytes: number or null` The most bytes of content that one exported span can contain, or `null` if only the API's maximum applies. Content means model prompts and responses, and tool inputs and outputs. The API shortens longer content to this size before it delivers the span. A destination whose `content_mode` is `metadata_only` keeps this value. It applies once `content_mode` is `content`. format: int32 - `updated_at: string` Time of the last change to the destination's configuration or state. Changes to `delivery_health` don't change it. An update that sets a header value always changes it, even when the value is the same as before. Adding or removing a single workspace on the destination's list doesn't change it. An update that changes the list does. format: date-time - `workspaces: BetaTelemetryDestinationWorkspaces` Which of the organization's workspaces the destination covers. - `BetaTelemetryDestinationWorkspacesAll object` The destination covers every workspace of the organization, including the default workspace, archived workspaces, and workspaces created later. It doesn't have a list. - `type: "all"` - `BetaTelemetryDestinationWorkspacesInclude object` The destination covers the workspaces on its list, and no others. - `type: "include"` - `BetaTelemetryDestinationWorkspacesExclude object` The destination covers every workspace of the organization except the workspaces on its list. A workspace created later is covered until it is added to the list. - `type: "exclude"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/telemetry_destinations/$DESTINATION_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: telemetry-destinations-2026-08-11' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "delivery_health": { "last_error": "last_error", "last_error_at": "2019-12-27T18:11:19.117Z", "last_success_at": "2019-12-27T18:11:19.117Z" }, "display_name": "display_name", "endpoint_url": "endpoint_url", "header_names": [ "string" ], "state": { "type": "enabled" }, "traces": { "content_mode": "metadata_only", "enabled": true, "endpoint_url": "endpoint_url", "max_content_bytes": 0 }, "type": "telemetry_destination", "updated_at": "2019-12-27T18:11:19.117Z", "workspaces": { "type": "all" } } ``` ### Update a Telemetry Destination **POST** `/v1/organizations/telemetry_destinations/{destination_id}` Change a telemetry destination's settings, its state, or which workspaces it covers. Send at least one field. Omitted fields keep their stored values, except the registered headers, which a change of the endpoint's hostname or port removes. Only `display_name`, `traces`, `traces.endpoint_url`, `traces.content_mode`, `traces.max_content_bytes`, and individual `headers` values accept `null`. If another request changes the destination while the update runs, the API returns a 409 `conflict_error`. Read the destination again, then retry the update. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=http#delivery-and-health) to learn more about changing a destination. #### Path parameters - `destination_id: string` ID of the destination (`tdst_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Body parameters - `display_name: optional string or null` New human-readable name, 1 to 255 characters. Null clears it. - `endpoint_url: optional string` The new base URL of the destination's OTLP/HTTP endpoint. The same rules as on create apply. A change of hostname or port first removes every registered header, so send the headers for the new endpoint in the same request. When the destination has a `traces.endpoint_url`, such a change must also set `traces.endpoint_url` to a URL with the new hostname and port, or to `null`. A change of the path alone keeps the headers. maxLength: 2048 - `headers: optional map[string] or null` Headers to set or remove. The API merges them into the destination's headers by name. Names compare case-insensitively. A string value sets or replaces that header. A `null` value removes it. Headers that you omit don't change. The field itself can't be `null`. A request that sets a header value must also include `endpoint_url`. The current URL is accepted. The resulting set must stay within the same limits as on create. When the request sets a value, each stored value that it doesn't set counts as 4,096 bytes toward the 16,384-byte limit, because you can't read its real length. So to change one header of a destination that has four or more other headers, send the values of the others again in the same request. - `state: optional BetaTelemetryDestinationStateParams` Whether the destination receives deliveries after the update. The field can't be `null`. - `BetaTelemetryDestinationStateEnabledParams object` Start deliveries to the telemetry destination again. This doesn't reset `delivery_health`. - `type: "enabled"` - `BetaTelemetryDestinationStateDisabledParams object` Stop deliveries to the telemetry destination. Spans produced while it is disabled aren't delivered later. A destination that is already disabled keeps its `reason`. - `type: "disabled"` - `traces: optional BetaTelemetryDestinationTracesParams or null` The traces settings to change. Omitted settings keep their stored values. `null` sets every traces setting to its create default. - `content_mode: optional BetaTelemetryDestinationContentMode or null` What the exported spans contain. Defaults to `metadata_only` on create. On update, `null` sets `metadata_only`. - `"metadata_only"` The spans contain identifiers, timing, status, token counts, and similar metadata. They don't contain prompt text, completion text, or tool inputs and outputs. - `"content"` The spans contain the same metadata as `metadata_only`, plus message and tool content. An organization with a data-handling restriction, such as under HIPAA, can't choose this mode. The API exports only metadata for such an organization, even to a destination that already has `content`. - `enabled: optional boolean` Whether the destination receives traces. Defaults to true on create. It cannot be null. - `endpoint_url: optional string or null` The full URL of your collector's traces endpoint, for a collector that takes traces on a path other than `/v1/traces`. The API posts traces to it exactly as given and appends nothing. The same rules as for `endpoint_url` apply, except that any path is allowed. It must have the same scheme, host, and port as `endpoint_url`. At most 2,048 characters. On create, `null` is the same as leaving it out. On update, `null` removes it. The API then posts traces to `endpoint_url` with `/v1/traces` appended. A change of this URL alone keeps the registered headers. maxLength: 2048 - `max_content_bytes: optional number or null` The most bytes of content that one exported span can contain, from 1 up to the API's maximum. `null` sets no bound, so only the API's maximum applies. On create, leaving it out is the same as `null`. The error for a value above the maximum states the maximum. format: int32 - `workspaces: optional BetaTelemetryDestinationWorkspacesParams` The new workspace scope, in the same form as on create. The field can't be `null`. The API refuses an update that changes the type or sends `workspace_ids` while the destination's list has more than 750 workspaces. Remove workspaces one at a time until 750 or fewer remain, then send the update again. - `BetaTelemetryDestinationWorkspacesAllParams object` Cover every workspace of the organization. Doesn't take `workspace_ids`. An update that sets `all` empties the destination's workspace list. - `type: "all"` - `BetaTelemetryDestinationWorkspacesIncludeParams object` Cover only the workspaces on the list. - `type: "include"` - `workspace_ids: optional array of string` The IDs of the workspaces on the destination's list (`wrkspc_...`). At most 100 per request. On create, these workspaces become the destination's list. If you leave `workspace_ids` out, the list starts empty. If the API refuses one of the IDs, it doesn't create the destination. On update, `workspace_ids` replaces the whole list. A workspace that stays on the list keeps its entry and its `created_at`. An empty array empties the list. If you leave `workspace_ids` out and the type stays the same, the list doesn't change. If you leave it out and the type changes, the new list starts empty. After a change to `include` without `workspace_ids`, the destination doesn't cover any workspace until one is added. After a change to `exclude` without `workspace_ids`, it covers every workspace. An ID sent more than once is added once. An archived workspace can't be added to a list. An update can keep an archived workspace that is already on the list. - `BetaTelemetryDestinationWorkspacesExcludeParams object` Cover every workspace of the organization except the workspaces on the list. - `type: "exclude"` - `workspace_ids: optional array of string` The IDs of the workspaces on the destination's list (`wrkspc_...`). At most 100 per request. On create, these workspaces become the destination's list. If you leave `workspace_ids` out, the list starts empty. If the API refuses one of the IDs, it doesn't create the destination. On update, `workspace_ids` replaces the whole list. A workspace that stays on the list keeps its entry and its `created_at`. An empty array empties the list. If you leave `workspace_ids` out and the type stays the same, the list doesn't change. If you leave it out and the type changes, the new list starts empty. After a change to `include` without `workspace_ids`, the destination doesn't cover any workspace until one is added. After a change to `exclude` without `workspace_ids`, it covers every workspace. An ID sent more than once is added once. An archived workspace can't be added to a list. An update can keep an archived workspace that is already on the list. #### Returns - `BetaTelemetryDestination object` An OpenTelemetry destination: an OTLP/HTTP endpoint, the request headers sent with every delivery to it, what the exported spans contain, and which workspaces it covers. A destination belongs to an organization. A workspace's spans go to every enabled destination that covers it. - `type: "telemetry_destination"` - `id: string` The unique ID of the destination (`tdst_...`). - `created_at: string` Time the destination was created. format: date-time - `delivery_health: BetaTelemetryDestinationDeliveryHealth` The most recent delivery results for this destination. - `last_error: string or null` A message that describes the most recent failed delivery to the destination, or `null` if no delivery has failed yet. Examples are `temporary DNS failure`, `TLS failure`, `timeout`, `connection failure`, `invalid address`, `HTTP error (status 503)`, and `redirect (status 301)`. The message is `invalid address` both for a hostname that doesn't exist and for an address that isn't publicly routable. It never contains the endpoint's response body, a header value, a network address, or TLS details. `last_error` and `last_error_at` always change together. A later successful delivery doesn't clear them. If `last_success_at` is later than `last_error_at`, a delivery has succeeded since this failure. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=http#delivery-errors) to learn the likely cause of each error. - `last_error_at: string or null` Time of the failure that `last_error` describes. Changes together with `last_error`. Null until a delivery first fails. format: date-time - `last_success_at: string or null` Time of the most recent successful delivery to the destination, or `null` if no delivery has succeeded yet. format: date-time - `display_name: string or null` Human-readable name for the destination. Null when none was set. - `endpoint_url: string` The base URL of the destination's OTLP/HTTP endpoint, exactly as registered. The API appends the per-signal path, such as `/v1/traces`, on delivery, unless `traces.endpoint_url` is set. - `header_names: array of string` Names of the registered request headers. Header values are write-only and are never returned. - `state: BetaTelemetryDestinationState` Whether the destination receives deliveries. - `BetaTelemetryDestinationStateEnabled object` The telemetry destination receives the spans of the workspaces that it covers. - `type: "enabled"` - `BetaTelemetryDestinationStateDisabled object` The API doesn't deliver anything to the telemetry destination. Spans produced while it is disabled aren't delivered later. - `type: "disabled"` - `reason: BetaTelemetryDestinationDisabledReason` Whether a caller or the API disabled the destination and, when the API did, why. Read-only. - `BetaTelemetryDestinationDisabledReasonCaller object` A caller disabled the destination with an update that set `state` to `disabled`. - `type: "caller"` - `BetaTelemetryDestinationDisabledReasonSustainedFailure object` The API disabled the destination because deliveries to it failed, with no successful delivery in between, for longer than a threshold that Anthropic configures and that is not part of this contract. The reason is `invalid_address` instead when the most recent failed delivery failed with an invalid address. - `type: "sustained_failure"` - `BetaTelemetryDestinationDisabledReasonInvalidAddress object` The API disabled the destination because deliveries to it failed for longer than the same threshold as for `sustained_failure`, and the most recent failed delivery failed with an invalid address: the DNS answer says that the endpoint's hostname doesn't exist or doesn't have an address, or the address that the API would connect to isn't publicly routable or is reserved, for example a loopback, link-local, private-network, or cloud-metadata address. The API doesn't connect to such an address, and retries the delivery a bounded number of times as it does after a timeout. A timeout or a server failure of the DNS lookup is a temporary DNS failure instead, not an invalid address. - `type: "invalid_address"` - `BetaTelemetryDestinationDisabledReasonRedirect object` The API disabled the destination because the endpoint answered a delivery with a 3xx status. Redirects are never followed, and one such answer disables the destination at once. - `type: "redirect"` - `traces: BetaTelemetryDestinationTraces` The destination's settings for the traces it receives. - `content_mode: BetaTelemetryDestinationContentMode` What the exported spans contain. - `"metadata_only"` The spans contain identifiers, timing, status, token counts, and similar metadata. They don't contain prompt text, completion text, or tool inputs and outputs. - `"content"` The spans contain the same metadata as `metadata_only`, plus message and tool content. An organization with a data-handling restriction, such as under HIPAA, can't choose this mode. The API exports only metadata for such an organization, even to a destination that already has `content`. - `enabled: boolean` Whether the destination receives traces. A destination whose `enabled` is false keeps its other settings. - `endpoint_url: string or null` The full URL that the API posts traces to, exactly as registered, or `null` if the destination doesn't have one. When it is `null`, the API posts traces to `endpoint_url` with `/v1/traces` appended. - `max_content_bytes: number or null` The most bytes of content that one exported span can contain, or `null` if only the API's maximum applies. Content means model prompts and responses, and tool inputs and outputs. The API shortens longer content to this size before it delivers the span. A destination whose `content_mode` is `metadata_only` keeps this value. It applies once `content_mode` is `content`. format: int32 - `updated_at: string` Time of the last change to the destination's configuration or state. Changes to `delivery_health` don't change it. An update that sets a header value always changes it, even when the value is the same as before. Adding or removing a single workspace on the destination's list doesn't change it. An update that changes the list does. format: date-time - `workspaces: BetaTelemetryDestinationWorkspaces` Which of the organization's workspaces the destination covers. - `BetaTelemetryDestinationWorkspacesAll object` The destination covers every workspace of the organization, including the default workspace, archived workspaces, and workspaces created later. It doesn't have a list. - `type: "all"` - `BetaTelemetryDestinationWorkspacesInclude object` The destination covers the workspaces on its list, and no others. - `type: "include"` - `BetaTelemetryDestinationWorkspacesExclude object` The destination covers every workspace of the organization except the workspaces on its list. A workspace created later is covered until it is added to the list. - `type: "exclude"` #### Example ```bash curl https://api.anthropic.com/v1/organizations/telemetry_destinations/$DESTINATION_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: telemetry-destinations-2026-08-11' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" \ -d '{}' ``` ##### Response (200) ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "delivery_health": { "last_error": "last_error", "last_error_at": "2019-12-27T18:11:19.117Z", "last_success_at": "2019-12-27T18:11:19.117Z" }, "display_name": "display_name", "endpoint_url": "endpoint_url", "header_names": [ "string" ], "state": { "type": "enabled" }, "traces": { "content_mode": "metadata_only", "enabled": true, "endpoint_url": "endpoint_url", "max_content_bytes": 0 }, "type": "telemetry_destination", "updated_at": "2019-12-27T18:11:19.117Z", "workspaces": { "type": "all" } } ``` ### Delete a Telemetry Destination **DELETE** `/v1/organizations/telemetry_destinations/{destination_id}` Delete a destination and its workspace list. The API stops sending spans to the destination. The spans of the workspaces it covered still go to the other destinations that cover them. A deleted destination can't be read, listed, or restored. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=http#delivery-and-health) to learn more about managing a destination. #### Path parameters - `destination_id: string` ID of the destination (`tdst_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaDeletedTelemetryDestination object` Confirmation that a destination was deleted. - `type: "telemetry_destination_deleted"` - `id: string` ID of the deleted destination (`tdst_...`). #### Example ```bash curl https://api.anthropic.com/v1/organizations/telemetry_destinations/$DESTINATION_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: telemetry-destinations-2026-08-11' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "id": "id", "type": "telemetry_destination_deleted" } ``` ### Test a Telemetry Destination **POST** `/v1/organizations/telemetry_destinations/{destination_id}/test` Send one test span, named `anthropic.test`, to the destination with its registered headers, once and without retries, and report the destination's answer. The response is 200 whether or not the destination answered with a 2xx status: its `result` has the type `success`, or the type `failure` and the reason in `error`. The destination's configuration, `state` and `delivery_health` do not change. A disabled destination can be tested too. Wait 10 seconds between tests of one destination; a request that comes sooner may be answered with status 429. #### Path parameters - `destination_id: string` ID of the destination to test (starts with `tdst_`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaTelemetryDestinationTestResponse object` The result of one test span sent to a destination. - `type: "telemetry_destination_test"` - `result: BetaTelemetryDestinationTestResult` How the test went: `success` when the destination answered with a 2xx status, else `failure` with the reason. - `BetaTelemetryDestinationTestSuccess object` The destination answered the test span with a 2xx status. - `type: "success"` - `BetaTelemetryDestinationTestFailure object` The test span was not delivered. - `type: "failure"` - `error: string` A message that describes why the test span was not delivered, including the HTTP status code when the destination returned one. Examples: `HTTP error (status 403)`, `timeout`, `TLS failure`. It has the same form as the destination's `delivery_health.last_error` and never contains the destination's response body, any header value, a network address, or TLS details. #### Example ```bash curl https://api.anthropic.com/v1/organizations/telemetry_destinations/$DESTINATION_ID/test \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: telemetry-destinations-2026-08-11' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "result": { "type": "success" }, "type": "telemetry_destination_test" } ``` ## Beta › Organization › Telemetry Destinations › Workspaces ### List Telemetry Destination Workspaces **GET** `/v1/organizations/telemetry_destinations/{destination_id}/workspaces` List the workspaces on a destination's workspace list, newest entry first. A destination whose `workspaces.type` is `all` doesn't have a list, so its page is empty. The list includes archived workspaces. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=http#choose-workspaces-for-a-destination) to learn more about choosing the workspaces of a destination. #### Path parameters - `destination_id: string` ID of the destination (`tdst_...`). #### Query parameters - `limit: optional number` Number of entries to return per page, between 1 and 1,000. Defaults to 20. format: int32 - `page: optional string` Opaque cursor from a previous response's `next_page`. Leave it out to get the first page. #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `data: array of BetaTelemetryDestinationWorkspace` Entries on this page, newest first. - `type: "telemetry_destination_workspace"` - `created_at: string` Time the workspace was added to the list. format: date-time - `telemetry_destination_id: string` ID of the telemetry destination (`tdst_...`). - `workspace_id: string` ID of the workspace (`wrkspc_...`). - `next_page: string or null` Cursor for the next page. Null on the last page. #### Example ```bash curl https://api.anthropic.com/v1/organizations/telemetry_destinations/$DESTINATION_ID/workspaces \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: telemetry-destinations-2026-08-11' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "data": [ { "created_at": "2019-12-27T18:11:19.117Z", "telemetry_destination_id": "telemetry_destination_id", "type": "telemetry_destination_workspace", "workspace_id": "workspace_id" } ], "next_page": "next_page" } ``` ### Add a Telemetry Destination Workspace **POST** `/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}` Add one workspace to a destination's workspace list. Under `include` the workspace's spans start going to the destination. Under `exclude` they stop. A list holds at most 1,000 workspaces. Adding a workspace that is already on the list changes nothing and returns the existing entry. An archived workspace that isn't on the list yet can't be added. A destination whose `workspaces.type` is `all` doesn't have a list, so the API returns 400. To change which workspaces such a destination covers, update its `workspaces`. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=http#choose-workspaces-for-a-destination) to learn more about choosing the workspaces of a destination. #### Path parameters - `destination_id: string` ID of the destination (`tdst_...`). - `workspace_id: string` ID of the workspace to add (`wrkspc_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaTelemetryDestinationWorkspace object` A workspace on a telemetry destination's workspace list. Under `include`, the destination covers the workspace. Under `exclude`, the destination covers every workspace except this one. The entry doesn't have an `id`. Its `telemetry_destination_id` and `workspace_id` together identify it. - `type: "telemetry_destination_workspace"` - `created_at: string` Time the workspace was added to the list. format: date-time - `telemetry_destination_id: string` ID of the telemetry destination (`tdst_...`). - `workspace_id: string` ID of the workspace (`wrkspc_...`). #### Example ```bash curl https://api.anthropic.com/v1/organizations/telemetry_destinations/$DESTINATION_ID/workspaces/$WORKSPACE_ID \ -X POST \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: telemetry-destinations-2026-08-11' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "created_at": "2019-12-27T18:11:19.117Z", "telemetry_destination_id": "telemetry_destination_id", "type": "telemetry_destination_workspace", "workspace_id": "workspace_id" } ``` ### Remove a Telemetry Destination Workspace **DELETE** `/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}` Remove one workspace from a destination's workspace list. Under `include` the workspace's spans stop going to the destination. Under `exclude` they start. An archived workspace can be removed too. The API returns 404 when the workspace isn't on the list. A destination whose `workspaces.type` is `all` doesn't have a list, so the API returns 400. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=http#choose-workspaces-for-a-destination) to learn more about choosing the workspaces of a destination. #### Path parameters - `destination_id: string` ID of the destination (`tdst_...`). - `workspace_id: string` ID of the workspace to remove (`wrkspc_...`). #### Headers - `"anthropic-version": optional string` The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning?sdk_languages=http). - `"anthropic-beta": optional array of AnthropicBeta` This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header. - `string` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `"telemetry-destinations-2026-08-11"` #### Returns - `BetaDeletedTelemetryDestinationWorkspace object` Confirmation that a workspace was removed from a destination's list. - `type: "telemetry_destination_workspace_deleted"` - `telemetry_destination_id: string` ID of the telemetry destination (`tdst_...`). - `workspace_id: string` ID of the workspace that was removed (`wrkspc_...`). #### Example ```bash curl https://api.anthropic.com/v1/organizations/telemetry_destinations/$DESTINATION_ID/workspaces/$WORKSPACE_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: telemetry-destinations-2026-08-11' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` ##### Response (200) ```json { "telemetry_destination_id": "telemetry_destination_id", "type": "telemetry_destination_workspace_deleted", "workspace_id": "workspace_id" } ```