# Beta ## Domain Types ### Beta API Error - `beta_api_error: object { message, type }` - `message: string` - `type: "api_error"` ### Beta Authentication Error - `beta_authentication_error: object { message, type }` - `message: string` - `type: "authentication_error"` ### Beta Billing Error - `beta_billing_error: object { message, type }` - `message: string` - `type: "billing_error"` ### Beta Error - `beta_error: BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 6 more` - `beta_invalid_request_error: object { message, type }` - `message: string` - `type: "invalid_request_error"` - `beta_authentication_error: object { message, type }` - `message: string` - `type: "authentication_error"` - `beta_billing_error: object { message, type }` - `message: string` - `type: "billing_error"` - `beta_permission_error: object { message, type }` - `message: string` - `type: "permission_error"` - `beta_not_found_error: object { message, type }` - `message: string` - `type: "not_found_error"` - `beta_rate_limit_error: object { message, type }` - `message: string` - `type: "rate_limit_error"` - `beta_gateway_timeout_error: object { message, type }` - `message: string` - `type: "timeout_error"` - `beta_api_error: object { message, type }` - `message: string` - `type: "api_error"` - `beta_overloaded_error: object { message, type }` - `message: string` - `type: "overloaded_error"` ### Beta Error Response - `beta_error_response: object { error, request_id, type }` - `error: BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 6 more` - `beta_invalid_request_error: object { message, type }` - `message: string` - `type: "invalid_request_error"` - `beta_authentication_error: object { message, type }` - `message: string` - `type: "authentication_error"` - `beta_billing_error: object { message, type }` - `message: string` - `type: "billing_error"` - `beta_permission_error: object { message, type }` - `message: string` - `type: "permission_error"` - `beta_not_found_error: object { message, type }` - `message: string` - `type: "not_found_error"` - `beta_rate_limit_error: object { message, type }` - `message: string` - `type: "rate_limit_error"` - `beta_gateway_timeout_error: object { message, type }` - `message: string` - `type: "timeout_error"` - `beta_api_error: object { message, type }` - `message: string` - `type: "api_error"` - `beta_overloaded_error: object { message, type }` - `message: string` - `type: "overloaded_error"` - `request_id: string` - `type: "error"` ### Beta Gateway Timeout Error - `beta_gateway_timeout_error: object { message, type }` - `message: string` - `type: "timeout_error"` ### Beta Invalid Request Error - `beta_invalid_request_error: object { message, type }` - `message: string` - `type: "invalid_request_error"` ### Beta Not Found Error - `beta_not_found_error: object { message, type }` - `message: string` - `type: "not_found_error"` ### Beta Overloaded Error - `beta_overloaded_error: object { message, type }` - `message: string` - `type: "overloaded_error"` ### Beta Permission Error - `beta_permission_error: object { message, type }` - `message: string` - `type: "permission_error"` ### Beta Rate Limit Error - `beta_rate_limit_error: object { message, type }` - `message: string` - `type: "rate_limit_error"` # Models ## List Models `$ ant beta:models list` **get** `/v1/models` List available models. The Models API response can be used to determine which models are available for use in the API. More recently released models are listed first. ### Parameters - `--after-id: optional string` Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `--before-id: optional string` Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `--limit: optional number` Query param: Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaListResponse_ModelInfo_: object { data, first_id, has_more, last_id }` - `data: array of BetaModelInfo` - `id: string` Unique model identifier. - `capabilities: object { batch, citations, code_execution, 6 more }` Model capability information. - `batch: object { supported }` Whether the model supports the Batch API. - `supported: boolean` Whether this capability is supported by the model. - `citations: object { supported }` Whether the model supports citation generation. - `supported: boolean` Whether this capability is supported by the model. - `code_execution: object { supported }` Whether the model supports code execution tools. - `supported: boolean` Whether this capability is supported by the model. - `context_management: object { clear_thinking_20251015, clear_tool_uses_20250919, compact_20260112, supported }` Context management support and available strategies. - `clear_thinking_20251015: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `clear_tool_uses_20250919: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `compact_20260112: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `supported: boolean` Whether this capability is supported by the model. - `effort: object { high, low, max, 3 more }` Effort (reasoning_effort) support and available levels. - `high: object { supported }` Whether the model supports high effort level. - `supported: boolean` Whether this capability is supported by the model. - `low: object { supported }` Whether the model supports low effort level. - `supported: boolean` Whether this capability is supported by the model. - `max: object { supported }` Whether the model supports max effort level. - `supported: boolean` Whether this capability is supported by the model. - `medium: object { supported }` Whether the model supports medium effort level. - `supported: boolean` Whether this capability is supported by the model. - `supported: boolean` Whether this capability is supported by the model. - `xhigh: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `image_input: object { supported }` Whether the model accepts image content blocks. - `supported: boolean` Whether this capability is supported by the model. - `pdf_input: object { supported }` Whether the model accepts PDF content blocks. - `supported: boolean` Whether this capability is supported by the model. - `structured_outputs: object { supported }` Whether the model supports structured output / JSON mode / strict tool schemas. - `supported: boolean` Whether this capability is supported by the model. - `thinking: object { supported, types }` Thinking capability and supported type configurations. - `supported: boolean` Whether this capability is supported by the model. - `types: object { adaptive, enabled }` Supported thinking type configurations. - `adaptive: object { supported }` Whether the model supports thinking with type 'adaptive' (auto). - `supported: boolean` Whether this capability is supported by the model. - `enabled: object { supported }` Whether the model supports thinking with type 'enabled'. - `supported: boolean` Whether this capability is supported by the model. - `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. - `display_name: string` A human-readable name for the model. - `max_input_tokens: number` Maximum input context window size in tokens for this model. - `max_tokens: number` Maximum value for the `max_tokens` parameter when using this model. - `type: "model"` Object type. For Models, this is always `"model"`. - `first_id: string` 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` Last ID in the `data` list. Can be used as the `after_id` for the next page. ### Example ```cli ant beta:models list \ --api-key my-anthropic-api-key ``` #### Response ```json { "data": [ { "id": "claude-opus-4-6", "capabilities": { "batch": { "supported": true }, "citations": { "supported": true }, "code_execution": { "supported": true }, "context_management": { "clear_thinking_20251015": { "supported": true }, "clear_tool_uses_20250919": { "supported": true }, "compact_20260112": { "supported": true }, "supported": true }, "effort": { "high": { "supported": true }, "low": { "supported": true }, "max": { "supported": true }, "medium": { "supported": true }, "supported": true, "xhigh": { "supported": true } }, "image_input": { "supported": true }, "pdf_input": { "supported": true }, "structured_outputs": { "supported": true }, "thinking": { "supported": true, "types": { "adaptive": { "supported": true }, "enabled": { "supported": true } } } }, "created_at": "2026-02-04T00:00:00Z", "display_name": "Claude Opus 4.6", "max_input_tokens": 0, "max_tokens": 0, "type": "model" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ## Get a Model `$ ant beta:models retrieve` **get** `/v1/models/{model_id}` Get a specific model. The Models API response can be used to determine information about a specific model or resolve a model alias to a model ID. ### Parameters - `--model-id: string` Model identifier or alias. - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_model_info: object { id, capabilities, created_at, 4 more }` - `id: string` Unique model identifier. - `capabilities: object { batch, citations, code_execution, 6 more }` Model capability information. - `batch: object { supported }` Whether the model supports the Batch API. - `supported: boolean` Whether this capability is supported by the model. - `citations: object { supported }` Whether the model supports citation generation. - `supported: boolean` Whether this capability is supported by the model. - `code_execution: object { supported }` Whether the model supports code execution tools. - `supported: boolean` Whether this capability is supported by the model. - `context_management: object { clear_thinking_20251015, clear_tool_uses_20250919, compact_20260112, supported }` Context management support and available strategies. - `clear_thinking_20251015: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `clear_tool_uses_20250919: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `compact_20260112: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `supported: boolean` Whether this capability is supported by the model. - `effort: object { high, low, max, 3 more }` Effort (reasoning_effort) support and available levels. - `high: object { supported }` Whether the model supports high effort level. - `supported: boolean` Whether this capability is supported by the model. - `low: object { supported }` Whether the model supports low effort level. - `supported: boolean` Whether this capability is supported by the model. - `max: object { supported }` Whether the model supports max effort level. - `supported: boolean` Whether this capability is supported by the model. - `medium: object { supported }` Whether the model supports medium effort level. - `supported: boolean` Whether this capability is supported by the model. - `supported: boolean` Whether this capability is supported by the model. - `xhigh: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `image_input: object { supported }` Whether the model accepts image content blocks. - `supported: boolean` Whether this capability is supported by the model. - `pdf_input: object { supported }` Whether the model accepts PDF content blocks. - `supported: boolean` Whether this capability is supported by the model. - `structured_outputs: object { supported }` Whether the model supports structured output / JSON mode / strict tool schemas. - `supported: boolean` Whether this capability is supported by the model. - `thinking: object { supported, types }` Thinking capability and supported type configurations. - `supported: boolean` Whether this capability is supported by the model. - `types: object { adaptive, enabled }` Supported thinking type configurations. - `adaptive: object { supported }` Whether the model supports thinking with type 'adaptive' (auto). - `supported: boolean` Whether this capability is supported by the model. - `enabled: object { supported }` Whether the model supports thinking with type 'enabled'. - `supported: boolean` Whether this capability is supported by the model. - `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. - `display_name: string` A human-readable name for the model. - `max_input_tokens: number` Maximum input context window size in tokens for this model. - `max_tokens: number` Maximum value for the `max_tokens` parameter when using this model. - `type: "model"` Object type. For Models, this is always `"model"`. ### Example ```cli ant beta:models retrieve \ --api-key my-anthropic-api-key \ --model-id model_id ``` #### Response ```json { "id": "claude-opus-4-6", "capabilities": { "batch": { "supported": true }, "citations": { "supported": true }, "code_execution": { "supported": true }, "context_management": { "clear_thinking_20251015": { "supported": true }, "clear_tool_uses_20250919": { "supported": true }, "compact_20260112": { "supported": true }, "supported": true }, "effort": { "high": { "supported": true }, "low": { "supported": true }, "max": { "supported": true }, "medium": { "supported": true }, "supported": true, "xhigh": { "supported": true } }, "image_input": { "supported": true }, "pdf_input": { "supported": true }, "structured_outputs": { "supported": true }, "thinking": { "supported": true, "types": { "adaptive": { "supported": true }, "enabled": { "supported": true } } } }, "created_at": "2026-02-04T00:00:00Z", "display_name": "Claude Opus 4.6", "max_input_tokens": 0, "max_tokens": 0, "type": "model" } ``` ## Domain Types ### Beta Capability Support - `beta_capability_support: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. ### Beta Context Management Capability - `beta_context_management_capability: object { clear_thinking_20251015, clear_tool_uses_20250919, compact_20260112, supported }` Context management capability details. - `clear_thinking_20251015: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `clear_tool_uses_20250919: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `compact_20260112: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `supported: boolean` Whether this capability is supported by the model. ### Beta Effort Capability - `beta_effort_capability: object { high, low, max, 3 more }` Effort (reasoning_effort) capability details. - `high: object { supported }` Whether the model supports high effort level. - `supported: boolean` Whether this capability is supported by the model. - `low: object { supported }` Whether the model supports low effort level. - `supported: boolean` Whether this capability is supported by the model. - `max: object { supported }` Whether the model supports max effort level. - `supported: boolean` Whether this capability is supported by the model. - `medium: object { supported }` Whether the model supports medium effort level. - `supported: boolean` Whether this capability is supported by the model. - `supported: boolean` Whether this capability is supported by the model. - `xhigh: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. ### Beta Model Capabilities - `beta_model_capabilities: object { batch, citations, code_execution, 6 more }` Model capability information. - `batch: object { supported }` Whether the model supports the Batch API. - `supported: boolean` Whether this capability is supported by the model. - `citations: object { supported }` Whether the model supports citation generation. - `supported: boolean` Whether this capability is supported by the model. - `code_execution: object { supported }` Whether the model supports code execution tools. - `supported: boolean` Whether this capability is supported by the model. - `context_management: object { clear_thinking_20251015, clear_tool_uses_20250919, compact_20260112, supported }` Context management support and available strategies. - `clear_thinking_20251015: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `clear_tool_uses_20250919: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `compact_20260112: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `supported: boolean` Whether this capability is supported by the model. - `effort: object { high, low, max, 3 more }` Effort (reasoning_effort) support and available levels. - `high: object { supported }` Whether the model supports high effort level. - `supported: boolean` Whether this capability is supported by the model. - `low: object { supported }` Whether the model supports low effort level. - `supported: boolean` Whether this capability is supported by the model. - `max: object { supported }` Whether the model supports max effort level. - `supported: boolean` Whether this capability is supported by the model. - `medium: object { supported }` Whether the model supports medium effort level. - `supported: boolean` Whether this capability is supported by the model. - `supported: boolean` Whether this capability is supported by the model. - `xhigh: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `image_input: object { supported }` Whether the model accepts image content blocks. - `supported: boolean` Whether this capability is supported by the model. - `pdf_input: object { supported }` Whether the model accepts PDF content blocks. - `supported: boolean` Whether this capability is supported by the model. - `structured_outputs: object { supported }` Whether the model supports structured output / JSON mode / strict tool schemas. - `supported: boolean` Whether this capability is supported by the model. - `thinking: object { supported, types }` Thinking capability and supported type configurations. - `supported: boolean` Whether this capability is supported by the model. - `types: object { adaptive, enabled }` Supported thinking type configurations. - `adaptive: object { supported }` Whether the model supports thinking with type 'adaptive' (auto). - `supported: boolean` Whether this capability is supported by the model. - `enabled: object { supported }` Whether the model supports thinking with type 'enabled'. - `supported: boolean` Whether this capability is supported by the model. ### Beta Model Info - `beta_model_info: object { id, capabilities, created_at, 4 more }` - `id: string` Unique model identifier. - `capabilities: object { batch, citations, code_execution, 6 more }` Model capability information. - `batch: object { supported }` Whether the model supports the Batch API. - `supported: boolean` Whether this capability is supported by the model. - `citations: object { supported }` Whether the model supports citation generation. - `supported: boolean` Whether this capability is supported by the model. - `code_execution: object { supported }` Whether the model supports code execution tools. - `supported: boolean` Whether this capability is supported by the model. - `context_management: object { clear_thinking_20251015, clear_tool_uses_20250919, compact_20260112, supported }` Context management support and available strategies. - `clear_thinking_20251015: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `clear_tool_uses_20250919: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `compact_20260112: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `supported: boolean` Whether this capability is supported by the model. - `effort: object { high, low, max, 3 more }` Effort (reasoning_effort) support and available levels. - `high: object { supported }` Whether the model supports high effort level. - `supported: boolean` Whether this capability is supported by the model. - `low: object { supported }` Whether the model supports low effort level. - `supported: boolean` Whether this capability is supported by the model. - `max: object { supported }` Whether the model supports max effort level. - `supported: boolean` Whether this capability is supported by the model. - `medium: object { supported }` Whether the model supports medium effort level. - `supported: boolean` Whether this capability is supported by the model. - `supported: boolean` Whether this capability is supported by the model. - `xhigh: object { supported }` Indicates whether a capability is supported. - `supported: boolean` Whether this capability is supported by the model. - `image_input: object { supported }` Whether the model accepts image content blocks. - `supported: boolean` Whether this capability is supported by the model. - `pdf_input: object { supported }` Whether the model accepts PDF content blocks. - `supported: boolean` Whether this capability is supported by the model. - `structured_outputs: object { supported }` Whether the model supports structured output / JSON mode / strict tool schemas. - `supported: boolean` Whether this capability is supported by the model. - `thinking: object { supported, types }` Thinking capability and supported type configurations. - `supported: boolean` Whether this capability is supported by the model. - `types: object { adaptive, enabled }` Supported thinking type configurations. - `adaptive: object { supported }` Whether the model supports thinking with type 'adaptive' (auto). - `supported: boolean` Whether this capability is supported by the model. - `enabled: object { supported }` Whether the model supports thinking with type 'enabled'. - `supported: boolean` Whether this capability is supported by the model. - `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. - `display_name: string` A human-readable name for the model. - `max_input_tokens: number` Maximum input context window size in tokens for this model. - `max_tokens: number` Maximum value for the `max_tokens` parameter when using this model. - `type: "model"` Object type. For Models, this is always `"model"`. ### Beta Thinking Capability - `beta_thinking_capability: object { supported, types }` Thinking capability details. - `supported: boolean` Whether this capability is supported by the model. - `types: object { adaptive, enabled }` Supported thinking type configurations. - `adaptive: object { supported }` Whether the model supports thinking with type 'adaptive' (auto). - `supported: boolean` Whether this capability is supported by the model. - `enabled: object { supported }` Whether the model supports thinking with type 'enabled'. - `supported: boolean` Whether this capability is supported by the model. ### Beta Thinking Types - `beta_thinking_types: object { adaptive, enabled }` Supported thinking type configurations. - `adaptive: object { supported }` Whether the model supports thinking with type 'adaptive' (auto). - `supported: boolean` Whether this capability is supported by the model. - `enabled: object { supported }` Whether the model supports thinking with type 'enabled'. - `supported: boolean` Whether this capability is supported by the model. # Messages ## Create a Message `$ ant beta:messages create` **post** `/v1/messages` Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation. The Messages API can be used for either single queries or stateless multi-turn conversations. Learn more about the Messages API in our [user guide](https://docs.claude.com/en/docs/initial-setup) ### Parameters - `--max-tokens: number` Body param: The maximum number of tokens to generate before stopping. Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Set to `0` to populate the [prompt cache](https://docs.claude.com/en/docs/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://docs.claude.com/en/docs/models-overview) for details. - `--message: array of BetaMessageParam` Body param: Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://docs.claude.com/en/api/messages-examples). Note that if you want to include a [system prompt](https://docs.claude.com/en/docs/system-prompts), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `--model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` Body param: 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 object { type, ttl }` Body param: Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `--container: optional BetaContainerParams or string` Body param: Container identifier for reuse across requests. - `--context-management: optional object { edits }` Body param: Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. - `--diagnostics: optional object { previous_message_id }` Body param: Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting. - `--inference-geo: optional string` Body param: Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `--mcp-server: optional array of BetaRequestMCPServerURLDefinition` Body param: MCP servers to be utilized in this request - `--metadata: optional object { user_id }` Body param: An object describing metadata about the request. - `--output-config: optional object { effort, format, task_budget }` Body param: Configuration options for the model's output, such as the output format. - `--output-format: optional object { schema, type }` Body param: Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. - `--service-tier: optional "auto" or "standard_only"` Body param: Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://docs.claude.com/en/api/service-tiers) for details. - `--speed: optional "standard" or "fast"` Body param: The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. - `--stop-sequence: optional array of string` Body param: Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `"stop_sequence"` and the response `stop_sequence` value will contain the matched stop sequence. - `--system: optional string or array of BetaTextBlockParam` Body param: System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://docs.claude.com/en/docs/system-prompts). - `--temperature: optional number` Body param: Amount of randomness injected into the response. Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. Note that even with `temperature` of `0.0`, the results will not be fully deterministic. - `--thinking: optional BetaThinkingConfigEnabled or BetaThinkingConfigDisabled or BetaThinkingConfigAdaptive` Body param: Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `--tool-choice: optional BetaToolChoiceAuto or BetaToolChoiceAny or BetaToolChoiceTool or BetaToolChoiceNone` Body param: How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `--tool: optional array of BetaToolUnion` Body param: Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://docs.claude.com/en/docs/agents-and-tools/tool-use/overview#server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://docs.claude.com/en/docs/agents-and-tools/tool-use/web-search-tool)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://docs.claude.com/en/docs/tool-use) for more details. - `--top-k: optional number` Body param: Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only. - `--top-p: optional number` Body param: Use nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. Recommended for advanced use cases only. - `--user-profile-id: optional string` Body param: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_message: object { id, container, content, 9 more }` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: object { id, expires_at, skills }` Information about the container used in the request (for the code execution tool) - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. - `skills: array of BetaSkill` Skills loaded in the container - `skill_id: string` Skill ID - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `version: string` Skill version or 'latest' for most recent version - `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)"}] ``` - `beta_text_block: object { citations, text, type }` - `citations: array of BetaTextCitation` 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`. - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `text: string` - `type: "text"` - `beta_thinking_block: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` - `beta_redacted_thinking_block: object { data, type }` - `data: string` - `type: "redacted_thinking"` - `beta_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` - `beta_server_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `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"` - `type: "server_tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_search_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock` - `beta_web_search_tool_result_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `union_member_1: array of BetaWebSearchResultBlock` - `encrypted_content: string` - `page_age: string` - `title: string` - `type: "web_search_result"` - `url: string` - `tool_use_id: string` - `type: "web_search_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_fetch_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - `beta_web_fetch_tool_result_error_block: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` - `beta_web_fetch_block: object { content, retrieved_at, type, url }` - `content: object { citations, source, title, type }` - `citations: object { enabled }` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource or BetaPlainTextSource` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `title: string` The title of the document - `type: "document"` - `retrieved_at: string` ISO 8601 timestamp when the content was retrieved - `type: "web_fetch_result"` - `url: string` Fetched content URL - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_advisor_tool_result_block: object { content, tool_use_id, type }` - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - `beta_advisor_tool_result_error: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` - `beta_advisor_result_block: object { stop_reason, text, type }` - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `text: string` - `type: "advisor_result"` - `beta_advisor_redacted_result_block: object { encrypted_content, stop_reason, type }` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `type: "advisor_redacted_result"` - `tool_use_id: string` - `type: "advisor_tool_result"` - `beta_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `tool_use_id: string` - `type: "code_execution_tool_result"` - `beta_bash_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - `beta_bash_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` - `beta_bash_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlock` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` - `beta_text_editor_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - `beta_text_editor_code_execution_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "text_editor_code_execution_tool_result_error"` - `beta_text_editor_code_execution_view_result_block: object { content, file_type, num_lines, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number` - `start_line: number` - `total_lines: number` - `type: "text_editor_code_execution_view_result"` - `beta_text_editor_code_execution_create_result_block: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `beta_text_editor_code_execution_str_replace_result_block: object { lines, new_lines, new_start, 3 more }` - `lines: array of string` - `new_lines: number` - `new_start: number` - `old_lines: number` - `old_start: number` - `type: "text_editor_code_execution_str_replace_result"` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `beta_tool_search_tool_result_block: object { content, tool_use_id, type }` - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - `beta_tool_search_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "tool_search_tool_result_error"` - `beta_tool_search_tool_search_result_block: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlock` - `tool_name: string` - `type: "tool_reference"` - `type: "tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `beta_mcp_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `beta_mcp_tool_result_block: object { content, is_error, tool_use_id, type }` - `content: string or array of BetaTextBlock` - `union_member_0: string` - `beta_mcp_tool_result_block_content: array of BetaTextBlock` - `citations: array of BetaTextCitation` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `text: string` - `type: "text"` - `is_error: boolean` - `tool_use_id: string` - `type: "mcp_tool_result"` - `beta_container_upload_block: object { file_id, type }` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `beta_compaction_block: object { content, encrypted_content, type }` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `content: string` Summary of compacted content, or null if compaction failed - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `context_management: object { applied_edits }` 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. - `beta_clear_tool_uses_20250919_edit_response: object { cleared_input_tokens, cleared_tool_uses, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_tool_uses: number` Number of tool uses that were cleared. - `type: "clear_tool_uses_20250919"` The type of context management edit applied. - `beta_clear_thinking_20251015_edit_response: object { cleared_input_tokens, cleared_thinking_turns, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_thinking_turns: number` Number of thinking turns that were cleared. - `type: "clear_thinking_20251015"` The type of context management edit applied. - `diagnostics: object { cache_miss_reason }` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more` 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. - `beta_cache_miss_model_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "model_changed"` - `beta_cache_miss_system_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "system_changed"` - `beta_cache_miss_tools_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "tools_changed"` - `beta_cache_miss_messages_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "messages_changed"` - `beta_cache_miss_previous_message_not_found: object { type }` - `type: "previous_message_not_found"` - `beta_cache_miss_unavailable: object { type }` - `type: "unavailable"` - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `stop_details: object { category, explanation, type }` Structured information about a refusal. - `category: "cyber" or "bio"` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `explanation: string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `type: "refusal"` - `stop_reason: "end_turn" or "max_tokens" or "stop_sequence" or 5 more` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `type: "message"` Object type. For Messages, this is always `"message"`. - `usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 8 more }` 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: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `inference_geo: string` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `beta_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a sampling iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `beta_compaction_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a compaction iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "compaction"` Usage for a compaction iteration - `beta_advisor_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` Token usage for an advisor sub-inference iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `output_tokens: number` The number of output tokens which were used. - `type: "advisor_message"` Usage for an advisor sub-inference iteration - `output_tokens: number` The number of output tokens which were used. - `output_tokens_details: object { thinking_tokens }` 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. - `server_tool_use: object { web_fetch_requests, web_search_requests }` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. - `web_search_requests: number` The number of web search tool requests. - `service_tier: "standard" or "priority" or "batch"` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" or "fast"` The inference speed mode used for this request. - `"standard"` - `"fast"` ### Example ```cli ant beta:messages create \ --api-key my-anthropic-api-key \ --max-tokens 1024 \ --message '{content: [{text: x, type: text}], role: user}' \ --model claude-opus-4-6 ``` #### Response ```json { "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF", "container": { "id": "id", "expires_at": "2019-12-27T18:11:19.117Z", "skills": [ { "skill_id": "pdf", "type": "anthropic", "version": "latest" } ] }, "content": [ { "citations": [ { "cited_text": "cited_text", "document_index": 0, "document_title": "document_title", "end_char_index": 0, "file_id": "file_id", "start_char_index": 0, "type": "char_location" } ], "text": "Hi! My name is Claude.", "type": "text" } ], "context_management": { "applied_edits": [ { "cleared_input_tokens": 0, "cleared_tool_uses": 0, "type": "clear_tool_uses_20250919" } ] }, "diagnostics": { "cache_miss_reason": { "cache_missed_input_tokens": 0, "type": "model_changed" } }, "model": "claude-opus-4-6", "role": "assistant", "stop_details": { "category": "cyber", "explanation": "explanation", "type": "refusal" }, "stop_reason": "end_turn", "stop_sequence": null, "type": "message", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_creation_input_tokens": 2051, "cache_read_input_tokens": 2051, "inference_geo": "inference_geo", "input_tokens": 2095, "iterations": [ { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0, "type": "message" } ], "output_tokens": 503, "output_tokens_details": { "thinking_tokens": 0 }, "server_tool_use": { "web_fetch_requests": 2, "web_search_requests": 0 }, "service_tier": "standard", "speed": "standard" } } ``` ## Count tokens in a Message `$ ant beta:messages count-tokens` **post** `/v1/messages/count_tokens` Count the number of tokens in a Message. The Token Count API can be used to count the number of tokens in a Message, including tools, images, and documents, without creating it. Learn more about token counting in our [user guide](https://docs.claude.com/en/docs/build-with-claude/token-counting) ### Parameters - `--message: array of BetaMessageParam` Body param: Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://docs.claude.com/en/api/messages-examples). Note that if you want to include a [system prompt](https://docs.claude.com/en/docs/system-prompts), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `--model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` Body param: 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 object { type, ttl }` Body param: Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `--context-management: optional object { edits }` Body param: Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. - `--mcp-server: optional array of BetaRequestMCPServerURLDefinition` Body param: MCP servers to be utilized in this request - `--output-config: optional object { effort, format, task_budget }` Body param: Configuration options for the model's output, such as the output format. - `--output-format: optional object { schema, type }` Body param: Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. - `--speed: optional "standard" or "fast"` Body param: The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. - `--system: optional string or array of BetaTextBlockParam` Body param: System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://docs.claude.com/en/docs/system-prompts). - `--thinking: optional BetaThinkingConfigEnabled or BetaThinkingConfigDisabled or BetaThinkingConfigAdaptive` Body param: Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `--tool-choice: optional BetaToolChoiceAuto or BetaToolChoiceAny or BetaToolChoiceTool or BetaToolChoiceNone` Body param: How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all. - `--tool: optional array of BetaTool or BetaToolBash20241022 or BetaToolBash20250124 or 20 more` Body param: Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://docs.claude.com/en/docs/agents-and-tools/tool-use/overview#server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://docs.claude.com/en/docs/agents-and-tools/tool-use/web-search-tool)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://docs.claude.com/en/docs/tool-use) for more details. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_message_tokens_count: object { context_management, input_tokens }` - `context_management: object { original_input_tokens }` 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 ```cli ant beta:messages count-tokens \ --api-key my-anthropic-api-key \ --message '{content: [{text: x, type: text}], role: user}' \ --model claude-opus-4-6 ``` #### Response ```json { "context_management": { "original_input_tokens": 0 }, "input_tokens": 2095 } ``` ## Domain Types ### Beta Advisor Message Iteration Usage - `beta_advisor_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` Token usage for an advisor sub-inference iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `output_tokens: number` The number of output tokens which were used. - `type: "advisor_message"` Usage for an advisor sub-inference iteration ### Beta Advisor Redacted Result Block - `beta_advisor_redacted_result_block: object { encrypted_content, stop_reason, type }` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `type: "advisor_redacted_result"` ### Beta Advisor Redacted Result Block Param - `beta_advisor_redacted_result_block_param: object { encrypted_content, type, stop_reason }` - `encrypted_content: string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `type: "advisor_redacted_result"` - `stop_reason: optional string` ### Beta Advisor Result Block - `beta_advisor_result_block: object { stop_reason, text, type }` - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `text: string` - `type: "advisor_result"` ### Beta Advisor Result Block Param - `beta_advisor_result_block_param: object { text, type, stop_reason }` - `text: string` - `type: "advisor_result"` - `stop_reason: optional string` ### Beta Advisor Tool 20260301 - `beta_advisor_tool_20260301: object { model, name, type, 6 more }` - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `name: "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "advisor_20260301"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `caching: optional object { type, ttl }` 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. - `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`. - `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` Maximum number of times the tool can be used in the API request. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs ### Beta Advisor Tool Result Block - `beta_advisor_tool_result_block: object { content, tool_use_id, type }` - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - `beta_advisor_tool_result_error: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` - `beta_advisor_result_block: object { stop_reason, text, type }` - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `text: string` - `type: "advisor_result"` - `beta_advisor_redacted_result_block: object { encrypted_content, stop_reason, type }` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `type: "advisor_redacted_result"` - `tool_use_id: string` - `type: "advisor_tool_result"` ### Beta Advisor Tool Result Block Param - `beta_advisor_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaAdvisorToolResultErrorParam or BetaAdvisorResultBlockParam or BetaAdvisorRedactedResultBlockParam` - `beta_advisor_tool_result_error_param: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` - `beta_advisor_result_block_param: object { text, type, stop_reason }` - `text: string` - `type: "advisor_result"` - `stop_reason: optional string` - `beta_advisor_redacted_result_block_param: object { encrypted_content, type, stop_reason }` - `encrypted_content: string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `type: "advisor_redacted_result"` - `stop_reason: optional string` - `tool_use_id: string` - `type: "advisor_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` ### Beta Advisor Tool Result Error - `beta_advisor_tool_result_error: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` ### Beta Advisor Tool Result Error Param - `beta_advisor_tool_result_error_param: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` ### Beta All Thinking Turns - `beta_all_thinking_turns: object { type }` - `type: "all"` ### Beta Base64 Image Source - `beta_base64_image_source: object { data, media_type, type }` - `data: string` - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` ### Beta Base64 PDF Source - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` ### Beta Bash Code Execution Output Block - `beta_bash_code_execution_output_block: object { file_id, type }` - `file_id: string` - `type: "bash_code_execution_output"` ### Beta Bash Code Execution Output Block Param - `beta_bash_code_execution_output_block_param: object { file_id, type }` - `file_id: string` - `type: "bash_code_execution_output"` ### Beta Bash Code Execution Result Block - `beta_bash_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlock` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` ### Beta Bash Code Execution Result Block Param - `beta_bash_code_execution_result_block_param: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlockParam` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` ### Beta Bash Code Execution Tool Result Block - `beta_bash_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - `beta_bash_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` - `beta_bash_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlock` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` ### Beta Bash Code Execution Tool Result Block Param - `beta_bash_code_execution_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaBashCodeExecutionToolResultErrorParam or BetaBashCodeExecutionResultBlockParam` - `beta_bash_code_execution_tool_result_error_param: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` - `beta_bash_code_execution_result_block_param: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlockParam` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` ### Beta Bash Code Execution Tool Result Error - `beta_bash_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` ### Beta Bash Code Execution Tool Result Error Param - `beta_bash_code_execution_tool_result_error_param: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` ### Beta Cache Control Ephemeral - `beta_cache_control_ephemeral: object { type, ttl }` - `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`. - `"5m"` - `"1h"` ### Beta Cache Creation - `beta_cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. ### Beta Cache Miss Messages Changed - `beta_cache_miss_messages_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "messages_changed"` ### Beta Cache Miss Model Changed - `beta_cache_miss_model_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "model_changed"` ### Beta Cache Miss Previous Message Not Found - `beta_cache_miss_previous_message_not_found: object { type }` - `type: "previous_message_not_found"` ### Beta Cache Miss System Changed - `beta_cache_miss_system_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "system_changed"` ### Beta Cache Miss Tools Changed - `beta_cache_miss_tools_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "tools_changed"` ### Beta Cache Miss Unavailable - `beta_cache_miss_unavailable: object { type }` - `type: "unavailable"` ### Beta Citation Char Location - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` ### Beta Citation Char Location Param - `beta_citation_char_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` ### Beta Citation Config - `beta_citation_config: object { enabled }` - `enabled: boolean` ### Beta Citation Content Block Location - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` ### Beta Citation Content Block Location Param - `beta_citation_content_block_location_param: object { cited_text, document_index, document_title, 3 more }` - `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` - `document_title: string` - `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. - `type: "content_block_location"` ### Beta Citation Page Location - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` ### Beta Citation Page Location Param - `beta_citation_page_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` ### Beta Citation Search Result Location - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` ### Beta Citation Search Result Location Param - `beta_citation_search_result_location_param: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` ### Beta Citation Web Search Result Location Param - `beta_citation_web_search_result_location_param: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` ### Beta Citations Config Param - `beta_citations_config_param: object { enabled }` - `enabled: optional boolean` ### Beta Citations Delta - `beta_citations_delta: object { citation, type }` - `citation: BetaCitationCharLocation or BetaCitationPageLocation or BetaCitationContentBlockLocation or 2 more` - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `type: "citations_delta"` ### Beta Citations Web Search Result Location - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` ### Beta Clear Thinking 20251015 Edit - `beta_clear_thinking_20251015_edit: object { type, keep }` - `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. - `beta_thinking_turns: object { type, value }` - `type: "thinking_turns"` - `value: number` - `beta_all_thinking_turns: object { type }` - `type: "all"` - `union_member_2: "all"` ### Beta Clear Thinking 20251015 Edit Response - `beta_clear_thinking_20251015_edit_response: object { cleared_input_tokens, cleared_thinking_turns, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_thinking_turns: number` Number of thinking turns that were cleared. - `type: "clear_thinking_20251015"` The type of context management edit applied. ### Beta Clear Tool Uses 20250919 Edit - `beta_clear_tool_uses_20250919_edit: object { type, clear_at_least, clear_tool_inputs, 3 more }` - `type: "clear_tool_uses_20250919"` - `clear_at_least: optional object { type, value }` 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` - `clear_tool_inputs: optional boolean or array of string` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `union_member_0: boolean` - `union_member_1: array of string` - `exclude_tools: optional array of string` Tool names whose uses are preserved from clearing - `keep: optional object { type, value }` Number of tool uses to retain in the conversation - `type: "tool_uses"` - `value: number` - `trigger: optional BetaInputTokensTrigger or BetaToolUsesTrigger` Condition that triggers the context management strategy - `beta_input_tokens_trigger: object { type, value }` - `type: "input_tokens"` - `value: number` - `beta_tool_uses_trigger: object { type, value }` - `type: "tool_uses"` - `value: number` ### Beta Clear Tool Uses 20250919 Edit Response - `beta_clear_tool_uses_20250919_edit_response: object { cleared_input_tokens, cleared_tool_uses, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_tool_uses: number` Number of tool uses that were cleared. - `type: "clear_tool_uses_20250919"` The type of context management edit applied. ### Beta Code Execution Output Block - `beta_code_execution_output_block: object { file_id, type }` - `file_id: string` - `type: "code_execution_output"` ### Beta Code Execution Output Block Param - `beta_code_execution_output_block_param: object { file_id, type }` - `file_id: string` - `type: "code_execution_output"` ### Beta Code Execution Result Block - `beta_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` ### Beta Code Execution Result Block Param - `beta_code_execution_result_block_param: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlockParam` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` ### Beta Code Execution Tool 20250522 - `beta_code_execution_tool_20250522: object { name, type, allowed_callers, 3 more }` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "code_execution_20250522"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool 20250825 - `beta_code_execution_tool_20250825: object { name, type, allowed_callers, 3 more }` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "code_execution_20250825"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool 20260120 - `beta_code_execution_tool_20260120: object { name, type, allowed_callers, 3 more }` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "code_execution_20260120"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool Result Block - `beta_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `tool_use_id: string` - `type: "code_execution_tool_result"` ### Beta Code Execution Tool Result Block Content - `beta_code_execution_tool_result_block_content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` ### Beta Code Execution Tool Result Block Param - `beta_code_execution_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaCodeExecutionToolResultErrorParam or BetaCodeExecutionResultBlockParam or BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error_param: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block_param: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlockParam` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block_param: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlockParam` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `tool_use_id: string` - `type: "code_execution_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` ### Beta Code Execution Tool Result Block Param Content - `beta_code_execution_tool_result_block_param_content: BetaCodeExecutionToolResultErrorParam or BetaCodeExecutionResultBlockParam or BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error_param: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block_param: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlockParam` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block_param: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlockParam` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` ### Beta Code Execution Tool Result Error - `beta_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` ### Beta Code Execution Tool Result Error Code - `beta_code_execution_tool_result_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"` ### Beta Code Execution Tool Result Error Param - `beta_code_execution_tool_result_error_param: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` ### Beta Compact 20260112 Edit - `beta_compact_20260112_edit: object { type, instructions, pause_after_compaction, trigger }` Automatically compact older context when reaching the configured trigger threshold. - `type: "compact_20260112"` - `instructions: optional string` Additional instructions for summarization. - `pause_after_compaction: optional boolean` Whether to pause after compaction and return the compaction block to the user. - `trigger: optional object { type, value }` When to trigger compaction. Defaults to 150000 input tokens. - `type: "input_tokens"` - `value: number` ### Beta Compaction Block - `beta_compaction_block: object { content, encrypted_content, type }` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `content: string` Summary of compacted content, or null if compaction failed - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` ### Beta Compaction Block Param - `beta_compaction_block_param: object { type, cache_control, content, encrypted_content }` 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 object { type, ttl }` 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`. - `"5m"` - `"1h"` - `content: optional string` Summary of previously compacted content, or null if compaction failed - `encrypted_content: optional string` Opaque metadata from prior compaction, to be round-tripped verbatim ### Beta Compaction Content Block Delta - `beta_compaction_content_block_delta: object { content, encrypted_content, type }` - `content: string` - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction_delta"` ### Beta Compaction Iteration Usage - `beta_compaction_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a compaction iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "compaction"` Usage for a compaction iteration ### Beta Container - `beta_container: object { id, expires_at, skills }` Information about the container used in the request (for the code execution tool) - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. - `skills: array of BetaSkill` Skills loaded in the container - `skill_id: string` Skill ID - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `version: string` Skill version or 'latest' for most recent version ### Beta Container Params - `beta_container_params: object { id, skills }` Container parameters with skills to be loaded. - `id: optional string` Container id - `skills: optional array of BetaSkillParams` List of skills to load in the container - `skill_id: string` Skill ID - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `version: optional string` Skill version or 'latest' for most recent version ### Beta Container Upload Block - `beta_container_upload_block: object { file_id, type }` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` ### Beta Container Upload Block Param - `beta_container_upload_block_param: object { file_id, type, cache_control }` 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. - `file_id: string` - `type: "container_upload"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` ### Beta Content Block - `beta_content_block: BetaTextBlock or BetaThinkingBlock or BetaRedactedThinkingBlock or 13 more` Response model for a file uploaded to the container. - `beta_text_block: object { citations, text, type }` - `citations: array of BetaTextCitation` 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`. - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `text: string` - `type: "text"` - `beta_thinking_block: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` - `beta_redacted_thinking_block: object { data, type }` - `data: string` - `type: "redacted_thinking"` - `beta_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` - `beta_server_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `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"` - `type: "server_tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_search_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock` - `beta_web_search_tool_result_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `union_member_1: array of BetaWebSearchResultBlock` - `encrypted_content: string` - `page_age: string` - `title: string` - `type: "web_search_result"` - `url: string` - `tool_use_id: string` - `type: "web_search_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_fetch_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - `beta_web_fetch_tool_result_error_block: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` - `beta_web_fetch_block: object { content, retrieved_at, type, url }` - `content: object { citations, source, title, type }` - `citations: object { enabled }` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource or BetaPlainTextSource` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `title: string` The title of the document - `type: "document"` - `retrieved_at: string` ISO 8601 timestamp when the content was retrieved - `type: "web_fetch_result"` - `url: string` Fetched content URL - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_advisor_tool_result_block: object { content, tool_use_id, type }` - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - `beta_advisor_tool_result_error: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` - `beta_advisor_result_block: object { stop_reason, text, type }` - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `text: string` - `type: "advisor_result"` - `beta_advisor_redacted_result_block: object { encrypted_content, stop_reason, type }` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `type: "advisor_redacted_result"` - `tool_use_id: string` - `type: "advisor_tool_result"` - `beta_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `tool_use_id: string` - `type: "code_execution_tool_result"` - `beta_bash_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - `beta_bash_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` - `beta_bash_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlock` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` - `beta_text_editor_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - `beta_text_editor_code_execution_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "text_editor_code_execution_tool_result_error"` - `beta_text_editor_code_execution_view_result_block: object { content, file_type, num_lines, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number` - `start_line: number` - `total_lines: number` - `type: "text_editor_code_execution_view_result"` - `beta_text_editor_code_execution_create_result_block: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `beta_text_editor_code_execution_str_replace_result_block: object { lines, new_lines, new_start, 3 more }` - `lines: array of string` - `new_lines: number` - `new_start: number` - `old_lines: number` - `old_start: number` - `type: "text_editor_code_execution_str_replace_result"` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `beta_tool_search_tool_result_block: object { content, tool_use_id, type }` - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - `beta_tool_search_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "tool_search_tool_result_error"` - `beta_tool_search_tool_search_result_block: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlock` - `tool_name: string` - `type: "tool_reference"` - `type: "tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `beta_mcp_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `beta_mcp_tool_result_block: object { content, is_error, tool_use_id, type }` - `content: string or array of BetaTextBlock` - `union_member_0: string` - `beta_mcp_tool_result_block_content: array of BetaTextBlock` - `citations: array of BetaTextCitation` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `text: string` - `type: "text"` - `is_error: boolean` - `tool_use_id: string` - `type: "mcp_tool_result"` - `beta_container_upload_block: object { file_id, type }` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `beta_compaction_block: object { content, encrypted_content, type }` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `content: string` Summary of compacted content, or null if compaction failed - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` ### Beta Content Block Param - `beta_content_block_param: BetaTextBlockParam or BetaImageBlockParam or BetaRequestDocumentBlock or 18 more` Regular text content. - `beta_text_block_param: object { text, type, cache_control, citations }` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `citations: optional array of BetaTextCitationParam` - `beta_citation_char_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location_param: object { cited_text, document_index, document_title, 3 more }` - `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` - `document_title: string` - `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. - `type: "content_block_location"` - `beta_citation_web_search_result_location_param: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location_param: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `beta_image_block_param: object { source, type, cache_control }` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `beta_base64_image_source: object { data, media_type, type }` - `data: string` - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `beta_url_image_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_image_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "image"` - `cache_control: optional object { type, ttl }` 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`. - `beta_request_document_block: object { source, type, cache_control, 3 more }` - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `beta_content_block_source: object { content, type }` - `content: string or array of BetaContentBlockSourceContent` - `union_member_0: string` - `beta_content_block_source_content: array of BetaContentBlockSourceContent` - `beta_text_block_param: object { text, type, cache_control, citations }` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam` - `beta_image_block_param: object { source, type, cache_control }` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `type: "image"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `type: "content"` - `beta_url_pdf_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_document_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "document"` - `cache_control: optional object { type, ttl }` 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`. - `citations: optional object { enabled }` - `enabled: optional boolean` - `context: optional string` - `title: optional string` - `beta_search_result_block_param: object { content, source, title, 3 more }` - `content: array of BetaTextBlockParam` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam` - `source: string` - `title: string` - `type: "search_result"` - `cache_control: optional object { type, ttl }` 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`. - `citations: optional object { enabled }` - `enabled: optional boolean` - `beta_thinking_block_param: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` - `beta_redacted_thinking_block_param: object { data, type }` - `data: string` - `type: "redacted_thinking"` - `beta_tool_use_block_param: object { id, input, name, 3 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `cache_control: optional object { type, ttl }` 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`. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` - `beta_tool_result_block_param: object { tool_use_id, type, cache_control, 2 more }` - `tool_use_id: string` - `type: "tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `content: optional array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 2 more` - `beta_text_block_param: object { text, type, cache_control, citations }` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam` - `beta_image_block_param: object { source, type, cache_control }` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `type: "image"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `beta_search_result_block_param: object { content, source, title, 3 more }` - `content: array of BetaTextBlockParam` - `source: string` - `title: string` - `type: "search_result"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional object { enabled }` - `beta_request_document_block: object { source, type, cache_control, 3 more }` - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` - `type: "document"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional object { enabled }` - `context: optional string` - `title: optional string` - `beta_tool_reference_block_param: object { tool_name, type, cache_control }` Tool reference block that can be included in tool_result content. - `tool_name: string` - `type: "tool_reference"` - `cache_control: optional object { type, ttl }` 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`. - `is_error: optional boolean` - `beta_server_tool_use_block_param: object { id, input, name, 3 more }` - `id: string` - `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"` - `type: "server_tool_use"` - `cache_control: optional object { type, ttl }` 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`. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_search_tool_result_block_param: object { content, tool_use_id, type, 2 more }` - `content: array of BetaWebSearchResultBlockParam or BetaWebSearchToolRequestError` - `Result Block: array of BetaWebSearchResultBlockParam` - `encrypted_content: string` - `title: string` - `type: "web_search_result"` - `url: string` - `page_age: optional string` - `beta_web_search_tool_request_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `tool_use_id: string` - `type: "web_search_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_fetch_tool_result_block_param: object { content, tool_use_id, type, 2 more }` - `content: BetaWebFetchToolResultErrorBlockParam or BetaWebFetchBlockParam` - `beta_web_fetch_tool_result_error_block_param: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` - `beta_web_fetch_block_param: object { content, type, url, retrieved_at }` - `content: object { source, type, cache_control, 3 more }` - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` - `type: "document"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional object { enabled }` - `context: optional string` - `title: optional string` - `type: "web_fetch_result"` - `url: string` Fetched content URL - `retrieved_at: optional string` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_advisor_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaAdvisorToolResultErrorParam or BetaAdvisorResultBlockParam or BetaAdvisorRedactedResultBlockParam` - `beta_advisor_tool_result_error_param: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` - `beta_advisor_result_block_param: object { text, type, stop_reason }` - `text: string` - `type: "advisor_result"` - `stop_reason: optional string` - `beta_advisor_redacted_result_block_param: object { encrypted_content, type, stop_reason }` - `encrypted_content: string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `type: "advisor_redacted_result"` - `stop_reason: optional string` - `tool_use_id: string` - `type: "advisor_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `beta_code_execution_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaCodeExecutionToolResultErrorParam or BetaCodeExecutionResultBlockParam or BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error_param: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block_param: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlockParam` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block_param: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlockParam` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `tool_use_id: string` - `type: "code_execution_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `beta_bash_code_execution_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaBashCodeExecutionToolResultErrorParam or BetaBashCodeExecutionResultBlockParam` - `beta_bash_code_execution_tool_result_error_param: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` - `beta_bash_code_execution_result_block_param: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlockParam` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `beta_text_editor_code_execution_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaTextEditorCodeExecutionToolResultErrorParam or BetaTextEditorCodeExecutionViewResultBlockParam or BetaTextEditorCodeExecutionCreateResultBlockParam or BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `beta_text_editor_code_execution_tool_result_error_param: object { error_code, type, error_message }` - `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"` - `type: "text_editor_code_execution_tool_result_error"` - `error_message: optional string` - `beta_text_editor_code_execution_view_result_block_param: object { content, file_type, type, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `type: "text_editor_code_execution_view_result"` - `num_lines: optional number` - `start_line: optional number` - `total_lines: optional number` - `beta_text_editor_code_execution_create_result_block_param: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `beta_text_editor_code_execution_str_replace_result_block_param: object { type, lines, new_lines, 3 more }` - `type: "text_editor_code_execution_str_replace_result"` - `lines: optional array of string` - `new_lines: optional number` - `new_start: optional number` - `old_lines: optional number` - `old_start: optional number` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `beta_tool_search_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaToolSearchToolResultErrorParam or BetaToolSearchToolSearchResultBlockParam` - `beta_tool_search_tool_result_error_param: object { error_code, type }` - `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"` - `type: "tool_search_tool_result_error"` - `beta_tool_search_tool_search_result_block_param: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlockParam` - `tool_name: string` - `type: "tool_reference"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `type: "tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `beta_mcp_tool_use_block_param: object { id, input, name, 3 more }` - `id: string` - `input: map[unknown]` - `name: string` - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `cache_control: optional object { type, ttl }` 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`. - `beta_request_mcp_tool_result_block_param: object { tool_use_id, type, cache_control, 2 more }` - `tool_use_id: string` - `type: "mcp_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `content: optional string or array of BetaTextBlockParam` - `union_member_0: string` - `beta_mcp_tool_result_block_param_content: array of BetaTextBlockParam` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam` - `is_error: optional boolean` - `beta_container_upload_block_param: object { file_id, type, cache_control }` 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. - `file_id: string` - `type: "container_upload"` - `cache_control: optional object { type, ttl }` 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`. - `beta_compaction_block_param: object { type, cache_control, content, encrypted_content }` 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 object { type, ttl }` 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`. - `content: optional string` Summary of previously compacted content, or null if compaction failed - `encrypted_content: optional string` Opaque metadata from prior compaction, to be round-tripped verbatim - `beta_mid_conversation_system_block_param: object { content, type, cache_control }` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `content: array of BetaTextBlockParam` System instruction text blocks. - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam` - `type: "mid_conv_system"` - `cache_control: optional object { type, ttl }` 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`. ### Beta Content Block Source - `beta_content_block_source: object { content, type }` - `content: string or array of BetaContentBlockSourceContent` - `union_member_0: string` - `beta_content_block_source_content: array of BetaContentBlockSourceContent` - `beta_text_block_param: object { text, type, cache_control, citations }` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `citations: optional array of BetaTextCitationParam` - `beta_citation_char_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location_param: object { cited_text, document_index, document_title, 3 more }` - `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` - `document_title: string` - `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. - `type: "content_block_location"` - `beta_citation_web_search_result_location_param: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location_param: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `beta_image_block_param: object { source, type, cache_control }` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `beta_base64_image_source: object { data, media_type, type }` - `data: string` - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `beta_url_image_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_image_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "image"` - `cache_control: optional object { type, ttl }` 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`. - `type: "content"` ### Beta Content Block Source Content - `beta_content_block_source_content: BetaTextBlockParam or BetaImageBlockParam` - `beta_text_block_param: object { text, type, cache_control, citations }` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `citations: optional array of BetaTextCitationParam` - `beta_citation_char_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location_param: object { cited_text, document_index, document_title, 3 more }` - `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` - `document_title: string` - `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. - `type: "content_block_location"` - `beta_citation_web_search_result_location_param: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location_param: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `beta_image_block_param: object { source, type, cache_control }` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `beta_base64_image_source: object { data, media_type, type }` - `data: string` - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `beta_url_image_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_image_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "image"` - `cache_control: optional object { type, ttl }` 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`. ### Beta Context Management Config - `beta_context_management_config: object { edits }` - `edits: optional array of BetaClearToolUses20250919Edit or BetaClearThinking20251015Edit or BetaCompact20260112Edit` List of context management edits to apply - `beta_clear_tool_uses_20250919_edit: object { type, clear_at_least, clear_tool_inputs, 3 more }` - `type: "clear_tool_uses_20250919"` - `clear_at_least: optional object { type, value }` 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` - `clear_tool_inputs: optional boolean or array of string` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `union_member_0: boolean` - `union_member_1: array of string` - `exclude_tools: optional array of string` Tool names whose uses are preserved from clearing - `keep: optional object { type, value }` Number of tool uses to retain in the conversation - `type: "tool_uses"` - `value: number` - `trigger: optional BetaInputTokensTrigger or BetaToolUsesTrigger` Condition that triggers the context management strategy - `beta_input_tokens_trigger: object { type, value }` - `type: "input_tokens"` - `value: number` - `beta_tool_uses_trigger: object { type, value }` - `type: "tool_uses"` - `value: number` - `beta_clear_thinking_20251015_edit: object { type, keep }` - `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. - `beta_thinking_turns: object { type, value }` - `type: "thinking_turns"` - `value: number` - `beta_all_thinking_turns: object { type }` - `type: "all"` - `union_member_2: "all"` - `beta_compact_20260112_edit: object { type, instructions, pause_after_compaction, trigger }` Automatically compact older context when reaching the configured trigger threshold. - `type: "compact_20260112"` - `instructions: optional string` Additional instructions for summarization. - `pause_after_compaction: optional boolean` Whether to pause after compaction and return the compaction block to the user. - `trigger: optional object { type, value }` When to trigger compaction. Defaults to 150000 input tokens. - `type: "input_tokens"` - `value: number` ### Beta Context Management Response - `beta_context_management_response: object { applied_edits }` - `applied_edits: array of BetaClearToolUses20250919EditResponse or BetaClearThinking20251015EditResponse` List of context management edits that were applied. - `beta_clear_tool_uses_20250919_edit_response: object { cleared_input_tokens, cleared_tool_uses, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_tool_uses: number` Number of tool uses that were cleared. - `type: "clear_tool_uses_20250919"` The type of context management edit applied. - `beta_clear_thinking_20251015_edit_response: object { cleared_input_tokens, cleared_thinking_turns, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_thinking_turns: number` Number of thinking turns that were cleared. - `type: "clear_thinking_20251015"` The type of context management edit applied. ### Beta Count Tokens Context Management Response - `beta_count_tokens_context_management_response: object { original_input_tokens }` - `original_input_tokens: number` The original token count before context management was applied ### Beta Diagnostics - `beta_diagnostics: object { cache_miss_reason }` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more` 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. - `beta_cache_miss_model_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "model_changed"` - `beta_cache_miss_system_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "system_changed"` - `beta_cache_miss_tools_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "tools_changed"` - `beta_cache_miss_messages_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "messages_changed"` - `beta_cache_miss_previous_message_not_found: object { type }` - `type: "previous_message_not_found"` - `beta_cache_miss_unavailable: object { type }` - `type: "unavailable"` ### Beta Diagnostics Param - `beta_diagnostics_param: object { previous_message_id }` Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting. - `previous_message_id: optional string` The `id` (`msg_...`) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns `diagnostics.cache_miss_reason` when the prompt-cache prefix could not be reused. Pass `null` on the first turn to opt in without a prior message to compare. ### Beta Direct Caller - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` ### Beta Document Block - `beta_document_block: object { citations, source, title, type }` - `citations: object { enabled }` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource or BetaPlainTextSource` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `title: string` The title of the document - `type: "document"` ### Beta Encrypted Code Execution Result Block - `beta_encrypted_code_execution_result_block: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` ### Beta Encrypted Code Execution Result Block Param - `beta_encrypted_code_execution_result_block_param: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlockParam` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` ### Beta File Document Source - `beta_file_document_source: object { file_id, type }` - `file_id: string` - `type: "file"` ### Beta File Image Source - `beta_file_image_source: object { file_id, type }` - `file_id: string` - `type: "file"` ### Beta Image Block Param - `beta_image_block_param: object { source, type, cache_control }` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `beta_base64_image_source: object { data, media_type, type }` - `data: string` - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `beta_url_image_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_image_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "image"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` ### Beta Input JSON Delta - `beta_input_json_delta: object { partial_json, type }` - `partial_json: string` - `type: "input_json_delta"` ### Beta Input Tokens Clear At Least - `beta_input_tokens_clear_at_least: object { type, value }` - `type: "input_tokens"` - `value: number` ### Beta Input Tokens Trigger - `beta_input_tokens_trigger: object { type, value }` - `type: "input_tokens"` - `value: number` ### Beta Iterations Usage - `beta_iterations_usage: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `beta_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a sampling iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `beta_compaction_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a compaction iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "compaction"` Usage for a compaction iteration - `beta_advisor_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` Token usage for an advisor sub-inference iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `output_tokens: number` The number of output tokens which were used. - `type: "advisor_message"` Usage for an advisor sub-inference iteration ### Beta JSON Output Format - `beta_json_output_format: object { schema, type }` - `schema: map[unknown]` The JSON schema of the format - `type: "json_schema"` ### Beta MCP Tool Config - `beta_mcp_tool_config: object { defer_loading, enabled }` Configuration for a specific tool in an MCP toolset. - `defer_loading: optional boolean` - `enabled: optional boolean` ### Beta MCP Tool Default Config - `beta_mcp_tool_default_config: object { defer_loading, enabled }` Default configuration for tools in an MCP toolset. - `defer_loading: optional boolean` - `enabled: optional boolean` ### Beta MCP Tool Result Block - `beta_mcp_tool_result_block: object { content, is_error, tool_use_id, type }` - `content: string or array of BetaTextBlock` - `union_member_0: string` - `beta_mcp_tool_result_block_content: array of BetaTextBlock` - `citations: array of BetaTextCitation` 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`. - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `text: string` - `type: "text"` - `is_error: boolean` - `tool_use_id: string` - `type: "mcp_tool_result"` ### Beta MCP Tool Use Block - `beta_mcp_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` ### Beta MCP Tool Use Block Param - `beta_mcp_tool_use_block_param: object { id, input, name, 3 more }` - `id: string` - `input: map[unknown]` - `name: string` - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` ### Beta MCP Toolset - `beta_mcp_toolset: object { mcp_server_name, type, cache_control, 2 more }` 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. - `mcp_server_name: string` Name of the MCP server to configure tools for - `type: "mcp_toolset"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `configs: optional map[BetaMCPToolConfig]` Configuration overrides for specific tools, keyed by tool name - `defer_loading: optional boolean` - `enabled: optional boolean` - `default_config: optional object { defer_loading, enabled }` Default configuration applied to all tools from this server - `defer_loading: optional boolean` - `enabled: optional boolean` ### Beta Memory Tool 20250818 - `beta_memory_tool_20250818: object { name, type, allowed_callers, 4 more }` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "memory_20250818"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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 ### Beta Memory Tool 20250818 Command - `beta_memory_tool_20250818_command: BetaMemoryTool20250818ViewCommand or BetaMemoryTool20250818CreateCommand or BetaMemoryTool20250818StrReplaceCommand or 3 more` - `beta_memory_tool_20250818_view_command: object { command, path, view_range }` - `command: "view"` Command type identifier - `path: string` Path to directory or file to view - `view_range: optional array of number` Optional line range for viewing specific lines - `beta_memory_tool_20250818_create_command: object { command, file_text, path }` - `command: "create"` Command type identifier - `file_text: string` Content to write to the file - `path: string` Path where the file should be created - `beta_memory_tool_20250818_str_replace_command: object { command, new_str, old_str, path }` - `command: "str_replace"` Command type identifier - `new_str: string` Text to replace with - `old_str: string` Text to search for and replace - `path: string` Path to the file where text should be replaced - `beta_memory_tool_20250818_insert_command: object { command, insert_line, insert_text, path }` - `command: "insert"` Command type identifier - `insert_line: number` Line number where text should be inserted - `insert_text: string` Text to insert at the specified line - `path: string` Path to the file where text should be inserted - `beta_memory_tool_20250818_delete_command: object { command, path }` - `command: "delete"` Command type identifier - `path: string` Path to the file or directory to delete - `beta_memory_tool_20250818_rename_command: object { command, new_path, old_path }` - `command: "rename"` Command type identifier - `new_path: string` New path for the file or directory - `old_path: string` Current path of the file or directory ### Beta Memory Tool 20250818 Create Command - `beta_memory_tool_20250818_create_command: object { command, file_text, path }` - `command: "create"` Command type identifier - `file_text: string` Content to write to the file - `path: string` Path where the file should be created ### Beta Memory Tool 20250818 Delete Command - `beta_memory_tool_20250818_delete_command: object { command, path }` - `command: "delete"` Command type identifier - `path: string` Path to the file or directory to delete ### Beta Memory Tool 20250818 Insert Command - `beta_memory_tool_20250818_insert_command: object { command, insert_line, insert_text, path }` - `command: "insert"` Command type identifier - `insert_line: number` Line number where text should be inserted - `insert_text: string` Text to insert at the specified line - `path: string` Path to the file where text should be inserted ### Beta Memory Tool 20250818 Rename Command - `beta_memory_tool_20250818_rename_command: object { command, new_path, old_path }` - `command: "rename"` Command type identifier - `new_path: string` New path for the file or directory - `old_path: string` Current path of the file or directory ### Beta Memory Tool 20250818 Str Replace Command - `beta_memory_tool_20250818_str_replace_command: object { command, new_str, old_str, path }` - `command: "str_replace"` Command type identifier - `new_str: string` Text to replace with - `old_str: string` Text to search for and replace - `path: string` Path to the file where text should be replaced ### Beta Memory Tool 20250818 View Command - `beta_memory_tool_20250818_view_command: object { command, path, view_range }` - `command: "view"` Command type identifier - `path: string` Path to directory or file to view - `view_range: optional array of number` Optional line range for viewing specific lines ### Beta Message - `beta_message: object { id, container, content, 9 more }` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: object { id, expires_at, skills }` Information about the container used in the request (for the code execution tool) - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. - `skills: array of BetaSkill` Skills loaded in the container - `skill_id: string` Skill ID - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `version: string` Skill version or 'latest' for most recent version - `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)"}] ``` - `beta_text_block: object { citations, text, type }` - `citations: array of BetaTextCitation` 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`. - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `text: string` - `type: "text"` - `beta_thinking_block: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` - `beta_redacted_thinking_block: object { data, type }` - `data: string` - `type: "redacted_thinking"` - `beta_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` - `beta_server_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `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"` - `type: "server_tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_search_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock` - `beta_web_search_tool_result_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `union_member_1: array of BetaWebSearchResultBlock` - `encrypted_content: string` - `page_age: string` - `title: string` - `type: "web_search_result"` - `url: string` - `tool_use_id: string` - `type: "web_search_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_fetch_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - `beta_web_fetch_tool_result_error_block: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` - `beta_web_fetch_block: object { content, retrieved_at, type, url }` - `content: object { citations, source, title, type }` - `citations: object { enabled }` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource or BetaPlainTextSource` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `title: string` The title of the document - `type: "document"` - `retrieved_at: string` ISO 8601 timestamp when the content was retrieved - `type: "web_fetch_result"` - `url: string` Fetched content URL - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_advisor_tool_result_block: object { content, tool_use_id, type }` - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - `beta_advisor_tool_result_error: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` - `beta_advisor_result_block: object { stop_reason, text, type }` - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `text: string` - `type: "advisor_result"` - `beta_advisor_redacted_result_block: object { encrypted_content, stop_reason, type }` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `type: "advisor_redacted_result"` - `tool_use_id: string` - `type: "advisor_tool_result"` - `beta_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `tool_use_id: string` - `type: "code_execution_tool_result"` - `beta_bash_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - `beta_bash_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` - `beta_bash_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlock` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` - `beta_text_editor_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - `beta_text_editor_code_execution_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "text_editor_code_execution_tool_result_error"` - `beta_text_editor_code_execution_view_result_block: object { content, file_type, num_lines, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number` - `start_line: number` - `total_lines: number` - `type: "text_editor_code_execution_view_result"` - `beta_text_editor_code_execution_create_result_block: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `beta_text_editor_code_execution_str_replace_result_block: object { lines, new_lines, new_start, 3 more }` - `lines: array of string` - `new_lines: number` - `new_start: number` - `old_lines: number` - `old_start: number` - `type: "text_editor_code_execution_str_replace_result"` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `beta_tool_search_tool_result_block: object { content, tool_use_id, type }` - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - `beta_tool_search_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "tool_search_tool_result_error"` - `beta_tool_search_tool_search_result_block: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlock` - `tool_name: string` - `type: "tool_reference"` - `type: "tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `beta_mcp_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `beta_mcp_tool_result_block: object { content, is_error, tool_use_id, type }` - `content: string or array of BetaTextBlock` - `union_member_0: string` - `beta_mcp_tool_result_block_content: array of BetaTextBlock` - `citations: array of BetaTextCitation` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `text: string` - `type: "text"` - `is_error: boolean` - `tool_use_id: string` - `type: "mcp_tool_result"` - `beta_container_upload_block: object { file_id, type }` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `beta_compaction_block: object { content, encrypted_content, type }` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `content: string` Summary of compacted content, or null if compaction failed - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `context_management: object { applied_edits }` 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. - `beta_clear_tool_uses_20250919_edit_response: object { cleared_input_tokens, cleared_tool_uses, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_tool_uses: number` Number of tool uses that were cleared. - `type: "clear_tool_uses_20250919"` The type of context management edit applied. - `beta_clear_thinking_20251015_edit_response: object { cleared_input_tokens, cleared_thinking_turns, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_thinking_turns: number` Number of thinking turns that were cleared. - `type: "clear_thinking_20251015"` The type of context management edit applied. - `diagnostics: object { cache_miss_reason }` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more` 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. - `beta_cache_miss_model_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "model_changed"` - `beta_cache_miss_system_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "system_changed"` - `beta_cache_miss_tools_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "tools_changed"` - `beta_cache_miss_messages_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "messages_changed"` - `beta_cache_miss_previous_message_not_found: object { type }` - `type: "previous_message_not_found"` - `beta_cache_miss_unavailable: object { type }` - `type: "unavailable"` - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `stop_details: object { category, explanation, type }` Structured information about a refusal. - `category: "cyber" or "bio"` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `explanation: string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `type: "refusal"` - `stop_reason: "end_turn" or "max_tokens" or "stop_sequence" or 5 more` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `type: "message"` Object type. For Messages, this is always `"message"`. - `usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 8 more }` 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: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `inference_geo: string` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `beta_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a sampling iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `beta_compaction_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a compaction iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "compaction"` Usage for a compaction iteration - `beta_advisor_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` Token usage for an advisor sub-inference iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `output_tokens: number` The number of output tokens which were used. - `type: "advisor_message"` Usage for an advisor sub-inference iteration - `output_tokens: number` The number of output tokens which were used. - `output_tokens_details: object { thinking_tokens }` 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. - `server_tool_use: object { web_fetch_requests, web_search_requests }` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. - `web_search_requests: number` The number of web search tool requests. - `service_tier: "standard" or "priority" or "batch"` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" or "fast"` The inference speed mode used for this request. - `"standard"` - `"fast"` ### Beta Message Delta Usage - `beta_message_delta_usage: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 4 more }` - `cache_creation_input_tokens: number` The cumulative number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The cumulative number of input tokens read from the cache. - `input_tokens: number` The cumulative number of input tokens which were used. - `iterations: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `beta_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a sampling iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `beta_compaction_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a compaction iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "compaction"` Usage for a compaction iteration - `beta_advisor_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` Token usage for an advisor sub-inference iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `output_tokens: number` The number of output tokens which were used. - `type: "advisor_message"` Usage for an advisor sub-inference iteration - `output_tokens: number` The cumulative number of output tokens which were used. - `output_tokens_details: object { thinking_tokens }` 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. - `server_tool_use: object { web_fetch_requests, web_search_requests }` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. - `web_search_requests: number` The number of web search tool requests. ### Beta Message Iteration Usage - `beta_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a sampling iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration ### Beta Message Param - `beta_message_param: object { content, role }` - `content: array of BetaContentBlockParam` - `beta_text_block_param: object { text, type, cache_control, citations }` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `citations: optional array of BetaTextCitationParam` - `beta_citation_char_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location_param: object { cited_text, document_index, document_title, 3 more }` - `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` - `document_title: string` - `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. - `type: "content_block_location"` - `beta_citation_web_search_result_location_param: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location_param: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `beta_image_block_param: object { source, type, cache_control }` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `beta_base64_image_source: object { data, media_type, type }` - `data: string` - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `beta_url_image_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_image_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "image"` - `cache_control: optional object { type, ttl }` 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`. - `beta_request_document_block: object { source, type, cache_control, 3 more }` - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `beta_content_block_source: object { content, type }` - `content: string or array of BetaContentBlockSourceContent` - `union_member_0: string` - `beta_content_block_source_content: array of BetaContentBlockSourceContent` - `beta_text_block_param: object { text, type, cache_control, citations }` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam` - `beta_image_block_param: object { source, type, cache_control }` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `type: "image"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `type: "content"` - `beta_url_pdf_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_document_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "document"` - `cache_control: optional object { type, ttl }` 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`. - `citations: optional object { enabled }` - `enabled: optional boolean` - `context: optional string` - `title: optional string` - `beta_search_result_block_param: object { content, source, title, 3 more }` - `content: array of BetaTextBlockParam` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam` - `source: string` - `title: string` - `type: "search_result"` - `cache_control: optional object { type, ttl }` 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`. - `citations: optional object { enabled }` - `enabled: optional boolean` - `beta_thinking_block_param: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` - `beta_redacted_thinking_block_param: object { data, type }` - `data: string` - `type: "redacted_thinking"` - `beta_tool_use_block_param: object { id, input, name, 3 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `cache_control: optional object { type, ttl }` 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`. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` - `beta_tool_result_block_param: object { tool_use_id, type, cache_control, 2 more }` - `tool_use_id: string` - `type: "tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `content: optional array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 2 more` - `beta_text_block_param: object { text, type, cache_control, citations }` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam` - `beta_image_block_param: object { source, type, cache_control }` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `type: "image"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `beta_search_result_block_param: object { content, source, title, 3 more }` - `content: array of BetaTextBlockParam` - `source: string` - `title: string` - `type: "search_result"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional object { enabled }` - `beta_request_document_block: object { source, type, cache_control, 3 more }` - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` - `type: "document"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional object { enabled }` - `context: optional string` - `title: optional string` - `beta_tool_reference_block_param: object { tool_name, type, cache_control }` Tool reference block that can be included in tool_result content. - `tool_name: string` - `type: "tool_reference"` - `cache_control: optional object { type, ttl }` 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`. - `is_error: optional boolean` - `beta_server_tool_use_block_param: object { id, input, name, 3 more }` - `id: string` - `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"` - `type: "server_tool_use"` - `cache_control: optional object { type, ttl }` 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`. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_search_tool_result_block_param: object { content, tool_use_id, type, 2 more }` - `content: array of BetaWebSearchResultBlockParam or BetaWebSearchToolRequestError` - `Result Block: array of BetaWebSearchResultBlockParam` - `encrypted_content: string` - `title: string` - `type: "web_search_result"` - `url: string` - `page_age: optional string` - `beta_web_search_tool_request_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `tool_use_id: string` - `type: "web_search_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_fetch_tool_result_block_param: object { content, tool_use_id, type, 2 more }` - `content: BetaWebFetchToolResultErrorBlockParam or BetaWebFetchBlockParam` - `beta_web_fetch_tool_result_error_block_param: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` - `beta_web_fetch_block_param: object { content, type, url, retrieved_at }` - `content: object { source, type, cache_control, 3 more }` - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` - `type: "document"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional object { enabled }` - `context: optional string` - `title: optional string` - `type: "web_fetch_result"` - `url: string` Fetched content URL - `retrieved_at: optional string` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_advisor_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaAdvisorToolResultErrorParam or BetaAdvisorResultBlockParam or BetaAdvisorRedactedResultBlockParam` - `beta_advisor_tool_result_error_param: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` - `beta_advisor_result_block_param: object { text, type, stop_reason }` - `text: string` - `type: "advisor_result"` - `stop_reason: optional string` - `beta_advisor_redacted_result_block_param: object { encrypted_content, type, stop_reason }` - `encrypted_content: string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `type: "advisor_redacted_result"` - `stop_reason: optional string` - `tool_use_id: string` - `type: "advisor_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `beta_code_execution_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaCodeExecutionToolResultErrorParam or BetaCodeExecutionResultBlockParam or BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error_param: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block_param: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlockParam` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block_param: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlockParam` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `tool_use_id: string` - `type: "code_execution_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `beta_bash_code_execution_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaBashCodeExecutionToolResultErrorParam or BetaBashCodeExecutionResultBlockParam` - `beta_bash_code_execution_tool_result_error_param: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` - `beta_bash_code_execution_result_block_param: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlockParam` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `beta_text_editor_code_execution_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaTextEditorCodeExecutionToolResultErrorParam or BetaTextEditorCodeExecutionViewResultBlockParam or BetaTextEditorCodeExecutionCreateResultBlockParam or BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `beta_text_editor_code_execution_tool_result_error_param: object { error_code, type, error_message }` - `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"` - `type: "text_editor_code_execution_tool_result_error"` - `error_message: optional string` - `beta_text_editor_code_execution_view_result_block_param: object { content, file_type, type, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `type: "text_editor_code_execution_view_result"` - `num_lines: optional number` - `start_line: optional number` - `total_lines: optional number` - `beta_text_editor_code_execution_create_result_block_param: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `beta_text_editor_code_execution_str_replace_result_block_param: object { type, lines, new_lines, 3 more }` - `type: "text_editor_code_execution_str_replace_result"` - `lines: optional array of string` - `new_lines: optional number` - `new_start: optional number` - `old_lines: optional number` - `old_start: optional number` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `beta_tool_search_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaToolSearchToolResultErrorParam or BetaToolSearchToolSearchResultBlockParam` - `beta_tool_search_tool_result_error_param: object { error_code, type }` - `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"` - `type: "tool_search_tool_result_error"` - `beta_tool_search_tool_search_result_block_param: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlockParam` - `tool_name: string` - `type: "tool_reference"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `type: "tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `beta_mcp_tool_use_block_param: object { id, input, name, 3 more }` - `id: string` - `input: map[unknown]` - `name: string` - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `cache_control: optional object { type, ttl }` 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`. - `beta_request_mcp_tool_result_block_param: object { tool_use_id, type, cache_control, 2 more }` - `tool_use_id: string` - `type: "mcp_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `content: optional string or array of BetaTextBlockParam` - `union_member_0: string` - `beta_mcp_tool_result_block_param_content: array of BetaTextBlockParam` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam` - `is_error: optional boolean` - `beta_container_upload_block_param: object { file_id, type, cache_control }` 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. - `file_id: string` - `type: "container_upload"` - `cache_control: optional object { type, ttl }` 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`. - `beta_compaction_block_param: object { type, cache_control, content, encrypted_content }` 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 object { type, ttl }` 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`. - `content: optional string` Summary of previously compacted content, or null if compaction failed - `encrypted_content: optional string` Opaque metadata from prior compaction, to be round-tripped verbatim - `beta_mid_conversation_system_block_param: object { content, type, cache_control }` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `content: array of BetaTextBlockParam` System instruction text blocks. - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam` - `type: "mid_conv_system"` - `cache_control: optional object { type, ttl }` 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`. - `role: "user" or "assistant" or "system"` - `"user"` - `"assistant"` - `"system"` ### Beta Message Tokens Count - `beta_message_tokens_count: object { context_management, input_tokens }` - `context_management: object { original_input_tokens }` 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. ### Beta Metadata - `beta_metadata: object { user_id }` - `user_id: optional string` An external identifier for the user who is associated with the request. This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number. ### Beta Mid Conversation System Block Param - `beta_mid_conversation_system_block_param: object { content, type, cache_control }` System instructions that appear mid-conversation. Use this block to provide or update system-level instructions at a specific point in the conversation, rather than only via the top-level `system` parameter. - `content: array of BetaTextBlockParam` System instruction text blocks. - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `citations: optional array of BetaTextCitationParam` - `beta_citation_char_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location_param: object { cited_text, document_index, document_title, 3 more }` - `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` - `document_title: string` - `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. - `type: "content_block_location"` - `beta_citation_web_search_result_location_param: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location_param: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `type: "mid_conv_system"` - `cache_control: optional object { type, ttl }` 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`. ### Beta Output Config - `beta_output_config: object { effort, format, task_budget }` - `effort: optional "low" or "medium" or "high" or 2 more` All possible effort levels. - `"low"` - `"medium"` - `"high"` - `"xhigh"` - `"max"` - `format: optional object { schema, type }` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) - `schema: map[unknown]` The JSON schema of the format - `type: "json_schema"` - `task_budget: optional object { total, type, remaining }` User-configurable total token budget across contexts. - `total: number` Total token budget across all contexts in the session. - `type: "tokens"` The budget type. Currently only 'tokens' is supported. - `remaining: optional number` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. ### Beta Output Tokens Details - `beta_output_tokens_details: object { thinking_tokens }` - `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. ### Beta Plain Text Source - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` ### Beta Raw Content Block Delta - `beta_raw_content_block_delta: BetaTextDelta or BetaInputJSONDelta or BetaCitationsDelta or 3 more` - `beta_text_delta: object { text, type }` - `text: string` - `type: "text_delta"` - `beta_input_json_delta: object { partial_json, type }` - `partial_json: string` - `type: "input_json_delta"` - `beta_citations_delta: object { citation, type }` - `citation: BetaCitationCharLocation or BetaCitationPageLocation or BetaCitationContentBlockLocation or 2 more` - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `type: "citations_delta"` - `beta_thinking_delta: object { estimated_tokens, thinking, type }` - `estimated_tokens: number` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `thinking: string` - `type: "thinking_delta"` - `beta_signature_delta: object { signature, type }` - `signature: string` - `type: "signature_delta"` - `beta_compaction_content_block_delta: object { content, encrypted_content, type }` - `content: string` - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction_delta"` ### Beta Raw Content Block Delta Event - `beta_raw_content_block_delta_event: object { delta, index, type }` - `delta: BetaTextDelta or BetaInputJSONDelta or BetaCitationsDelta or 3 more` - `beta_text_delta: object { text, type }` - `text: string` - `type: "text_delta"` - `beta_input_json_delta: object { partial_json, type }` - `partial_json: string` - `type: "input_json_delta"` - `beta_citations_delta: object { citation, type }` - `citation: BetaCitationCharLocation or BetaCitationPageLocation or BetaCitationContentBlockLocation or 2 more` - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `type: "citations_delta"` - `beta_thinking_delta: object { estimated_tokens, thinking, type }` - `estimated_tokens: number` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `thinking: string` - `type: "thinking_delta"` - `beta_signature_delta: object { signature, type }` - `signature: string` - `type: "signature_delta"` - `beta_compaction_content_block_delta: object { content, encrypted_content, type }` - `content: string` - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction_delta"` - `index: number` - `type: "content_block_delta"` ### Beta Raw Content Block Start Event - `beta_raw_content_block_start_event: object { content_block, index, type }` - `content_block: BetaTextBlock or BetaThinkingBlock or BetaRedactedThinkingBlock or 13 more` Response model for a file uploaded to the container. - `beta_text_block: object { citations, text, type }` - `citations: array of BetaTextCitation` 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`. - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `text: string` - `type: "text"` - `beta_thinking_block: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` - `beta_redacted_thinking_block: object { data, type }` - `data: string` - `type: "redacted_thinking"` - `beta_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` - `beta_server_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `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"` - `type: "server_tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_search_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock` - `beta_web_search_tool_result_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `union_member_1: array of BetaWebSearchResultBlock` - `encrypted_content: string` - `page_age: string` - `title: string` - `type: "web_search_result"` - `url: string` - `tool_use_id: string` - `type: "web_search_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_fetch_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - `beta_web_fetch_tool_result_error_block: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` - `beta_web_fetch_block: object { content, retrieved_at, type, url }` - `content: object { citations, source, title, type }` - `citations: object { enabled }` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource or BetaPlainTextSource` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `title: string` The title of the document - `type: "document"` - `retrieved_at: string` ISO 8601 timestamp when the content was retrieved - `type: "web_fetch_result"` - `url: string` Fetched content URL - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_advisor_tool_result_block: object { content, tool_use_id, type }` - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - `beta_advisor_tool_result_error: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` - `beta_advisor_result_block: object { stop_reason, text, type }` - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `text: string` - `type: "advisor_result"` - `beta_advisor_redacted_result_block: object { encrypted_content, stop_reason, type }` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `type: "advisor_redacted_result"` - `tool_use_id: string` - `type: "advisor_tool_result"` - `beta_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `tool_use_id: string` - `type: "code_execution_tool_result"` - `beta_bash_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - `beta_bash_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` - `beta_bash_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlock` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` - `beta_text_editor_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - `beta_text_editor_code_execution_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "text_editor_code_execution_tool_result_error"` - `beta_text_editor_code_execution_view_result_block: object { content, file_type, num_lines, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number` - `start_line: number` - `total_lines: number` - `type: "text_editor_code_execution_view_result"` - `beta_text_editor_code_execution_create_result_block: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `beta_text_editor_code_execution_str_replace_result_block: object { lines, new_lines, new_start, 3 more }` - `lines: array of string` - `new_lines: number` - `new_start: number` - `old_lines: number` - `old_start: number` - `type: "text_editor_code_execution_str_replace_result"` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `beta_tool_search_tool_result_block: object { content, tool_use_id, type }` - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - `beta_tool_search_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "tool_search_tool_result_error"` - `beta_tool_search_tool_search_result_block: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlock` - `tool_name: string` - `type: "tool_reference"` - `type: "tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `beta_mcp_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `beta_mcp_tool_result_block: object { content, is_error, tool_use_id, type }` - `content: string or array of BetaTextBlock` - `union_member_0: string` - `beta_mcp_tool_result_block_content: array of BetaTextBlock` - `citations: array of BetaTextCitation` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `text: string` - `type: "text"` - `is_error: boolean` - `tool_use_id: string` - `type: "mcp_tool_result"` - `beta_container_upload_block: object { file_id, type }` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `beta_compaction_block: object { content, encrypted_content, type }` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `content: string` Summary of compacted content, or null if compaction failed - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `index: number` - `type: "content_block_start"` ### Beta Raw Content Block Stop Event - `beta_raw_content_block_stop_event: object { index, type }` - `index: number` - `type: "content_block_stop"` ### Beta Raw Message Delta Event - `beta_raw_message_delta_event: object { context_management, delta, type, usage }` - `context_management: object { applied_edits }` Information about context management strategies applied during the request - `applied_edits: array of BetaClearToolUses20250919EditResponse or BetaClearThinking20251015EditResponse` List of context management edits that were applied. - `beta_clear_tool_uses_20250919_edit_response: object { cleared_input_tokens, cleared_tool_uses, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_tool_uses: number` Number of tool uses that were cleared. - `type: "clear_tool_uses_20250919"` The type of context management edit applied. - `beta_clear_thinking_20251015_edit_response: object { cleared_input_tokens, cleared_thinking_turns, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_thinking_turns: number` Number of thinking turns that were cleared. - `type: "clear_thinking_20251015"` The type of context management edit applied. - `delta: object { container, stop_details, stop_reason, stop_sequence }` - `container: object { id, expires_at, skills }` Information about the container used in the request (for the code execution tool) - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. - `skills: array of BetaSkill` Skills loaded in the container - `skill_id: string` Skill ID - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `version: string` Skill version or 'latest' for most recent version - `stop_details: object { category, explanation, type }` Structured information about a refusal. - `category: "cyber" or "bio"` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `explanation: string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `type: "refusal"` - `stop_reason: "end_turn" or "max_tokens" or "stop_sequence" or 5 more` - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string` - `type: "message_delta"` - `usage: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 4 more }` 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` The cumulative number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The cumulative number of input tokens read from the cache. - `input_tokens: number` The cumulative number of input tokens which were used. - `iterations: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `beta_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a sampling iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `beta_compaction_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a compaction iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "compaction"` Usage for a compaction iteration - `beta_advisor_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` Token usage for an advisor sub-inference iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `output_tokens: number` The number of output tokens which were used. - `type: "advisor_message"` Usage for an advisor sub-inference iteration - `output_tokens: number` The cumulative number of output tokens which were used. - `output_tokens_details: object { thinking_tokens }` 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. - `server_tool_use: object { web_fetch_requests, web_search_requests }` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. - `web_search_requests: number` The number of web search tool requests. ### Beta Raw Message Start Event - `beta_raw_message_start_event: object { message, type }` - `message: object { id, container, content, 9 more }` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: object { id, expires_at, skills }` Information about the container used in the request (for the code execution tool) - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. - `skills: array of BetaSkill` Skills loaded in the container - `skill_id: string` Skill ID - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `version: string` Skill version or 'latest' for most recent version - `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)"}] ``` - `beta_text_block: object { citations, text, type }` - `citations: array of BetaTextCitation` 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`. - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `text: string` - `type: "text"` - `beta_thinking_block: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` - `beta_redacted_thinking_block: object { data, type }` - `data: string` - `type: "redacted_thinking"` - `beta_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` - `beta_server_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `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"` - `type: "server_tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_search_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock` - `beta_web_search_tool_result_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `union_member_1: array of BetaWebSearchResultBlock` - `encrypted_content: string` - `page_age: string` - `title: string` - `type: "web_search_result"` - `url: string` - `tool_use_id: string` - `type: "web_search_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_fetch_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - `beta_web_fetch_tool_result_error_block: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` - `beta_web_fetch_block: object { content, retrieved_at, type, url }` - `content: object { citations, source, title, type }` - `citations: object { enabled }` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource or BetaPlainTextSource` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `title: string` The title of the document - `type: "document"` - `retrieved_at: string` ISO 8601 timestamp when the content was retrieved - `type: "web_fetch_result"` - `url: string` Fetched content URL - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_advisor_tool_result_block: object { content, tool_use_id, type }` - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - `beta_advisor_tool_result_error: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` - `beta_advisor_result_block: object { stop_reason, text, type }` - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `text: string` - `type: "advisor_result"` - `beta_advisor_redacted_result_block: object { encrypted_content, stop_reason, type }` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `type: "advisor_redacted_result"` - `tool_use_id: string` - `type: "advisor_tool_result"` - `beta_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `tool_use_id: string` - `type: "code_execution_tool_result"` - `beta_bash_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - `beta_bash_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` - `beta_bash_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlock` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` - `beta_text_editor_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - `beta_text_editor_code_execution_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "text_editor_code_execution_tool_result_error"` - `beta_text_editor_code_execution_view_result_block: object { content, file_type, num_lines, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number` - `start_line: number` - `total_lines: number` - `type: "text_editor_code_execution_view_result"` - `beta_text_editor_code_execution_create_result_block: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `beta_text_editor_code_execution_str_replace_result_block: object { lines, new_lines, new_start, 3 more }` - `lines: array of string` - `new_lines: number` - `new_start: number` - `old_lines: number` - `old_start: number` - `type: "text_editor_code_execution_str_replace_result"` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `beta_tool_search_tool_result_block: object { content, tool_use_id, type }` - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - `beta_tool_search_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "tool_search_tool_result_error"` - `beta_tool_search_tool_search_result_block: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlock` - `tool_name: string` - `type: "tool_reference"` - `type: "tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `beta_mcp_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `beta_mcp_tool_result_block: object { content, is_error, tool_use_id, type }` - `content: string or array of BetaTextBlock` - `union_member_0: string` - `beta_mcp_tool_result_block_content: array of BetaTextBlock` - `citations: array of BetaTextCitation` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `text: string` - `type: "text"` - `is_error: boolean` - `tool_use_id: string` - `type: "mcp_tool_result"` - `beta_container_upload_block: object { file_id, type }` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `beta_compaction_block: object { content, encrypted_content, type }` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `content: string` Summary of compacted content, or null if compaction failed - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `context_management: object { applied_edits }` 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. - `beta_clear_tool_uses_20250919_edit_response: object { cleared_input_tokens, cleared_tool_uses, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_tool_uses: number` Number of tool uses that were cleared. - `type: "clear_tool_uses_20250919"` The type of context management edit applied. - `beta_clear_thinking_20251015_edit_response: object { cleared_input_tokens, cleared_thinking_turns, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_thinking_turns: number` Number of thinking turns that were cleared. - `type: "clear_thinking_20251015"` The type of context management edit applied. - `diagnostics: object { cache_miss_reason }` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more` 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. - `beta_cache_miss_model_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "model_changed"` - `beta_cache_miss_system_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "system_changed"` - `beta_cache_miss_tools_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "tools_changed"` - `beta_cache_miss_messages_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "messages_changed"` - `beta_cache_miss_previous_message_not_found: object { type }` - `type: "previous_message_not_found"` - `beta_cache_miss_unavailable: object { type }` - `type: "unavailable"` - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `stop_details: object { category, explanation, type }` Structured information about a refusal. - `category: "cyber" or "bio"` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `explanation: string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `type: "refusal"` - `stop_reason: "end_turn" or "max_tokens" or "stop_sequence" or 5 more` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `type: "message"` Object type. For Messages, this is always `"message"`. - `usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 8 more }` 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: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `inference_geo: string` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `beta_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a sampling iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `beta_compaction_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a compaction iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "compaction"` Usage for a compaction iteration - `beta_advisor_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` Token usage for an advisor sub-inference iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `output_tokens: number` The number of output tokens which were used. - `type: "advisor_message"` Usage for an advisor sub-inference iteration - `output_tokens: number` The number of output tokens which were used. - `output_tokens_details: object { thinking_tokens }` 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. - `server_tool_use: object { web_fetch_requests, web_search_requests }` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. - `web_search_requests: number` The number of web search tool requests. - `service_tier: "standard" or "priority" or "batch"` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" or "fast"` The inference speed mode used for this request. - `"standard"` - `"fast"` - `type: "message_start"` ### Beta Raw Message Stop Event - `beta_raw_message_stop_event: object { type }` - `type: "message_stop"` ### Beta Raw Message Stream Event - `beta_raw_message_stream_event: BetaRawMessageStartEvent or BetaRawMessageDeltaEvent or BetaRawMessageStopEvent or 3 more` - `beta_raw_message_start_event: object { message, type }` - `message: object { id, container, content, 9 more }` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: object { id, expires_at, skills }` Information about the container used in the request (for the code execution tool) - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. - `skills: array of BetaSkill` Skills loaded in the container - `skill_id: string` Skill ID - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `version: string` Skill version or 'latest' for most recent version - `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)"}] ``` - `beta_text_block: object { citations, text, type }` - `citations: array of BetaTextCitation` 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`. - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `text: string` - `type: "text"` - `beta_thinking_block: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` - `beta_redacted_thinking_block: object { data, type }` - `data: string` - `type: "redacted_thinking"` - `beta_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` - `beta_server_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `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"` - `type: "server_tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_search_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock` - `beta_web_search_tool_result_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `union_member_1: array of BetaWebSearchResultBlock` - `encrypted_content: string` - `page_age: string` - `title: string` - `type: "web_search_result"` - `url: string` - `tool_use_id: string` - `type: "web_search_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_fetch_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - `beta_web_fetch_tool_result_error_block: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` - `beta_web_fetch_block: object { content, retrieved_at, type, url }` - `content: object { citations, source, title, type }` - `citations: object { enabled }` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource or BetaPlainTextSource` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `title: string` The title of the document - `type: "document"` - `retrieved_at: string` ISO 8601 timestamp when the content was retrieved - `type: "web_fetch_result"` - `url: string` Fetched content URL - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_advisor_tool_result_block: object { content, tool_use_id, type }` - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - `beta_advisor_tool_result_error: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` - `beta_advisor_result_block: object { stop_reason, text, type }` - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `text: string` - `type: "advisor_result"` - `beta_advisor_redacted_result_block: object { encrypted_content, stop_reason, type }` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `type: "advisor_redacted_result"` - `tool_use_id: string` - `type: "advisor_tool_result"` - `beta_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `tool_use_id: string` - `type: "code_execution_tool_result"` - `beta_bash_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - `beta_bash_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` - `beta_bash_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlock` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` - `beta_text_editor_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - `beta_text_editor_code_execution_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "text_editor_code_execution_tool_result_error"` - `beta_text_editor_code_execution_view_result_block: object { content, file_type, num_lines, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number` - `start_line: number` - `total_lines: number` - `type: "text_editor_code_execution_view_result"` - `beta_text_editor_code_execution_create_result_block: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `beta_text_editor_code_execution_str_replace_result_block: object { lines, new_lines, new_start, 3 more }` - `lines: array of string` - `new_lines: number` - `new_start: number` - `old_lines: number` - `old_start: number` - `type: "text_editor_code_execution_str_replace_result"` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `beta_tool_search_tool_result_block: object { content, tool_use_id, type }` - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - `beta_tool_search_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "tool_search_tool_result_error"` - `beta_tool_search_tool_search_result_block: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlock` - `tool_name: string` - `type: "tool_reference"` - `type: "tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `beta_mcp_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `beta_mcp_tool_result_block: object { content, is_error, tool_use_id, type }` - `content: string or array of BetaTextBlock` - `union_member_0: string` - `beta_mcp_tool_result_block_content: array of BetaTextBlock` - `citations: array of BetaTextCitation` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `text: string` - `type: "text"` - `is_error: boolean` - `tool_use_id: string` - `type: "mcp_tool_result"` - `beta_container_upload_block: object { file_id, type }` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `beta_compaction_block: object { content, encrypted_content, type }` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `content: string` Summary of compacted content, or null if compaction failed - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `context_management: object { applied_edits }` 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. - `beta_clear_tool_uses_20250919_edit_response: object { cleared_input_tokens, cleared_tool_uses, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_tool_uses: number` Number of tool uses that were cleared. - `type: "clear_tool_uses_20250919"` The type of context management edit applied. - `beta_clear_thinking_20251015_edit_response: object { cleared_input_tokens, cleared_thinking_turns, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_thinking_turns: number` Number of thinking turns that were cleared. - `type: "clear_thinking_20251015"` The type of context management edit applied. - `diagnostics: object { cache_miss_reason }` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more` 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. - `beta_cache_miss_model_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "model_changed"` - `beta_cache_miss_system_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "system_changed"` - `beta_cache_miss_tools_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "tools_changed"` - `beta_cache_miss_messages_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "messages_changed"` - `beta_cache_miss_previous_message_not_found: object { type }` - `type: "previous_message_not_found"` - `beta_cache_miss_unavailable: object { type }` - `type: "unavailable"` - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `stop_details: object { category, explanation, type }` Structured information about a refusal. - `category: "cyber" or "bio"` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `explanation: string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `type: "refusal"` - `stop_reason: "end_turn" or "max_tokens" or "stop_sequence" or 5 more` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `type: "message"` Object type. For Messages, this is always `"message"`. - `usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 8 more }` 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: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `inference_geo: string` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `beta_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a sampling iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `beta_compaction_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a compaction iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "compaction"` Usage for a compaction iteration - `beta_advisor_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` Token usage for an advisor sub-inference iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `output_tokens: number` The number of output tokens which were used. - `type: "advisor_message"` Usage for an advisor sub-inference iteration - `output_tokens: number` The number of output tokens which were used. - `output_tokens_details: object { thinking_tokens }` 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. - `server_tool_use: object { web_fetch_requests, web_search_requests }` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. - `web_search_requests: number` The number of web search tool requests. - `service_tier: "standard" or "priority" or "batch"` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" or "fast"` The inference speed mode used for this request. - `"standard"` - `"fast"` - `type: "message_start"` - `beta_raw_message_delta_event: object { context_management, delta, type, usage }` - `context_management: object { applied_edits }` Information about context management strategies applied during the request - `applied_edits: array of BetaClearToolUses20250919EditResponse or BetaClearThinking20251015EditResponse` List of context management edits that were applied. - `delta: object { container, stop_details, stop_reason, stop_sequence }` - `container: object { id, expires_at, skills }` Information about the container used in the request (for the code execution tool) - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. - `skills: array of BetaSkill` Skills loaded in the container - `stop_details: object { category, explanation, type }` Structured information about a refusal. - `category: "cyber" or "bio"` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `explanation: string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `type: "refusal"` - `stop_reason: "end_turn" or "max_tokens" or "stop_sequence" or 5 more` - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string` - `type: "message_delta"` - `usage: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 4 more }` 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` The cumulative number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The cumulative number of input tokens read from the cache. - `input_tokens: number` The cumulative number of input tokens which were used. - `iterations: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `beta_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a sampling iteration. - `beta_compaction_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a compaction iteration. - `beta_advisor_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` Token usage for an advisor sub-inference iteration. - `output_tokens: number` The cumulative number of output tokens which were used. - `output_tokens_details: object { thinking_tokens }` 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. - `server_tool_use: object { web_fetch_requests, web_search_requests }` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. - `web_search_requests: number` The number of web search tool requests. - `beta_raw_message_stop_event: object { type }` - `type: "message_stop"` - `beta_raw_content_block_start_event: object { content_block, index, type }` - `content_block: BetaTextBlock or BetaThinkingBlock or BetaRedactedThinkingBlock or 13 more` Response model for a file uploaded to the container. - `beta_text_block: object { citations, text, type }` - `citations: array of BetaTextCitation` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `text: string` - `type: "text"` - `beta_thinking_block: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` - `beta_redacted_thinking_block: object { data, type }` - `data: string` - `type: "redacted_thinking"` - `beta_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_server_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: "advisor" or "web_search" or "web_fetch" or 5 more` - `type: "server_tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_web_search_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock` - `tool_use_id: string` - `type: "web_search_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_web_fetch_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_advisor_tool_result_block: object { content, tool_use_id, type }` - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - `tool_use_id: string` - `type: "advisor_tool_result"` - `beta_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `tool_use_id: string` - `type: "code_execution_tool_result"` - `beta_bash_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` - `beta_text_editor_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `beta_tool_search_tool_result_block: object { content, tool_use_id, type }` - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `beta_mcp_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `beta_mcp_tool_result_block: object { content, is_error, tool_use_id, type }` - `content: string or array of BetaTextBlock` - `is_error: boolean` - `tool_use_id: string` - `type: "mcp_tool_result"` - `beta_container_upload_block: object { file_id, type }` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `beta_compaction_block: object { content, encrypted_content, type }` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `content: string` Summary of compacted content, or null if compaction failed - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `index: number` - `type: "content_block_start"` - `beta_raw_content_block_delta_event: object { delta, index, type }` - `delta: BetaTextDelta or BetaInputJSONDelta or BetaCitationsDelta or 3 more` - `beta_text_delta: object { text, type }` - `text: string` - `type: "text_delta"` - `beta_input_json_delta: object { partial_json, type }` - `partial_json: string` - `type: "input_json_delta"` - `beta_citations_delta: object { citation, type }` - `citation: BetaCitationCharLocation or BetaCitationPageLocation or BetaCitationContentBlockLocation or 2 more` - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `type: "citations_delta"` - `beta_thinking_delta: object { estimated_tokens, thinking, type }` - `estimated_tokens: number` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `thinking: string` - `type: "thinking_delta"` - `beta_signature_delta: object { signature, type }` - `signature: string` - `type: "signature_delta"` - `beta_compaction_content_block_delta: object { content, encrypted_content, type }` - `content: string` - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction_delta"` - `index: number` - `type: "content_block_delta"` - `beta_raw_content_block_stop_event: object { index, type }` - `index: number` - `type: "content_block_stop"` ### Beta Redacted Thinking Block - `beta_redacted_thinking_block: object { data, type }` - `data: string` - `type: "redacted_thinking"` ### Beta Redacted Thinking Block Param - `beta_redacted_thinking_block_param: object { data, type }` - `data: string` - `type: "redacted_thinking"` ### Beta Refusal Stop Details - `beta_refusal_stop_details: object { category, explanation, type }` Structured information about a refusal. - `category: "cyber" or "bio"` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `explanation: string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `type: "refusal"` ### Beta Request Document Block - `beta_request_document_block: object { source, type, cache_control, 3 more }` - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `beta_content_block_source: object { content, type }` - `content: string or array of BetaContentBlockSourceContent` - `union_member_0: string` - `beta_content_block_source_content: array of BetaContentBlockSourceContent` - `beta_text_block_param: object { text, type, cache_control, citations }` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `citations: optional array of BetaTextCitationParam` - `beta_citation_char_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location_param: object { cited_text, document_index, document_title, 3 more }` - `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` - `document_title: string` - `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. - `type: "content_block_location"` - `beta_citation_web_search_result_location_param: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location_param: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `beta_image_block_param: object { source, type, cache_control }` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `beta_base64_image_source: object { data, media_type, type }` - `data: string` - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `beta_url_image_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_image_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "image"` - `cache_control: optional object { type, ttl }` 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`. - `type: "content"` - `beta_url_pdf_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_document_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "document"` - `cache_control: optional object { type, ttl }` 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`. - `citations: optional object { enabled }` - `enabled: optional boolean` - `context: optional string` - `title: optional string` ### Beta Request MCP Server Tool Configuration - `beta_request_mcp_server_tool_configuration: object { allowed_tools, enabled }` - `allowed_tools: optional array of string` - `enabled: optional boolean` ### Beta Request MCP Server URL Definition - `beta_request_mcp_server_url_definition: object { name, type, url, 2 more }` - `name: string` - `type: "url"` - `url: string` - `authorization_token: optional string` - `tool_configuration: optional object { allowed_tools, enabled }` - `allowed_tools: optional array of string` - `enabled: optional boolean` ### Beta Request MCP Tool Result Block Param - `beta_request_mcp_tool_result_block_param: object { tool_use_id, type, cache_control, 2 more }` - `tool_use_id: string` - `type: "mcp_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `content: optional string or array of BetaTextBlockParam` - `union_member_0: string` - `beta_mcp_tool_result_block_param_content: array of BetaTextBlockParam` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` 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`. - `citations: optional array of BetaTextCitationParam` - `beta_citation_char_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location_param: object { cited_text, document_index, document_title, 3 more }` - `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` - `document_title: string` - `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. - `type: "content_block_location"` - `beta_citation_web_search_result_location_param: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location_param: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `is_error: optional boolean` ### Beta Search Result Block Param - `beta_search_result_block_param: object { content, source, title, 3 more }` - `content: array of BetaTextBlockParam` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `citations: optional array of BetaTextCitationParam` - `beta_citation_char_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location_param: object { cited_text, document_index, document_title, 3 more }` - `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` - `document_title: string` - `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. - `type: "content_block_location"` - `beta_citation_web_search_result_location_param: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location_param: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `source: string` - `title: string` - `type: "search_result"` - `cache_control: optional object { type, ttl }` 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`. - `citations: optional object { enabled }` - `enabled: optional boolean` ### Beta Server Tool Caller - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` ### Beta Server Tool Caller 20260120 - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` ### Beta Server Tool Usage - `beta_server_tool_usage: object { web_fetch_requests, web_search_requests }` - `web_fetch_requests: number` The number of web fetch tool requests. - `web_search_requests: number` The number of web search tool requests. ### Beta Server Tool Use Block - `beta_server_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `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"` - `type: "server_tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` ### Beta Server Tool Use Block Param - `beta_server_tool_use_block_param: object { id, input, name, 3 more }` - `id: string` - `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"` - `type: "server_tool_use"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` ### Beta Signature Delta - `beta_signature_delta: object { signature, type }` - `signature: string` - `type: "signature_delta"` ### Beta Skill - `beta_skill: object { skill_id, type, version }` A skill that was loaded in a container (response model). - `skill_id: string` Skill ID - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `version: string` Skill version or 'latest' for most recent version ### Beta Skill Params - `beta_skill_params: object { skill_id, type, version }` Specification for a skill to be loaded in a container (request model). - `skill_id: string` Skill ID - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `version: optional string` Skill version or 'latest' for most recent version ### Beta Stop Reason - `beta_stop_reason: "end_turn" or "max_tokens" or "stop_sequence" or 5 more` - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` ### Beta Text Block - `beta_text_block: object { citations, text, type }` - `citations: array of BetaTextCitation` 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`. - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `text: string` - `type: "text"` ### Beta Text Block Param - `beta_text_block_param: object { text, type, cache_control, citations }` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `citations: optional array of BetaTextCitationParam` - `beta_citation_char_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location_param: object { cited_text, document_index, document_title, 3 more }` - `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` - `document_title: string` - `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. - `type: "content_block_location"` - `beta_citation_web_search_result_location_param: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location_param: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` ### Beta Text Citation - `beta_text_citation: BetaCitationCharLocation or BetaCitationPageLocation or BetaCitationContentBlockLocation or 2 more` - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` ### Beta Text Citation Param - `beta_text_citation_param: BetaCitationCharLocationParam or BetaCitationPageLocationParam or BetaCitationContentBlockLocationParam or 2 more` - `beta_citation_char_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location_param: object { cited_text, document_index, document_title, 3 more }` - `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` - `document_title: string` - `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. - `type: "content_block_location"` - `beta_citation_web_search_result_location_param: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location_param: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` ### Beta Text Delta - `beta_text_delta: object { text, type }` - `text: string` - `type: "text_delta"` ### Beta Text Editor Code Execution Create Result Block - `beta_text_editor_code_execution_create_result_block: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` ### Beta Text Editor Code Execution Create Result Block Param - `beta_text_editor_code_execution_create_result_block_param: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` ### Beta Text Editor Code Execution Str Replace Result Block - `beta_text_editor_code_execution_str_replace_result_block: object { lines, new_lines, new_start, 3 more }` - `lines: array of string` - `new_lines: number` - `new_start: number` - `old_lines: number` - `old_start: number` - `type: "text_editor_code_execution_str_replace_result"` ### Beta Text Editor Code Execution Str Replace Result Block Param - `beta_text_editor_code_execution_str_replace_result_block_param: object { type, lines, new_lines, 3 more }` - `type: "text_editor_code_execution_str_replace_result"` - `lines: optional array of string` - `new_lines: optional number` - `new_start: optional number` - `old_lines: optional number` - `old_start: optional number` ### Beta Text Editor Code Execution Tool Result Block - `beta_text_editor_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - `beta_text_editor_code_execution_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "text_editor_code_execution_tool_result_error"` - `beta_text_editor_code_execution_view_result_block: object { content, file_type, num_lines, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number` - `start_line: number` - `total_lines: number` - `type: "text_editor_code_execution_view_result"` - `beta_text_editor_code_execution_create_result_block: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `beta_text_editor_code_execution_str_replace_result_block: object { lines, new_lines, new_start, 3 more }` - `lines: array of string` - `new_lines: number` - `new_start: number` - `old_lines: number` - `old_start: number` - `type: "text_editor_code_execution_str_replace_result"` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` ### Beta Text Editor Code Execution Tool Result Block Param - `beta_text_editor_code_execution_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaTextEditorCodeExecutionToolResultErrorParam or BetaTextEditorCodeExecutionViewResultBlockParam or BetaTextEditorCodeExecutionCreateResultBlockParam or BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `beta_text_editor_code_execution_tool_result_error_param: object { error_code, type, error_message }` - `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"` - `type: "text_editor_code_execution_tool_result_error"` - `error_message: optional string` - `beta_text_editor_code_execution_view_result_block_param: object { content, file_type, type, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `type: "text_editor_code_execution_view_result"` - `num_lines: optional number` - `start_line: optional number` - `total_lines: optional number` - `beta_text_editor_code_execution_create_result_block_param: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `beta_text_editor_code_execution_str_replace_result_block_param: object { type, lines, new_lines, 3 more }` - `type: "text_editor_code_execution_str_replace_result"` - `lines: optional array of string` - `new_lines: optional number` - `new_start: optional number` - `old_lines: optional number` - `old_start: optional number` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` ### Beta Text Editor Code Execution Tool Result Error - `beta_text_editor_code_execution_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "text_editor_code_execution_tool_result_error"` ### Beta Text Editor Code Execution Tool Result Error Param - `beta_text_editor_code_execution_tool_result_error_param: object { error_code, type, error_message }` - `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"` - `type: "text_editor_code_execution_tool_result_error"` - `error_message: optional string` ### Beta Text Editor Code Execution View Result Block - `beta_text_editor_code_execution_view_result_block: object { content, file_type, num_lines, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number` - `start_line: number` - `total_lines: number` - `type: "text_editor_code_execution_view_result"` ### Beta Text Editor Code Execution View Result Block Param - `beta_text_editor_code_execution_view_result_block_param: object { content, file_type, type, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `type: "text_editor_code_execution_view_result"` - `num_lines: optional number` - `start_line: optional number` - `total_lines: optional number` ### Beta Thinking Block - `beta_thinking_block: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` ### Beta Thinking Block Param - `beta_thinking_block_param: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` ### Beta Thinking Config Adaptive - `beta_thinking_config_adaptive: object { type, display }` - `type: "adaptive"` - `display: optional "summarized" or "omitted"` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` ### Beta Thinking Config Disabled - `beta_thinking_config_disabled: object { type }` - `type: "disabled"` ### Beta Thinking Config Enabled - `beta_thinking_config_enabled: object { budget_tokens, type, display }` - `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://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `type: "enabled"` - `display: optional "summarized" or "omitted"` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` ### Beta Thinking Config Param - `beta_thinking_config_param: BetaThinkingConfigEnabled or BetaThinkingConfigDisabled or BetaThinkingConfigAdaptive` Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `beta_thinking_config_enabled: object { budget_tokens, type, display }` - `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://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. - `type: "enabled"` - `display: optional "summarized" or "omitted"` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` - `beta_thinking_config_disabled: object { type }` - `type: "disabled"` - `beta_thinking_config_adaptive: object { type, display }` - `type: "adaptive"` - `display: optional "summarized" or "omitted"` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`. - `"summarized"` - `"omitted"` ### Beta Thinking Delta - `beta_thinking_delta: object { estimated_tokens, thinking, type }` - `estimated_tokens: number` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `thinking: string` - `type: "thinking_delta"` ### Beta Thinking Turns - `beta_thinking_turns: object { type, value }` - `type: "thinking_turns"` - `value: number` ### Beta Token Task Budget - `beta_token_task_budget: object { total, type, remaining }` User-configurable total token budget across contexts. - `total: number` Total token budget across all contexts in the session. - `type: "tokens"` The budget type. Currently only 'tokens' is supported. - `remaining: optional number` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. ### Beta Tool - `beta_tool: object { input_schema, name, allowed_callers, 7 more }` - `input_schema: object { type, properties, required }` [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]` - `required: optional array of string` - `name: string` 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"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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. - `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` 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 - `type: optional "custom"` - `"custom"` ### Beta Tool Bash 20241022 - `beta_tool_bash_20241022: object { name, type, allowed_callers, 4 more }` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "bash_20241022"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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 ### Beta Tool Bash 20250124 - `beta_tool_bash_20250124: object { name, type, allowed_callers, 4 more }` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "bash_20250124"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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 ### Beta Tool Choice - `beta_tool_choice: BetaToolChoiceAuto or BetaToolChoiceAny or BetaToolChoiceTool or BetaToolChoiceNone` 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. - `beta_tool_choice_auto: object { type, disable_parallel_tool_use }` 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. - `beta_tool_choice_any: object { type, disable_parallel_tool_use }` 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. - `beta_tool_choice_tool: object { name, type, disable_parallel_tool_use }` The model will use the specified tool with `tool_choice.name`. - `name: string` The name of the tool to use. - `type: "tool"` - `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. - `beta_tool_choice_none: object { type }` The model will not be allowed to use tools. - `type: "none"` ### Beta Tool Choice Any - `beta_tool_choice_any: object { type, disable_parallel_tool_use }` 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. ### Beta Tool Choice Auto - `beta_tool_choice_auto: object { type, disable_parallel_tool_use }` 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. ### Beta Tool Choice None - `beta_tool_choice_none: object { type }` The model will not be allowed to use tools. - `type: "none"` ### Beta Tool Choice Tool - `beta_tool_choice_tool: object { name, type, disable_parallel_tool_use }` The model will use the specified tool with `tool_choice.name`. - `name: string` The name of the tool to use. - `type: "tool"` - `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. ### Beta Tool Computer Use 20241022 - `beta_tool_computer_use_20241022: object { display_height_px, display_width_px, name, 7 more }` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "computer_20241022"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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. - `display_number: optional number` The X11 display number (e.g. 0, 1) for the display. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Computer Use 20250124 - `beta_tool_computer_use_20250124: object { display_height_px, display_width_px, name, 7 more }` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "computer_20250124"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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. - `display_number: optional number` The X11 display number (e.g. 0, 1) for the display. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Computer Use 20251124 - `beta_tool_computer_use_20251124: object { display_height_px, display_width_px, name, 8 more }` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "computer_20251124"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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. - `display_number: optional number` The X11 display number (e.g. 0, 1) for the display. - `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 ### Beta Tool Reference Block - `beta_tool_reference_block: object { tool_name, type }` - `tool_name: string` - `type: "tool_reference"` ### Beta Tool Reference Block Param - `beta_tool_reference_block_param: object { tool_name, type, cache_control }` Tool reference block that can be included in tool_result content. - `tool_name: string` - `type: "tool_reference"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` ### Beta Tool Result Block Param - `beta_tool_result_block_param: object { tool_use_id, type, cache_control, 2 more }` - `tool_use_id: string` - `type: "tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `content: optional array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 2 more` - `beta_text_block_param: object { text, type, cache_control, citations }` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` 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`. - `citations: optional array of BetaTextCitationParam` - `beta_citation_char_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location_param: object { cited_text, document_index, document_title, 3 more }` - `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` - `document_title: string` - `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. - `type: "content_block_location"` - `beta_citation_web_search_result_location_param: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location_param: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `beta_image_block_param: object { source, type, cache_control }` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `beta_base64_image_source: object { data, media_type, type }` - `data: string` - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `beta_url_image_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_image_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "image"` - `cache_control: optional object { type, ttl }` 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`. - `beta_search_result_block_param: object { content, source, title, 3 more }` - `content: array of BetaTextBlockParam` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam` - `source: string` - `title: string` - `type: "search_result"` - `cache_control: optional object { type, ttl }` 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`. - `citations: optional object { enabled }` - `enabled: optional boolean` - `beta_request_document_block: object { source, type, cache_control, 3 more }` - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `beta_content_block_source: object { content, type }` - `content: string or array of BetaContentBlockSourceContent` - `union_member_0: string` - `beta_content_block_source_content: array of BetaContentBlockSourceContent` - `beta_text_block_param: object { text, type, cache_control, citations }` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `citations: optional array of BetaTextCitationParam` - `beta_image_block_param: object { source, type, cache_control }` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `type: "image"` - `cache_control: optional object { type, ttl }` Create a cache control breakpoint at this content block. - `type: "content"` - `beta_url_pdf_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_document_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "document"` - `cache_control: optional object { type, ttl }` 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`. - `citations: optional object { enabled }` - `enabled: optional boolean` - `context: optional string` - `title: optional string` - `beta_tool_reference_block_param: object { tool_name, type, cache_control }` Tool reference block that can be included in tool_result content. - `tool_name: string` - `type: "tool_reference"` - `cache_control: optional object { type, ttl }` 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`. - `is_error: optional boolean` ### Beta Tool Search Tool Bm25 20251119 - `beta_tool_search_tool_bm25_20251119: object { name, type, allowed_callers, 3 more }` - `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. - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Search Tool Regex 20251119 - `beta_tool_search_tool_regex_20251119: object { name, type, allowed_callers, 3 more }` - `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. - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Search Tool Result Block - `beta_tool_search_tool_result_block: object { content, tool_use_id, type }` - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - `beta_tool_search_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "tool_search_tool_result_error"` - `beta_tool_search_tool_search_result_block: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlock` - `tool_name: string` - `type: "tool_reference"` - `type: "tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` ### Beta Tool Search Tool Result Block Param - `beta_tool_search_tool_result_block_param: object { content, tool_use_id, type, cache_control }` - `content: BetaToolSearchToolResultErrorParam or BetaToolSearchToolSearchResultBlockParam` - `beta_tool_search_tool_result_error_param: object { error_code, type }` - `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"` - `type: "tool_search_tool_result_error"` - `beta_tool_search_tool_search_result_block_param: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlockParam` - `tool_name: string` - `type: "tool_reference"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `type: "tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `cache_control: optional object { type, ttl }` 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`. ### Beta Tool Search Tool Result Error - `beta_tool_search_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "tool_search_tool_result_error"` ### Beta Tool Search Tool Result Error Param - `beta_tool_search_tool_result_error_param: object { error_code, type }` - `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"` - `type: "tool_search_tool_result_error"` ### Beta Tool Search Tool Search Result Block - `beta_tool_search_tool_search_result_block: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlock` - `tool_name: string` - `type: "tool_reference"` - `type: "tool_search_tool_search_result"` ### Beta Tool Search Tool Search Result Block Param - `beta_tool_search_tool_search_result_block_param: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlockParam` - `tool_name: string` - `type: "tool_reference"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `type: "tool_search_tool_search_result"` ### Beta Tool Text Editor 20241022 - `beta_tool_text_editor_20241022: object { name, type, allowed_callers, 4 more }` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "text_editor_20241022"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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 ### Beta Tool Text Editor 20250124 - `beta_tool_text_editor_20250124: object { name, type, allowed_callers, 4 more }` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "text_editor_20250124"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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 ### Beta Tool Text Editor 20250429 - `beta_tool_text_editor_20250429: object { name, type, allowed_callers, 4 more }` - `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. - `type: "text_editor_20250429"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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 ### Beta Tool Text Editor 20250728 - `beta_tool_text_editor_20250728: object { name, type, allowed_callers, 5 more }` - `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. - `type: "text_editor_20250728"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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]` - `max_characters: optional number` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs ### Beta Tool Union - `beta_tool_union: BetaTool or BetaToolBash20241022 or BetaToolBash20250124 or 20 more` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `beta_tool: object { input_schema, name, allowed_callers, 7 more }` - `input_schema: object { type, properties, required }` [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]` - `required: optional array of string` - `name: string` 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"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `"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. - `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` 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 - `type: optional "custom"` - `"custom"` - `beta_tool_bash_20241022: object { name, type, allowed_callers, 4 more }` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "bash_20241022"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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 - `beta_tool_bash_20250124: object { name, type, allowed_callers, 4 more }` - `name: "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "bash_20250124"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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 - `beta_code_execution_tool_20250522: object { name, type, allowed_callers, 3 more }` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "code_execution_20250522"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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 - `beta_code_execution_tool_20250825: object { name, type, allowed_callers, 3 more }` - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "code_execution_20250825"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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 - `beta_code_execution_tool_20260120: object { name, type, allowed_callers, 3 more }` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `name: "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "code_execution_20260120"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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 - `beta_tool_computer_use_20241022: object { display_height_px, display_width_px, name, 7 more }` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "computer_20241022"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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` The X11 display number (e.g. 0, 1) for the display. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `beta_memory_tool_20250818: object { name, type, allowed_callers, 4 more }` - `name: "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "memory_20250818"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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 - `beta_tool_computer_use_20250124: object { display_height_px, display_width_px, name, 7 more }` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "computer_20250124"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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` The X11 display number (e.g. 0, 1) for the display. - `input_examples: optional array of map[unknown]` - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `beta_tool_text_editor_20241022: object { name, type, allowed_callers, 4 more }` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "text_editor_20241022"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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 - `beta_tool_computer_use_20251124: object { display_height_px, display_width_px, name, 8 more }` - `display_height_px: number` The height of the display in pixels. - `display_width_px: number` The width of the display in pixels. - `name: "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "computer_20251124"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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` The X11 display number (e.g. 0, 1) for the display. - `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 - `beta_tool_text_editor_20250124: object { name, type, allowed_callers, 4 more }` - `name: "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "text_editor_20250124"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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 - `beta_tool_text_editor_20250429: object { name, type, allowed_callers, 4 more }` - `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. - `type: "text_editor_20250429"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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 - `beta_tool_text_editor_20250728: object { name, type, allowed_callers, 5 more }` - `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. - `type: "text_editor_20250728"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `beta_web_search_tool_20250305: object { name, type, allowed_callers, 7 more }` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "web_search_20250305"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains: optional array of string` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional object { type, ttl }` 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`. - `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` Maximum number of times the tool can be used in the API request. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional object { type, city, country, 2 more }` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city: optional string` The city of the user. - `country: optional string` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `region: optional string` The region of the user. - `timezone: optional string` The [IANA timezone](https://nodatime.org/TimeZones) of the user. - `beta_web_fetch_tool_20250910: object { name, type, allowed_callers, 8 more }` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "web_fetch_20250910"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains: optional array of string` List of domains to allow fetching from - `blocked_domains: optional array of string` List of domains to block fetching from - `cache_control: optional object { type, ttl }` 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`. - `citations: optional object { enabled }` 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` 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. - `max_uses: optional number` Maximum number of times the tool can be used in the API request. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `beta_web_search_tool_20260209: object { name, type, allowed_callers, 7 more }` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "web_search_20260209"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains: optional array of string` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional object { type, ttl }` 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`. - `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` Maximum number of times the tool can be used in the API request. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional object { type, city, country, 2 more }` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city: optional string` The city of the user. - `country: optional string` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `region: optional string` The region of the user. - `timezone: optional string` The [IANA timezone](https://nodatime.org/TimeZones) of the user. - `beta_web_fetch_tool_20260209: object { name, type, allowed_callers, 8 more }` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "web_fetch_20260209"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains: optional array of string` List of domains to allow fetching from - `blocked_domains: optional array of string` List of domains to block fetching from - `cache_control: optional object { type, ttl }` 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`. - `citations: optional object { enabled }` 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` 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. - `max_uses: optional number` Maximum number of times the tool can be used in the API request. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `beta_web_fetch_tool_20260309: object { name, type, allowed_callers, 9 more }` Web fetch tool with use_cache parameter for bypassing cached content. - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "web_fetch_20260309"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains: optional array of string` List of domains to allow fetching from - `blocked_domains: optional array of string` List of domains to block fetching from - `cache_control: optional object { type, ttl }` 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`. - `citations: optional object { enabled }` 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` 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. - `max_uses: optional number` Maximum number of times the tool can be used in the API request. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `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. - `beta_advisor_tool_20260301: object { model, name, type, 6 more }` - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `name: "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "advisor_20260301"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `caching: optional object { type, ttl }` 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. - `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`. - `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` Maximum number of times the tool can be used in the API request. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `beta_tool_search_tool_bm25_20251119: object { name, type, allowed_callers, 3 more }` - `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. - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"` - `"tool_search_tool_bm25_20251119"` - `"tool_search_tool_bm25"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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 - `beta_tool_search_tool_regex_20251119: object { name, type, allowed_callers, 3 more }` - `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. - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"` - `"tool_search_tool_regex_20251119"` - `"tool_search_tool_regex"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `cache_control: optional object { type, ttl }` 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`. - `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 - `beta_mcp_toolset: object { mcp_server_name, type, cache_control, 2 more }` 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. - `mcp_server_name: string` Name of the MCP server to configure tools for - `type: "mcp_toolset"` - `cache_control: optional object { type, ttl }` 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`. - `configs: optional map[BetaMCPToolConfig]` Configuration overrides for specific tools, keyed by tool name - `defer_loading: optional boolean` - `enabled: optional boolean` - `default_config: optional object { defer_loading, enabled }` Default configuration applied to all tools from this server - `defer_loading: optional boolean` - `enabled: optional boolean` ### Beta Tool Use Block - `beta_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` ### Beta Tool Use Block Param - `beta_tool_use_block_param: object { id, input, name, 3 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` ### Beta Tool Uses Keep - `beta_tool_uses_keep: object { type, value }` - `type: "tool_uses"` - `value: number` ### Beta Tool Uses Trigger - `beta_tool_uses_trigger: object { type, value }` - `type: "tool_uses"` - `value: number` ### Beta URL Image Source - `beta_url_image_source: object { type, url }` - `type: "url"` - `url: string` ### Beta URL PDF Source - `beta_url_pdf_source: object { type, url }` - `type: "url"` - `url: string` ### Beta Usage - `beta_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 8 more }` - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `inference_geo: string` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `beta_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a sampling iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `beta_compaction_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a compaction iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "compaction"` Usage for a compaction iteration - `beta_advisor_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` Token usage for an advisor sub-inference iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `output_tokens: number` The number of output tokens which were used. - `type: "advisor_message"` Usage for an advisor sub-inference iteration - `output_tokens: number` The number of output tokens which were used. - `output_tokens_details: object { thinking_tokens }` 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. - `server_tool_use: object { web_fetch_requests, web_search_requests }` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. - `web_search_requests: number` The number of web search tool requests. - `service_tier: "standard" or "priority" or "batch"` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" or "fast"` The inference speed mode used for this request. - `"standard"` - `"fast"` ### Beta User Location - `beta_user_location: object { type, city, country, 2 more }` - `type: "approximate"` - `city: optional string` The city of the user. - `country: optional string` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `region: optional string` The region of the user. - `timezone: optional string` The [IANA timezone](https://nodatime.org/TimeZones) of the user. ### Beta Web Fetch Block - `beta_web_fetch_block: object { content, retrieved_at, type, url }` - `content: object { citations, source, title, type }` - `citations: object { enabled }` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource or BetaPlainTextSource` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `title: string` The title of the document - `type: "document"` - `retrieved_at: string` ISO 8601 timestamp when the content was retrieved - `type: "web_fetch_result"` - `url: string` Fetched content URL ### Beta Web Fetch Block Param - `beta_web_fetch_block_param: object { content, type, url, retrieved_at }` - `content: object { source, type, cache_control, 3 more }` - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `beta_content_block_source: object { content, type }` - `content: string or array of BetaContentBlockSourceContent` - `union_member_0: string` - `beta_content_block_source_content: array of BetaContentBlockSourceContent` - `beta_text_block_param: object { text, type, cache_control, citations }` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `citations: optional array of BetaTextCitationParam` - `beta_citation_char_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location_param: object { cited_text, document_index, document_title, 3 more }` - `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` - `document_title: string` - `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. - `type: "content_block_location"` - `beta_citation_web_search_result_location_param: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location_param: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `beta_image_block_param: object { source, type, cache_control }` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `beta_base64_image_source: object { data, media_type, type }` - `data: string` - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `beta_url_image_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_image_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "image"` - `cache_control: optional object { type, ttl }` 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`. - `type: "content"` - `beta_url_pdf_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_document_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "document"` - `cache_control: optional object { type, ttl }` 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`. - `citations: optional object { enabled }` - `enabled: optional boolean` - `context: optional string` - `title: optional string` - `type: "web_fetch_result"` - `url: string` Fetched content URL - `retrieved_at: optional string` ISO 8601 timestamp when the content was retrieved ### Beta Web Fetch Tool 20250910 - `beta_web_fetch_tool_20250910: object { name, type, allowed_callers, 8 more }` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "web_fetch_20250910"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains: optional array of string` List of domains to allow fetching from - `blocked_domains: optional array of string` List of domains to block fetching from - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `citations: optional object { enabled }` 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` 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. - `max_uses: optional number` Maximum number of times the tool can be used in the API request. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs ### Beta Web Fetch Tool 20260209 - `beta_web_fetch_tool_20260209: object { name, type, allowed_callers, 8 more }` - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "web_fetch_20260209"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains: optional array of string` List of domains to allow fetching from - `blocked_domains: optional array of string` List of domains to block fetching from - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `citations: optional object { enabled }` 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` 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. - `max_uses: optional number` Maximum number of times the tool can be used in the API request. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs ### Beta Web Fetch Tool 20260309 - `beta_web_fetch_tool_20260309: object { name, type, allowed_callers, 9 more }` Web fetch tool with use_cache parameter for bypassing cached content. - `name: "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "web_fetch_20260309"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains: optional array of string` List of domains to allow fetching from - `blocked_domains: optional array of string` List of domains to block fetching from - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `citations: optional object { enabled }` 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` 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. - `max_uses: optional number` Maximum number of times the tool can be used in the API request. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `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. ### Beta Web Fetch Tool Result Block - `beta_web_fetch_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - `beta_web_fetch_tool_result_error_block: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` - `beta_web_fetch_block: object { content, retrieved_at, type, url }` - `content: object { citations, source, title, type }` - `citations: object { enabled }` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource or BetaPlainTextSource` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `title: string` The title of the document - `type: "document"` - `retrieved_at: string` ISO 8601 timestamp when the content was retrieved - `type: "web_fetch_result"` - `url: string` Fetched content URL - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` ### Beta Web Fetch Tool Result Block Param - `beta_web_fetch_tool_result_block_param: object { content, tool_use_id, type, 2 more }` - `content: BetaWebFetchToolResultErrorBlockParam or BetaWebFetchBlockParam` - `beta_web_fetch_tool_result_error_block_param: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` - `beta_web_fetch_block_param: object { content, type, url, retrieved_at }` - `content: object { source, type, cache_control, 3 more }` - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `beta_content_block_source: object { content, type }` - `content: string or array of BetaContentBlockSourceContent` - `union_member_0: string` - `beta_content_block_source_content: array of BetaContentBlockSourceContent` - `beta_text_block_param: object { text, type, cache_control, citations }` - `text: string` - `type: "text"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `citations: optional array of BetaTextCitationParam` - `beta_citation_char_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location_param: object { cited_text, document_index, document_title, 3 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location_param: object { cited_text, document_index, document_title, 3 more }` - `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` - `document_title: string` - `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. - `type: "content_block_location"` - `beta_citation_web_search_result_location_param: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location_param: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `beta_image_block_param: object { source, type, cache_control }` - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` - `beta_base64_image_source: object { data, media_type, type }` - `data: string` - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` - `"image/jpeg"` - `"image/png"` - `"image/gif"` - `"image/webp"` - `type: "base64"` - `beta_url_image_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_image_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "image"` - `cache_control: optional object { type, ttl }` 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`. - `type: "content"` - `beta_url_pdf_source: object { type, url }` - `type: "url"` - `url: string` - `beta_file_document_source: object { file_id, type }` - `file_id: string` - `type: "file"` - `type: "document"` - `cache_control: optional object { type, ttl }` 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`. - `citations: optional object { enabled }` - `enabled: optional boolean` - `context: optional string` - `title: optional string` - `type: "web_fetch_result"` - `url: string` Fetched content URL - `retrieved_at: optional string` ISO 8601 timestamp when the content was retrieved - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` ### Beta Web Fetch Tool Result Error Block - `beta_web_fetch_tool_result_error_block: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` ### Beta Web Fetch Tool Result Error Block Param - `beta_web_fetch_tool_result_error_block_param: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` ### Beta Web Fetch Tool Result Error Code - `beta_web_fetch_tool_result_error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` ### Beta Web Search Result Block - `beta_web_search_result_block: object { encrypted_content, page_age, title, 2 more }` - `encrypted_content: string` - `page_age: string` - `title: string` - `type: "web_search_result"` - `url: string` ### Beta Web Search Result Block Param - `beta_web_search_result_block_param: object { encrypted_content, title, type, 2 more }` - `encrypted_content: string` - `title: string` - `type: "web_search_result"` - `url: string` - `page_age: optional string` ### Beta Web Search Tool 20250305 - `beta_web_search_tool_20250305: object { name, type, allowed_callers, 7 more }` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "web_search_20250305"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains: optional array of string` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional object { type, ttl }` 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`. - `"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. - `max_uses: optional number` Maximum number of times the tool can be used in the API request. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional object { type, city, country, 2 more }` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city: optional string` The city of the user. - `country: optional string` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `region: optional string` The region of the user. - `timezone: optional string` The [IANA timezone](https://nodatime.org/TimeZones) of the user. ### Beta Web Search Tool 20260209 - `beta_web_search_tool_20260209: object { name, type, allowed_callers, 7 more }` - `name: "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `type: "web_search_20260209"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` - `"direct"` - `"code_execution_20250825"` - `"code_execution_20260120"` - `allowed_domains: optional array of string` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains: optional array of string` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control: optional object { type, ttl }` 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`. - `"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. - `max_uses: optional number` Maximum number of times the tool can be used in the API request. - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - `user_location: optional object { type, city, country, 2 more }` Parameters for the user's location. Used to provide more relevant search results. - `type: "approximate"` - `city: optional string` The city of the user. - `country: optional string` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - `region: optional string` The region of the user. - `timezone: optional string` The [IANA timezone](https://nodatime.org/TimeZones) of the user. ### Beta Web Search Tool Request Error - `beta_web_search_tool_request_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` ### Beta Web Search Tool Result Block - `beta_web_search_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock` - `beta_web_search_tool_result_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `union_member_1: array of BetaWebSearchResultBlock` - `encrypted_content: string` - `page_age: string` - `title: string` - `type: "web_search_result"` - `url: string` - `tool_use_id: string` - `type: "web_search_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` ### Beta Web Search Tool Result Block Content - `beta_web_search_tool_result_block_content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock` - `beta_web_search_tool_result_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `union_member_1: array of BetaWebSearchResultBlock` - `encrypted_content: string` - `page_age: string` - `title: string` - `type: "web_search_result"` - `url: string` ### Beta Web Search Tool Result Block Param - `beta_web_search_tool_result_block_param: object { content, tool_use_id, type, 2 more }` - `content: array of BetaWebSearchResultBlockParam or BetaWebSearchToolRequestError` - `Result Block: array of BetaWebSearchResultBlockParam` - `encrypted_content: string` - `title: string` - `type: "web_search_result"` - `url: string` - `page_age: optional string` - `beta_web_search_tool_request_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `tool_use_id: string` - `type: "web_search_tool_result"` - `cache_control: optional object { type, ttl }` 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`. - `"5m"` - `"1h"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` ### Beta Web Search Tool Result Block Param Content - `beta_web_search_tool_result_block_param_content: array of BetaWebSearchResultBlockParam or BetaWebSearchToolRequestError` - `Result Block: array of BetaWebSearchResultBlockParam` - `encrypted_content: string` - `title: string` - `type: "web_search_result"` - `url: string` - `page_age: optional string` - `beta_web_search_tool_request_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` ### Beta Web Search Tool Result Error - `beta_web_search_tool_result_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` ### Beta Web Search Tool Result Error Code - `beta_web_search_tool_result_error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` # Batches ## Create a Message Batch `$ ant beta:messages:batches create` **post** `/v1/messages/batches` Send a batch of Message creation requests. The Message Batches API can be used to process multiple Messages API requests at once. Once a Message Batch is created, it begins processing immediately. Batches can take up to 24 hours to complete. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `--request: array of object { custom_id, params }` Body param: List of requests for prompt completion. Each is an individual request to create a Message. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_message_batch: object { id, archived_at, cancel_initiated_at, 7 more }` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `cancel_initiated_at: string` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. - `ended_at: string` 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. - `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. - `processing_status: "in_progress" or "canceling" or "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: object { canceled, errored, expired, 2 more }` 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. - `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. - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `processing: number` Number of requests in the Message Batch that are processing. - `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. - `results_url: string` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. ### Example ```cli ant beta:messages:batches create \ --api-key my-anthropic-api-key \ --request '{custom_id: my-custom-id-1, params: {max_tokens: 1024, messages: [{content: [{text: x, type: text}], role: user}], model: claude-opus-4-6}}' ``` #### Response ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ## Retrieve a Message Batch `$ ant beta:messages:batches retrieve` **get** `/v1/messages/batches/{message_batch_id}` This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `--message-batch-id: string` ID of the Message Batch. - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_message_batch: object { id, archived_at, cancel_initiated_at, 7 more }` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `cancel_initiated_at: string` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. - `ended_at: string` 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. - `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. - `processing_status: "in_progress" or "canceling" or "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: object { canceled, errored, expired, 2 more }` 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. - `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. - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `processing: number` Number of requests in the Message Batch that are processing. - `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. - `results_url: string` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. ### Example ```cli ant beta:messages:batches retrieve \ --api-key my-anthropic-api-key \ --message-batch-id message_batch_id ``` #### Response ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ## List Message Batches `$ ant beta:messages:batches list` **get** `/v1/messages/batches` List all Message Batches within a Workspace. Most recently created batches are returned first. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `--after-id: optional string` Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `--before-id: optional string` Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `--limit: optional number` Query param: Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaListResponse_MessageBatch_: object { data, first_id, has_more, last_id }` - `data: array of BetaMessageBatch` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `cancel_initiated_at: string` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. - `ended_at: string` 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. - `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. - `processing_status: "in_progress" or "canceling" or "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: object { canceled, errored, expired, 2 more }` 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. - `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. - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `processing: number` Number of requests in the Message Batch that are processing. - `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. - `results_url: string` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. - `first_id: string` 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` Last ID in the `data` list. Can be used as the `after_id` for the next page. ### Example ```cli ant beta:messages:batches list \ --api-key my-anthropic-api-key ``` #### Response ```json { "data": [ { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ## Cancel a Message Batch `$ ant beta:messages:batches cancel` **post** `/v1/messages/batches/{message_batch_id}/cancel` Batches may be canceled any time before processing ends. Once cancellation is initiated, the batch enters a `canceling` state, at which time the system may complete any in-progress, non-interruptible requests before finalizing cancellation. The number of canceled requests is specified in `request_counts`. To determine which requests were canceled, check the individual results within the batch. Note that cancellation may not result in any canceled requests if they were non-interruptible. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `--message-batch-id: string` ID of the Message Batch. - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_message_batch: object { id, archived_at, cancel_initiated_at, 7 more }` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `cancel_initiated_at: string` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. - `ended_at: string` 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. - `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. - `processing_status: "in_progress" or "canceling" or "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: object { canceled, errored, expired, 2 more }` 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. - `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. - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `processing: number` Number of requests in the Message Batch that are processing. - `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. - `results_url: string` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. ### Example ```cli ant beta:messages:batches cancel \ --api-key my-anthropic-api-key \ --message-batch-id message_batch_id ``` #### Response ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ## Delete a Message Batch `$ ant beta:messages:batches delete` **delete** `/v1/messages/batches/{message_batch_id}` Delete a Message Batch. Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it. Learn more about the Message Batches API in our [user guide](https://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `--message-batch-id: string` ID of the Message Batch. - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_deleted_message_batch: object { id, type }` - `id: string` ID of the Message Batch. - `type: "message_batch_deleted"` Deleted object type. For Message Batches, this is always `"message_batch_deleted"`. ### Example ```cli ant beta:messages:batches delete \ --api-key my-anthropic-api-key \ --message-batch-id message_batch_id ``` #### Response ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "type": "message_batch_deleted" } ``` ## Retrieve Message Batch results `$ ant beta:messages:batches 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://docs.claude.com/en/docs/build-with-claude/batch-processing) ### Parameters - `--message-batch-id: string` ID of the Message Batch. - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_message_batch_individual_response: object { custom_id, result }` 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: BetaMessageBatchSucceededResult or BetaMessageBatchErroredResult or BetaMessageBatchCanceledResult or BetaMessageBatchExpiredResult` 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. - `beta_message_batch_succeeded_result: object { message, type }` - `message: object { id, container, content, 9 more }` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: object { id, expires_at, skills }` Information about the container used in the request (for the code execution tool) - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. - `skills: array of BetaSkill` Skills loaded in the container - `skill_id: string` Skill ID - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `version: string` Skill version or 'latest' for most recent version - `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)"}] ``` - `beta_text_block: object { citations, text, type }` - `citations: array of BetaTextCitation` 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`. - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `text: string` - `type: "text"` - `beta_thinking_block: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` - `beta_redacted_thinking_block: object { data, type }` - `data: string` - `type: "redacted_thinking"` - `beta_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` - `beta_server_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `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"` - `type: "server_tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_search_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock` - `beta_web_search_tool_result_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `union_member_1: array of BetaWebSearchResultBlock` - `encrypted_content: string` - `page_age: string` - `title: string` - `type: "web_search_result"` - `url: string` - `tool_use_id: string` - `type: "web_search_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_fetch_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - `beta_web_fetch_tool_result_error_block: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` - `beta_web_fetch_block: object { content, retrieved_at, type, url }` - `content: object { citations, source, title, type }` - `citations: object { enabled }` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource or BetaPlainTextSource` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `title: string` The title of the document - `type: "document"` - `retrieved_at: string` ISO 8601 timestamp when the content was retrieved - `type: "web_fetch_result"` - `url: string` Fetched content URL - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_advisor_tool_result_block: object { content, tool_use_id, type }` - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - `beta_advisor_tool_result_error: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` - `beta_advisor_result_block: object { stop_reason, text, type }` - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `text: string` - `type: "advisor_result"` - `beta_advisor_redacted_result_block: object { encrypted_content, stop_reason, type }` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `type: "advisor_redacted_result"` - `tool_use_id: string` - `type: "advisor_tool_result"` - `beta_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `tool_use_id: string` - `type: "code_execution_tool_result"` - `beta_bash_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - `beta_bash_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` - `beta_bash_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlock` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` - `beta_text_editor_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - `beta_text_editor_code_execution_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "text_editor_code_execution_tool_result_error"` - `beta_text_editor_code_execution_view_result_block: object { content, file_type, num_lines, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number` - `start_line: number` - `total_lines: number` - `type: "text_editor_code_execution_view_result"` - `beta_text_editor_code_execution_create_result_block: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `beta_text_editor_code_execution_str_replace_result_block: object { lines, new_lines, new_start, 3 more }` - `lines: array of string` - `new_lines: number` - `new_start: number` - `old_lines: number` - `old_start: number` - `type: "text_editor_code_execution_str_replace_result"` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `beta_tool_search_tool_result_block: object { content, tool_use_id, type }` - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - `beta_tool_search_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "tool_search_tool_result_error"` - `beta_tool_search_tool_search_result_block: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlock` - `tool_name: string` - `type: "tool_reference"` - `type: "tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `beta_mcp_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `beta_mcp_tool_result_block: object { content, is_error, tool_use_id, type }` - `content: string or array of BetaTextBlock` - `union_member_0: string` - `beta_mcp_tool_result_block_content: array of BetaTextBlock` - `citations: array of BetaTextCitation` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `text: string` - `type: "text"` - `is_error: boolean` - `tool_use_id: string` - `type: "mcp_tool_result"` - `beta_container_upload_block: object { file_id, type }` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `beta_compaction_block: object { content, encrypted_content, type }` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `content: string` Summary of compacted content, or null if compaction failed - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `context_management: object { applied_edits }` 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. - `beta_clear_tool_uses_20250919_edit_response: object { cleared_input_tokens, cleared_tool_uses, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_tool_uses: number` Number of tool uses that were cleared. - `type: "clear_tool_uses_20250919"` The type of context management edit applied. - `beta_clear_thinking_20251015_edit_response: object { cleared_input_tokens, cleared_thinking_turns, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_thinking_turns: number` Number of thinking turns that were cleared. - `type: "clear_thinking_20251015"` The type of context management edit applied. - `diagnostics: object { cache_miss_reason }` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more` 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. - `beta_cache_miss_model_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "model_changed"` - `beta_cache_miss_system_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "system_changed"` - `beta_cache_miss_tools_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "tools_changed"` - `beta_cache_miss_messages_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "messages_changed"` - `beta_cache_miss_previous_message_not_found: object { type }` - `type: "previous_message_not_found"` - `beta_cache_miss_unavailable: object { type }` - `type: "unavailable"` - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `stop_details: object { category, explanation, type }` Structured information about a refusal. - `category: "cyber" or "bio"` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `explanation: string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `type: "refusal"` - `stop_reason: "end_turn" or "max_tokens" or "stop_sequence" or 5 more` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `type: "message"` Object type. For Messages, this is always `"message"`. - `usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 8 more }` 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: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `inference_geo: string` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `beta_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a sampling iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `beta_compaction_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a compaction iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "compaction"` Usage for a compaction iteration - `beta_advisor_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` Token usage for an advisor sub-inference iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `output_tokens: number` The number of output tokens which were used. - `type: "advisor_message"` Usage for an advisor sub-inference iteration - `output_tokens: number` The number of output tokens which were used. - `output_tokens_details: object { thinking_tokens }` 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. - `server_tool_use: object { web_fetch_requests, web_search_requests }` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. - `web_search_requests: number` The number of web search tool requests. - `service_tier: "standard" or "priority" or "batch"` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" or "fast"` The inference speed mode used for this request. - `"standard"` - `"fast"` - `type: "succeeded"` - `beta_message_batch_errored_result: object { error, type }` - `error: object { error, request_id, type }` - `error: BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 6 more` - `beta_invalid_request_error: object { message, type }` - `message: string` - `type: "invalid_request_error"` - `beta_authentication_error: object { message, type }` - `message: string` - `type: "authentication_error"` - `beta_billing_error: object { message, type }` - `message: string` - `type: "billing_error"` - `beta_permission_error: object { message, type }` - `message: string` - `type: "permission_error"` - `beta_not_found_error: object { message, type }` - `message: string` - `type: "not_found_error"` - `beta_rate_limit_error: object { message, type }` - `message: string` - `type: "rate_limit_error"` - `beta_gateway_timeout_error: object { message, type }` - `message: string` - `type: "timeout_error"` - `beta_api_error: object { message, type }` - `message: string` - `type: "api_error"` - `beta_overloaded_error: object { message, type }` - `message: string` - `type: "overloaded_error"` - `request_id: string` - `type: "error"` - `type: "errored"` - `beta_message_batch_canceled_result: object { type }` - `type: "canceled"` - `beta_message_batch_expired_result: object { type }` - `type: "expired"` ### Example ```cli ant beta:messages:batches results \ --api-key my-anthropic-api-key \ --message-batch-id message_batch_id ``` ## Domain Types ### Beta Deleted Message Batch - `beta_deleted_message_batch: object { id, type }` - `id: string` ID of the Message Batch. - `type: "message_batch_deleted"` Deleted object type. For Message Batches, this is always `"message_batch_deleted"`. ### Beta Message Batch - `beta_message_batch: object { id, archived_at, cancel_initiated_at, 7 more }` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `archived_at: string` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `cancel_initiated_at: string` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `created_at: string` RFC 3339 datetime string representing the time at which the Message Batch was created. - `ended_at: string` 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. - `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. - `processing_status: "in_progress" or "canceling" or "ended"` Processing status of the Message Batch. - `"in_progress"` - `"canceling"` - `"ended"` - `request_counts: object { canceled, errored, expired, 2 more }` 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. - `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. - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `processing: number` Number of requests in the Message Batch that are processing. - `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. - `results_url: string` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `type: "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. ### Beta Message Batch Canceled Result - `beta_message_batch_canceled_result: object { type }` - `type: "canceled"` ### Beta Message Batch Errored Result - `beta_message_batch_errored_result: object { error, type }` - `error: object { error, request_id, type }` - `error: BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 6 more` - `beta_invalid_request_error: object { message, type }` - `message: string` - `type: "invalid_request_error"` - `beta_authentication_error: object { message, type }` - `message: string` - `type: "authentication_error"` - `beta_billing_error: object { message, type }` - `message: string` - `type: "billing_error"` - `beta_permission_error: object { message, type }` - `message: string` - `type: "permission_error"` - `beta_not_found_error: object { message, type }` - `message: string` - `type: "not_found_error"` - `beta_rate_limit_error: object { message, type }` - `message: string` - `type: "rate_limit_error"` - `beta_gateway_timeout_error: object { message, type }` - `message: string` - `type: "timeout_error"` - `beta_api_error: object { message, type }` - `message: string` - `type: "api_error"` - `beta_overloaded_error: object { message, type }` - `message: string` - `type: "overloaded_error"` - `request_id: string` - `type: "error"` - `type: "errored"` ### Beta Message Batch Expired Result - `beta_message_batch_expired_result: object { type }` - `type: "expired"` ### Beta Message Batch Individual Response - `beta_message_batch_individual_response: object { custom_id, result }` 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: BetaMessageBatchSucceededResult or BetaMessageBatchErroredResult or BetaMessageBatchCanceledResult or BetaMessageBatchExpiredResult` 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. - `beta_message_batch_succeeded_result: object { message, type }` - `message: object { id, container, content, 9 more }` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: object { id, expires_at, skills }` Information about the container used in the request (for the code execution tool) - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. - `skills: array of BetaSkill` Skills loaded in the container - `skill_id: string` Skill ID - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `version: string` Skill version or 'latest' for most recent version - `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)"}] ``` - `beta_text_block: object { citations, text, type }` - `citations: array of BetaTextCitation` 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`. - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `text: string` - `type: "text"` - `beta_thinking_block: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` - `beta_redacted_thinking_block: object { data, type }` - `data: string` - `type: "redacted_thinking"` - `beta_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` - `beta_server_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `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"` - `type: "server_tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_search_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock` - `beta_web_search_tool_result_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `union_member_1: array of BetaWebSearchResultBlock` - `encrypted_content: string` - `page_age: string` - `title: string` - `type: "web_search_result"` - `url: string` - `tool_use_id: string` - `type: "web_search_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_fetch_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - `beta_web_fetch_tool_result_error_block: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` - `beta_web_fetch_block: object { content, retrieved_at, type, url }` - `content: object { citations, source, title, type }` - `citations: object { enabled }` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource or BetaPlainTextSource` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `title: string` The title of the document - `type: "document"` - `retrieved_at: string` ISO 8601 timestamp when the content was retrieved - `type: "web_fetch_result"` - `url: string` Fetched content URL - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_advisor_tool_result_block: object { content, tool_use_id, type }` - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - `beta_advisor_tool_result_error: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` - `beta_advisor_result_block: object { stop_reason, text, type }` - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `text: string` - `type: "advisor_result"` - `beta_advisor_redacted_result_block: object { encrypted_content, stop_reason, type }` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `type: "advisor_redacted_result"` - `tool_use_id: string` - `type: "advisor_tool_result"` - `beta_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `tool_use_id: string` - `type: "code_execution_tool_result"` - `beta_bash_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - `beta_bash_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` - `beta_bash_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlock` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` - `beta_text_editor_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - `beta_text_editor_code_execution_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "text_editor_code_execution_tool_result_error"` - `beta_text_editor_code_execution_view_result_block: object { content, file_type, num_lines, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number` - `start_line: number` - `total_lines: number` - `type: "text_editor_code_execution_view_result"` - `beta_text_editor_code_execution_create_result_block: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `beta_text_editor_code_execution_str_replace_result_block: object { lines, new_lines, new_start, 3 more }` - `lines: array of string` - `new_lines: number` - `new_start: number` - `old_lines: number` - `old_start: number` - `type: "text_editor_code_execution_str_replace_result"` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `beta_tool_search_tool_result_block: object { content, tool_use_id, type }` - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - `beta_tool_search_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "tool_search_tool_result_error"` - `beta_tool_search_tool_search_result_block: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlock` - `tool_name: string` - `type: "tool_reference"` - `type: "tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `beta_mcp_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `beta_mcp_tool_result_block: object { content, is_error, tool_use_id, type }` - `content: string or array of BetaTextBlock` - `union_member_0: string` - `beta_mcp_tool_result_block_content: array of BetaTextBlock` - `citations: array of BetaTextCitation` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `text: string` - `type: "text"` - `is_error: boolean` - `tool_use_id: string` - `type: "mcp_tool_result"` - `beta_container_upload_block: object { file_id, type }` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `beta_compaction_block: object { content, encrypted_content, type }` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `content: string` Summary of compacted content, or null if compaction failed - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `context_management: object { applied_edits }` 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. - `beta_clear_tool_uses_20250919_edit_response: object { cleared_input_tokens, cleared_tool_uses, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_tool_uses: number` Number of tool uses that were cleared. - `type: "clear_tool_uses_20250919"` The type of context management edit applied. - `beta_clear_thinking_20251015_edit_response: object { cleared_input_tokens, cleared_thinking_turns, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_thinking_turns: number` Number of thinking turns that were cleared. - `type: "clear_thinking_20251015"` The type of context management edit applied. - `diagnostics: object { cache_miss_reason }` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more` 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. - `beta_cache_miss_model_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "model_changed"` - `beta_cache_miss_system_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "system_changed"` - `beta_cache_miss_tools_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "tools_changed"` - `beta_cache_miss_messages_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "messages_changed"` - `beta_cache_miss_previous_message_not_found: object { type }` - `type: "previous_message_not_found"` - `beta_cache_miss_unavailable: object { type }` - `type: "unavailable"` - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `stop_details: object { category, explanation, type }` Structured information about a refusal. - `category: "cyber" or "bio"` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `explanation: string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `type: "refusal"` - `stop_reason: "end_turn" or "max_tokens" or "stop_sequence" or 5 more` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `type: "message"` Object type. For Messages, this is always `"message"`. - `usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 8 more }` 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: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `inference_geo: string` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `beta_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a sampling iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `beta_compaction_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a compaction iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "compaction"` Usage for a compaction iteration - `beta_advisor_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` Token usage for an advisor sub-inference iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `output_tokens: number` The number of output tokens which were used. - `type: "advisor_message"` Usage for an advisor sub-inference iteration - `output_tokens: number` The number of output tokens which were used. - `output_tokens_details: object { thinking_tokens }` 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. - `server_tool_use: object { web_fetch_requests, web_search_requests }` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. - `web_search_requests: number` The number of web search tool requests. - `service_tier: "standard" or "priority" or "batch"` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" or "fast"` The inference speed mode used for this request. - `"standard"` - `"fast"` - `type: "succeeded"` - `beta_message_batch_errored_result: object { error, type }` - `error: object { error, request_id, type }` - `error: BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 6 more` - `beta_invalid_request_error: object { message, type }` - `message: string` - `type: "invalid_request_error"` - `beta_authentication_error: object { message, type }` - `message: string` - `type: "authentication_error"` - `beta_billing_error: object { message, type }` - `message: string` - `type: "billing_error"` - `beta_permission_error: object { message, type }` - `message: string` - `type: "permission_error"` - `beta_not_found_error: object { message, type }` - `message: string` - `type: "not_found_error"` - `beta_rate_limit_error: object { message, type }` - `message: string` - `type: "rate_limit_error"` - `beta_gateway_timeout_error: object { message, type }` - `message: string` - `type: "timeout_error"` - `beta_api_error: object { message, type }` - `message: string` - `type: "api_error"` - `beta_overloaded_error: object { message, type }` - `message: string` - `type: "overloaded_error"` - `request_id: string` - `type: "error"` - `type: "errored"` - `beta_message_batch_canceled_result: object { type }` - `type: "canceled"` - `beta_message_batch_expired_result: object { type }` - `type: "expired"` ### Beta Message Batch Request Counts - `beta_message_batch_request_counts: object { canceled, errored, expired, 2 more }` - `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. - `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. - `expired: number` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `processing: number` Number of requests in the Message Batch that are processing. - `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. ### Beta Message Batch Result - `beta_message_batch_result: BetaMessageBatchSucceededResult or BetaMessageBatchErroredResult or BetaMessageBatchCanceledResult or BetaMessageBatchExpiredResult` 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. - `beta_message_batch_succeeded_result: object { message, type }` - `message: object { id, container, content, 9 more }` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: object { id, expires_at, skills }` Information about the container used in the request (for the code execution tool) - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. - `skills: array of BetaSkill` Skills loaded in the container - `skill_id: string` Skill ID - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `version: string` Skill version or 'latest' for most recent version - `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)"}] ``` - `beta_text_block: object { citations, text, type }` - `citations: array of BetaTextCitation` 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`. - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `text: string` - `type: "text"` - `beta_thinking_block: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` - `beta_redacted_thinking_block: object { data, type }` - `data: string` - `type: "redacted_thinking"` - `beta_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` - `beta_server_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `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"` - `type: "server_tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_search_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock` - `beta_web_search_tool_result_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `union_member_1: array of BetaWebSearchResultBlock` - `encrypted_content: string` - `page_age: string` - `title: string` - `type: "web_search_result"` - `url: string` - `tool_use_id: string` - `type: "web_search_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_fetch_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - `beta_web_fetch_tool_result_error_block: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` - `beta_web_fetch_block: object { content, retrieved_at, type, url }` - `content: object { citations, source, title, type }` - `citations: object { enabled }` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource or BetaPlainTextSource` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `title: string` The title of the document - `type: "document"` - `retrieved_at: string` ISO 8601 timestamp when the content was retrieved - `type: "web_fetch_result"` - `url: string` Fetched content URL - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_advisor_tool_result_block: object { content, tool_use_id, type }` - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - `beta_advisor_tool_result_error: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` - `beta_advisor_result_block: object { stop_reason, text, type }` - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `text: string` - `type: "advisor_result"` - `beta_advisor_redacted_result_block: object { encrypted_content, stop_reason, type }` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `type: "advisor_redacted_result"` - `tool_use_id: string` - `type: "advisor_tool_result"` - `beta_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `tool_use_id: string` - `type: "code_execution_tool_result"` - `beta_bash_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - `beta_bash_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` - `beta_bash_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlock` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` - `beta_text_editor_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - `beta_text_editor_code_execution_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "text_editor_code_execution_tool_result_error"` - `beta_text_editor_code_execution_view_result_block: object { content, file_type, num_lines, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number` - `start_line: number` - `total_lines: number` - `type: "text_editor_code_execution_view_result"` - `beta_text_editor_code_execution_create_result_block: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `beta_text_editor_code_execution_str_replace_result_block: object { lines, new_lines, new_start, 3 more }` - `lines: array of string` - `new_lines: number` - `new_start: number` - `old_lines: number` - `old_start: number` - `type: "text_editor_code_execution_str_replace_result"` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `beta_tool_search_tool_result_block: object { content, tool_use_id, type }` - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - `beta_tool_search_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "tool_search_tool_result_error"` - `beta_tool_search_tool_search_result_block: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlock` - `tool_name: string` - `type: "tool_reference"` - `type: "tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `beta_mcp_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `beta_mcp_tool_result_block: object { content, is_error, tool_use_id, type }` - `content: string or array of BetaTextBlock` - `union_member_0: string` - `beta_mcp_tool_result_block_content: array of BetaTextBlock` - `citations: array of BetaTextCitation` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `text: string` - `type: "text"` - `is_error: boolean` - `tool_use_id: string` - `type: "mcp_tool_result"` - `beta_container_upload_block: object { file_id, type }` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `beta_compaction_block: object { content, encrypted_content, type }` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `content: string` Summary of compacted content, or null if compaction failed - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `context_management: object { applied_edits }` 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. - `beta_clear_tool_uses_20250919_edit_response: object { cleared_input_tokens, cleared_tool_uses, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_tool_uses: number` Number of tool uses that were cleared. - `type: "clear_tool_uses_20250919"` The type of context management edit applied. - `beta_clear_thinking_20251015_edit_response: object { cleared_input_tokens, cleared_thinking_turns, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_thinking_turns: number` Number of thinking turns that were cleared. - `type: "clear_thinking_20251015"` The type of context management edit applied. - `diagnostics: object { cache_miss_reason }` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more` 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. - `beta_cache_miss_model_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "model_changed"` - `beta_cache_miss_system_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "system_changed"` - `beta_cache_miss_tools_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "tools_changed"` - `beta_cache_miss_messages_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "messages_changed"` - `beta_cache_miss_previous_message_not_found: object { type }` - `type: "previous_message_not_found"` - `beta_cache_miss_unavailable: object { type }` - `type: "unavailable"` - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `stop_details: object { category, explanation, type }` Structured information about a refusal. - `category: "cyber" or "bio"` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `explanation: string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `type: "refusal"` - `stop_reason: "end_turn" or "max_tokens" or "stop_sequence" or 5 more` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `type: "message"` Object type. For Messages, this is always `"message"`. - `usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 8 more }` 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: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `inference_geo: string` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `beta_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a sampling iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `beta_compaction_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a compaction iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "compaction"` Usage for a compaction iteration - `beta_advisor_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` Token usage for an advisor sub-inference iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `output_tokens: number` The number of output tokens which were used. - `type: "advisor_message"` Usage for an advisor sub-inference iteration - `output_tokens: number` The number of output tokens which were used. - `output_tokens_details: object { thinking_tokens }` 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. - `server_tool_use: object { web_fetch_requests, web_search_requests }` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. - `web_search_requests: number` The number of web search tool requests. - `service_tier: "standard" or "priority" or "batch"` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" or "fast"` The inference speed mode used for this request. - `"standard"` - `"fast"` - `type: "succeeded"` - `beta_message_batch_errored_result: object { error, type }` - `error: object { error, request_id, type }` - `error: BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 6 more` - `beta_invalid_request_error: object { message, type }` - `message: string` - `type: "invalid_request_error"` - `beta_authentication_error: object { message, type }` - `message: string` - `type: "authentication_error"` - `beta_billing_error: object { message, type }` - `message: string` - `type: "billing_error"` - `beta_permission_error: object { message, type }` - `message: string` - `type: "permission_error"` - `beta_not_found_error: object { message, type }` - `message: string` - `type: "not_found_error"` - `beta_rate_limit_error: object { message, type }` - `message: string` - `type: "rate_limit_error"` - `beta_gateway_timeout_error: object { message, type }` - `message: string` - `type: "timeout_error"` - `beta_api_error: object { message, type }` - `message: string` - `type: "api_error"` - `beta_overloaded_error: object { message, type }` - `message: string` - `type: "overloaded_error"` - `request_id: string` - `type: "error"` - `type: "errored"` - `beta_message_batch_canceled_result: object { type }` - `type: "canceled"` - `beta_message_batch_expired_result: object { type }` - `type: "expired"` ### Beta Message Batch Succeeded Result - `beta_message_batch_succeeded_result: object { message, type }` - `message: object { id, container, content, 9 more }` - `id: string` Unique object identifier. The format and length of IDs may change over time. - `container: object { id, expires_at, skills }` Information about the container used in the request (for the code execution tool) - `id: string` Identifier for the container used in this request - `expires_at: string` The time at which the container will expire. - `skills: array of BetaSkill` Skills loaded in the container - `skill_id: string` Skill ID - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `"anthropic"` - `"custom"` - `version: string` Skill version or 'latest' for most recent version - `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)"}] ``` - `beta_text_block: object { citations, text, type }` - `citations: array of BetaTextCitation` 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`. - `beta_citation_char_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_char_index: number` - `file_id: string` - `start_char_index: number` - `type: "char_location"` - `beta_citation_page_location: object { cited_text, document_index, document_title, 4 more }` - `cited_text: string` - `document_index: number` - `document_title: string` - `end_page_number: number` - `file_id: string` - `start_page_number: number` - `type: "page_location"` - `beta_citation_content_block_location: object { cited_text, document_index, document_title, 4 more }` - `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` - `document_title: string` - `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` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `type: "content_block_location"` - `beta_citations_web_search_result_location: object { cited_text, encrypted_index, title, 2 more }` - `cited_text: string` - `encrypted_index: string` - `title: string` - `type: "web_search_result_location"` - `url: string` - `beta_citation_search_result_location: object { cited_text, end_block_index, search_result_index, 4 more }` - `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. - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. - `title: string` - `type: "search_result_location"` - `text: string` - `type: "text"` - `beta_thinking_block: object { signature, thinking, type }` - `signature: string` - `thinking: string` - `type: "thinking"` - `beta_redacted_thinking_block: object { data, type }` - `data: string` - `type: "redacted_thinking"` - `beta_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` - `type: "tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `type: "direct"` - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `tool_id: string` - `type: "code_execution_20250825"` - `beta_server_tool_caller_20260120: object { tool_id, type }` - `tool_id: string` - `type: "code_execution_20260120"` - `beta_server_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `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"` - `type: "server_tool_use"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_search_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebSearchToolResultError or array of BetaWebSearchResultBlock` - `beta_web_search_tool_result_error: object { error_code, type }` - `error_code: "invalid_tool_input" or "unavailable" or "max_uses_exceeded" or 3 more` - `"invalid_tool_input"` - `"unavailable"` - `"max_uses_exceeded"` - `"too_many_requests"` - `"query_too_long"` - `"request_too_large"` - `type: "web_search_tool_result_error"` - `union_member_1: array of BetaWebSearchResultBlock` - `encrypted_content: string` - `page_age: string` - `title: string` - `type: "web_search_result"` - `url: string` - `tool_use_id: string` - `type: "web_search_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_web_fetch_tool_result_block: object { content, tool_use_id, type, caller }` - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` - `beta_web_fetch_tool_result_error_block: object { error_code, type }` - `error_code: "invalid_tool_input" or "url_too_long" or "url_not_allowed" or 6 more` - `"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"` - `type: "web_fetch_tool_result_error"` - `beta_web_fetch_block: object { content, retrieved_at, type, url }` - `content: object { citations, source, title, type }` - `citations: object { enabled }` Citation configuration for the document - `enabled: boolean` - `source: BetaBase64PDFSource or BetaPlainTextSource` - `beta_base64_pdf_source: object { data, media_type, type }` - `data: string` - `media_type: "application/pdf"` - `type: "base64"` - `beta_plain_text_source: object { data, media_type, type }` - `data: string` - `media_type: "text/plain"` - `type: "text"` - `title: string` The title of the document - `type: "document"` - `retrieved_at: string` ISO 8601 timestamp when the content was retrieved - `type: "web_fetch_result"` - `url: string` Fetched content URL - `tool_use_id: string` - `type: "web_fetch_tool_result"` - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` Tool invocation directly from the model. - `beta_direct_caller: object { type }` Tool invocation directly from the model. - `beta_server_tool_caller: object { tool_id, type }` Tool invocation generated by a server-side tool. - `beta_server_tool_caller_20260120: object { tool_id, type }` - `beta_advisor_tool_result_block: object { content, tool_use_id, type }` - `content: BetaAdvisorToolResultError or BetaAdvisorResultBlock or BetaAdvisorRedactedResultBlock` - `beta_advisor_tool_result_error: object { error_code, type }` - `error_code: "max_uses_exceeded" or "prompt_too_long" or "too_many_requests" or 3 more` - `"max_uses_exceeded"` - `"prompt_too_long"` - `"too_many_requests"` - `"overloaded"` - `"unavailable"` - `"execution_time_exceeded"` - `type: "advisor_tool_result_error"` - `beta_advisor_result_block: object { stop_reason, text, type }` - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `text: string` - `type: "advisor_result"` - `beta_advisor_redacted_result_block: object { encrypted_content, stop_reason, type }` - `encrypted_content: string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `stop_reason: string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `type: "advisor_redacted_result"` - `tool_use_id: string` - `type: "advisor_tool_result"` - `beta_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaCodeExecutionToolResultError or BetaCodeExecutionResultBlock or BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `beta_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "code_execution_tool_result_error"` - `beta_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "code_execution_result"` - `beta_encrypted_code_execution_result_block: object { content, encrypted_stdout, return_code, 2 more }` Code execution result with encrypted stdout for PFC + web_search results. - `content: array of BetaCodeExecutionOutputBlock` - `file_id: string` - `type: "code_execution_output"` - `encrypted_stdout: string` - `return_code: number` - `stderr: string` - `type: "encrypted_code_execution_result"` - `tool_use_id: string` - `type: "code_execution_tool_result"` - `beta_bash_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` - `beta_bash_code_execution_tool_result_error: object { error_code, type }` - `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"` - `type: "bash_code_execution_tool_result_error"` - `beta_bash_code_execution_result_block: object { content, return_code, stderr, 2 more }` - `content: array of BetaBashCodeExecutionOutputBlock` - `file_id: string` - `type: "bash_code_execution_output"` - `return_code: number` - `stderr: string` - `stdout: string` - `type: "bash_code_execution_result"` - `tool_use_id: string` - `type: "bash_code_execution_tool_result"` - `beta_text_editor_code_execution_tool_result_block: object { content, tool_use_id, type }` - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` - `beta_text_editor_code_execution_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "text_editor_code_execution_tool_result_error"` - `beta_text_editor_code_execution_view_result_block: object { content, file_type, num_lines, 3 more }` - `content: string` - `file_type: "text" or "image" or "pdf"` - `"text"` - `"image"` - `"pdf"` - `num_lines: number` - `start_line: number` - `total_lines: number` - `type: "text_editor_code_execution_view_result"` - `beta_text_editor_code_execution_create_result_block: object { is_file_update, type }` - `is_file_update: boolean` - `type: "text_editor_code_execution_create_result"` - `beta_text_editor_code_execution_str_replace_result_block: object { lines, new_lines, new_start, 3 more }` - `lines: array of string` - `new_lines: number` - `new_start: number` - `old_lines: number` - `old_start: number` - `type: "text_editor_code_execution_str_replace_result"` - `tool_use_id: string` - `type: "text_editor_code_execution_tool_result"` - `beta_tool_search_tool_result_block: object { content, tool_use_id, type }` - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` - `beta_tool_search_tool_result_error: object { error_code, error_message, type }` - `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` - `type: "tool_search_tool_result_error"` - `beta_tool_search_tool_search_result_block: object { tool_references, type }` - `tool_references: array of BetaToolReferenceBlock` - `tool_name: string` - `type: "tool_reference"` - `type: "tool_search_tool_search_result"` - `tool_use_id: string` - `type: "tool_search_tool_result"` - `beta_mcp_tool_use_block: object { id, input, name, 2 more }` - `id: string` - `input: map[unknown]` - `name: string` The name of the MCP tool - `server_name: string` The name of the MCP server - `type: "mcp_tool_use"` - `beta_mcp_tool_result_block: object { content, is_error, tool_use_id, type }` - `content: string or array of BetaTextBlock` - `union_member_0: string` - `beta_mcp_tool_result_block_content: array of BetaTextBlock` - `citations: array of BetaTextCitation` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `text: string` - `type: "text"` - `is_error: boolean` - `tool_use_id: string` - `type: "mcp_tool_result"` - `beta_container_upload_block: object { file_id, type }` Response model for a file uploaded to the container. - `file_id: string` - `type: "container_upload"` - `beta_compaction_block: object { content, encrypted_content, type }` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `content: string` Summary of compacted content, or null if compaction failed - `encrypted_content: string` Opaque metadata from prior compaction, to be round-tripped verbatim - `type: "compaction"` - `context_management: object { applied_edits }` 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. - `beta_clear_tool_uses_20250919_edit_response: object { cleared_input_tokens, cleared_tool_uses, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_tool_uses: number` Number of tool uses that were cleared. - `type: "clear_tool_uses_20250919"` The type of context management edit applied. - `beta_clear_thinking_20251015_edit_response: object { cleared_input_tokens, cleared_thinking_turns, type }` - `cleared_input_tokens: number` Number of input tokens cleared by this edit. - `cleared_thinking_turns: number` Number of thinking turns that were cleared. - `type: "clear_thinking_20251015"` The type of context management edit applied. - `diagnostics: object { cache_miss_reason }` Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied `diagnostics` on the request. - `cache_miss_reason: BetaCacheMissModelChanged or BetaCacheMissSystemChanged or BetaCacheMissToolsChanged or 3 more` 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. - `beta_cache_miss_model_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "model_changed"` - `beta_cache_miss_system_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "system_changed"` - `beta_cache_miss_tools_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "tools_changed"` - `beta_cache_miss_messages_changed: object { cache_missed_input_tokens, type }` - `cache_missed_input_tokens: number` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type: "messages_changed"` - `beta_cache_miss_previous_message_not_found: object { type }` - `type: "previous_message_not_found"` - `beta_cache_miss_unavailable: object { type }` - `type: "unavailable"` - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `role: "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `stop_details: object { category, explanation, type }` Structured information about a refusal. - `category: "cyber" or "bio"` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `"cyber"` - `"bio"` - `explanation: string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `type: "refusal"` - `stop_reason: "end_turn" or "max_tokens" or "stop_sequence" or 5 more` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `"end_turn"` - `"max_tokens"` - `"stop_sequence"` - `"tool_use"` - `"pause_turn"` - `"compaction"` - `"refusal"` - `"model_context_window_exceeded"` - `stop_sequence: string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `type: "message"` Object type. For Messages, this is always `"message"`. - `usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 8 more }` 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: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `inference_geo: string` The geographic region where inference was performed for this request. - `input_tokens: number` The number of input tokens which were used. - `iterations: array of BetaMessageIterationUsage or BetaCompactionIterationUsage or BetaAdvisorMessageIterationUsage` Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: - Determine which iterations exceeded long context thresholds (>=200k tokens) - Calculate the true context window size from the last iteration - Understand token accumulation across server-side tool use loops - `beta_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a sampling iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "message"` Usage for a sampling iteration - `beta_compaction_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` Token usage for a compaction iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `output_tokens: number` The number of output tokens which were used. - `type: "compaction"` Usage for a compaction iteration - `beta_advisor_message_iteration_usage: object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 4 more }` Token usage for an advisor sub-inference iteration. - `cache_creation: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Breakdown of cached tokens by TTL - `ephemeral_1h_input_tokens: number` The number of input tokens used to create the 1 hour cache entry. - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. - `cache_creation_input_tokens: number` The number of input tokens used to create the cache entry. - `cache_read_input_tokens: number` The number of input tokens read from the cache. - `input_tokens: number` The number of input tokens which were used. - `model: "claude-opus-4-8" or "claude-opus-4-7" or "claude-mythos-preview" or 15 more or string` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-mythos-preview"` New class of intelligence, strongest in coding and cybersecurity - `"claude-opus-4-6"` Frontier intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `"claude-opus-4-1"` Exceptional model for specialized complex tasks - `"claude-opus-4-1-20250805"` Exceptional model for specialized complex tasks - `"claude-opus-4-0"` Powerful model for complex tasks - `"claude-opus-4-20250514"` Powerful model for complex tasks - `"claude-sonnet-4-0"` High-performance model with extended thinking - `"claude-sonnet-4-20250514"` High-performance model with extended thinking - `"claude-3-haiku-20240307"` Fast and cost-effective model - `output_tokens: number` The number of output tokens which were used. - `type: "advisor_message"` Usage for an advisor sub-inference iteration - `output_tokens: number` The number of output tokens which were used. - `output_tokens_details: object { thinking_tokens }` 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. - `server_tool_use: object { web_fetch_requests, web_search_requests }` The number of server tool requests. - `web_fetch_requests: number` The number of web fetch tool requests. - `web_search_requests: number` The number of web search tool requests. - `service_tier: "standard" or "priority" or "batch"` If the request used the priority, standard, or batch tier. - `"standard"` - `"priority"` - `"batch"` - `speed: "standard" or "fast"` The inference speed mode used for this request. - `"standard"` - `"fast"` - `type: "succeeded"` # Agents ## Create Agent `$ ant beta:agents create` **post** `/v1/agents` Create Agent ### Parameters - `--model: BetaManagedAgentsModelConfigParams` Body param: Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-4-6`, or a `model_config` object for additional configuration control - `--name: string` Body param: Human-readable name for the agent. 1-256 characters. - `--description: optional string` Body param: Description of what the agent does. Up to 2048 characters. - `--mcp-server: optional array of BetaManagedAgentsURLMCPServerParams` Body param: MCP servers this agent connects to. Maximum 20. Names must be unique within the array. - `--metadata: optional map[string]` Body param: Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `--multiagent: optional object { agents, type }` Body param: A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster. - `--skill: optional array of BetaManagedAgentsSkillParams` Body param: Skills available to the agent. Maximum 20. - `--system: optional string` Body param: System prompt for the agent. Up to 100,000 characters. - `--tool: optional array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams` Body param: Tool configurations available to the agent. Maximum of 128 tools across all toolsets allowed. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_agent: object { id, archived_at, created_at, 12 more }` A Managed Agents `agent`. - `id: string` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `metadata: map[string]` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with a concrete agent roster. - `agents: array of BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `id: string` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `updated_at: string` A timestamp in RFC 3339 format - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. ### Example ```cli ant beta:agents create \ --api-key my-anthropic-api-key \ --model '{id: claude-opus-4-6}' \ --name 'My First Agent' ``` #### Response ```json { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ``` ## List Agents `$ ant beta:agents list` **get** `/v1/agents` List Agents ### Parameters - `--created-at-gte: optional string` Query param: Return agents created at or after this time (inclusive). - `--created-at-lte: optional string` Query param: Return agents created at or before this time (inclusive). - `--include-archived: optional boolean` Query param: Include archived agents in results. Defaults to false. - `--limit: optional number` Query param: Maximum results per page. Default 20, maximum 100. - `--page: optional string` Query param: Opaque pagination cursor from a previous response. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaManagedAgentsListAgents: object { data, next_page }` Paginated list of agents. - `data: optional array of BetaManagedAgentsAgent` List of agents. - `id: string` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `metadata: map[string]` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with a concrete agent roster. - `agents: array of BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `id: string` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `updated_at: string` A timestamp in RFC 3339 format - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. - `next_page: optional string` Opaque cursor for the next page. Null when no more results. ### Example ```cli ant beta:agents list \ --api-key my-anthropic-api-key ``` #### Response ```json { "data": [ { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ], "next_page": "next_page" } ``` ## Get Agent `$ ant beta:agents retrieve` **get** `/v1/agents/{agent_id}` Get Agent ### Parameters - `--agent-id: string` Path param: Path parameter agent_id - `--version: optional number` Query param: Agent version. Omit for the most recent version. Must be at least 1 if specified. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_agent: object { id, archived_at, created_at, 12 more }` A Managed Agents `agent`. - `id: string` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `metadata: map[string]` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with a concrete agent roster. - `agents: array of BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `id: string` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `updated_at: string` A timestamp in RFC 3339 format - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. ### Example ```cli ant beta:agents retrieve \ --api-key my-anthropic-api-key \ --agent-id agent_011CZkYpogX7uDKUyvBTophP ``` #### Response ```json { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ``` ## Update Agent `$ ant beta:agents update` **post** `/v1/agents/{agent_id}` Update Agent ### Parameters - `--agent-id: string` Path param: Path parameter agent_id - `--version: number` Body param: The agent's current version, used to prevent concurrent overwrites. Obtain this value from a create or retrieve response. The request fails if this does not match the server's current version. - `--description: optional string` Body param: Description. Up to 2048 characters. Omit to preserve; send empty string or null to clear. - `--mcp-server: optional array of BetaManagedAgentsURLMCPServerParams` Body param: MCP servers. Full replacement. Omit to preserve; send empty array or null to clear. Names must be unique. Maximum 20. - `--metadata: optional map[string]` Body param: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars. - `--model: optional BetaManagedAgentsModelConfigParams` Body param: Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-4-6`, or a `model_config` object for additional configuration control. Omit to preserve. Cannot be cleared. - `--multiagent: optional object { agents, type }` Body param: A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster. - `--name: optional string` Body param: Human-readable name. 1-256 characters. Omit to preserve. Cannot be cleared. - `--skill: optional array of BetaManagedAgentsSkillParams` Body param: Skills. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 20. - `--system: optional string` Body param: System prompt. Up to 100,000 characters. Omit to preserve; send empty string or null to clear. - `--tool: optional array of BetaManagedAgentsAgentToolset20260401Params or BetaManagedAgentsMCPToolsetParams or BetaManagedAgentsCustomToolParams` Body param: Tool configurations available to the agent. Full replacement. Omit to preserve; send empty array or null to clear. Maximum of 128 tools across all toolsets allowed. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_agent: object { id, archived_at, created_at, 12 more }` A Managed Agents `agent`. - `id: string` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `metadata: map[string]` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with a concrete agent roster. - `agents: array of BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `id: string` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `updated_at: string` A timestamp in RFC 3339 format - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. ### Example ```cli ant beta:agents update \ --api-key my-anthropic-api-key \ --agent-id agent_011CZkYpogX7uDKUyvBTophP \ --version 1 ``` #### Response ```json { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ``` ## Archive Agent `$ ant beta:agents archive` **post** `/v1/agents/{agent_id}/archive` Archive Agent ### Parameters - `--agent-id: string` Path parameter agent_id - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_agent: object { id, archived_at, created_at, 12 more }` A Managed Agents `agent`. - `id: string` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `metadata: map[string]` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with a concrete agent roster. - `agents: array of BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `id: string` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `updated_at: string` A timestamp in RFC 3339 format - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. ### Example ```cli ant beta:agents archive \ --api-key my-anthropic-api-key \ --agent-id agent_011CZkYpogX7uDKUyvBTophP ``` #### Response ```json { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ``` ## Domain Types ### Beta Managed Agents Agent - `beta_managed_agents_agent: object { id, archived_at, created_at, 12 more }` A Managed Agents `agent`. - `id: string` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `metadata: map[string]` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with a concrete agent roster. - `agents: array of BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `id: string` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `updated_at: string` A timestamp in RFC 3339 format - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. ### Beta Managed Agents Agent Reference - `beta_managed_agents_agent_reference: object { id, type, version }` A resolved agent reference with a concrete version. - `id: string` - `type: "agent"` - `"agent"` - `version: number` ### Beta Managed Agents Agent Tool Config - `beta_managed_agents_agent_tool_config: object { enabled, name, permission_policy }` Configuration for a specific agent tool. - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` ### Beta Managed Agents Agent Tool Config Params - `beta_managed_agents_agent_tool_config_params: object { name, enabled, permission_policy }` Configuration override for a specific tool within a toolset. - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `enabled: optional boolean` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` ### Beta Managed Agents Agent Toolset Default Config - `beta_managed_agents_agent_toolset_default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` ### Beta Managed Agents Agent Toolset Default Config Params - `beta_managed_agents_agent_toolset_default_config_params: object { enabled, permission_policy }` Default configuration for all tools in a toolset. - `enabled: optional boolean` Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` ### Beta Managed Agents Agent Toolset20260401 - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` ### Beta Managed Agents Agent Toolset20260401 Bash Input - `beta_managed_agents_agent_toolset20260401_bash_input: object { command, restart, timeout_ms }` Input payload for the `bash` tool of the `agent_toolset_20260401` toolset. All fields are optional; a normal invocation supplies `command`, while `restart=true` (with no `command`) reboots the runner-side bash session. - `command: optional string` Shell command to execute. Omit only when `restart` is true. - `restart: optional boolean` When true, restart the persistent bash session instead of running a command. Subsequent calls without `restart` will run against the fresh session. - `timeout_ms: optional number` Per-call timeout in milliseconds. Defaults to the runner-wide tool timeout when omitted or zero. ### Beta Managed Agents Agent Toolset20260401 Edit Input - `beta_managed_agents_agent_toolset20260401_edit_input: object { file_path, new_string, old_string, replace_all }` Input payload for the `edit` tool. Performs a string replacement in the named file; by default `old_string` must occur exactly once. - `file_path: string` Path of the file to edit. - `new_string: string` Replacement text. - `old_string: string` Substring to find and replace. - `replace_all: optional boolean` When true, replace every occurrence of `old_string` instead of requiring a unique match. ### Beta Managed Agents Agent Toolset20260401 Glob Input - `beta_managed_agents_agent_toolset20260401_glob_input: object { pattern, path }` Input payload for the `glob` tool. Returns paths matching a doublestar glob pattern, newest first. - `pattern: string` Doublestar glob pattern (e.g. `**/*.go`). Absolute patterns are only permitted when the runner is configured to allow them. - `path: optional string` Optional directory root to search under. Defaults to the runner's working directory. ### Beta Managed Agents Agent Toolset20260401 Grep Input - `beta_managed_agents_agent_toolset20260401_grep_input: object { pattern, path }` Input payload for the `grep` tool. Searches file contents for a regular expression, returning matching lines. - `pattern: string` Regular expression to search for. - `path: optional string` Optional directory root to search under. Defaults to the runner's working directory. ### Beta Managed Agents Agent Toolset20260401 Params - `beta_managed_agents_agent_toolset20260401_params: object { type, configs, default_config }` Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `configs: optional array of BetaManagedAgentsAgentToolConfigParams` Per-tool configuration overrides. - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `enabled: optional boolean` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: optional object { enabled, permission_policy }` Default configuration for all tools in a toolset. - `enabled: optional boolean` Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. ### Beta Managed Agents Agent Toolset20260401 Read Input - `beta_managed_agents_agent_toolset20260401_read_input: object { file_path, view_range }` Input payload for the `read` tool. Reads file contents relative to the runner's working directory (or absolute when the runner permits). - `file_path: string` Path of the file to read. - `view_range: optional array of number` Optional `[start_line, end_line]` 1-indexed inclusive range. When omitted the entire file is returned. `end_line` of 0 or negative means "to end of file". ### Beta Managed Agents Agent Toolset20260401 Write Input - `beta_managed_agents_agent_toolset20260401_write_input: object { content, file_path }` Input payload for the `write` tool. Writes (overwriting) the entire file contents. - `content: string` Full file contents to write. - `file_path: string` Path of the file to write. ### Beta Managed Agents Always Allow Policy - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` ### Beta Managed Agents Always Ask Policy - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` ### Beta Managed Agents Anthropic Skill - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` ### Beta Managed Agents Anthropic Skill Params - `beta_managed_agents_anthropic_skill_params: object { skill_id, type, version }` An Anthropic-managed skill. - `skill_id: string` Identifier of the Anthropic skill (e.g., "xlsx"). - `type: "anthropic"` - `"anthropic"` - `version: optional string` Version to pin. Defaults to latest if omitted. ### Beta Managed Agents Custom Skill - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` ### Beta Managed Agents Custom Skill Params - `beta_managed_agents_custom_skill_params: object { skill_id, type, version }` A user-created custom skill. - `skill_id: string` Tagged ID of the custom skill (e.g., "skill_01XJ5..."). - `type: "custom"` - `"custom"` - `version: optional string` Version to pin. Defaults to latest if omitted. ### Beta Managed Agents Custom Tool - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` ### Beta Managed Agents Custom Tool Input Schema - `beta_managed_agents_custom_tool_input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` ### Beta Managed Agents Custom Tool Params - `beta_managed_agents_custom_tool_params: object { description, input_schema, name, type }` A custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an `agent.custom_tool_use` event is emitted and the session goes idle, waiting for the client to provide the result via a `user.custom_tool_result` event. - `description: string` Description of what the tool does, shown to the agent to help it decide when to use the tool. 1-1024 characters. - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens. - `type: "custom"` - `"custom"` ### Beta Managed Agents MCP Server URL Definition - `beta_managed_agents_mcp_server_url_definition: object { name, type, url }` URL-based MCP server connection as returned in API responses. - `name: string` - `type: "url"` - `"url"` - `url: string` ### Beta Managed Agents MCP Tool Config - `beta_managed_agents_mcp_tool_config: object { enabled, name, permission_policy }` Resolved configuration for a specific MCP tool. - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` ### Beta Managed Agents MCP Tool Config Params - `beta_managed_agents_mcp_tool_config_params: object { name, enabled, permission_policy }` Configuration override for a specific MCP tool. - `name: string` Name of the MCP tool to configure. 1-128 characters. - `enabled: optional boolean` Whether this tool is enabled. Overrides the `default_config` setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` ### Beta Managed Agents MCP Toolset - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` ### Beta Managed Agents MCP Toolset Default Config - `beta_managed_agents_mcp_toolset_default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` ### Beta Managed Agents MCP Toolset Default Config Params - `beta_managed_agents_mcp_toolset_default_config_params: object { enabled, permission_policy }` Default configuration for all tools from an MCP server. - `enabled: optional boolean` Whether tools are enabled by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` ### Beta Managed Agents MCP Toolset Params - `beta_managed_agents_mcp_toolset_params: object { mcp_server_name, type, configs, default_config }` Configuration for tools from an MCP server defined in `mcp_servers`. - `mcp_server_name: string` Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters. - `type: "mcp_toolset"` - `"mcp_toolset"` - `configs: optional array of BetaManagedAgentsMCPToolConfigParams` Per-tool configuration overrides. - `name: string` Name of the MCP tool to configure. 1-128 characters. - `enabled: optional boolean` Whether this tool is enabled. Overrides the `default_config` setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: optional object { enabled, permission_policy }` Default configuration for all tools from an MCP server. - `enabled: optional boolean` Whether tools are enabled by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. ### Beta Managed Agents Model Config - `beta_managed_agents_model_config: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` ### Beta Managed Agents Model Config Params - `beta_managed_agents_model_config_params: object { id, speed }` An object that defines additional configuration control over model use - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` ### Beta Managed Agents Multiagent Coordinator - `beta_managed_agents_multiagent_coordinator: object { agents, type }` Resolved coordinator topology with a concrete agent roster. - `agents: array of BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `id: string` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` ### Beta Managed Agents Multiagent Coordinator Params - `beta_managed_agents_multiagent_coordinator_params: object { agents, type }` A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster. - `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). - `union_member_0: string` - `beta_managed_agents_agent_params: object { id, type, version }` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `id: string` The `agent` ID. - `type: "agent"` - `"agent"` - `version: optional number` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. - `beta_managed_agents_multiagent_self_params: object { type }` Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. - `type: "self"` - `"self"` - `type: "coordinator"` - `"coordinator"` ### Beta Managed Agents Multiagent Self Params - `beta_managed_agents_multiagent_self_params: object { type }` Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. - `type: "self"` - `"self"` ### Beta Managed Agents Session Thread Agent - `beta_managed_agents_session_thread_agent: object { id, description, mcp_servers, 7 more }` Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` ### Beta Managed Agents Skill Params - `beta_managed_agents_skill_params: BetaManagedAgentsAnthropicSkillParams or BetaManagedAgentsCustomSkillParams` Skill to load in the session container. - `beta_managed_agents_anthropic_skill_params: object { skill_id, type, version }` An Anthropic-managed skill. - `skill_id: string` Identifier of the Anthropic skill (e.g., "xlsx"). - `type: "anthropic"` - `"anthropic"` - `version: optional string` Version to pin. Defaults to latest if omitted. - `beta_managed_agents_custom_skill_params: object { skill_id, type, version }` A user-created custom skill. - `skill_id: string` Tagged ID of the custom skill (e.g., "skill_01XJ5..."). - `type: "custom"` - `"custom"` - `version: optional string` Version to pin. Defaults to latest if omitted. ### Beta Managed Agents URL MCP Server Params - `beta_managed_agents_url_mcp_server_params: object { name, type, url }` URL-based MCP server connection. - `name: string` Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters. - `type: "url"` - `"url"` - `url: string` Endpoint URL for the MCP server. # Versions ## List Agent Versions `$ ant beta:agents:versions list` **get** `/v1/agents/{agent_id}/versions` List Agent Versions ### Parameters - `--agent-id: string` Path param: Path parameter agent_id - `--limit: optional number` Query param: Maximum results per page. Default 20, maximum 100. - `--page: optional string` Query param: Opaque pagination cursor. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaManagedAgentsListAgentVersions: object { data, next_page }` Paginated list of agent versions. - `data: optional array of BetaManagedAgentsAgent` Agent versions. - `id: string` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `metadata: map[string]` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with a concrete agent roster. - `agents: array of BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `id: string` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `updated_at: string` A timestamp in RFC 3339 format - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. - `next_page: optional string` Opaque cursor for the next page. Null when no more results. ### Example ```cli ant beta:agents:versions list \ --api-key my-anthropic-api-key \ --agent-id agent_011CZkYpogX7uDKUyvBTophP ``` #### Response ```json { "data": [ { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ], "next_page": "next_page" } ``` # Environments ## Create Environment `$ ant beta:environments create` **post** `/v1/environments` Create a new environment with the specified configuration. ### Parameters - `--name: string` Body param: Human-readable name for the environment - `--config: optional BetaCloudConfigParams or BetaSelfHostedConfigParams` Body param: Environment configuration - `--description: optional string` Body param: Optional description of the environment - `--metadata: optional map[string]` Body param: User-provided metadata key-value pairs - `--scope: optional "organization" or "account"` Body param: The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. Only applicable for self-hosted environments. If not specified, defaults based on organization type. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_environment: object { id, archived_at, config, 7 more }` Unified Environment resource for both cloud and self-hosted environments. - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig or BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `beta_cloud_config: object { networking, packages, type }` `cloud` environment configuration. - `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork` Network configuration policy. - `beta_unrestricted_network: object { type }` Unrestricted network access. - `type: "unrestricted"` Network policy type - `beta_limited_network: object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }` Limited network access. - `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. - `type: "limited"` Network policy type - `packages: object { apt, cargo, gem, 4 more }` Package manager configuration. - `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 - `type: optional "packages"` Package configuration type - `"packages"` - `type: "cloud"` Environment type - `beta_self_hosted_config: object { type }` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `created_at: string` RFC 3339 timestamp when environment was created - `description: string` User-provided description for the environment - `metadata: map[string]` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `type: "environment"` The type of object (always '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 ```cli ant beta:environments create \ --api-key my-anthropic-api-key \ --name python-data-analysis ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ``` ## List Environments `$ ant beta:environments list` **get** `/v1/environments` List environments with pagination support. ### Parameters - `--include-archived: optional boolean` Query param: Include archived environments in the response - `--limit: optional number` Query param: Maximum number of environments to return - `--page: optional string` Query param: Opaque cursor from previous response for pagination. Pass the `next_page` value from the previous response. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaEnvironmentListResponse: object { data, next_page }` Response when listing environments. This response model uses opaque cursor-based pagination. Use the `page` query parameter with the value from `next_page` to fetch the next page. - `data: array of BetaEnvironment` List of environments. - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig or BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `beta_cloud_config: object { networking, packages, type }` `cloud` environment configuration. - `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork` Network configuration policy. - `beta_unrestricted_network: object { type }` Unrestricted network access. - `type: "unrestricted"` Network policy type - `beta_limited_network: object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }` Limited network access. - `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. - `type: "limited"` Network policy type - `packages: object { apt, cargo, gem, 4 more }` Package manager configuration. - `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 - `type: optional "packages"` Package configuration type - `"packages"` - `type: "cloud"` Environment type - `beta_self_hosted_config: object { type }` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `created_at: string` RFC 3339 timestamp when environment was created - `description: string` User-provided description for the environment - `metadata: map[string]` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `type: "environment"` The type of object (always '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` 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 ```cli ant beta:environments list \ --api-key my-anthropic-api-key ``` #### Response ```json { "data": [ { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Environment `$ ant beta:environments retrieve` **get** `/v1/environments/{environment_id}` Retrieve a specific environment by ID. ### Parameters - `--environment-id: string` - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_environment: object { id, archived_at, config, 7 more }` Unified Environment resource for both cloud and self-hosted environments. - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig or BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `beta_cloud_config: object { networking, packages, type }` `cloud` environment configuration. - `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork` Network configuration policy. - `beta_unrestricted_network: object { type }` Unrestricted network access. - `type: "unrestricted"` Network policy type - `beta_limited_network: object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }` Limited network access. - `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. - `type: "limited"` Network policy type - `packages: object { apt, cargo, gem, 4 more }` Package manager configuration. - `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 - `type: optional "packages"` Package configuration type - `"packages"` - `type: "cloud"` Environment type - `beta_self_hosted_config: object { type }` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `created_at: string` RFC 3339 timestamp when environment was created - `description: string` User-provided description for the environment - `metadata: map[string]` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `type: "environment"` The type of object (always '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 ```cli ant beta:environments retrieve \ --api-key my-anthropic-api-key \ --environment-id env_011CZkZ9X2dpNyB7HsEFoRfW ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ``` ## Update Environment `$ ant beta:environments update` **post** `/v1/environments/{environment_id}` Update an existing environment's configuration. ### Parameters - `--environment-id: string` Path param - `--config: optional BetaCloudConfigParams or BetaSelfHostedConfigParams` Body param: Updated environment configuration - `--description: optional string` Body param: Updated description of the environment - `--metadata: optional map[string]` Body param: User-provided metadata key-value pairs. Set a value to null or empty string to delete the key. - `--name: optional string` Body param: Updated name for the environment - `--scope: optional "organization" or "account"` Body param: The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_environment: object { id, archived_at, config, 7 more }` Unified Environment resource for both cloud and self-hosted environments. - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig or BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `beta_cloud_config: object { networking, packages, type }` `cloud` environment configuration. - `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork` Network configuration policy. - `beta_unrestricted_network: object { type }` Unrestricted network access. - `type: "unrestricted"` Network policy type - `beta_limited_network: object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }` Limited network access. - `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. - `type: "limited"` Network policy type - `packages: object { apt, cargo, gem, 4 more }` Package manager configuration. - `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 - `type: optional "packages"` Package configuration type - `"packages"` - `type: "cloud"` Environment type - `beta_self_hosted_config: object { type }` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `created_at: string` RFC 3339 timestamp when environment was created - `description: string` User-provided description for the environment - `metadata: map[string]` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `type: "environment"` The type of object (always '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 ```cli ant beta:environments update \ --api-key my-anthropic-api-key \ --environment-id env_011CZkZ9X2dpNyB7HsEFoRfW ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ``` ## Delete Environment `$ ant beta:environments delete` **delete** `/v1/environments/{environment_id}` Delete an environment by ID. Returns a confirmation of the deletion. ### Parameters - `--environment-id: string` - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_environment_delete_response: object { id, type }` Response after deleting an environment. - `id: string` Environment identifier - `type: "environment_deleted"` The type of response ### Example ```cli ant beta:environments delete \ --api-key my-anthropic-api-key \ --environment-id env_011CZkZ9X2dpNyB7HsEFoRfW ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "type": "environment_deleted" } ``` ## Archive Environment `$ ant beta:environments archive` **post** `/v1/environments/{environment_id}/archive` Archive an environment by ID. Archived environments cannot be used to create new sessions. ### Parameters - `--environment-id: string` - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_environment: object { id, archived_at, config, 7 more }` Unified Environment resource for both cloud and self-hosted environments. - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig or BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `beta_cloud_config: object { networking, packages, type }` `cloud` environment configuration. - `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork` Network configuration policy. - `beta_unrestricted_network: object { type }` Unrestricted network access. - `type: "unrestricted"` Network policy type - `beta_limited_network: object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }` Limited network access. - `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. - `type: "limited"` Network policy type - `packages: object { apt, cargo, gem, 4 more }` Package manager configuration. - `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 - `type: optional "packages"` Package configuration type - `"packages"` - `type: "cloud"` Environment type - `beta_self_hosted_config: object { type }` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `created_at: string` RFC 3339 timestamp when environment was created - `description: string` User-provided description for the environment - `metadata: map[string]` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `type: "environment"` The type of object (always '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 ```cli ant beta:environments archive \ --api-key my-anthropic-api-key \ --environment-id env_011CZkZ9X2dpNyB7HsEFoRfW ``` #### Response ```json { "id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "archived_at": null, "config": { "networking": { "allow_mcp_servers": false, "allow_package_managers": true, "allowed_hosts": [ "api.example.com" ], "type": "limited" }, "packages": { "apt": [ "string" ], "cargo": [ "string" ], "gem": [ "string" ], "go": [ "string" ], "npm": [ "string" ], "pip": [ "pandas", "numpy" ], "type": "packages" }, "type": "cloud" }, "created_at": "2026-03-15T10:00:00Z", "description": "Python environment with data-analysis packages.", "metadata": {}, "name": "python-data-analysis", "type": "environment", "updated_at": "2026-03-15T10:00:00Z", "scope": "organization" } ``` ## Domain Types ### Beta Cloud Config - `beta_cloud_config: object { networking, packages, type }` `cloud` environment configuration. - `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork` Network configuration policy. - `beta_unrestricted_network: object { type }` Unrestricted network access. - `type: "unrestricted"` Network policy type - `beta_limited_network: object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }` Limited network access. - `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. - `type: "limited"` Network policy type - `packages: object { apt, cargo, gem, 4 more }` Package manager configuration. - `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 - `type: optional "packages"` Package configuration type - `"packages"` - `type: "cloud"` Environment type ### Beta Cloud Config Params - `beta_cloud_config_params: object { type, networking, packages }` 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` Network configuration policy. Omit on update to preserve the existing value. - `beta_unrestricted_network: object { type }` Unrestricted network access. - `type: "unrestricted"` Network policy type - `beta_limited_network_params: object { type, allow_mcp_servers, allow_package_managers, allowed_hosts }` 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` 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` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `allowed_hosts: optional array of string` Specifies domains the container can reach. - `packages: optional object { apt, cargo, gem, 4 more }` Specify packages (and optionally their versions) available in this environment. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. - `apt: optional array of string` Ubuntu/Debian packages to install - `cargo: optional array of string` Rust packages to install - `gem: optional array of string` Ruby packages to install - `go: optional array of string` Go packages to install - `npm: optional array of string` Node.js packages to install - `pip: optional array of string` Python packages to install - `type: optional "packages"` Package configuration type - `"packages"` ### Beta Environment - `beta_environment: object { id, archived_at, config, 7 more }` Unified Environment resource for both cloud and self-hosted environments. - `id: string` Environment identifier (e.g., 'env_...') - `archived_at: string` RFC 3339 timestamp when environment was archived, or null if not archived - `config: BetaCloudConfig or BetaSelfHostedConfig` Environment configuration (either Anthropic Cloud or self-hosted) - `beta_cloud_config: object { networking, packages, type }` `cloud` environment configuration. - `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork` Network configuration policy. - `beta_unrestricted_network: object { type }` Unrestricted network access. - `type: "unrestricted"` Network policy type - `beta_limited_network: object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }` Limited network access. - `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. - `type: "limited"` Network policy type - `packages: object { apt, cargo, gem, 4 more }` Package manager configuration. - `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 - `type: optional "packages"` Package configuration type - `"packages"` - `type: "cloud"` Environment type - `beta_self_hosted_config: object { type }` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type - `created_at: string` RFC 3339 timestamp when environment was created - `description: string` User-provided description for the environment - `metadata: map[string]` User-provided metadata key-value pairs - `name: string` Human-readable name for the environment - `type: "environment"` The type of object (always '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"` ### Beta Environment Delete Response - `beta_environment_delete_response: object { id, type }` Response after deleting an environment. - `id: string` Environment identifier - `type: "environment_deleted"` The type of response ### Beta Limited Network - `beta_limited_network: object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }` Limited network access. - `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. - `type: "limited"` Network policy type ### Beta Limited Network Params - `beta_limited_network_params: object { type, allow_mcp_servers, allow_package_managers, allowed_hosts }` 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` 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` Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. - `allowed_hosts: optional array of string` Specifies domains the container can reach. ### Beta Packages - `beta_packages: object { apt, cargo, gem, 4 more }` Packages (and their versions) available in this environment. - `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 - `type: optional "packages"` Package configuration type - `"packages"` ### Beta Packages Params - `beta_packages_params: object { apt, cargo, gem, 4 more }` Specify packages (and optionally their versions) available in this environment. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. - `apt: optional array of string` Ubuntu/Debian packages to install - `cargo: optional array of string` Rust packages to install - `gem: optional array of string` Ruby packages to install - `go: optional array of string` Go packages to install - `npm: optional array of string` Node.js packages to install - `pip: optional array of string` Python packages to install - `type: optional "packages"` Package configuration type - `"packages"` ### Beta Self Hosted Config - `beta_self_hosted_config: object { type }` Configuration for self-hosted environments. - `type: "self_hosted"` Environment type ### Beta Self Hosted Config Params - `beta_self_hosted_config_params: object { type }` Request params for `self_hosted` environment configuration. - `type: "self_hosted"` Environment type ### Beta Unrestricted Network - `beta_unrestricted_network: object { type }` Unrestricted network access. - `type: "unrestricted"` Network policy type # Work ## Get Work Item `$ ant beta:environments:work retrieve` **get** `/v1/environments/{environment_id}/work/{work_id}` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Retrieve detailed information about a specific work item. ### Parameters - `--environment-id: string` Path param - `--work-id: string` Path param - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_self_hosted_work: object { id, acknowledged_at, created_at, 9 more }` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string` 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: object { id, type }` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string` RFC 3339 timestamp of the most recent heartbeat - `metadata: map[string]` User-provided metadata key-value pairs associated with this work item - `started_at: string` 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` RFC 3339 timestamp when stop was requested - `stopped_at: string` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') ### Example ```cli ant beta:environments:work retrieve \ --api-key my-anthropic-api-key \ --environment-id env_011CZkZ9X2dpNyB7HsEFoRfW \ --work-id work_id ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## Poll for Work `$ ant beta:environments:work poll` **get** `/v1/environments/{environment_id}/work/poll` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Long poll for work items in the queue. ### Parameters - `--environment-id: string` Path param - `--block-ms: optional number` Query param: How long to wait for work to arrive before returning. Must be 1-999 in milliseconds. Defaults to non-blocking (returns immediately if no work is available). - `--reclaim-older-than-ms: optional number` Query param: Reclaim unacknowledged work items older than this many milliseconds. If omitted, uses the default (5000ms). - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. - `--anthropic-worker-id: optional string` Header param: Unique identifier for the specific worker polling, used to track aggregated environment-level work metrics in Console ### Returns - `beta_self_hosted_work: object { id, acknowledged_at, created_at, 9 more }` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string` 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: object { id, type }` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string` RFC 3339 timestamp of the most recent heartbeat - `metadata: map[string]` User-provided metadata key-value pairs associated with this work item - `started_at: string` 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` RFC 3339 timestamp when stop was requested - `stopped_at: string` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') ### Example ```cli ant beta:environments:work poll \ --api-key my-anthropic-api-key \ --environment-id env_011CZkZ9X2dpNyB7HsEFoRfW ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## Acknowledge Work `$ ant beta:environments:work ack` **post** `/v1/environments/{environment_id}/work/{work_id}/ack` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Acknowledge receipt of a work item, transitioning it from 'queued' to 'starting' and removing it from the queue. ### Parameters - `--environment-id: string` Path param - `--work-id: string` Path param - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_self_hosted_work: object { id, acknowledged_at, created_at, 9 more }` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string` 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: object { id, type }` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string` RFC 3339 timestamp of the most recent heartbeat - `metadata: map[string]` User-provided metadata key-value pairs associated with this work item - `started_at: string` 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` RFC 3339 timestamp when stop was requested - `stopped_at: string` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') ### Example ```cli ant beta:environments:work ack \ --api-key my-anthropic-api-key \ --environment-id env_011CZkZ9X2dpNyB7HsEFoRfW \ --work-id work_id ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## Record Heartbeat `$ ant beta:environments:work 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. ### Parameters - `--environment-id: string` Path param - `--work-id: string` Path param - `--desired-ttl-seconds: optional number` Query param: Desired TTL in seconds - `--expected-last-heartbeat: optional string` Query param: Expected last_heartbeat for conditional update (optimistic concurrency). Use literal 'NO_HEARTBEAT' to claim an unclaimed lease (first heartbeat). For subsequent heartbeats, echo the server's previous last_heartbeat value exactly. Returns 412 Precondition Failed if the actual value doesn't match. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_self_hosted_work_heartbeat_response: object { last_heartbeat, lease_extended, state, 2 more }` Response after recording a heartbeat for a work item. - `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 - `type: "work_heartbeat"` The type of response ### Example ```cli ant beta:environments:work heartbeat \ --api-key my-anthropic-api-key \ --environment-id env_011CZkZ9X2dpNyB7HsEFoRfW \ --work-id work_id ``` #### Response ```json { "last_heartbeat": "last_heartbeat", "lease_extended": true, "state": "queued", "ttl_seconds": 0, "type": "work_heartbeat" } ``` ## Stop Work `$ ant beta:environments:work stop` **post** `/v1/environments/{environment_id}/work/{work_id}/stop` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Stop a work item, initiating graceful or forced shutdown. ### Parameters - `--environment-id: string` Path param - `--work-id: string` Path param - `--force: optional boolean` Body param: If true, immediately stop work without graceful shutdown - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_self_hosted_work: object { id, acknowledged_at, created_at, 9 more }` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string` 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: object { id, type }` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string` RFC 3339 timestamp of the most recent heartbeat - `metadata: map[string]` User-provided metadata key-value pairs associated with this work item - `started_at: string` 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` RFC 3339 timestamp when stop was requested - `stopped_at: string` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') ### Example ```cli ant beta:environments:work stop \ --api-key my-anthropic-api-key \ --environment-id env_011CZkZ9X2dpNyB7HsEFoRfW \ --work-id work_id ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## List Work Items `$ ant beta:environments:work list` **get** `/v1/environments/{environment_id}/work` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. List work items in an environment. ### Parameters - `--environment-id: string` Path param - `--limit: optional number` Query param: Maximum number of work items to return - `--page: optional string` Query param: Opaque cursor from previous response for pagination - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_self_hosted_work_list_response: object { data, next_page }` Response when listing work items with cursor-based pagination. - `data: array of BetaSelfHostedWork` List of work items - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string` 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: object { id, type }` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string` RFC 3339 timestamp of the most recent heartbeat - `metadata: map[string]` User-provided metadata key-value pairs associated with this work item - `started_at: string` 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` RFC 3339 timestamp when stop was requested - `stopped_at: string` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') - `next_page: string` Opaque cursor for fetching the next page of results ### Example ```cli ant beta:environments:work list \ --api-key my-anthropic-api-key \ --environment-id env_011CZkZ9X2dpNyB7HsEFoRfW ``` #### Response ```json { "data": [ { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ], "next_page": "next_page" } ``` ## Update Work Item `$ ant beta:environments:work update` **post** `/v1/environments/{environment_id}/work/{work_id}` Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly. Update work item metadata with merge semantics. ### Parameters - `--environment-id: string` Path param - `--work-id: string` Path param - `--metadata: map[string]` Body param: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve existing metadata. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_self_hosted_work: object { id, acknowledged_at, created_at, 9 more }` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string` 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: object { id, type }` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string` RFC 3339 timestamp of the most recent heartbeat - `metadata: map[string]` User-provided metadata key-value pairs associated with this work item - `started_at: string` 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` RFC 3339 timestamp when stop was requested - `stopped_at: string` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') ### Example ```cli ant beta:environments:work update \ --api-key my-anthropic-api-key \ --environment-id env_011CZkZ9X2dpNyB7HsEFoRfW \ --work-id work_id \ --metadata '{foo: string}' ``` #### Response ```json { "id": "id", "acknowledged_at": "acknowledged_at", "created_at": "created_at", "data": { "id": "id", "type": "session" }, "environment_id": "environment_id", "latest_heartbeat_at": "latest_heartbeat_at", "metadata": { "foo": "string" }, "started_at": "started_at", "state": "queued", "stop_requested_at": "stop_requested_at", "stopped_at": "stopped_at", "type": "work" } ``` ## Get Queue Statistics `$ ant beta:environments:work stats` **get** `/v1/environments/{environment_id}/work/stats` Get statistics about the work queue for an environment. ### Parameters - `--environment-id: string` - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_self_hosted_work_queue_stats: object { depth, oldest_queued_at, pending, 2 more }` Statistics about the work queue for an environment. Uses Redis Stream consumer group metrics for O(1) queries. - `depth: number` Number of work items waiting to be picked up (lag from consumer group) - `oldest_queued_at: string` 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) - `type: "work_queue_stats"` The type of object - `workers_polling: number` Number of workers that have polled for work in the last 30 seconds. Requires worker_id to be sent with poll requests. ### Example ```cli ant beta:environments:work stats \ --api-key my-anthropic-api-key \ --environment-id env_011CZkZ9X2dpNyB7HsEFoRfW ``` #### Response ```json { "depth": 0, "oldest_queued_at": "oldest_queued_at", "pending": 0, "type": "work_queue_stats", "workers_polling": 0 } ``` ## Domain Types ### Beta Self Hosted Work - `beta_self_hosted_work: object { id, acknowledged_at, created_at, 9 more }` Work resource representing a unit of work in a self-hosted environment. Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string` 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: object { id, type }` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string` RFC 3339 timestamp of the most recent heartbeat - `metadata: map[string]` User-provided metadata key-value pairs associated with this work item - `started_at: string` 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` RFC 3339 timestamp when stop was requested - `stopped_at: string` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') ### Beta Self Hosted Work Heartbeat Response - `beta_self_hosted_work_heartbeat_response: object { last_heartbeat, lease_extended, state, 2 more }` Response after recording a heartbeat for a work item. - `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 - `type: "work_heartbeat"` The type of response ### Beta Self Hosted Work List Response - `beta_self_hosted_work_list_response: object { data, next_page }` Response when listing work items with cursor-based pagination. - `data: array of BetaSelfHostedWork` List of work items - `id: string` Work identifier (e.g., 'work_...') - `acknowledged_at: string` 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: object { id, type }` The actual work to be performed - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data - `environment_id: string` Environment identifier this work belongs to (e.g., `env_...`) - `latest_heartbeat_at: string` RFC 3339 timestamp of the most recent heartbeat - `metadata: map[string]` User-provided metadata key-value pairs associated with this work item - `started_at: string` 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` RFC 3339 timestamp when stop was requested - `stopped_at: string` RFC 3339 timestamp when work execution stopped - `type: "work"` The type of object (always 'work') - `next_page: string` Opaque cursor for fetching the next page of results ### Beta Self Hosted Work Queue Stats - `beta_self_hosted_work_queue_stats: object { depth, oldest_queued_at, pending, 2 more }` Statistics about the work queue for an environment. Uses Redis Stream consumer group metrics for O(1) queries. - `depth: number` Number of work items waiting to be picked up (lag from consumer group) - `oldest_queued_at: string` 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) - `type: "work_queue_stats"` The type of object - `workers_polling: number` Number of workers that have polled for work in the last 30 seconds. Requires worker_id to be sent with poll requests. ### Beta Self Hosted Work Stop Request - `beta_self_hosted_work_stop_request: object { force }` Request to stop a work item. - `force: optional boolean` If true, immediately stop work without graceful shutdown ### Beta Self Hosted Work Update Request - `beta_self_hosted_work_update_request: object { metadata }` Request to update work item metadata. - `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. ### Beta Session Work Data - `beta_session_work_data: object { id, type }` Work data for session work items. This resource type is used when work represents a session that needs to be executed in a self-hosted environment. - `id: string` Session identifier (e.g., 'session_...') - `type: "session"` Type of work data # Sessions ## Create Session `$ ant beta:sessions create` **post** `/v1/sessions` Create Session ### Parameters - `--agent: string or BetaManagedAgentsAgentParams` Body param: Agent identifier. Accepts the `agent` ID string, which pins the latest version for the session, or an `agent` object with both id and version specified. - `--environment-id: string` Body param: ID of the `environment` defining the container configuration for this session. - `--metadata: optional map[string]` Body param: Arbitrary key-value metadata attached to the session. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `--resource: optional array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam` Body param: Resources (e.g. repositories, files) to mount into the session's container. - `--title: optional string` Body param: Human-readable session title. - `--vault-id: optional array of string` Body param: Vault IDs for stored credentials the agent can use during the session. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_session: object { id, agent, archived_at, 12 more }` A Managed Agents `session`. - `id: string` - `agent: object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `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. - `completed_at: string` A timestamp in RFC 3339 format - `description: string` What the agent should produce. - `explanation: string` Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - `iteration: number` 0-indexed revision cycle the outcome is currently on. - `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. - `type: "outcome_evaluation"` - `"outcome_evaluation"` - `resources: array of BetaManagedAgentsSessionResource` - `beta_managed_agents_github_repository_resource: object { id, created_at, mount_path, 4 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `mount_path: string` - `type: "github_repository"` - `"github_repository"` - `updated_at: string` A timestamp in RFC 3339 format - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout` - `beta_managed_agents_branch_checkout: object { name, type }` - `name: string` Branch name to check out. - `type: "branch"` - `"branch"` - `beta_managed_agents_commit_checkout: object { sha, type }` - `sha: string` Full commit SHA to check out. - `type: "commit"` - `"commit"` - `beta_managed_agents_file_resource: object { id, created_at, file_id, 3 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `file_id: string` - `mount_path: string` - `type: "file"` - `"file"` - `updated_at: string` A timestamp in RFC 3339 format - `beta_managed_agents_memory_store_resource: object { memory_store_id, type, access, 4 more }` A memory store attached to an agent session. - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `type: "memory_store"` - `"memory_store"` - `access: optional "read_write" or "read_only"` Access mode for an attached memory store. - `"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` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `mount_path: optional string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `name: optional string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - `stats: object { active_seconds, duration_seconds }` Timing statistics for a session. - `active_seconds: optional number` Cumulative time in seconds the session spent in running status. Excludes idle time. - `duration_seconds: optional number` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. - `status: "rescheduling" or "running" or "idle" or "terminated"` SessionStatus enum - `"rescheduling"` - `"running"` - `"idle"` - `"terminated"` - `title: string` - `type: "session"` - `"session"` - `updated_at: string` A timestamp in RFC 3339 format - `usage: object { cache_creation, cache_read_input_tokens, input_tokens, output_tokens }` Cumulative token usage for a session across all turns. - `cache_creation: optional object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Prompt-cache creation token usage broken down by cache lifetime. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. - `input_tokens: optional number` Total input tokens consumed across all turns. - `output_tokens: optional number` Total output tokens generated across all turns. - `vault_ids: array of string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. ### Example ```cli ant beta:sessions create \ --api-key my-anthropic-api-key \ --agent agent_011CZkYpogX7uDKUyvBTophP \ --environment-id env_011CZkZ9X2dpNyB7HsEFoRfW ``` #### Response ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ] } ``` ## List Sessions `$ ant beta:sessions list` **get** `/v1/sessions` List Sessions ### Parameters - `--agent-id: optional string` Query param: Filter sessions created with this agent ID. - `--agent-version: optional number` Query param: Filter by agent version. Only applies when agent_id is also set. - `--created-at-gt: optional string` Query param: Return sessions created after this time (exclusive). - `--created-at-gte: optional string` Query param: Return sessions created at or after this time (inclusive). - `--created-at-lt: optional string` Query param: Return sessions created before this time (exclusive). - `--created-at-lte: optional string` Query param: Return sessions created at or before this time (inclusive). - `--include-archived: optional boolean` Query param: When true, includes archived sessions. Default: false (exclude archived). - `--limit: optional number` Query param: Maximum number of results to return. - `--memory-store-id: optional string` Query param: Filter sessions whose resources contain a memory_store with this memory store ID. - `--order: optional "asc" or "desc"` Query param: Sort direction for results, ordered by created_at. Defaults to desc (newest first). - `--page: optional string` Query param: Opaque pagination cursor from a previous response's next_page. - `--status: optional array of "rescheduling" or "running" or "idle" or "terminated"` Query param: Filter by session status. Repeat the parameter to match any of multiple statuses. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaManagedAgentsListSessions: object { data, next_page }` Paginated list of sessions. - `data: optional array of BetaManagedAgentsSession` List of sessions. - `id: string` - `agent: object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `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. - `completed_at: string` A timestamp in RFC 3339 format - `description: string` What the agent should produce. - `explanation: string` Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - `iteration: number` 0-indexed revision cycle the outcome is currently on. - `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. - `type: "outcome_evaluation"` - `"outcome_evaluation"` - `resources: array of BetaManagedAgentsSessionResource` - `beta_managed_agents_github_repository_resource: object { id, created_at, mount_path, 4 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `mount_path: string` - `type: "github_repository"` - `"github_repository"` - `updated_at: string` A timestamp in RFC 3339 format - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout` - `beta_managed_agents_branch_checkout: object { name, type }` - `name: string` Branch name to check out. - `type: "branch"` - `"branch"` - `beta_managed_agents_commit_checkout: object { sha, type }` - `sha: string` Full commit SHA to check out. - `type: "commit"` - `"commit"` - `beta_managed_agents_file_resource: object { id, created_at, file_id, 3 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `file_id: string` - `mount_path: string` - `type: "file"` - `"file"` - `updated_at: string` A timestamp in RFC 3339 format - `beta_managed_agents_memory_store_resource: object { memory_store_id, type, access, 4 more }` A memory store attached to an agent session. - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `type: "memory_store"` - `"memory_store"` - `access: optional "read_write" or "read_only"` Access mode for an attached memory store. - `"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` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `mount_path: optional string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `name: optional string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - `stats: object { active_seconds, duration_seconds }` Timing statistics for a session. - `active_seconds: optional number` Cumulative time in seconds the session spent in running status. Excludes idle time. - `duration_seconds: optional number` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. - `status: "rescheduling" or "running" or "idle" or "terminated"` SessionStatus enum - `"rescheduling"` - `"running"` - `"idle"` - `"terminated"` - `title: string` - `type: "session"` - `"session"` - `updated_at: string` A timestamp in RFC 3339 format - `usage: object { cache_creation, cache_read_input_tokens, input_tokens, output_tokens }` Cumulative token usage for a session across all turns. - `cache_creation: optional object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Prompt-cache creation token usage broken down by cache lifetime. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. - `input_tokens: optional number` Total input tokens consumed across all turns. - `output_tokens: optional number` Total output tokens generated across all turns. - `vault_ids: array of string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. - `next_page: optional string` Opaque cursor for the next page. Null when no more results. ### Example ```cli ant beta:sessions list \ --api-key my-anthropic-api-key ``` #### Response ```json { "data": [ { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ] } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Session `$ ant beta:sessions retrieve` **get** `/v1/sessions/{session_id}` Get Session ### Parameters - `--session-id: string` Path parameter session_id - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_session: object { id, agent, archived_at, 12 more }` A Managed Agents `session`. - `id: string` - `agent: object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `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. - `completed_at: string` A timestamp in RFC 3339 format - `description: string` What the agent should produce. - `explanation: string` Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - `iteration: number` 0-indexed revision cycle the outcome is currently on. - `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. - `type: "outcome_evaluation"` - `"outcome_evaluation"` - `resources: array of BetaManagedAgentsSessionResource` - `beta_managed_agents_github_repository_resource: object { id, created_at, mount_path, 4 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `mount_path: string` - `type: "github_repository"` - `"github_repository"` - `updated_at: string` A timestamp in RFC 3339 format - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout` - `beta_managed_agents_branch_checkout: object { name, type }` - `name: string` Branch name to check out. - `type: "branch"` - `"branch"` - `beta_managed_agents_commit_checkout: object { sha, type }` - `sha: string` Full commit SHA to check out. - `type: "commit"` - `"commit"` - `beta_managed_agents_file_resource: object { id, created_at, file_id, 3 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `file_id: string` - `mount_path: string` - `type: "file"` - `"file"` - `updated_at: string` A timestamp in RFC 3339 format - `beta_managed_agents_memory_store_resource: object { memory_store_id, type, access, 4 more }` A memory store attached to an agent session. - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `type: "memory_store"` - `"memory_store"` - `access: optional "read_write" or "read_only"` Access mode for an attached memory store. - `"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` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `mount_path: optional string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `name: optional string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - `stats: object { active_seconds, duration_seconds }` Timing statistics for a session. - `active_seconds: optional number` Cumulative time in seconds the session spent in running status. Excludes idle time. - `duration_seconds: optional number` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. - `status: "rescheduling" or "running" or "idle" or "terminated"` SessionStatus enum - `"rescheduling"` - `"running"` - `"idle"` - `"terminated"` - `title: string` - `type: "session"` - `"session"` - `updated_at: string` A timestamp in RFC 3339 format - `usage: object { cache_creation, cache_read_input_tokens, input_tokens, output_tokens }` Cumulative token usage for a session across all turns. - `cache_creation: optional object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Prompt-cache creation token usage broken down by cache lifetime. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. - `input_tokens: optional number` Total input tokens consumed across all turns. - `output_tokens: optional number` Total output tokens generated across all turns. - `vault_ids: array of string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. ### Example ```cli ant beta:sessions retrieve \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 ``` #### Response ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ] } ``` ## Update Session `$ ant beta:sessions update` **post** `/v1/sessions/{session_id}` Update Session ### Parameters - `--session-id: string` Path param: Path parameter session_id - `--agent: optional object { mcp_servers, tools }` Body param: Mid-session agent configuration update. Only `tools` and `mcp_servers` are updatable. Full replacement: the provided array becomes the new value. To preserve existing entries, GET the session, modify the array, and POST it back. - `--metadata: optional map[string]` Body param: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. - `--title: optional string` Body param: Human-readable session title. - `--vault-id: optional array of string` Body param: Vault IDs (`vlt_*`) to attach to the session. Not yet supported; requests setting this field are rejected. Reserved for future use. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_session: object { id, agent, archived_at, 12 more }` A Managed Agents `session`. - `id: string` - `agent: object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `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. - `completed_at: string` A timestamp in RFC 3339 format - `description: string` What the agent should produce. - `explanation: string` Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - `iteration: number` 0-indexed revision cycle the outcome is currently on. - `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. - `type: "outcome_evaluation"` - `"outcome_evaluation"` - `resources: array of BetaManagedAgentsSessionResource` - `beta_managed_agents_github_repository_resource: object { id, created_at, mount_path, 4 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `mount_path: string` - `type: "github_repository"` - `"github_repository"` - `updated_at: string` A timestamp in RFC 3339 format - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout` - `beta_managed_agents_branch_checkout: object { name, type }` - `name: string` Branch name to check out. - `type: "branch"` - `"branch"` - `beta_managed_agents_commit_checkout: object { sha, type }` - `sha: string` Full commit SHA to check out. - `type: "commit"` - `"commit"` - `beta_managed_agents_file_resource: object { id, created_at, file_id, 3 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `file_id: string` - `mount_path: string` - `type: "file"` - `"file"` - `updated_at: string` A timestamp in RFC 3339 format - `beta_managed_agents_memory_store_resource: object { memory_store_id, type, access, 4 more }` A memory store attached to an agent session. - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `type: "memory_store"` - `"memory_store"` - `access: optional "read_write" or "read_only"` Access mode for an attached memory store. - `"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` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `mount_path: optional string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `name: optional string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - `stats: object { active_seconds, duration_seconds }` Timing statistics for a session. - `active_seconds: optional number` Cumulative time in seconds the session spent in running status. Excludes idle time. - `duration_seconds: optional number` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. - `status: "rescheduling" or "running" or "idle" or "terminated"` SessionStatus enum - `"rescheduling"` - `"running"` - `"idle"` - `"terminated"` - `title: string` - `type: "session"` - `"session"` - `updated_at: string` A timestamp in RFC 3339 format - `usage: object { cache_creation, cache_read_input_tokens, input_tokens, output_tokens }` Cumulative token usage for a session across all turns. - `cache_creation: optional object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Prompt-cache creation token usage broken down by cache lifetime. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. - `input_tokens: optional number` Total input tokens consumed across all turns. - `output_tokens: optional number` Total output tokens generated across all turns. - `vault_ids: array of string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. ### Example ```cli ant beta:sessions update \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 ``` #### Response ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ] } ``` ## Delete Session `$ ant beta:sessions delete` **delete** `/v1/sessions/{session_id}` Delete Session ### Parameters - `--session-id: string` Path parameter session_id - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_deleted_session: object { id, type }` Confirmation that a `session` has been permanently deleted. - `id: string` - `type: "session_deleted"` - `"session_deleted"` ### Example ```cli ant beta:sessions delete \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 ``` #### Response ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "type": "session_deleted" } ``` ## Archive Session `$ ant beta:sessions archive` **post** `/v1/sessions/{session_id}/archive` Archive Session ### Parameters - `--session-id: string` Path parameter session_id - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_session: object { id, agent, archived_at, 12 more }` A Managed Agents `session`. - `id: string` - `agent: object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `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. - `completed_at: string` A timestamp in RFC 3339 format - `description: string` What the agent should produce. - `explanation: string` Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - `iteration: number` 0-indexed revision cycle the outcome is currently on. - `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. - `type: "outcome_evaluation"` - `"outcome_evaluation"` - `resources: array of BetaManagedAgentsSessionResource` - `beta_managed_agents_github_repository_resource: object { id, created_at, mount_path, 4 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `mount_path: string` - `type: "github_repository"` - `"github_repository"` - `updated_at: string` A timestamp in RFC 3339 format - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout` - `beta_managed_agents_branch_checkout: object { name, type }` - `name: string` Branch name to check out. - `type: "branch"` - `"branch"` - `beta_managed_agents_commit_checkout: object { sha, type }` - `sha: string` Full commit SHA to check out. - `type: "commit"` - `"commit"` - `beta_managed_agents_file_resource: object { id, created_at, file_id, 3 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `file_id: string` - `mount_path: string` - `type: "file"` - `"file"` - `updated_at: string` A timestamp in RFC 3339 format - `beta_managed_agents_memory_store_resource: object { memory_store_id, type, access, 4 more }` A memory store attached to an agent session. - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `type: "memory_store"` - `"memory_store"` - `access: optional "read_write" or "read_only"` Access mode for an attached memory store. - `"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` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `mount_path: optional string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `name: optional string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - `stats: object { active_seconds, duration_seconds }` Timing statistics for a session. - `active_seconds: optional number` Cumulative time in seconds the session spent in running status. Excludes idle time. - `duration_seconds: optional number` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. - `status: "rescheduling" or "running" or "idle" or "terminated"` SessionStatus enum - `"rescheduling"` - `"running"` - `"idle"` - `"terminated"` - `title: string` - `type: "session"` - `"session"` - `updated_at: string` A timestamp in RFC 3339 format - `usage: object { cache_creation, cache_read_input_tokens, input_tokens, output_tokens }` Cumulative token usage for a session across all turns. - `cache_creation: optional object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Prompt-cache creation token usage broken down by cache lifetime. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. - `input_tokens: optional number` Total input tokens consumed across all turns. - `output_tokens: optional number` Total output tokens generated across all turns. - `vault_ids: array of string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. ### Example ```cli ant beta:sessions archive \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 ``` #### Response ```json { "id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "agent": { "id": "agent_011CZkYpogX7uDKUyvBTophP", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "multiagent": { "agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 } ], "type": "coordinator" }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW", "metadata": {}, "outcome_evaluations": [ { "completed_at": "2026-03-15T10:02:31Z", "description": "Produce a 2-page summary as summary.md", "explanation": "All five sections present with inline citations.", "iteration": 0, "outcome_id": "outc_011CZkZRSw2kEfs6ncTVljxP", "result": "satisfied", "type": "outcome_evaluation" } ], "resources": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "stats": { "active_seconds": 0, "duration_seconds": 0 }, "status": "idle", "title": "Order #1234 inquiry", "type": "session", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 }, "vault_ids": [ "vlt_011CZkZDLs7fYzm1hXNPeRjv" ] } ``` ## Domain Types ### Beta Managed Agents Agent Params - `beta_managed_agents_agent_params: object { id, type, version }` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `id: string` The `agent` ID. - `type: "agent"` - `"agent"` - `version: optional number` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. ### Beta Managed Agents Branch Checkout - `beta_managed_agents_branch_checkout: object { name, type }` - `name: string` Branch name to check out. - `type: "branch"` - `"branch"` ### Beta Managed Agents Cache Creation Usage - `beta_managed_agents_cache_creation_usage: object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Prompt-cache creation token usage broken down by cache lifetime. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. ### Beta Managed Agents Commit Checkout - `beta_managed_agents_commit_checkout: object { sha, type }` - `sha: string` Full commit SHA to check out. - `type: "commit"` - `"commit"` ### Beta Managed Agents Deleted Session - `beta_managed_agents_deleted_session: object { id, type }` Confirmation that a `session` has been permanently deleted. - `id: string` - `type: "session_deleted"` - `"session_deleted"` ### Beta Managed Agents File Resource Params - `beta_managed_agents_file_resource_params: object { file_id, type, mount_path }` Mount a file uploaded via the Files API into the session. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `mount_path: optional string` Mount path in the container. Defaults to `/mnt/session/uploads/`. ### Beta Managed Agents GitHub Repository Resource Params - `beta_managed_agents_github_repository_resource_params: object { authorization_token, type, url, 2 more }` Mount a GitHub repository into the session's container. - `authorization_token: string` GitHub authorization token used to clone the repository. - `type: "github_repository"` - `"github_repository"` - `url: string` Github URL of the repository - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout` Branch or commit to check out. Defaults to the repository's default branch. - `beta_managed_agents_branch_checkout: object { name, type }` - `name: string` Branch name to check out. - `type: "branch"` - `"branch"` - `beta_managed_agents_commit_checkout: object { sha, type }` - `sha: string` Full commit SHA to check out. - `type: "commit"` - `"commit"` - `mount_path: optional string` Mount path in the container. Defaults to `/workspace/`. ### Beta Managed Agents Memory Store Resource Param - `beta_managed_agents_memory_store_resource_param: object { memory_store_id, type, access, instructions }` Parameters for attaching a memory store to an agent session. - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `type: "memory_store"` - `"memory_store"` - `access: optional "read_write" or "read_only"` Access mode for an attached memory store. - `"read_write"` - `"read_only"` - `instructions: optional string` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. ### Beta Managed Agents Multiagent - `beta_managed_agents_multiagent: object { agents, type }` Resolved coordinator topology with a concrete agent roster. - `agents: array of BetaManagedAgentsAgentReference` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `id: string` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` ### Beta Managed Agents Multiagent Params - `beta_managed_agents_multiagent_params: object { agents, type }` A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the `agents` roster. - `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). - `union_member_0: string` - `beta_managed_agents_agent_params: object { id, type, version }` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `id: string` The `agent` ID. - `type: "agent"` - `"agent"` - `version: optional number` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. - `beta_managed_agents_multiagent_self_params: object { type }` Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. - `type: "self"` - `"self"` - `type: "coordinator"` - `"coordinator"` ### Beta Managed Agents Multiagent Roster Entry Params - `beta_managed_agents_multiagent_roster_entry_params: string or BetaManagedAgentsAgentParams or BetaManagedAgentsMultiagentSelfParams` An entry in a multiagent roster: an agent ID string, a versioned agent reference, or `self`. - `union_member_0: string` - `beta_managed_agents_agent_params: object { id, type, version }` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version - `id: string` The `agent` ID. - `type: "agent"` - `"agent"` - `version: optional number` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. - `beta_managed_agents_multiagent_self_params: object { type }` Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. - `type: "self"` - `"self"` ### Beta Managed Agents Outcome Evaluation Resource - `beta_managed_agents_outcome_evaluation_resource: object { completed_at, description, explanation, 4 more }` Evaluation state for a single outcome defined via a define_outcome event. - `completed_at: string` A timestamp in RFC 3339 format - `description: string` What the agent should produce. - `explanation: string` Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - `iteration: number` 0-indexed revision cycle the outcome is currently on. - `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. - `type: "outcome_evaluation"` - `"outcome_evaluation"` ### Beta Managed Agents Session - `beta_managed_agents_session: object { id, agent, archived_at, 12 more }` A Managed Agents `session`. - `id: string` - `agent: object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `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. - `completed_at: string` A timestamp in RFC 3339 format - `description: string` What the agent should produce. - `explanation: string` Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - `iteration: number` 0-indexed revision cycle the outcome is currently on. - `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. - `type: "outcome_evaluation"` - `"outcome_evaluation"` - `resources: array of BetaManagedAgentsSessionResource` - `beta_managed_agents_github_repository_resource: object { id, created_at, mount_path, 4 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `mount_path: string` - `type: "github_repository"` - `"github_repository"` - `updated_at: string` A timestamp in RFC 3339 format - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout` - `beta_managed_agents_branch_checkout: object { name, type }` - `name: string` Branch name to check out. - `type: "branch"` - `"branch"` - `beta_managed_agents_commit_checkout: object { sha, type }` - `sha: string` Full commit SHA to check out. - `type: "commit"` - `"commit"` - `beta_managed_agents_file_resource: object { id, created_at, file_id, 3 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `file_id: string` - `mount_path: string` - `type: "file"` - `"file"` - `updated_at: string` A timestamp in RFC 3339 format - `beta_managed_agents_memory_store_resource: object { memory_store_id, type, access, 4 more }` A memory store attached to an agent session. - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `type: "memory_store"` - `"memory_store"` - `access: optional "read_write" or "read_only"` Access mode for an attached memory store. - `"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` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `mount_path: optional string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `name: optional string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - `stats: object { active_seconds, duration_seconds }` Timing statistics for a session. - `active_seconds: optional number` Cumulative time in seconds the session spent in running status. Excludes idle time. - `duration_seconds: optional number` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. - `status: "rescheduling" or "running" or "idle" or "terminated"` SessionStatus enum - `"rescheduling"` - `"running"` - `"idle"` - `"terminated"` - `title: string` - `type: "session"` - `"session"` - `updated_at: string` A timestamp in RFC 3339 format - `usage: object { cache_creation, cache_read_input_tokens, input_tokens, output_tokens }` Cumulative token usage for a session across all turns. - `cache_creation: optional object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Prompt-cache creation token usage broken down by cache lifetime. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. - `input_tokens: optional number` Total input tokens consumed across all turns. - `output_tokens: optional number` Total output tokens generated across all turns. - `vault_ids: array of string` Vault IDs attached to the session at creation. Empty when no vaults were supplied. ### Beta Managed Agents Session Agent - `beta_managed_agents_session_agent: object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` ### Beta Managed Agents Session Agent Update - `beta_managed_agents_session_agent_update: object { mcp_servers, tools }` Mid-session agent configuration update. Only `tools` and `mcp_servers` are updatable. Full replacement: the provided array becomes the new value. To preserve existing entries, GET the session, modify the array, and POST it back. - `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. - `name: string` Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters. - `type: "url"` - `"url"` - `url: string` Endpoint URL for the MCP server. - `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. - `beta_managed_agents_agent_toolset20260401_params: object { type, configs, default_config }` Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `configs: optional array of BetaManagedAgentsAgentToolConfigParams` Per-tool configuration overrides. - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `enabled: optional boolean` Whether this tool is enabled and available to Claude. Overrides the default_config setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: optional object { enabled, permission_policy }` Default configuration for all tools in a toolset. - `enabled: optional boolean` Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `beta_managed_agents_mcp_toolset_params: object { mcp_server_name, type, configs, default_config }` Configuration for tools from an MCP server defined in `mcp_servers`. - `mcp_server_name: string` Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters. - `type: "mcp_toolset"` - `"mcp_toolset"` - `configs: optional array of BetaManagedAgentsMCPToolConfigParams` Per-tool configuration overrides. - `name: string` Name of the MCP tool to configure. 1-128 characters. - `enabled: optional boolean` Whether this tool is enabled. Overrides the `default_config` setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: optional object { enabled, permission_policy }` Default configuration for all tools from an MCP server. - `enabled: optional boolean` Whether tools are enabled by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `beta_managed_agents_custom_tool_params: object { description, input_schema, name, type }` A custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an `agent.custom_tool_use` event is emitted and the session goes idle, waiting for the client to provide the result via a `user.custom_tool_result` event. - `description: string` Description of what the tool does, shown to the agent to help it decide when to use the tool. 1-1024 characters. - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens. - `type: "custom"` - `"custom"` ### Beta Managed Agents Session Multiagent Coordinator - `beta_managed_agents_session_multiagent_coordinator: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` ### Beta Managed Agents Session Stats - `beta_managed_agents_session_stats: object { active_seconds, duration_seconds }` Timing statistics for a session. - `active_seconds: optional number` Cumulative time in seconds the session spent in running status. Excludes idle time. - `duration_seconds: optional number` Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. ### Beta Managed Agents Session Updated Event - `beta_managed_agents_session_updated_event: object { id, processed_at, type, 3 more }` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.updated"` - `"session.updated"` - `agent: optional object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` - `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` The session's new title. Present only when the update changed it. ### Beta Managed Agents Session Usage - `beta_managed_agents_session_usage: object { cache_creation, cache_read_input_tokens, input_tokens, output_tokens }` Cumulative token usage for a session across all turns. - `cache_creation: optional object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Prompt-cache creation token usage broken down by cache lifetime. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. - `input_tokens: optional number` Total input tokens consumed across all turns. - `output_tokens: optional number` Total output tokens generated across all turns. ### Beta Managed Agents User Tool Result Event - `beta_managed_agents_user_tool_result_event: object { id, tool_use_id, type, 4 more }` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `id: string` Unique identifier for this event. - `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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_result"` - `"user.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. # Events ## List Events `$ ant beta:sessions:events list` **get** `/v1/sessions/{session_id}/events` List Events ### Parameters - `--session-id: string` Path param: Path parameter session_id - `--created-at-gt: optional string` Query param: Return events created after this time (exclusive). - `--created-at-gte: optional string` Query param: Return events created at or after this time (inclusive). - `--created-at-lt: optional string` Query param: Return events created before this time (exclusive). - `--created-at-lte: optional string` Query param: Return events created at or before this time (inclusive). - `--limit: optional number` Query param: Query parameter for limit - `--order: optional "asc" or "desc"` Query param: Sort direction for results, ordered by created_at. Defaults to asc (chronological). - `--page: optional string` Query param: Opaque pagination cursor from a previous response's next_page. - `--type: optional array of string` Query param: Filter by event type. Values match the `type` field on returned events (for example, `user.message` or `agent.tool_use`). Omit to return all event types. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaManagedAgentsListSessionEvents: object { data, next_page }` Paginated list of events for a `session`. - `data: optional array of BetaManagedAgentsSessionEvent` Events for the session, ordered by `created_at`. - `beta_managed_agents_user_message_event: object { id, content, type, processed_at }` A user message event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Array of content blocks comprising the user message. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `type: "user.message"` - `"user.message"` - `processed_at: optional string` A timestamp in RFC 3339 format - `beta_managed_agents_user_interrupt_event: object { id, type, processed_at, session_thread_id }` An interrupt event that pauses agent execution and returns control to the user. - `id: string` Unique identifier for this event. - `type: "user.interrupt"` - `"user.interrupt"` - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `beta_managed_agents_user_tool_confirmation_event: object { id, result, tool_use_id, 4 more }` A tool confirmation event that approves or denies a pending tool execution. - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` UserToolConfirmationResult enum - `"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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_confirmation"` - `"user.tool_confirmation"` - `deny_message: optional string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `beta_managed_agents_user_custom_tool_result_event: object { id, custom_tool_use_id, type, 4 more }` Event sent by the client providing the result of a custom tool execution. - `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, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.custom_tool_result"` - `"user.custom_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `beta_managed_agents_agent_custom_tool_use_event: object { id, input, name, 3 more }` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the custom tool being called. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.custom_tool_use"` - `"agent.custom_tool_use"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - `beta_managed_agents_agent_message_event: object { id, content, processed_at, type }` An agent response event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `text: string` The text content. - `type: "text"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.message"` - `"agent.message"` - `beta_managed_agents_agent_thinking_event: object { id, processed_at, type }` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thinking"` - `"agent.thinking"` - `beta_managed_agents_agent_mcp_tool_use_event: object { id, input, mcp_server_name, 5 more }` Event emitted when the agent invokes a tool provided by an MCP server. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_use"` - `"agent.mcp_tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `beta_managed_agents_agent_mcp_tool_result_event: object { id, mcp_tool_use_id, processed_at, 3 more }` Event representing the result of an MCP tool execution. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_result"` - `"agent.mcp_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_agent_tool_use_event: object { id, input, name, 4 more }` Event emitted when the agent invokes a built-in agent tool. - `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` A timestamp in RFC 3339 format - `type: "agent.tool_use"` - `"agent.tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `beta_managed_agents_agent_tool_result_event: object { id, processed_at, tool_use_id, 3 more }` Event representing the result of an agent tool execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `tool_use_id: string` The id of the `agent.tool_use` event this result corresponds to. - `type: "agent.tool_result"` - `"agent.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_agent_thread_message_received_event: object { id, content, from_session_thread_id, 3 more }` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `from_session_thread_id: string` Public `sthr_` ID of the thread that sent the message. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_message_received"` - `"agent.thread_message_received"` - `from_agent_name: optional string` Name of the callable agent this message came from. Absent when received from the primary agent. - `beta_managed_agents_agent_thread_message_sent_event: object { id, content, processed_at, 3 more }` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `processed_at: string` A timestamp in RFC 3339 format - `to_session_thread_id: string` Public `sthr_` ID of the thread the message was sent to. - `type: "agent.thread_message_sent"` - `"agent.thread_message_sent"` - `to_agent_name: optional string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `beta_managed_agents_agent_thread_context_compacted_event: object { id, processed_at, type }` Indicates that context compaction (summarization) occurred during the session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_context_compacted"` - `"agent.thread_context_compacted"` - `beta_managed_agents_session_error_event: object { id, error, processed_at, type }` An error event indicating a problem occurred during session execution. - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 4 more` 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. - `beta_managed_agents_unknown_error: object { message, retry_status, type }` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "unknown_error"` - `"unknown_error"` - `beta_managed_agents_model_overloaded_error: object { message, retry_status, type }` The model is currently overloaded. Emitted after automatic retries are exhausted. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_overloaded_error"` - `"model_overloaded_error"` - `beta_managed_agents_model_rate_limited_error: object { message, retry_status, type }` The model request was rate-limited. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_rate_limited_error"` - `"model_rate_limited_error"` - `beta_managed_agents_model_request_failed_error: object { message, retry_status, type }` A model request failed for a reason other than overload or rate-limiting. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_request_failed_error"` - `"model_request_failed_error"` - `beta_managed_agents_mcp_connection_failed_error: object { mcp_server_name, message, retry_status, type }` Failed to connect to an MCP server. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_connection_failed_error"` - `"mcp_connection_failed_error"` - `beta_managed_agents_mcp_authentication_failed_error: object { mcp_server_name, message, retry_status, type }` Authentication to an MCP server failed. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_authentication_failed_error"` - `"mcp_authentication_failed_error"` - `beta_managed_agents_billing_error: object { message, retry_status, type }` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "billing_error"` - `"billing_error"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.error"` - `"session.error"` - `beta_managed_agents_session_status_rescheduled_event: object { id, processed_at, type }` Indicates the session is recovering from an error state and is rescheduled for execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_rescheduled"` - `"session.status_rescheduled"` - `beta_managed_agents_session_status_running_event: object { id, processed_at, type }` Indicates the session is actively running and the agent is working. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_running"` - `"session.status_running"` - `beta_managed_agents_session_status_idle_event: object { id, processed_at, stop_reason, type }` Indicates the agent has paused and is awaiting user input. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `type: "end_turn"` - `"end_turn"` - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `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. - `type: "requires_action"` - `"requires_action"` - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "retries_exhausted"` - `"retries_exhausted"` - `type: "session.status_idle"` - `"session.status_idle"` - `beta_managed_agents_session_status_terminated_event: object { id, processed_at, type }` Indicates the session has terminated, either due to an error or completion. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_terminated"` - `"session.status_terminated"` - `beta_managed_agents_session_thread_created_event: object { id, agent_name, processed_at, 2 more }` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the callable agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public `sthr_` ID of the newly created thread. - `type: "session.thread_created"` - `"session.thread_created"` - `beta_managed_agents_span_outcome_evaluation_start_event: object { id, iteration, outcome_id, 2 more }` Emitted when an outcome evaluation cycle begins. - `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. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_start"` - `"span.outcome_evaluation_start"` - `beta_managed_agents_span_outcome_evaluation_end_event: object { id, explanation, iteration, 6 more }` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `id: string` Unique identifier for this event. - `explanation: string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `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` A timestamp in RFC 3339 format - `result: string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `type: "span.outcome_evaluation_end"` - `"span.outcome_evaluation_end"` - `usage: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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"` - `beta_managed_agents_span_model_request_start_event: object { id, processed_at, type }` Emitted when a model request is initiated by the agent. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_start"` - `"span.model_request_start"` - `beta_managed_agents_span_model_request_end_event: object { id, is_error, model_request_start_id, 3 more }` Emitted when a model request completes. - `id: string` Unique identifier for this event. - `is_error: boolean` 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: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_end"` - `"span.model_request_end"` - `beta_managed_agents_span_outcome_evaluation_ongoing_event: object { id, iteration, outcome_id, 2 more }` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_ongoing"` - `"span.outcome_evaluation_ongoing"` - `beta_managed_agents_user_define_outcome_event: object { id, description, max_iterations, 4 more }` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `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` A timestamp in RFC 3339 format - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` Rubric for grading the quality of an outcome. - `beta_managed_agents_file_rubric: object { file_id, type }` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` - `beta_managed_agents_text_rubric: object { content, type }` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `type: "text"` - `"text"` - `type: "user.define_outcome"` - `"user.define_outcome"` - `beta_managed_agents_session_deleted_event: object { id, processed_at, type }` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.deleted"` - `"session.deleted"` - `beta_managed_agents_session_thread_status_running_event: object { id, agent_name, processed_at, 2 more }` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that started running. - `type: "session.thread_status_running"` - `"session.thread_status_running"` - `beta_managed_agents_session_thread_status_idle_event: object { id, agent_name, processed_at, 3 more }` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that went idle. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "session.thread_status_idle"` - `"session.thread_status_idle"` - `beta_managed_agents_session_thread_status_terminated_event: object { id, agent_name, processed_at, 2 more }` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that terminated. - `type: "session.thread_status_terminated"` - `"session.thread_status_terminated"` - `beta_managed_agents_user_tool_result_event: object { id, tool_use_id, type, 4 more }` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `id: string` Unique identifier for this event. - `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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_result"` - `"user.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - `beta_managed_agents_session_thread_status_rescheduled_event: object { id, agent_name, processed_at, 2 more }` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that is retrying. - `type: "session.thread_status_rescheduled"` - `"session.thread_status_rescheduled"` - `beta_managed_agents_session_updated_event: object { id, processed_at, type, 3 more }` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.updated"` - `"session.updated"` - `agent: optional object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` - `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` The session's new title. Present only when the update changed it. - `next_page: optional string` Opaque cursor for the next page. Null when no more results. ### Example ```cli ant beta:sessions:events list \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 ``` #### Response ```json { "data": [ { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" }, { "id": "sevt_011CZkZHPq1jCdq5lbRTjiVnz", "content": [ { "text": "Let me look up order #1234 for you.", "type": "text" } ], "processed_at": "2026-03-15T10:00:00Z", "type": "agent.message" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Send Events `$ ant beta:sessions:events send` **post** `/v1/sessions/{session_id}/events` Send Events ### Parameters - `--session-id: string` Path param: Path parameter session_id - `--event: array of BetaManagedAgentsEventParams` Body param: Events to send to the `session`. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_send_session_events: object { data }` Events that were successfully sent to the session. - `data: optional array of BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 3 more` Sent events - `beta_managed_agents_user_message_event: object { id, content, type, processed_at }` A user message event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Array of content blocks comprising the user message. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `type: "user.message"` - `"user.message"` - `processed_at: optional string` A timestamp in RFC 3339 format - `beta_managed_agents_user_interrupt_event: object { id, type, processed_at, session_thread_id }` An interrupt event that pauses agent execution and returns control to the user. - `id: string` Unique identifier for this event. - `type: "user.interrupt"` - `"user.interrupt"` - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `beta_managed_agents_user_tool_confirmation_event: object { id, result, tool_use_id, 4 more }` A tool confirmation event that approves or denies a pending tool execution. - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` UserToolConfirmationResult enum - `"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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_confirmation"` - `"user.tool_confirmation"` - `deny_message: optional string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `beta_managed_agents_user_custom_tool_result_event: object { id, custom_tool_use_id, type, 4 more }` Event sent by the client providing the result of a custom tool execution. - `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, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.custom_tool_result"` - `"user.custom_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `beta_managed_agents_user_define_outcome_event: object { id, description, max_iterations, 4 more }` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `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` A timestamp in RFC 3339 format - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` Rubric for grading the quality of an outcome. - `beta_managed_agents_file_rubric: object { file_id, type }` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` - `beta_managed_agents_text_rubric: object { content, type }` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `type: "text"` - `"text"` - `type: "user.define_outcome"` - `"user.define_outcome"` - `beta_managed_agents_user_tool_result_event: object { id, tool_use_id, type, 4 more }` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `id: string` Unique identifier for this event. - `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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_result"` - `"user.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. ### Example ```cli ant beta:sessions:events send \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 \ --event "{content: [{text: 'Where is my order #1234?', type: text}], type: user.message}" ``` #### Response ```json { "data": [ { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } ] } ``` ## Stream Events `$ ant beta:sessions:events stream` **get** `/v1/sessions/{session_id}/events/stream` Stream Events ### Parameters - `--session-id: string` Path parameter session_id - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_stream_session_events: BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 30 more` Server-sent event in the session stream. - `beta_managed_agents_user_message_event: object { id, content, type, processed_at }` A user message event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Array of content blocks comprising the user message. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `type: "user.message"` - `"user.message"` - `processed_at: optional string` A timestamp in RFC 3339 format - `beta_managed_agents_user_interrupt_event: object { id, type, processed_at, session_thread_id }` An interrupt event that pauses agent execution and returns control to the user. - `id: string` Unique identifier for this event. - `type: "user.interrupt"` - `"user.interrupt"` - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `beta_managed_agents_user_tool_confirmation_event: object { id, result, tool_use_id, 4 more }` A tool confirmation event that approves or denies a pending tool execution. - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` UserToolConfirmationResult enum - `"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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_confirmation"` - `"user.tool_confirmation"` - `deny_message: optional string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `beta_managed_agents_user_custom_tool_result_event: object { id, custom_tool_use_id, type, 4 more }` Event sent by the client providing the result of a custom tool execution. - `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, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.custom_tool_result"` - `"user.custom_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `beta_managed_agents_agent_custom_tool_use_event: object { id, input, name, 3 more }` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the custom tool being called. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.custom_tool_use"` - `"agent.custom_tool_use"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - `beta_managed_agents_agent_message_event: object { id, content, processed_at, type }` An agent response event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `text: string` The text content. - `type: "text"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.message"` - `"agent.message"` - `beta_managed_agents_agent_thinking_event: object { id, processed_at, type }` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thinking"` - `"agent.thinking"` - `beta_managed_agents_agent_mcp_tool_use_event: object { id, input, mcp_server_name, 5 more }` Event emitted when the agent invokes a tool provided by an MCP server. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_use"` - `"agent.mcp_tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `beta_managed_agents_agent_mcp_tool_result_event: object { id, mcp_tool_use_id, processed_at, 3 more }` Event representing the result of an MCP tool execution. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_result"` - `"agent.mcp_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_agent_tool_use_event: object { id, input, name, 4 more }` Event emitted when the agent invokes a built-in agent tool. - `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` A timestamp in RFC 3339 format - `type: "agent.tool_use"` - `"agent.tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `beta_managed_agents_agent_tool_result_event: object { id, processed_at, tool_use_id, 3 more }` Event representing the result of an agent tool execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `tool_use_id: string` The id of the `agent.tool_use` event this result corresponds to. - `type: "agent.tool_result"` - `"agent.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_agent_thread_message_received_event: object { id, content, from_session_thread_id, 3 more }` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `from_session_thread_id: string` Public `sthr_` ID of the thread that sent the message. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_message_received"` - `"agent.thread_message_received"` - `from_agent_name: optional string` Name of the callable agent this message came from. Absent when received from the primary agent. - `beta_managed_agents_agent_thread_message_sent_event: object { id, content, processed_at, 3 more }` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `processed_at: string` A timestamp in RFC 3339 format - `to_session_thread_id: string` Public `sthr_` ID of the thread the message was sent to. - `type: "agent.thread_message_sent"` - `"agent.thread_message_sent"` - `to_agent_name: optional string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `beta_managed_agents_agent_thread_context_compacted_event: object { id, processed_at, type }` Indicates that context compaction (summarization) occurred during the session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_context_compacted"` - `"agent.thread_context_compacted"` - `beta_managed_agents_session_error_event: object { id, error, processed_at, type }` An error event indicating a problem occurred during session execution. - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 4 more` 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. - `beta_managed_agents_unknown_error: object { message, retry_status, type }` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "unknown_error"` - `"unknown_error"` - `beta_managed_agents_model_overloaded_error: object { message, retry_status, type }` The model is currently overloaded. Emitted after automatic retries are exhausted. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_overloaded_error"` - `"model_overloaded_error"` - `beta_managed_agents_model_rate_limited_error: object { message, retry_status, type }` The model request was rate-limited. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_rate_limited_error"` - `"model_rate_limited_error"` - `beta_managed_agents_model_request_failed_error: object { message, retry_status, type }` A model request failed for a reason other than overload or rate-limiting. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_request_failed_error"` - `"model_request_failed_error"` - `beta_managed_agents_mcp_connection_failed_error: object { mcp_server_name, message, retry_status, type }` Failed to connect to an MCP server. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_connection_failed_error"` - `"mcp_connection_failed_error"` - `beta_managed_agents_mcp_authentication_failed_error: object { mcp_server_name, message, retry_status, type }` Authentication to an MCP server failed. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_authentication_failed_error"` - `"mcp_authentication_failed_error"` - `beta_managed_agents_billing_error: object { message, retry_status, type }` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "billing_error"` - `"billing_error"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.error"` - `"session.error"` - `beta_managed_agents_session_status_rescheduled_event: object { id, processed_at, type }` Indicates the session is recovering from an error state and is rescheduled for execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_rescheduled"` - `"session.status_rescheduled"` - `beta_managed_agents_session_status_running_event: object { id, processed_at, type }` Indicates the session is actively running and the agent is working. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_running"` - `"session.status_running"` - `beta_managed_agents_session_status_idle_event: object { id, processed_at, stop_reason, type }` Indicates the agent has paused and is awaiting user input. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `type: "end_turn"` - `"end_turn"` - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `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. - `type: "requires_action"` - `"requires_action"` - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "retries_exhausted"` - `"retries_exhausted"` - `type: "session.status_idle"` - `"session.status_idle"` - `beta_managed_agents_session_status_terminated_event: object { id, processed_at, type }` Indicates the session has terminated, either due to an error or completion. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_terminated"` - `"session.status_terminated"` - `beta_managed_agents_session_thread_created_event: object { id, agent_name, processed_at, 2 more }` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the callable agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public `sthr_` ID of the newly created thread. - `type: "session.thread_created"` - `"session.thread_created"` - `beta_managed_agents_span_outcome_evaluation_start_event: object { id, iteration, outcome_id, 2 more }` Emitted when an outcome evaluation cycle begins. - `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. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_start"` - `"span.outcome_evaluation_start"` - `beta_managed_agents_span_outcome_evaluation_end_event: object { id, explanation, iteration, 6 more }` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `id: string` Unique identifier for this event. - `explanation: string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `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` A timestamp in RFC 3339 format - `result: string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `type: "span.outcome_evaluation_end"` - `"span.outcome_evaluation_end"` - `usage: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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"` - `beta_managed_agents_span_model_request_start_event: object { id, processed_at, type }` Emitted when a model request is initiated by the agent. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_start"` - `"span.model_request_start"` - `beta_managed_agents_span_model_request_end_event: object { id, is_error, model_request_start_id, 3 more }` Emitted when a model request completes. - `id: string` Unique identifier for this event. - `is_error: boolean` 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: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_end"` - `"span.model_request_end"` - `beta_managed_agents_span_outcome_evaluation_ongoing_event: object { id, iteration, outcome_id, 2 more }` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_ongoing"` - `"span.outcome_evaluation_ongoing"` - `beta_managed_agents_user_define_outcome_event: object { id, description, max_iterations, 4 more }` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `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` A timestamp in RFC 3339 format - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` Rubric for grading the quality of an outcome. - `beta_managed_agents_file_rubric: object { file_id, type }` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` - `beta_managed_agents_text_rubric: object { content, type }` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `type: "text"` - `"text"` - `type: "user.define_outcome"` - `"user.define_outcome"` - `beta_managed_agents_session_deleted_event: object { id, processed_at, type }` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.deleted"` - `"session.deleted"` - `beta_managed_agents_session_thread_status_running_event: object { id, agent_name, processed_at, 2 more }` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that started running. - `type: "session.thread_status_running"` - `"session.thread_status_running"` - `beta_managed_agents_session_thread_status_idle_event: object { id, agent_name, processed_at, 3 more }` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that went idle. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "session.thread_status_idle"` - `"session.thread_status_idle"` - `beta_managed_agents_session_thread_status_terminated_event: object { id, agent_name, processed_at, 2 more }` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that terminated. - `type: "session.thread_status_terminated"` - `"session.thread_status_terminated"` - `beta_managed_agents_user_tool_result_event: object { id, tool_use_id, type, 4 more }` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `id: string` Unique identifier for this event. - `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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_result"` - `"user.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - `beta_managed_agents_session_thread_status_rescheduled_event: object { id, agent_name, processed_at, 2 more }` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that is retrying. - `type: "session.thread_status_rescheduled"` - `"session.thread_status_rescheduled"` - `beta_managed_agents_session_updated_event: object { id, processed_at, type, 3 more }` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.updated"` - `"session.updated"` - `agent: optional object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` - `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` The session's new title. Present only when the update changed it. ### Example ```cli ant beta:sessions:events stream \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 ``` #### Response ```json { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } ``` ## Domain Types ### Beta Managed Agents Agent Custom Tool Use Event - `beta_managed_agents_agent_custom_tool_use_event: object { id, input, name, 3 more }` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the custom tool being called. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.custom_tool_use"` - `"agent.custom_tool_use"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. ### Beta Managed Agents Agent MCP Tool Result Event - `beta_managed_agents_agent_mcp_tool_result_event: object { id, mcp_tool_use_id, processed_at, 3 more }` Event representing the result of an MCP tool execution. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_result"` - `"agent.mcp_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. ### Beta Managed Agents Agent MCP Tool Use Event - `beta_managed_agents_agent_mcp_tool_use_event: object { id, input, mcp_server_name, 5 more }` Event emitted when the agent invokes a tool provided by an MCP server. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_use"` - `"agent.mcp_tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. ### Beta Managed Agents Agent Message Event - `beta_managed_agents_agent_message_event: object { id, content, processed_at, type }` An agent response event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `text: string` The text content. - `type: "text"` - `"text"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.message"` - `"agent.message"` ### Beta Managed Agents Agent Thinking Event - `beta_managed_agents_agent_thinking_event: object { id, processed_at, type }` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thinking"` - `"agent.thinking"` ### Beta Managed Agents Agent Thread Context Compacted Event - `beta_managed_agents_agent_thread_context_compacted_event: object { id, processed_at, type }` Indicates that context compaction (summarization) occurred during the session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_context_compacted"` - `"agent.thread_context_compacted"` ### Beta Managed Agents Agent Thread Message Received Event - `beta_managed_agents_agent_thread_message_received_event: object { id, content, from_session_thread_id, 3 more }` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `from_session_thread_id: string` Public `sthr_` ID of the thread that sent the message. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_message_received"` - `"agent.thread_message_received"` - `from_agent_name: optional string` Name of the callable agent this message came from. Absent when received from the primary agent. ### Beta Managed Agents Agent Thread Message Sent Event - `beta_managed_agents_agent_thread_message_sent_event: object { id, content, processed_at, 3 more }` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `processed_at: string` A timestamp in RFC 3339 format - `to_session_thread_id: string` Public `sthr_` ID of the thread the message was sent to. - `type: "agent.thread_message_sent"` - `"agent.thread_message_sent"` - `to_agent_name: optional string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. ### Beta Managed Agents Agent Tool Result Event - `beta_managed_agents_agent_tool_result_event: object { id, processed_at, tool_use_id, 3 more }` Event representing the result of an agent tool execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `tool_use_id: string` The id of the `agent.tool_use` event this result corresponds to. - `type: "agent.tool_result"` - `"agent.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. ### Beta Managed Agents Agent Tool Use Event - `beta_managed_agents_agent_tool_use_event: object { id, input, name, 4 more }` Event emitted when the agent invokes a built-in agent tool. - `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` A timestamp in RFC 3339 format - `type: "agent.tool_use"` - `"agent.tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. ### Beta Managed Agents Base64 Document Source - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` ### Beta Managed Agents Base64 Image Source - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` ### Beta Managed Agents Billing Error - `beta_managed_agents_billing_error: object { message, retry_status, type }` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "billing_error"` - `"billing_error"` ### Beta Managed Agents Document Block - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. ### Beta Managed Agents Event Params - `beta_managed_agents_event_params: BetaManagedAgentsUserMessageEventParams or BetaManagedAgentsUserInterruptEventParams or BetaManagedAgentsUserToolConfirmationEventParams or 3 more` Union type for event parameters that can be sent to a session. - `beta_managed_agents_user_message_event_params: object { content, type }` Parameters for sending a user message to the session. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Array of content blocks for the user message. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `type: "user.message"` - `"user.message"` - `beta_managed_agents_user_interrupt_event_params: object { type, session_thread_id }` Parameters for sending an interrupt to pause the agent. - `type: "user.interrupt"` - `"user.interrupt"` - `session_thread_id: optional string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `beta_managed_agents_user_tool_confirmation_event_params: object { result, tool_use_id, type, deny_message }` Parameters for confirming or denying a tool execution request. - `result: "allow" or "deny"` UserToolConfirmationResult enum - `"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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_confirmation"` - `"user.tool_confirmation"` - `deny_message: optional string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `beta_managed_agents_user_custom_tool_result_event_params: object { custom_tool_use_id, type, content, is_error }` Parameters for providing the result of a custom tool execution. - `custom_tool_use_id: string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.custom_tool_result"` - `"user.custom_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_user_define_outcome_event_params: object { description, rubric, type, max_iterations }` Parameters for defining an outcome the agent should work toward. The agent begins work on receipt. - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams` Rubric for grading the quality of an outcome. - `beta_managed_agents_file_rubric_params: object { file_id, type }` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` - `beta_managed_agents_text_rubric_params: object { content, type }` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. - `type: "text"` - `"text"` - `type: "user.define_outcome"` - `"user.define_outcome"` - `max_iterations: optional number` Eval→revision cycles before giving up. Default 3, max 20. - `beta_managed_agents_user_tool_result_event_params: object { tool_use_id, type, content, is_error }` 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. - `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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_result"` - `"user.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. ### Beta Managed Agents File Document Source - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` ### Beta Managed Agents File Image Source - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` ### Beta Managed Agents File Rubric - `beta_managed_agents_file_rubric: object { file_id, type }` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` ### Beta Managed Agents File Rubric Params - `beta_managed_agents_file_rubric_params: object { file_id, type }` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` ### Beta Managed Agents Image Block - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` ### Beta Managed Agents MCP Authentication Failed Error - `beta_managed_agents_mcp_authentication_failed_error: object { mcp_server_name, message, retry_status, type }` Authentication to an MCP server failed. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "mcp_authentication_failed_error"` - `"mcp_authentication_failed_error"` ### Beta Managed Agents MCP Connection Failed Error - `beta_managed_agents_mcp_connection_failed_error: object { mcp_server_name, message, retry_status, type }` Failed to connect to an MCP server. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "mcp_connection_failed_error"` - `"mcp_connection_failed_error"` ### Beta Managed Agents Model Overloaded Error - `beta_managed_agents_model_overloaded_error: object { message, retry_status, type }` The model is currently overloaded. Emitted after automatic retries are exhausted. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "model_overloaded_error"` - `"model_overloaded_error"` ### Beta Managed Agents Model Rate Limited Error - `beta_managed_agents_model_rate_limited_error: object { message, retry_status, type }` The model request was rate-limited. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "model_rate_limited_error"` - `"model_rate_limited_error"` ### Beta Managed Agents Model Request Failed Error - `beta_managed_agents_model_request_failed_error: object { message, retry_status, type }` A model request failed for a reason other than overload or rate-limiting. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "model_request_failed_error"` - `"model_request_failed_error"` ### Beta Managed Agents Plain Text Document Source - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` ### Beta Managed Agents Retry Status Exhausted - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` ### Beta Managed Agents Retry Status Retrying - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` ### Beta Managed Agents Retry Status Terminal - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` ### Beta Managed Agents Search Result Block - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` ### Beta Managed Agents Search Result Citations - `beta_managed_agents_search_result_citations: object { enabled }` Citation settings for a search result. - `enabled: boolean` Whether citations are enabled for this search result. ### Beta Managed Agents Search Result Content - `beta_managed_agents_search_result_content: object { text, type }` Text content within a search result. - `text: string` The text content. - `type: "text"` - `"text"` ### Beta Managed Agents Send Session Events - `beta_managed_agents_send_session_events: object { data }` Events that were successfully sent to the session. - `data: optional array of BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 3 more` Sent events - `beta_managed_agents_user_message_event: object { id, content, type, processed_at }` A user message event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Array of content blocks comprising the user message. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `type: "user.message"` - `"user.message"` - `processed_at: optional string` A timestamp in RFC 3339 format - `beta_managed_agents_user_interrupt_event: object { id, type, processed_at, session_thread_id }` An interrupt event that pauses agent execution and returns control to the user. - `id: string` Unique identifier for this event. - `type: "user.interrupt"` - `"user.interrupt"` - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `beta_managed_agents_user_tool_confirmation_event: object { id, result, tool_use_id, 4 more }` A tool confirmation event that approves or denies a pending tool execution. - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` UserToolConfirmationResult enum - `"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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_confirmation"` - `"user.tool_confirmation"` - `deny_message: optional string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `beta_managed_agents_user_custom_tool_result_event: object { id, custom_tool_use_id, type, 4 more }` Event sent by the client providing the result of a custom tool execution. - `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, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.custom_tool_result"` - `"user.custom_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `beta_managed_agents_user_define_outcome_event: object { id, description, max_iterations, 4 more }` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `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` A timestamp in RFC 3339 format - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` Rubric for grading the quality of an outcome. - `beta_managed_agents_file_rubric: object { file_id, type }` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` - `beta_managed_agents_text_rubric: object { content, type }` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `type: "text"` - `"text"` - `type: "user.define_outcome"` - `"user.define_outcome"` - `beta_managed_agents_user_tool_result_event: object { id, tool_use_id, type, 4 more }` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `id: string` Unique identifier for this event. - `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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_result"` - `"user.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. ### Beta Managed Agents Session Deleted Event - `beta_managed_agents_session_deleted_event: object { id, processed_at, type }` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.deleted"` - `"session.deleted"` ### Beta Managed Agents Session End Turn - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `type: "end_turn"` - `"end_turn"` ### Beta Managed Agents Session Error Event - `beta_managed_agents_session_error_event: object { id, error, processed_at, type }` An error event indicating a problem occurred during session execution. - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 4 more` 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. - `beta_managed_agents_unknown_error: object { message, retry_status, type }` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "unknown_error"` - `"unknown_error"` - `beta_managed_agents_model_overloaded_error: object { message, retry_status, type }` The model is currently overloaded. Emitted after automatic retries are exhausted. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_overloaded_error"` - `"model_overloaded_error"` - `beta_managed_agents_model_rate_limited_error: object { message, retry_status, type }` The model request was rate-limited. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_rate_limited_error"` - `"model_rate_limited_error"` - `beta_managed_agents_model_request_failed_error: object { message, retry_status, type }` A model request failed for a reason other than overload or rate-limiting. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_request_failed_error"` - `"model_request_failed_error"` - `beta_managed_agents_mcp_connection_failed_error: object { mcp_server_name, message, retry_status, type }` Failed to connect to an MCP server. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_connection_failed_error"` - `"mcp_connection_failed_error"` - `beta_managed_agents_mcp_authentication_failed_error: object { mcp_server_name, message, retry_status, type }` Authentication to an MCP server failed. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_authentication_failed_error"` - `"mcp_authentication_failed_error"` - `beta_managed_agents_billing_error: object { message, retry_status, type }` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "billing_error"` - `"billing_error"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.error"` - `"session.error"` ### Beta Managed Agents Session Event - `beta_managed_agents_session_event: BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 30 more` Union type for all event types in a session. - `beta_managed_agents_user_message_event: object { id, content, type, processed_at }` A user message event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Array of content blocks comprising the user message. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `type: "user.message"` - `"user.message"` - `processed_at: optional string` A timestamp in RFC 3339 format - `beta_managed_agents_user_interrupt_event: object { id, type, processed_at, session_thread_id }` An interrupt event that pauses agent execution and returns control to the user. - `id: string` Unique identifier for this event. - `type: "user.interrupt"` - `"user.interrupt"` - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `beta_managed_agents_user_tool_confirmation_event: object { id, result, tool_use_id, 4 more }` A tool confirmation event that approves or denies a pending tool execution. - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` UserToolConfirmationResult enum - `"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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_confirmation"` - `"user.tool_confirmation"` - `deny_message: optional string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `beta_managed_agents_user_custom_tool_result_event: object { id, custom_tool_use_id, type, 4 more }` Event sent by the client providing the result of a custom tool execution. - `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, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.custom_tool_result"` - `"user.custom_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `beta_managed_agents_agent_custom_tool_use_event: object { id, input, name, 3 more }` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the custom tool being called. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.custom_tool_use"` - `"agent.custom_tool_use"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - `beta_managed_agents_agent_message_event: object { id, content, processed_at, type }` An agent response event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `text: string` The text content. - `type: "text"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.message"` - `"agent.message"` - `beta_managed_agents_agent_thinking_event: object { id, processed_at, type }` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thinking"` - `"agent.thinking"` - `beta_managed_agents_agent_mcp_tool_use_event: object { id, input, mcp_server_name, 5 more }` Event emitted when the agent invokes a tool provided by an MCP server. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_use"` - `"agent.mcp_tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `beta_managed_agents_agent_mcp_tool_result_event: object { id, mcp_tool_use_id, processed_at, 3 more }` Event representing the result of an MCP tool execution. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_result"` - `"agent.mcp_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_agent_tool_use_event: object { id, input, name, 4 more }` Event emitted when the agent invokes a built-in agent tool. - `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` A timestamp in RFC 3339 format - `type: "agent.tool_use"` - `"agent.tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `beta_managed_agents_agent_tool_result_event: object { id, processed_at, tool_use_id, 3 more }` Event representing the result of an agent tool execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `tool_use_id: string` The id of the `agent.tool_use` event this result corresponds to. - `type: "agent.tool_result"` - `"agent.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_agent_thread_message_received_event: object { id, content, from_session_thread_id, 3 more }` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `from_session_thread_id: string` Public `sthr_` ID of the thread that sent the message. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_message_received"` - `"agent.thread_message_received"` - `from_agent_name: optional string` Name of the callable agent this message came from. Absent when received from the primary agent. - `beta_managed_agents_agent_thread_message_sent_event: object { id, content, processed_at, 3 more }` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `processed_at: string` A timestamp in RFC 3339 format - `to_session_thread_id: string` Public `sthr_` ID of the thread the message was sent to. - `type: "agent.thread_message_sent"` - `"agent.thread_message_sent"` - `to_agent_name: optional string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `beta_managed_agents_agent_thread_context_compacted_event: object { id, processed_at, type }` Indicates that context compaction (summarization) occurred during the session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_context_compacted"` - `"agent.thread_context_compacted"` - `beta_managed_agents_session_error_event: object { id, error, processed_at, type }` An error event indicating a problem occurred during session execution. - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 4 more` 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. - `beta_managed_agents_unknown_error: object { message, retry_status, type }` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "unknown_error"` - `"unknown_error"` - `beta_managed_agents_model_overloaded_error: object { message, retry_status, type }` The model is currently overloaded. Emitted after automatic retries are exhausted. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_overloaded_error"` - `"model_overloaded_error"` - `beta_managed_agents_model_rate_limited_error: object { message, retry_status, type }` The model request was rate-limited. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_rate_limited_error"` - `"model_rate_limited_error"` - `beta_managed_agents_model_request_failed_error: object { message, retry_status, type }` A model request failed for a reason other than overload or rate-limiting. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_request_failed_error"` - `"model_request_failed_error"` - `beta_managed_agents_mcp_connection_failed_error: object { mcp_server_name, message, retry_status, type }` Failed to connect to an MCP server. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_connection_failed_error"` - `"mcp_connection_failed_error"` - `beta_managed_agents_mcp_authentication_failed_error: object { mcp_server_name, message, retry_status, type }` Authentication to an MCP server failed. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_authentication_failed_error"` - `"mcp_authentication_failed_error"` - `beta_managed_agents_billing_error: object { message, retry_status, type }` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "billing_error"` - `"billing_error"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.error"` - `"session.error"` - `beta_managed_agents_session_status_rescheduled_event: object { id, processed_at, type }` Indicates the session is recovering from an error state and is rescheduled for execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_rescheduled"` - `"session.status_rescheduled"` - `beta_managed_agents_session_status_running_event: object { id, processed_at, type }` Indicates the session is actively running and the agent is working. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_running"` - `"session.status_running"` - `beta_managed_agents_session_status_idle_event: object { id, processed_at, stop_reason, type }` Indicates the agent has paused and is awaiting user input. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `type: "end_turn"` - `"end_turn"` - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `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. - `type: "requires_action"` - `"requires_action"` - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "retries_exhausted"` - `"retries_exhausted"` - `type: "session.status_idle"` - `"session.status_idle"` - `beta_managed_agents_session_status_terminated_event: object { id, processed_at, type }` Indicates the session has terminated, either due to an error or completion. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_terminated"` - `"session.status_terminated"` - `beta_managed_agents_session_thread_created_event: object { id, agent_name, processed_at, 2 more }` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the callable agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public `sthr_` ID of the newly created thread. - `type: "session.thread_created"` - `"session.thread_created"` - `beta_managed_agents_span_outcome_evaluation_start_event: object { id, iteration, outcome_id, 2 more }` Emitted when an outcome evaluation cycle begins. - `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. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_start"` - `"span.outcome_evaluation_start"` - `beta_managed_agents_span_outcome_evaluation_end_event: object { id, explanation, iteration, 6 more }` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `id: string` Unique identifier for this event. - `explanation: string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `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` A timestamp in RFC 3339 format - `result: string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `type: "span.outcome_evaluation_end"` - `"span.outcome_evaluation_end"` - `usage: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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"` - `beta_managed_agents_span_model_request_start_event: object { id, processed_at, type }` Emitted when a model request is initiated by the agent. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_start"` - `"span.model_request_start"` - `beta_managed_agents_span_model_request_end_event: object { id, is_error, model_request_start_id, 3 more }` Emitted when a model request completes. - `id: string` Unique identifier for this event. - `is_error: boolean` 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: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_end"` - `"span.model_request_end"` - `beta_managed_agents_span_outcome_evaluation_ongoing_event: object { id, iteration, outcome_id, 2 more }` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_ongoing"` - `"span.outcome_evaluation_ongoing"` - `beta_managed_agents_user_define_outcome_event: object { id, description, max_iterations, 4 more }` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `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` A timestamp in RFC 3339 format - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` Rubric for grading the quality of an outcome. - `beta_managed_agents_file_rubric: object { file_id, type }` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` - `beta_managed_agents_text_rubric: object { content, type }` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `type: "text"` - `"text"` - `type: "user.define_outcome"` - `"user.define_outcome"` - `beta_managed_agents_session_deleted_event: object { id, processed_at, type }` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.deleted"` - `"session.deleted"` - `beta_managed_agents_session_thread_status_running_event: object { id, agent_name, processed_at, 2 more }` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that started running. - `type: "session.thread_status_running"` - `"session.thread_status_running"` - `beta_managed_agents_session_thread_status_idle_event: object { id, agent_name, processed_at, 3 more }` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that went idle. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "session.thread_status_idle"` - `"session.thread_status_idle"` - `beta_managed_agents_session_thread_status_terminated_event: object { id, agent_name, processed_at, 2 more }` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that terminated. - `type: "session.thread_status_terminated"` - `"session.thread_status_terminated"` - `beta_managed_agents_user_tool_result_event: object { id, tool_use_id, type, 4 more }` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `id: string` Unique identifier for this event. - `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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_result"` - `"user.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - `beta_managed_agents_session_thread_status_rescheduled_event: object { id, agent_name, processed_at, 2 more }` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that is retrying. - `type: "session.thread_status_rescheduled"` - `"session.thread_status_rescheduled"` - `beta_managed_agents_session_updated_event: object { id, processed_at, type, 3 more }` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.updated"` - `"session.updated"` - `agent: optional object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` - `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` The session's new title. Present only when the update changed it. ### Beta Managed Agents Session Requires Action - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `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. - `type: "requires_action"` - `"requires_action"` ### Beta Managed Agents Session Retries Exhausted - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "retries_exhausted"` - `"retries_exhausted"` ### Beta Managed Agents Session Status Idle Event - `beta_managed_agents_session_status_idle_event: object { id, processed_at, stop_reason, type }` Indicates the agent has paused and is awaiting user input. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `type: "end_turn"` - `"end_turn"` - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `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. - `type: "requires_action"` - `"requires_action"` - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "retries_exhausted"` - `"retries_exhausted"` - `type: "session.status_idle"` - `"session.status_idle"` ### Beta Managed Agents Session Status Rescheduled Event - `beta_managed_agents_session_status_rescheduled_event: object { id, processed_at, type }` Indicates the session is recovering from an error state and is rescheduled for execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_rescheduled"` - `"session.status_rescheduled"` ### Beta Managed Agents Session Status Running Event - `beta_managed_agents_session_status_running_event: object { id, processed_at, type }` Indicates the session is actively running and the agent is working. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_running"` - `"session.status_running"` ### Beta Managed Agents Session Status Terminated Event - `beta_managed_agents_session_status_terminated_event: object { id, processed_at, type }` Indicates the session has terminated, either due to an error or completion. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_terminated"` - `"session.status_terminated"` ### Beta Managed Agents Session Thread Created Event - `beta_managed_agents_session_thread_created_event: object { id, agent_name, processed_at, 2 more }` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the callable agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public `sthr_` ID of the newly created thread. - `type: "session.thread_created"` - `"session.thread_created"` ### Beta Managed Agents Session Thread Status Idle Event - `beta_managed_agents_session_thread_status_idle_event: object { id, agent_name, processed_at, 3 more }` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that went idle. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `type: "end_turn"` - `"end_turn"` - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `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. - `type: "requires_action"` - `"requires_action"` - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "retries_exhausted"` - `"retries_exhausted"` - `type: "session.thread_status_idle"` - `"session.thread_status_idle"` ### Beta Managed Agents Session Thread Status Rescheduled Event - `beta_managed_agents_session_thread_status_rescheduled_event: object { id, agent_name, processed_at, 2 more }` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that is retrying. - `type: "session.thread_status_rescheduled"` - `"session.thread_status_rescheduled"` ### Beta Managed Agents Session Thread Status Running Event - `beta_managed_agents_session_thread_status_running_event: object { id, agent_name, processed_at, 2 more }` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that started running. - `type: "session.thread_status_running"` - `"session.thread_status_running"` ### Beta Managed Agents Session Thread Status Terminated Event - `beta_managed_agents_session_thread_status_terminated_event: object { id, agent_name, processed_at, 2 more }` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that terminated. - `type: "session.thread_status_terminated"` - `"session.thread_status_terminated"` ### Beta Managed Agents Span Model Request End Event - `beta_managed_agents_span_model_request_end_event: object { id, is_error, model_request_start_id, 3 more }` Emitted when a model request completes. - `id: string` Unique identifier for this event. - `is_error: boolean` 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: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_end"` - `"span.model_request_end"` ### Beta Managed Agents Span Model Request Start Event - `beta_managed_agents_span_model_request_start_event: object { id, processed_at, type }` Emitted when a model request is initiated by the agent. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_start"` - `"span.model_request_start"` ### Beta Managed Agents Span Model Usage - `beta_managed_agents_span_model_usage: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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"` ### Beta Managed Agents Span Outcome Evaluation End Event - `beta_managed_agents_span_outcome_evaluation_end_event: object { id, explanation, iteration, 6 more }` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `id: string` Unique identifier for this event. - `explanation: string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `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` A timestamp in RFC 3339 format - `result: string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `type: "span.outcome_evaluation_end"` - `"span.outcome_evaluation_end"` - `usage: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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"` ### Beta Managed Agents Span Outcome Evaluation Ongoing Event - `beta_managed_agents_span_outcome_evaluation_ongoing_event: object { id, iteration, outcome_id, 2 more }` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_ongoing"` - `"span.outcome_evaluation_ongoing"` ### Beta Managed Agents Span Outcome Evaluation Start Event - `beta_managed_agents_span_outcome_evaluation_start_event: object { id, iteration, outcome_id, 2 more }` Emitted when an outcome evaluation cycle begins. - `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. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_start"` - `"span.outcome_evaluation_start"` ### Beta Managed Agents Stream Session Events - `beta_managed_agents_stream_session_events: BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 30 more` Server-sent event in the session stream. - `beta_managed_agents_user_message_event: object { id, content, type, processed_at }` A user message event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Array of content blocks comprising the user message. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `type: "user.message"` - `"user.message"` - `processed_at: optional string` A timestamp in RFC 3339 format - `beta_managed_agents_user_interrupt_event: object { id, type, processed_at, session_thread_id }` An interrupt event that pauses agent execution and returns control to the user. - `id: string` Unique identifier for this event. - `type: "user.interrupt"` - `"user.interrupt"` - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `beta_managed_agents_user_tool_confirmation_event: object { id, result, tool_use_id, 4 more }` A tool confirmation event that approves or denies a pending tool execution. - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` UserToolConfirmationResult enum - `"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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_confirmation"` - `"user.tool_confirmation"` - `deny_message: optional string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `beta_managed_agents_user_custom_tool_result_event: object { id, custom_tool_use_id, type, 4 more }` Event sent by the client providing the result of a custom tool execution. - `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, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.custom_tool_result"` - `"user.custom_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `beta_managed_agents_agent_custom_tool_use_event: object { id, input, name, 3 more }` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the custom tool being called. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.custom_tool_use"` - `"agent.custom_tool_use"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - `beta_managed_agents_agent_message_event: object { id, content, processed_at, type }` An agent response event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `text: string` The text content. - `type: "text"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.message"` - `"agent.message"` - `beta_managed_agents_agent_thinking_event: object { id, processed_at, type }` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thinking"` - `"agent.thinking"` - `beta_managed_agents_agent_mcp_tool_use_event: object { id, input, mcp_server_name, 5 more }` Event emitted when the agent invokes a tool provided by an MCP server. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_use"` - `"agent.mcp_tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `beta_managed_agents_agent_mcp_tool_result_event: object { id, mcp_tool_use_id, processed_at, 3 more }` Event representing the result of an MCP tool execution. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_result"` - `"agent.mcp_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_agent_tool_use_event: object { id, input, name, 4 more }` Event emitted when the agent invokes a built-in agent tool. - `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` A timestamp in RFC 3339 format - `type: "agent.tool_use"` - `"agent.tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `beta_managed_agents_agent_tool_result_event: object { id, processed_at, tool_use_id, 3 more }` Event representing the result of an agent tool execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `tool_use_id: string` The id of the `agent.tool_use` event this result corresponds to. - `type: "agent.tool_result"` - `"agent.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_agent_thread_message_received_event: object { id, content, from_session_thread_id, 3 more }` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `from_session_thread_id: string` Public `sthr_` ID of the thread that sent the message. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_message_received"` - `"agent.thread_message_received"` - `from_agent_name: optional string` Name of the callable agent this message came from. Absent when received from the primary agent. - `beta_managed_agents_agent_thread_message_sent_event: object { id, content, processed_at, 3 more }` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `processed_at: string` A timestamp in RFC 3339 format - `to_session_thread_id: string` Public `sthr_` ID of the thread the message was sent to. - `type: "agent.thread_message_sent"` - `"agent.thread_message_sent"` - `to_agent_name: optional string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `beta_managed_agents_agent_thread_context_compacted_event: object { id, processed_at, type }` Indicates that context compaction (summarization) occurred during the session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_context_compacted"` - `"agent.thread_context_compacted"` - `beta_managed_agents_session_error_event: object { id, error, processed_at, type }` An error event indicating a problem occurred during session execution. - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 4 more` 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. - `beta_managed_agents_unknown_error: object { message, retry_status, type }` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "unknown_error"` - `"unknown_error"` - `beta_managed_agents_model_overloaded_error: object { message, retry_status, type }` The model is currently overloaded. Emitted after automatic retries are exhausted. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_overloaded_error"` - `"model_overloaded_error"` - `beta_managed_agents_model_rate_limited_error: object { message, retry_status, type }` The model request was rate-limited. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_rate_limited_error"` - `"model_rate_limited_error"` - `beta_managed_agents_model_request_failed_error: object { message, retry_status, type }` A model request failed for a reason other than overload or rate-limiting. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_request_failed_error"` - `"model_request_failed_error"` - `beta_managed_agents_mcp_connection_failed_error: object { mcp_server_name, message, retry_status, type }` Failed to connect to an MCP server. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_connection_failed_error"` - `"mcp_connection_failed_error"` - `beta_managed_agents_mcp_authentication_failed_error: object { mcp_server_name, message, retry_status, type }` Authentication to an MCP server failed. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_authentication_failed_error"` - `"mcp_authentication_failed_error"` - `beta_managed_agents_billing_error: object { message, retry_status, type }` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "billing_error"` - `"billing_error"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.error"` - `"session.error"` - `beta_managed_agents_session_status_rescheduled_event: object { id, processed_at, type }` Indicates the session is recovering from an error state and is rescheduled for execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_rescheduled"` - `"session.status_rescheduled"` - `beta_managed_agents_session_status_running_event: object { id, processed_at, type }` Indicates the session is actively running and the agent is working. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_running"` - `"session.status_running"` - `beta_managed_agents_session_status_idle_event: object { id, processed_at, stop_reason, type }` Indicates the agent has paused and is awaiting user input. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `type: "end_turn"` - `"end_turn"` - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `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. - `type: "requires_action"` - `"requires_action"` - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "retries_exhausted"` - `"retries_exhausted"` - `type: "session.status_idle"` - `"session.status_idle"` - `beta_managed_agents_session_status_terminated_event: object { id, processed_at, type }` Indicates the session has terminated, either due to an error or completion. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_terminated"` - `"session.status_terminated"` - `beta_managed_agents_session_thread_created_event: object { id, agent_name, processed_at, 2 more }` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the callable agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public `sthr_` ID of the newly created thread. - `type: "session.thread_created"` - `"session.thread_created"` - `beta_managed_agents_span_outcome_evaluation_start_event: object { id, iteration, outcome_id, 2 more }` Emitted when an outcome evaluation cycle begins. - `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. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_start"` - `"span.outcome_evaluation_start"` - `beta_managed_agents_span_outcome_evaluation_end_event: object { id, explanation, iteration, 6 more }` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `id: string` Unique identifier for this event. - `explanation: string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `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` A timestamp in RFC 3339 format - `result: string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `type: "span.outcome_evaluation_end"` - `"span.outcome_evaluation_end"` - `usage: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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"` - `beta_managed_agents_span_model_request_start_event: object { id, processed_at, type }` Emitted when a model request is initiated by the agent. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_start"` - `"span.model_request_start"` - `beta_managed_agents_span_model_request_end_event: object { id, is_error, model_request_start_id, 3 more }` Emitted when a model request completes. - `id: string` Unique identifier for this event. - `is_error: boolean` 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: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_end"` - `"span.model_request_end"` - `beta_managed_agents_span_outcome_evaluation_ongoing_event: object { id, iteration, outcome_id, 2 more }` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_ongoing"` - `"span.outcome_evaluation_ongoing"` - `beta_managed_agents_user_define_outcome_event: object { id, description, max_iterations, 4 more }` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `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` A timestamp in RFC 3339 format - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` Rubric for grading the quality of an outcome. - `beta_managed_agents_file_rubric: object { file_id, type }` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` - `beta_managed_agents_text_rubric: object { content, type }` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `type: "text"` - `"text"` - `type: "user.define_outcome"` - `"user.define_outcome"` - `beta_managed_agents_session_deleted_event: object { id, processed_at, type }` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.deleted"` - `"session.deleted"` - `beta_managed_agents_session_thread_status_running_event: object { id, agent_name, processed_at, 2 more }` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that started running. - `type: "session.thread_status_running"` - `"session.thread_status_running"` - `beta_managed_agents_session_thread_status_idle_event: object { id, agent_name, processed_at, 3 more }` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that went idle. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "session.thread_status_idle"` - `"session.thread_status_idle"` - `beta_managed_agents_session_thread_status_terminated_event: object { id, agent_name, processed_at, 2 more }` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that terminated. - `type: "session.thread_status_terminated"` - `"session.thread_status_terminated"` - `beta_managed_agents_user_tool_result_event: object { id, tool_use_id, type, 4 more }` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `id: string` Unique identifier for this event. - `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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_result"` - `"user.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - `beta_managed_agents_session_thread_status_rescheduled_event: object { id, agent_name, processed_at, 2 more }` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that is retrying. - `type: "session.thread_status_rescheduled"` - `"session.thread_status_rescheduled"` - `beta_managed_agents_session_updated_event: object { id, processed_at, type, 3 more }` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.updated"` - `"session.updated"` - `agent: optional object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` - `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` The session's new title. Present only when the update changed it. ### Beta Managed Agents Text Block - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` ### Beta Managed Agents Text Rubric - `beta_managed_agents_text_rubric: object { content, type }` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `type: "text"` - `"text"` ### Beta Managed Agents Text Rubric Params - `beta_managed_agents_text_rubric_params: object { content, type }` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. - `type: "text"` - `"text"` ### Beta Managed Agents Unknown Error - `beta_managed_agents_unknown_error: object { message, retry_status, type }` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "unknown_error"` - `"unknown_error"` ### Beta Managed Agents URL Document Source - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. ### Beta Managed Agents URL Image Source - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. ### Beta Managed Agents User Custom Tool Result Event - `beta_managed_agents_user_custom_tool_result_event: object { id, custom_tool_use_id, type, 4 more }` Event sent by the client providing the result of a custom tool execution. - `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, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.custom_tool_result"` - `"user.custom_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. ### Beta Managed Agents User Custom Tool Result Event Params - `beta_managed_agents_user_custom_tool_result_event_params: object { custom_tool_use_id, type, content, is_error }` Parameters for providing the result of a custom tool execution. - `custom_tool_use_id: string` The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.custom_tool_result"` - `"user.custom_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. ### Beta Managed Agents User Define Outcome Event - `beta_managed_agents_user_define_outcome_event: object { id, description, max_iterations, 4 more }` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `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` A timestamp in RFC 3339 format - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` Rubric for grading the quality of an outcome. - `beta_managed_agents_file_rubric: object { file_id, type }` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` - `beta_managed_agents_text_rubric: object { content, type }` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `type: "text"` - `"text"` - `type: "user.define_outcome"` - `"user.define_outcome"` ### Beta Managed Agents User Define Outcome Event Params - `beta_managed_agents_user_define_outcome_event_params: object { description, rubric, type, max_iterations }` Parameters for defining an outcome the agent should work toward. The agent begins work on receipt. - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams` Rubric for grading the quality of an outcome. - `beta_managed_agents_file_rubric_params: object { file_id, type }` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` - `beta_managed_agents_text_rubric_params: object { content, type }` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. - `type: "text"` - `"text"` - `type: "user.define_outcome"` - `"user.define_outcome"` - `max_iterations: optional number` Eval→revision cycles before giving up. Default 3, max 20. ### Beta Managed Agents User Interrupt Event - `beta_managed_agents_user_interrupt_event: object { id, type, processed_at, session_thread_id }` An interrupt event that pauses agent execution and returns control to the user. - `id: string` Unique identifier for this event. - `type: "user.interrupt"` - `"user.interrupt"` - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. ### Beta Managed Agents User Interrupt Event Params - `beta_managed_agents_user_interrupt_event_params: object { type, session_thread_id }` Parameters for sending an interrupt to pause the agent. - `type: "user.interrupt"` - `"user.interrupt"` - `session_thread_id: optional string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. ### Beta Managed Agents User Message Event - `beta_managed_agents_user_message_event: object { id, content, type, processed_at }` A user message event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Array of content blocks comprising the user message. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `type: "user.message"` - `"user.message"` - `processed_at: optional string` A timestamp in RFC 3339 format ### Beta Managed Agents User Message Event Params - `beta_managed_agents_user_message_event_params: object { content, type }` Parameters for sending a user message to the session. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Array of content blocks for the user message. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `type: "user.message"` - `"user.message"` ### Beta Managed Agents User Tool Confirmation Event - `beta_managed_agents_user_tool_confirmation_event: object { id, result, tool_use_id, 4 more }` A tool confirmation event that approves or denies a pending tool execution. - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` UserToolConfirmationResult enum - `"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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_confirmation"` - `"user.tool_confirmation"` - `deny_message: optional string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. ### Beta Managed Agents User Tool Confirmation Event Params - `beta_managed_agents_user_tool_confirmation_event_params: object { result, tool_use_id, type, deny_message }` Parameters for confirming or denying a tool execution request. - `result: "allow" or "deny"` UserToolConfirmationResult enum - `"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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_confirmation"` - `"user.tool_confirmation"` - `deny_message: optional string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. ### Beta Managed Agents User Tool Result Event Params - `beta_managed_agents_user_tool_result_event_params: object { tool_use_id, type, content, is_error }` 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. - `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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_result"` - `"user.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. # Resources ## Add Session Resource `$ ant beta:sessions:resources add` **post** `/v1/sessions/{session_id}/resources` Add Session Resource ### Parameters - `--session-id: string` Path param: Path parameter session_id - `--file-id: string` Body param: ID of a previously uploaded file. - `--type: "file"` Body param - `--mount-path: optional string` Body param: Mount path in the container. Defaults to `/mnt/session/uploads/`. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_file_resource: object { id, created_at, file_id, 3 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `file_id: string` - `mount_path: string` - `type: "file"` - `"file"` - `updated_at: string` A timestamp in RFC 3339 format ### Example ```cli ant beta:sessions:resources add \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 \ --file-id file_011CNha8iCJcU1wXNR6q4V8w \ --type file ``` #### Response ```json { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" } ``` ## List Session Resources `$ ant beta:sessions:resources list` **get** `/v1/sessions/{session_id}/resources` List Session Resources ### Parameters - `--session-id: string` Path param: Path parameter session_id - `--limit: optional number` Query param: Maximum number of resources to return per page (max 1000). If omitted, returns all resources. - `--page: optional string` Query param: Opaque cursor from a previous response's next_page field. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaManagedAgentsListSessionResources: object { data, next_page }` Paginated list of resources attached to a session. - `data: array of BetaManagedAgentsSessionResource` Resources for the session, ordered by `created_at`. - `beta_managed_agents_github_repository_resource: object { id, created_at, mount_path, 4 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `mount_path: string` - `type: "github_repository"` - `"github_repository"` - `updated_at: string` A timestamp in RFC 3339 format - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout` - `beta_managed_agents_branch_checkout: object { name, type }` - `name: string` Branch name to check out. - `type: "branch"` - `"branch"` - `beta_managed_agents_commit_checkout: object { sha, type }` - `sha: string` Full commit SHA to check out. - `type: "commit"` - `"commit"` - `beta_managed_agents_file_resource: object { id, created_at, file_id, 3 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `file_id: string` - `mount_path: string` - `type: "file"` - `"file"` - `updated_at: string` A timestamp in RFC 3339 format - `beta_managed_agents_memory_store_resource: object { memory_store_id, type, access, 4 more }` A memory store attached to an agent session. - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `type: "memory_store"` - `"memory_store"` - `access: optional "read_write" or "read_only"` Access mode for an attached memory store. - `"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` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `mount_path: optional string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `name: optional string` 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` Opaque cursor for the next page. Null when no more results. ### Example ```cli ant beta:sessions:resources list \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 ``` #### Response ```json { "data": [ { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "created_at": "2026-03-15T10:00:00Z", "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "mount_path": "/uploads/receipt.pdf", "type": "file", "updated_at": "2026-03-15T10:00:00Z" }, { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Session Resource `$ ant beta:sessions:resources retrieve` **get** `/v1/sessions/{session_id}/resources/{resource_id}` Get Session Resource ### Parameters - `--session-id: string` Path param: Path parameter session_id - `--resource-id: string` Path param: Path parameter resource_id - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaSessionResourceGetResponse: BetaManagedAgentsGitHubRepositoryResource or BetaManagedAgentsFileResource or BetaManagedAgentsMemoryStoreResource` The requested session resource. - `beta_managed_agents_github_repository_resource: object { id, created_at, mount_path, 4 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `mount_path: string` - `type: "github_repository"` - `"github_repository"` - `updated_at: string` A timestamp in RFC 3339 format - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout` - `beta_managed_agents_branch_checkout: object { name, type }` - `name: string` Branch name to check out. - `type: "branch"` - `"branch"` - `beta_managed_agents_commit_checkout: object { sha, type }` - `sha: string` Full commit SHA to check out. - `type: "commit"` - `"commit"` - `beta_managed_agents_file_resource: object { id, created_at, file_id, 3 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `file_id: string` - `mount_path: string` - `type: "file"` - `"file"` - `updated_at: string` A timestamp in RFC 3339 format - `beta_managed_agents_memory_store_resource: object { memory_store_id, type, access, 4 more }` A memory store attached to an agent session. - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `type: "memory_store"` - `"memory_store"` - `access: optional "read_write" or "read_only"` Access mode for an attached memory store. - `"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` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `mount_path: optional string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `name: optional string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. ### Example ```cli ant beta:sessions:resources retrieve \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 \ --resource-id sesrsc_011CZkZBJq5dWxk9fVLNcPht ``` #### Response ```json { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ``` ## Update Session Resource `$ ant beta:sessions:resources update` **post** `/v1/sessions/{session_id}/resources/{resource_id}` Update Session Resource ### Parameters - `--session-id: string` Path param: Path parameter session_id - `--resource-id: string` Path param: Path parameter resource_id - `--authorization-token: string` Body param: New authorization token for the resource. Currently only `github_repository` resources support token rotation. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaSessionResourceUpdateResponse: BetaManagedAgentsGitHubRepositoryResource or BetaManagedAgentsFileResource or BetaManagedAgentsMemoryStoreResource` The updated session resource. - `beta_managed_agents_github_repository_resource: object { id, created_at, mount_path, 4 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `mount_path: string` - `type: "github_repository"` - `"github_repository"` - `updated_at: string` A timestamp in RFC 3339 format - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout` - `beta_managed_agents_branch_checkout: object { name, type }` - `name: string` Branch name to check out. - `type: "branch"` - `"branch"` - `beta_managed_agents_commit_checkout: object { sha, type }` - `sha: string` Full commit SHA to check out. - `type: "commit"` - `"commit"` - `beta_managed_agents_file_resource: object { id, created_at, file_id, 3 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `file_id: string` - `mount_path: string` - `type: "file"` - `"file"` - `updated_at: string` A timestamp in RFC 3339 format - `beta_managed_agents_memory_store_resource: object { memory_store_id, type, access, 4 more }` A memory store attached to an agent session. - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `type: "memory_store"` - `"memory_store"` - `access: optional "read_write" or "read_only"` Access mode for an attached memory store. - `"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` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `mount_path: optional string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `name: optional string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. ### Example ```cli ant beta:sessions:resources update \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 \ --resource-id sesrsc_011CZkZBJq5dWxk9fVLNcPht \ --authorization-token ghp_exampletoken ``` #### Response ```json { "id": "sesrsc_011CZkZCKr6eXyl0gWMOdQiu", "created_at": "2026-03-15T10:00:00Z", "mount_path": "/workspace/example-repo", "type": "github_repository", "updated_at": "2026-03-15T10:00:00Z", "url": "https://github.com/example-org/example-repo", "checkout": { "name": "main", "type": "branch" } } ``` ## Delete Session Resource `$ ant beta:sessions:resources delete` **delete** `/v1/sessions/{session_id}/resources/{resource_id}` Delete Session Resource ### Parameters - `--session-id: string` Path param: Path parameter session_id - `--resource-id: string` Path param: Path parameter resource_id - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_delete_session_resource: object { id, type }` Confirmation of resource deletion. - `id: string` - `type: "session_resource_deleted"` - `"session_resource_deleted"` ### Example ```cli ant beta:sessions:resources delete \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 \ --resource-id sesrsc_011CZkZBJq5dWxk9fVLNcPht ``` #### Response ```json { "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht", "type": "session_resource_deleted" } ``` ## Domain Types ### Beta Managed Agents Delete Session Resource - `beta_managed_agents_delete_session_resource: object { id, type }` Confirmation of resource deletion. - `id: string` - `type: "session_resource_deleted"` - `"session_resource_deleted"` ### Beta Managed Agents File Resource - `beta_managed_agents_file_resource: object { id, created_at, file_id, 3 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `file_id: string` - `mount_path: string` - `type: "file"` - `"file"` - `updated_at: string` A timestamp in RFC 3339 format ### Beta Managed Agents GitHub Repository Resource - `beta_managed_agents_github_repository_resource: object { id, created_at, mount_path, 4 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `mount_path: string` - `type: "github_repository"` - `"github_repository"` - `updated_at: string` A timestamp in RFC 3339 format - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout` - `beta_managed_agents_branch_checkout: object { name, type }` - `name: string` Branch name to check out. - `type: "branch"` - `"branch"` - `beta_managed_agents_commit_checkout: object { sha, type }` - `sha: string` Full commit SHA to check out. - `type: "commit"` - `"commit"` ### Beta Managed Agents Memory Store Resource - `beta_managed_agents_memory_store_resource: object { memory_store_id, type, access, 4 more }` A memory store attached to an agent session. - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `type: "memory_store"` - `"memory_store"` - `access: optional "read_write" or "read_only"` Access mode for an attached memory store. - `"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` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `mount_path: optional string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `name: optional string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. ### Beta Managed Agents Session Resource - `beta_managed_agents_session_resource: BetaManagedAgentsGitHubRepositoryResource or BetaManagedAgentsFileResource or BetaManagedAgentsMemoryStoreResource` A memory store attached to an agent session. - `beta_managed_agents_github_repository_resource: object { id, created_at, mount_path, 4 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `mount_path: string` - `type: "github_repository"` - `"github_repository"` - `updated_at: string` A timestamp in RFC 3339 format - `url: string` - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout` - `beta_managed_agents_branch_checkout: object { name, type }` - `name: string` Branch name to check out. - `type: "branch"` - `"branch"` - `beta_managed_agents_commit_checkout: object { sha, type }` - `sha: string` Full commit SHA to check out. - `type: "commit"` - `"commit"` - `beta_managed_agents_file_resource: object { id, created_at, file_id, 3 more }` - `id: string` - `created_at: string` A timestamp in RFC 3339 format - `file_id: string` - `mount_path: string` - `type: "file"` - `"file"` - `updated_at: string` A timestamp in RFC 3339 format - `beta_managed_agents_memory_store_resource: object { memory_store_id, type, access, 4 more }` A memory store attached to an agent session. - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `type: "memory_store"` - `"memory_store"` - `access: optional "read_write" or "read_only"` Access mode for an attached memory store. - `"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` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `mount_path: optional string` Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - `name: optional string` Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. # Threads ## List Session Threads `$ ant beta:sessions:threads list` **get** `/v1/sessions/{session_id}/threads` List Session Threads ### Parameters - `--session-id: string` Path param: Path parameter session_id - `--limit: optional number` Query param: Maximum results per page. Defaults to 1000. - `--page: optional string` Query param: Opaque pagination cursor from a previous response's next_page. Forward-only. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaManagedAgentsListSessionThreads: object { data, next_page }` Paginated list of threads within a `session`. - `data: optional array of BetaManagedAgentsSessionThread` Threads in the session, primary first then children in spawn order. - `id: string` Unique identifier for this thread. - `agent: object { id, description, mcp_servers, 7 more }` Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `parent_thread_id: string` Parent thread that spawned this thread. Null for the primary thread. - `session_id: string` The session this thread belongs to. - `stats: object { active_seconds, duration_seconds, startup_seconds }` Timing statistics for a session thread. - `active_seconds: optional number` Cumulative time in seconds the thread spent actively running. Excludes idle time. - `duration_seconds: optional number` Elapsed time since thread creation in seconds. For archived threads, frozen at the final update. - `startup_seconds: optional number` Time in seconds for the thread to begin running. Zero for child threads, which start immediately. - `status: "running" or "idle" or "rescheduling" or "terminated"` SessionThreadStatus enum - `"running"` - `"idle"` - `"rescheduling"` - `"terminated"` - `type: "session_thread"` - `"session_thread"` - `updated_at: string` A timestamp in RFC 3339 format - `usage: object { cache_creation, cache_read_input_tokens, input_tokens, output_tokens }` Cumulative token usage for a session thread across all turns. - `cache_creation: optional object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Prompt-cache creation token usage broken down by cache lifetime. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. - `input_tokens: optional number` Total input tokens consumed across all turns. - `output_tokens: optional number` Total output tokens generated across all turns. - `next_page: optional string` Opaque cursor for the next page. Null when no more results. ### Example ```cli ant beta:sessions:threads list \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 ``` #### Response ```json { "data": [ { "id": "sthr_011CZkZVWa6oIjw0rgXZpnBt", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "parent_thread_id": null, "session_id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "stats": { "active_seconds": 0, "duration_seconds": 0, "startup_seconds": 0 }, "status": "idle", "type": "session_thread", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Session Thread `$ ant beta:sessions:threads retrieve` **get** `/v1/sessions/{session_id}/threads/{thread_id}` Get Session Thread ### Parameters - `--session-id: string` Path param: Path parameter session_id - `--thread-id: string` Path param: Path parameter thread_id - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_session_thread: object { id, agent, archived_at, 8 more }` An execution thread within a `session`. Each session has one primary thread plus zero or more child threads spawned by the coordinator. - `id: string` Unique identifier for this thread. - `agent: object { id, description, mcp_servers, 7 more }` Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `parent_thread_id: string` Parent thread that spawned this thread. Null for the primary thread. - `session_id: string` The session this thread belongs to. - `stats: object { active_seconds, duration_seconds, startup_seconds }` Timing statistics for a session thread. - `active_seconds: optional number` Cumulative time in seconds the thread spent actively running. Excludes idle time. - `duration_seconds: optional number` Elapsed time since thread creation in seconds. For archived threads, frozen at the final update. - `startup_seconds: optional number` Time in seconds for the thread to begin running. Zero for child threads, which start immediately. - `status: "running" or "idle" or "rescheduling" or "terminated"` SessionThreadStatus enum - `"running"` - `"idle"` - `"rescheduling"` - `"terminated"` - `type: "session_thread"` - `"session_thread"` - `updated_at: string` A timestamp in RFC 3339 format - `usage: object { cache_creation, cache_read_input_tokens, input_tokens, output_tokens }` Cumulative token usage for a session thread across all turns. - `cache_creation: optional object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Prompt-cache creation token usage broken down by cache lifetime. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. - `input_tokens: optional number` Total input tokens consumed across all turns. - `output_tokens: optional number` Total output tokens generated across all turns. ### Example ```cli ant beta:sessions:threads retrieve \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 \ --thread-id sthr_011CZkZVWa6oIjw0rgXZpnBt ``` #### Response ```json { "id": "sthr_011CZkZVWa6oIjw0rgXZpnBt", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "parent_thread_id": null, "session_id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "stats": { "active_seconds": 0, "duration_seconds": 0, "startup_seconds": 0 }, "status": "idle", "type": "session_thread", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } ``` ## Archive Session Thread `$ ant beta:sessions:threads archive` **post** `/v1/sessions/{session_id}/threads/{thread_id}/archive` Archive Session Thread ### Parameters - `--session-id: string` Path param: Path parameter session_id - `--thread-id: string` Path param: Path parameter thread_id - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_session_thread: object { id, agent, archived_at, 8 more }` An execution thread within a `session`. Each session has one primary thread plus zero or more child threads spawned by the coordinator. - `id: string` Unique identifier for this thread. - `agent: object { id, description, mcp_servers, 7 more }` Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `parent_thread_id: string` Parent thread that spawned this thread. Null for the primary thread. - `session_id: string` The session this thread belongs to. - `stats: object { active_seconds, duration_seconds, startup_seconds }` Timing statistics for a session thread. - `active_seconds: optional number` Cumulative time in seconds the thread spent actively running. Excludes idle time. - `duration_seconds: optional number` Elapsed time since thread creation in seconds. For archived threads, frozen at the final update. - `startup_seconds: optional number` Time in seconds for the thread to begin running. Zero for child threads, which start immediately. - `status: "running" or "idle" or "rescheduling" or "terminated"` SessionThreadStatus enum - `"running"` - `"idle"` - `"rescheduling"` - `"terminated"` - `type: "session_thread"` - `"session_thread"` - `updated_at: string` A timestamp in RFC 3339 format - `usage: object { cache_creation, cache_read_input_tokens, input_tokens, output_tokens }` Cumulative token usage for a session thread across all turns. - `cache_creation: optional object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Prompt-cache creation token usage broken down by cache lifetime. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. - `input_tokens: optional number` Total input tokens consumed across all turns. - `output_tokens: optional number` Total output tokens generated across all turns. ### Example ```cli ant beta:sessions:threads archive \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 \ --thread-id sthr_011CZkZVWa6oIjw0rgXZpnBt ``` #### Response ```json { "id": "sthr_011CZkZVWa6oIjw0rgXZpnBt", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "description": "A focused research subagent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "model": { "id": "claude-sonnet-4-6", "speed": "standard" }, "name": "Researcher", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" } ], "system": "You are a research subagent that gathers and summarises sources for the coordinating agent.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" } } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "version": 1 }, "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "parent_thread_id": null, "session_id": "sesn_011CZkZAtmR3yMPDzynEDxu7", "stats": { "active_seconds": 0, "duration_seconds": 0, "startup_seconds": 0 }, "status": "idle", "type": "session_thread", "updated_at": "2026-03-15T10:00:00Z", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_read_input_tokens": 0, "input_tokens": 0, "output_tokens": 0 } } ``` ## Domain Types ### Beta Managed Agents Session Thread - `beta_managed_agents_session_thread: object { id, agent, archived_at, 8 more }` An execution thread within a `session`. Each session has one primary thread plus zero or more child threads spawned by the coordinator. - `id: string` Unique identifier for this thread. - `agent: object { id, description, mcp_servers, 7 more }` Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `parent_thread_id: string` Parent thread that spawned this thread. Null for the primary thread. - `session_id: string` The session this thread belongs to. - `stats: object { active_seconds, duration_seconds, startup_seconds }` Timing statistics for a session thread. - `active_seconds: optional number` Cumulative time in seconds the thread spent actively running. Excludes idle time. - `duration_seconds: optional number` Elapsed time since thread creation in seconds. For archived threads, frozen at the final update. - `startup_seconds: optional number` Time in seconds for the thread to begin running. Zero for child threads, which start immediately. - `status: "running" or "idle" or "rescheduling" or "terminated"` SessionThreadStatus enum - `"running"` - `"idle"` - `"rescheduling"` - `"terminated"` - `type: "session_thread"` - `"session_thread"` - `updated_at: string` A timestamp in RFC 3339 format - `usage: object { cache_creation, cache_read_input_tokens, input_tokens, output_tokens }` Cumulative token usage for a session thread across all turns. - `cache_creation: optional object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Prompt-cache creation token usage broken down by cache lifetime. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. - `input_tokens: optional number` Total input tokens consumed across all turns. - `output_tokens: optional number` Total output tokens generated across all turns. ### Beta Managed Agents Session Thread Stats - `beta_managed_agents_session_thread_stats: object { active_seconds, duration_seconds, startup_seconds }` Timing statistics for a session thread. - `active_seconds: optional number` Cumulative time in seconds the thread spent actively running. Excludes idle time. - `duration_seconds: optional number` Elapsed time since thread creation in seconds. For archived threads, frozen at the final update. - `startup_seconds: optional number` Time in seconds for the thread to begin running. Zero for child threads, which start immediately. ### Beta Managed Agents Session Thread Status - `beta_managed_agents_session_thread_status: "running" or "idle" or "rescheduling" or "terminated"` SessionThreadStatus enum - `"running"` - `"idle"` - `"rescheduling"` - `"terminated"` ### Beta Managed Agents Session Thread Usage - `beta_managed_agents_session_thread_usage: object { cache_creation, cache_read_input_tokens, input_tokens, output_tokens }` Cumulative token usage for a session thread across all turns. - `cache_creation: optional object { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }` Prompt-cache creation token usage broken down by cache lifetime. - `ephemeral_1h_input_tokens: optional number` Tokens used to create 1-hour ephemeral cache entries. - `ephemeral_5m_input_tokens: optional number` Tokens used to create 5-minute ephemeral cache entries. - `cache_read_input_tokens: optional number` Total tokens read from prompt cache. - `input_tokens: optional number` Total input tokens consumed across all turns. - `output_tokens: optional number` Total output tokens generated across all turns. ### Beta Managed Agents Stream Session Thread Events - `beta_managed_agents_stream_session_thread_events: BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 30 more` Server-sent event in a single thread's stream. - `beta_managed_agents_user_message_event: object { id, content, type, processed_at }` A user message event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Array of content blocks comprising the user message. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `type: "user.message"` - `"user.message"` - `processed_at: optional string` A timestamp in RFC 3339 format - `beta_managed_agents_user_interrupt_event: object { id, type, processed_at, session_thread_id }` An interrupt event that pauses agent execution and returns control to the user. - `id: string` Unique identifier for this event. - `type: "user.interrupt"` - `"user.interrupt"` - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `beta_managed_agents_user_tool_confirmation_event: object { id, result, tool_use_id, 4 more }` A tool confirmation event that approves or denies a pending tool execution. - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` UserToolConfirmationResult enum - `"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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_confirmation"` - `"user.tool_confirmation"` - `deny_message: optional string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `beta_managed_agents_user_custom_tool_result_event: object { id, custom_tool_use_id, type, 4 more }` Event sent by the client providing the result of a custom tool execution. - `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, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.custom_tool_result"` - `"user.custom_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `beta_managed_agents_agent_custom_tool_use_event: object { id, input, name, 3 more }` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the custom tool being called. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.custom_tool_use"` - `"agent.custom_tool_use"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - `beta_managed_agents_agent_message_event: object { id, content, processed_at, type }` An agent response event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `text: string` The text content. - `type: "text"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.message"` - `"agent.message"` - `beta_managed_agents_agent_thinking_event: object { id, processed_at, type }` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thinking"` - `"agent.thinking"` - `beta_managed_agents_agent_mcp_tool_use_event: object { id, input, mcp_server_name, 5 more }` Event emitted when the agent invokes a tool provided by an MCP server. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_use"` - `"agent.mcp_tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `beta_managed_agents_agent_mcp_tool_result_event: object { id, mcp_tool_use_id, processed_at, 3 more }` Event representing the result of an MCP tool execution. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_result"` - `"agent.mcp_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_agent_tool_use_event: object { id, input, name, 4 more }` Event emitted when the agent invokes a built-in agent tool. - `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` A timestamp in RFC 3339 format - `type: "agent.tool_use"` - `"agent.tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `beta_managed_agents_agent_tool_result_event: object { id, processed_at, tool_use_id, 3 more }` Event representing the result of an agent tool execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `tool_use_id: string` The id of the `agent.tool_use` event this result corresponds to. - `type: "agent.tool_result"` - `"agent.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_agent_thread_message_received_event: object { id, content, from_session_thread_id, 3 more }` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `from_session_thread_id: string` Public `sthr_` ID of the thread that sent the message. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_message_received"` - `"agent.thread_message_received"` - `from_agent_name: optional string` Name of the callable agent this message came from. Absent when received from the primary agent. - `beta_managed_agents_agent_thread_message_sent_event: object { id, content, processed_at, 3 more }` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `processed_at: string` A timestamp in RFC 3339 format - `to_session_thread_id: string` Public `sthr_` ID of the thread the message was sent to. - `type: "agent.thread_message_sent"` - `"agent.thread_message_sent"` - `to_agent_name: optional string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `beta_managed_agents_agent_thread_context_compacted_event: object { id, processed_at, type }` Indicates that context compaction (summarization) occurred during the session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_context_compacted"` - `"agent.thread_context_compacted"` - `beta_managed_agents_session_error_event: object { id, error, processed_at, type }` An error event indicating a problem occurred during session execution. - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 4 more` 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. - `beta_managed_agents_unknown_error: object { message, retry_status, type }` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "unknown_error"` - `"unknown_error"` - `beta_managed_agents_model_overloaded_error: object { message, retry_status, type }` The model is currently overloaded. Emitted after automatic retries are exhausted. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_overloaded_error"` - `"model_overloaded_error"` - `beta_managed_agents_model_rate_limited_error: object { message, retry_status, type }` The model request was rate-limited. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_rate_limited_error"` - `"model_rate_limited_error"` - `beta_managed_agents_model_request_failed_error: object { message, retry_status, type }` A model request failed for a reason other than overload or rate-limiting. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_request_failed_error"` - `"model_request_failed_error"` - `beta_managed_agents_mcp_connection_failed_error: object { mcp_server_name, message, retry_status, type }` Failed to connect to an MCP server. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_connection_failed_error"` - `"mcp_connection_failed_error"` - `beta_managed_agents_mcp_authentication_failed_error: object { mcp_server_name, message, retry_status, type }` Authentication to an MCP server failed. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_authentication_failed_error"` - `"mcp_authentication_failed_error"` - `beta_managed_agents_billing_error: object { message, retry_status, type }` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "billing_error"` - `"billing_error"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.error"` - `"session.error"` - `beta_managed_agents_session_status_rescheduled_event: object { id, processed_at, type }` Indicates the session is recovering from an error state and is rescheduled for execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_rescheduled"` - `"session.status_rescheduled"` - `beta_managed_agents_session_status_running_event: object { id, processed_at, type }` Indicates the session is actively running and the agent is working. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_running"` - `"session.status_running"` - `beta_managed_agents_session_status_idle_event: object { id, processed_at, stop_reason, type }` Indicates the agent has paused and is awaiting user input. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `type: "end_turn"` - `"end_turn"` - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `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. - `type: "requires_action"` - `"requires_action"` - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "retries_exhausted"` - `"retries_exhausted"` - `type: "session.status_idle"` - `"session.status_idle"` - `beta_managed_agents_session_status_terminated_event: object { id, processed_at, type }` Indicates the session has terminated, either due to an error or completion. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_terminated"` - `"session.status_terminated"` - `beta_managed_agents_session_thread_created_event: object { id, agent_name, processed_at, 2 more }` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the callable agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public `sthr_` ID of the newly created thread. - `type: "session.thread_created"` - `"session.thread_created"` - `beta_managed_agents_span_outcome_evaluation_start_event: object { id, iteration, outcome_id, 2 more }` Emitted when an outcome evaluation cycle begins. - `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. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_start"` - `"span.outcome_evaluation_start"` - `beta_managed_agents_span_outcome_evaluation_end_event: object { id, explanation, iteration, 6 more }` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `id: string` Unique identifier for this event. - `explanation: string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `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` A timestamp in RFC 3339 format - `result: string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `type: "span.outcome_evaluation_end"` - `"span.outcome_evaluation_end"` - `usage: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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"` - `beta_managed_agents_span_model_request_start_event: object { id, processed_at, type }` Emitted when a model request is initiated by the agent. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_start"` - `"span.model_request_start"` - `beta_managed_agents_span_model_request_end_event: object { id, is_error, model_request_start_id, 3 more }` Emitted when a model request completes. - `id: string` Unique identifier for this event. - `is_error: boolean` 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: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_end"` - `"span.model_request_end"` - `beta_managed_agents_span_outcome_evaluation_ongoing_event: object { id, iteration, outcome_id, 2 more }` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_ongoing"` - `"span.outcome_evaluation_ongoing"` - `beta_managed_agents_user_define_outcome_event: object { id, description, max_iterations, 4 more }` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `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` A timestamp in RFC 3339 format - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` Rubric for grading the quality of an outcome. - `beta_managed_agents_file_rubric: object { file_id, type }` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` - `beta_managed_agents_text_rubric: object { content, type }` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `type: "text"` - `"text"` - `type: "user.define_outcome"` - `"user.define_outcome"` - `beta_managed_agents_session_deleted_event: object { id, processed_at, type }` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.deleted"` - `"session.deleted"` - `beta_managed_agents_session_thread_status_running_event: object { id, agent_name, processed_at, 2 more }` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that started running. - `type: "session.thread_status_running"` - `"session.thread_status_running"` - `beta_managed_agents_session_thread_status_idle_event: object { id, agent_name, processed_at, 3 more }` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that went idle. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "session.thread_status_idle"` - `"session.thread_status_idle"` - `beta_managed_agents_session_thread_status_terminated_event: object { id, agent_name, processed_at, 2 more }` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that terminated. - `type: "session.thread_status_terminated"` - `"session.thread_status_terminated"` - `beta_managed_agents_user_tool_result_event: object { id, tool_use_id, type, 4 more }` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `id: string` Unique identifier for this event. - `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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_result"` - `"user.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - `beta_managed_agents_session_thread_status_rescheduled_event: object { id, agent_name, processed_at, 2 more }` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that is retrying. - `type: "session.thread_status_rescheduled"` - `"session.thread_status_rescheduled"` - `beta_managed_agents_session_updated_event: object { id, processed_at, type, 3 more }` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.updated"` - `"session.updated"` - `agent: optional object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` - `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` The session's new title. Present only when the update changed it. # Events ## List Session Thread Events `$ ant beta:sessions:threads:events list` **get** `/v1/sessions/{session_id}/threads/{thread_id}/events` List Session Thread Events ### Parameters - `--session-id: string` Path param: Path parameter session_id - `--thread-id: string` Path param: Path parameter thread_id - `--limit: optional number` Query param: Query parameter for limit - `--page: optional string` Query param: Query parameter for page - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaManagedAgentsListSessionThreadEvents: object { data, next_page }` Paginated list of events for a single thread within a `session`. - `data: optional array of BetaManagedAgentsSessionEvent` Events for the thread, ordered by `created_at`. - `beta_managed_agents_user_message_event: object { id, content, type, processed_at }` A user message event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Array of content blocks comprising the user message. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `type: "user.message"` - `"user.message"` - `processed_at: optional string` A timestamp in RFC 3339 format - `beta_managed_agents_user_interrupt_event: object { id, type, processed_at, session_thread_id }` An interrupt event that pauses agent execution and returns control to the user. - `id: string` Unique identifier for this event. - `type: "user.interrupt"` - `"user.interrupt"` - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `beta_managed_agents_user_tool_confirmation_event: object { id, result, tool_use_id, 4 more }` A tool confirmation event that approves or denies a pending tool execution. - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` UserToolConfirmationResult enum - `"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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_confirmation"` - `"user.tool_confirmation"` - `deny_message: optional string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `beta_managed_agents_user_custom_tool_result_event: object { id, custom_tool_use_id, type, 4 more }` Event sent by the client providing the result of a custom tool execution. - `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, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.custom_tool_result"` - `"user.custom_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `beta_managed_agents_agent_custom_tool_use_event: object { id, input, name, 3 more }` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the custom tool being called. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.custom_tool_use"` - `"agent.custom_tool_use"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - `beta_managed_agents_agent_message_event: object { id, content, processed_at, type }` An agent response event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `text: string` The text content. - `type: "text"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.message"` - `"agent.message"` - `beta_managed_agents_agent_thinking_event: object { id, processed_at, type }` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thinking"` - `"agent.thinking"` - `beta_managed_agents_agent_mcp_tool_use_event: object { id, input, mcp_server_name, 5 more }` Event emitted when the agent invokes a tool provided by an MCP server. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_use"` - `"agent.mcp_tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `beta_managed_agents_agent_mcp_tool_result_event: object { id, mcp_tool_use_id, processed_at, 3 more }` Event representing the result of an MCP tool execution. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_result"` - `"agent.mcp_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_agent_tool_use_event: object { id, input, name, 4 more }` Event emitted when the agent invokes a built-in agent tool. - `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` A timestamp in RFC 3339 format - `type: "agent.tool_use"` - `"agent.tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `beta_managed_agents_agent_tool_result_event: object { id, processed_at, tool_use_id, 3 more }` Event representing the result of an agent tool execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `tool_use_id: string` The id of the `agent.tool_use` event this result corresponds to. - `type: "agent.tool_result"` - `"agent.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_agent_thread_message_received_event: object { id, content, from_session_thread_id, 3 more }` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `from_session_thread_id: string` Public `sthr_` ID of the thread that sent the message. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_message_received"` - `"agent.thread_message_received"` - `from_agent_name: optional string` Name of the callable agent this message came from. Absent when received from the primary agent. - `beta_managed_agents_agent_thread_message_sent_event: object { id, content, processed_at, 3 more }` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `processed_at: string` A timestamp in RFC 3339 format - `to_session_thread_id: string` Public `sthr_` ID of the thread the message was sent to. - `type: "agent.thread_message_sent"` - `"agent.thread_message_sent"` - `to_agent_name: optional string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `beta_managed_agents_agent_thread_context_compacted_event: object { id, processed_at, type }` Indicates that context compaction (summarization) occurred during the session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_context_compacted"` - `"agent.thread_context_compacted"` - `beta_managed_agents_session_error_event: object { id, error, processed_at, type }` An error event indicating a problem occurred during session execution. - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 4 more` 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. - `beta_managed_agents_unknown_error: object { message, retry_status, type }` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "unknown_error"` - `"unknown_error"` - `beta_managed_agents_model_overloaded_error: object { message, retry_status, type }` The model is currently overloaded. Emitted after automatic retries are exhausted. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_overloaded_error"` - `"model_overloaded_error"` - `beta_managed_agents_model_rate_limited_error: object { message, retry_status, type }` The model request was rate-limited. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_rate_limited_error"` - `"model_rate_limited_error"` - `beta_managed_agents_model_request_failed_error: object { message, retry_status, type }` A model request failed for a reason other than overload or rate-limiting. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_request_failed_error"` - `"model_request_failed_error"` - `beta_managed_agents_mcp_connection_failed_error: object { mcp_server_name, message, retry_status, type }` Failed to connect to an MCP server. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_connection_failed_error"` - `"mcp_connection_failed_error"` - `beta_managed_agents_mcp_authentication_failed_error: object { mcp_server_name, message, retry_status, type }` Authentication to an MCP server failed. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_authentication_failed_error"` - `"mcp_authentication_failed_error"` - `beta_managed_agents_billing_error: object { message, retry_status, type }` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "billing_error"` - `"billing_error"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.error"` - `"session.error"` - `beta_managed_agents_session_status_rescheduled_event: object { id, processed_at, type }` Indicates the session is recovering from an error state and is rescheduled for execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_rescheduled"` - `"session.status_rescheduled"` - `beta_managed_agents_session_status_running_event: object { id, processed_at, type }` Indicates the session is actively running and the agent is working. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_running"` - `"session.status_running"` - `beta_managed_agents_session_status_idle_event: object { id, processed_at, stop_reason, type }` Indicates the agent has paused and is awaiting user input. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `type: "end_turn"` - `"end_turn"` - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `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. - `type: "requires_action"` - `"requires_action"` - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "retries_exhausted"` - `"retries_exhausted"` - `type: "session.status_idle"` - `"session.status_idle"` - `beta_managed_agents_session_status_terminated_event: object { id, processed_at, type }` Indicates the session has terminated, either due to an error or completion. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_terminated"` - `"session.status_terminated"` - `beta_managed_agents_session_thread_created_event: object { id, agent_name, processed_at, 2 more }` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the callable agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public `sthr_` ID of the newly created thread. - `type: "session.thread_created"` - `"session.thread_created"` - `beta_managed_agents_span_outcome_evaluation_start_event: object { id, iteration, outcome_id, 2 more }` Emitted when an outcome evaluation cycle begins. - `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. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_start"` - `"span.outcome_evaluation_start"` - `beta_managed_agents_span_outcome_evaluation_end_event: object { id, explanation, iteration, 6 more }` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `id: string` Unique identifier for this event. - `explanation: string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `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` A timestamp in RFC 3339 format - `result: string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `type: "span.outcome_evaluation_end"` - `"span.outcome_evaluation_end"` - `usage: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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"` - `beta_managed_agents_span_model_request_start_event: object { id, processed_at, type }` Emitted when a model request is initiated by the agent. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_start"` - `"span.model_request_start"` - `beta_managed_agents_span_model_request_end_event: object { id, is_error, model_request_start_id, 3 more }` Emitted when a model request completes. - `id: string` Unique identifier for this event. - `is_error: boolean` 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: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_end"` - `"span.model_request_end"` - `beta_managed_agents_span_outcome_evaluation_ongoing_event: object { id, iteration, outcome_id, 2 more }` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_ongoing"` - `"span.outcome_evaluation_ongoing"` - `beta_managed_agents_user_define_outcome_event: object { id, description, max_iterations, 4 more }` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `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` A timestamp in RFC 3339 format - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` Rubric for grading the quality of an outcome. - `beta_managed_agents_file_rubric: object { file_id, type }` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` - `beta_managed_agents_text_rubric: object { content, type }` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `type: "text"` - `"text"` - `type: "user.define_outcome"` - `"user.define_outcome"` - `beta_managed_agents_session_deleted_event: object { id, processed_at, type }` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.deleted"` - `"session.deleted"` - `beta_managed_agents_session_thread_status_running_event: object { id, agent_name, processed_at, 2 more }` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that started running. - `type: "session.thread_status_running"` - `"session.thread_status_running"` - `beta_managed_agents_session_thread_status_idle_event: object { id, agent_name, processed_at, 3 more }` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that went idle. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "session.thread_status_idle"` - `"session.thread_status_idle"` - `beta_managed_agents_session_thread_status_terminated_event: object { id, agent_name, processed_at, 2 more }` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that terminated. - `type: "session.thread_status_terminated"` - `"session.thread_status_terminated"` - `beta_managed_agents_user_tool_result_event: object { id, tool_use_id, type, 4 more }` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `id: string` Unique identifier for this event. - `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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_result"` - `"user.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - `beta_managed_agents_session_thread_status_rescheduled_event: object { id, agent_name, processed_at, 2 more }` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that is retrying. - `type: "session.thread_status_rescheduled"` - `"session.thread_status_rescheduled"` - `beta_managed_agents_session_updated_event: object { id, processed_at, type, 3 more }` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.updated"` - `"session.updated"` - `agent: optional object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` - `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` The session's new title. Present only when the update changed it. - `next_page: optional string` Opaque cursor for the next page. Null when no more results. ### Example ```cli ant beta:sessions:threads:events list \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 \ --thread-id sthr_011CZkZVWa6oIjw0rgXZpnBt ``` #### Response ```json { "data": [ { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } ], "next_page": "next_page" } ``` ## Stream Session Thread Events `$ ant beta:sessions:threads:events stream` **get** `/v1/sessions/{session_id}/threads/{thread_id}/stream` Stream Session Thread Events ### Parameters - `--session-id: string` Path param: Path parameter session_id - `--thread-id: string` Path param: Path parameter thread_id - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_stream_session_thread_events: BetaManagedAgentsUserMessageEvent or BetaManagedAgentsUserInterruptEvent or BetaManagedAgentsUserToolConfirmationEvent or 30 more` Server-sent event in a single thread's stream. - `beta_managed_agents_user_message_event: object { id, content, type, processed_at }` A user message event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Array of content blocks comprising the user message. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource` Union type for image source variants. - `beta_managed_agents_base64_image_source: object { data, media_type, type }` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `beta_managed_agents_url_image_source: object { type, url }` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `beta_managed_agents_file_image_source: object { file_id, type }` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `beta_managed_agents_base64_document_source: object { data, media_type, type }` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `beta_managed_agents_plain_text_document_source: object { data, media_type, type }` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `beta_managed_agents_url_document_source: object { type, url }` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `beta_managed_agents_file_document_source: object { file_id, type }` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context: optional string` Additional context about the document for the model. - `title: optional string` The title of the document. - `type: "user.message"` - `"user.message"` - `processed_at: optional string` A timestamp in RFC 3339 format - `beta_managed_agents_user_interrupt_event: object { id, type, processed_at, session_thread_id }` An interrupt event that pauses agent execution and returns control to the user. - `id: string` Unique identifier for this event. - `type: "user.interrupt"` - `"user.interrupt"` - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - `beta_managed_agents_user_tool_confirmation_event: object { id, result, tool_use_id, 4 more }` A tool confirmation event that approves or denies a pending tool execution. - `id: string` Unique identifier for this event. - `result: "allow" or "deny"` UserToolConfirmationResult enum - `"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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_confirmation"` - `"user.tool_confirmation"` - `deny_message: optional string` Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - `beta_managed_agents_user_custom_tool_result_event: object { id, custom_tool_use_id, type, 4 more }` Event sent by the client providing the result of a custom tool execution. - `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, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.custom_tool_result"` - `"user.custom_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `citations: object { enabled }` Citation settings for a 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. - `text: string` The text content. - `type: "text"` - `"text"` - `source: string` The URL source of the search result. - `title: string` The title of the search result. - `type: "search_result"` - `"search_result"` - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - `beta_managed_agents_agent_custom_tool_use_event: object { id, input, name, 3 more }` Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. - `id: string` Unique identifier for this event. - `input: map[unknown]` Input parameters for the tool call. - `name: string` Name of the custom tool being called. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.custom_tool_use"` - `"agent.custom_tool_use"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - `beta_managed_agents_agent_message_event: object { id, content, processed_at, type }` An agent response event in the session conversation. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock` Array of text blocks comprising the agent response. - `text: string` The text content. - `type: "text"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.message"` - `"agent.message"` - `beta_managed_agents_agent_thinking_event: object { id, processed_at, type }` Indicates the agent is making forward progress via extended thinking. A progress signal, not a content carrier. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thinking"` - `"agent.thinking"` - `beta_managed_agents_agent_mcp_tool_use_event: object { id, input, mcp_server_name, 5 more }` Event emitted when the agent invokes a tool provided by an MCP server. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_use"` - `"agent.mcp_tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `beta_managed_agents_agent_mcp_tool_result_event: object { id, mcp_tool_use_id, processed_at, 3 more }` Event representing the result of an MCP tool execution. - `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` A timestamp in RFC 3339 format - `type: "agent.mcp_tool_result"` - `"agent.mcp_tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_agent_tool_use_event: object { id, input, name, 4 more }` Event emitted when the agent invokes a built-in agent tool. - `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` A timestamp in RFC 3339 format - `type: "agent.tool_use"` - `"agent.tool_use"` - `evaluated_permission: optional "allow" or "ask" or "deny"` AgentEvaluatedPermission enum - `"allow"` - `"ask"` - `"deny"` - `session_thread_id: optional string` When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - `beta_managed_agents_agent_tool_result_event: object { id, processed_at, tool_use_id, 3 more }` Event representing the result of an agent tool execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `tool_use_id: string` The id of the `agent.tool_use` event this result corresponds to. - `type: "agent.tool_result"` - `"agent.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `beta_managed_agents_agent_thread_message_received_event: object { id, content, from_session_thread_id, 3 more }` Delivery event written to the target thread's input stream when an agent-to-agent message arrives. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `from_session_thread_id: string` Public `sthr_` ID of the thread that sent the message. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_message_received"` - `"agent.thread_message_received"` - `from_agent_name: optional string` Name of the callable agent this message came from. Absent when received from the primary agent. - `beta_managed_agents_agent_thread_message_sent_event: object { id, content, processed_at, 3 more }` Observability event emitted to the sender's output stream when an agent-to-agent message is sent. - `id: string` Unique identifier for this event. - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock` Message content blocks. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `processed_at: string` A timestamp in RFC 3339 format - `to_session_thread_id: string` Public `sthr_` ID of the thread the message was sent to. - `type: "agent.thread_message_sent"` - `"agent.thread_message_sent"` - `to_agent_name: optional string` Name of the callable agent this message was sent to. Absent when sent to the primary agent. - `beta_managed_agents_agent_thread_context_compacted_event: object { id, processed_at, type }` Indicates that context compaction (summarization) occurred during the session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "agent.thread_context_compacted"` - `"agent.thread_context_compacted"` - `beta_managed_agents_session_error_event: object { id, error, processed_at, type }` An error event indicating a problem occurred during session execution. - `id: string` Unique identifier for this event. - `error: BetaManagedAgentsUnknownError or BetaManagedAgentsModelOverloadedError or BetaManagedAgentsModelRateLimitedError or 4 more` 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. - `beta_managed_agents_unknown_error: object { message, retry_status, type }` An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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"` - `"retrying"` - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `type: "exhausted"` - `"exhausted"` - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "terminal"` - `"terminal"` - `type: "unknown_error"` - `"unknown_error"` - `beta_managed_agents_model_overloaded_error: object { message, retry_status, type }` The model is currently overloaded. Emitted after automatic retries are exhausted. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_overloaded_error"` - `"model_overloaded_error"` - `beta_managed_agents_model_rate_limited_error: object { message, retry_status, type }` The model request was rate-limited. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_rate_limited_error"` - `"model_rate_limited_error"` - `beta_managed_agents_model_request_failed_error: object { message, retry_status, type }` A model request failed for a reason other than overload or rate-limiting. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "model_request_failed_error"` - `"model_request_failed_error"` - `beta_managed_agents_mcp_connection_failed_error: object { mcp_server_name, message, retry_status, type }` Failed to connect to an MCP server. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_connection_failed_error"` - `"mcp_connection_failed_error"` - `beta_managed_agents_mcp_authentication_failed_error: object { mcp_server_name, message, retry_status, type }` Authentication to an MCP server failed. - `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 in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "mcp_authentication_failed_error"` - `"mcp_authentication_failed_error"` - `beta_managed_agents_billing_error: object { message, retry_status, type }` The caller's organization or workspace cannot make model requests — out of credits or spend limit reached. Retrying with the same credentials will not succeed; the caller must resolve the billing state. - `message: string` Human-readable error description. - `retry_status: BetaManagedAgentsRetryStatusRetrying or BetaManagedAgentsRetryStatusExhausted or BetaManagedAgentsRetryStatusTerminal` What the client should do next in response to this error. - `beta_managed_agents_retry_status_retrying: object { type }` 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. - `beta_managed_agents_retry_status_exhausted: object { type }` This turn is dead; queued inputs are flushed and the session returns to idle. Client may send a new prompt. - `beta_managed_agents_retry_status_terminal: object { type }` The session encountered a terminal error and will transition to `terminated` state. - `type: "billing_error"` - `"billing_error"` - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.error"` - `"session.error"` - `beta_managed_agents_session_status_rescheduled_event: object { id, processed_at, type }` Indicates the session is recovering from an error state and is rescheduled for execution. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_rescheduled"` - `"session.status_rescheduled"` - `beta_managed_agents_session_status_running_event: object { id, processed_at, type }` Indicates the session is actively running and the agent is working. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_running"` - `"session.status_running"` - `beta_managed_agents_session_status_idle_event: object { id, processed_at, stop_reason, type }` Indicates the agent has paused and is awaiting user input. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `type: "end_turn"` - `"end_turn"` - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `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. - `type: "requires_action"` - `"requires_action"` - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "retries_exhausted"` - `"retries_exhausted"` - `type: "session.status_idle"` - `"session.status_idle"` - `beta_managed_agents_session_status_terminated_event: object { id, processed_at, type }` Indicates the session has terminated, either due to an error or completion. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.status_terminated"` - `"session.status_terminated"` - `beta_managed_agents_session_thread_created_event: object { id, agent_name, processed_at, 2 more }` Emitted when a subagent is spawned as a new thread. Written to the parent thread's output stream so clients observing the session see child creation. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the callable agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public `sthr_` ID of the newly created thread. - `type: "session.thread_created"` - `"session.thread_created"` - `beta_managed_agents_span_outcome_evaluation_start_event: object { id, iteration, outcome_id, 2 more }` Emitted when an outcome evaluation cycle begins. - `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. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_start"` - `"span.outcome_evaluation_start"` - `beta_managed_agents_span_outcome_evaluation_end_event: object { id, explanation, iteration, 6 more }` Emitted when an outcome evaluation cycle completes. Carries the verdict and aggregate token usage. A verdict of `needs_revision` means another evaluation cycle follows; `satisfied`, `max_iterations_reached`, `failed`, or `interrupted` are terminal — no further evaluation cycles follow. - `id: string` Unique identifier for this event. - `explanation: string` Human-readable explanation of the verdict. For `needs_revision`, describes which criteria failed and why. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `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` A timestamp in RFC 3339 format - `result: string` Evaluation verdict. 'satisfied': criteria met, session goes idle. 'needs_revision': criteria not met, another revision cycle follows. 'max_iterations_reached': evaluation budget exhausted with criteria still unmet — one final acknowledgment turn follows before the session goes idle, but no further evaluation runs. 'failed': grader determined the rubric does not apply to the deliverables. 'interrupted': user sent an interrupt while evaluation was in progress. - `type: "span.outcome_evaluation_end"` - `"span.outcome_evaluation_end"` - `usage: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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"` - `beta_managed_agents_span_model_request_start_event: object { id, processed_at, type }` Emitted when a model request is initiated by the agent. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_start"` - `"span.model_request_start"` - `beta_managed_agents_span_model_request_end_event: object { id, is_error, model_request_start_id, 3 more }` Emitted when a model request completes. - `id: string` Unique identifier for this event. - `is_error: boolean` 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: object { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 2 more }` Token usage for a single model request. - `cache_creation_input_tokens: number` Tokens used to create prompt cache in this request. - `cache_read_input_tokens: number` Tokens read from prompt cache in this request. - `input_tokens: number` Input tokens consumed by this request. - `output_tokens: number` Output tokens generated by this request. - `speed: optional "standard" or "fast"` 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. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.model_request_end"` - `"span.model_request_end"` - `beta_managed_agents_span_outcome_evaluation_ongoing_event: object { id, iteration, outcome_id, 2 more }` Periodic heartbeat emitted while an outcome evaluation cycle is in progress. Distinguishes 'evaluation is actively running' from 'evaluation is stuck' between the corresponding `span.outcome_evaluation_start` and `span.outcome_evaluation_end` events. - `id: string` Unique identifier for this event. - `iteration: number` 0-indexed revision cycle, matching the corresponding `span.outcome_evaluation_start`. - `outcome_id: string` The `outc_` ID of the outcome being evaluated. - `processed_at: string` A timestamp in RFC 3339 format - `type: "span.outcome_evaluation_ongoing"` - `"span.outcome_evaluation_ongoing"` - `beta_managed_agents_user_define_outcome_event: object { id, description, max_iterations, 4 more }` Echo of a `user.define_outcome` input event. Carries the server-generated `outcome_id` that subsequent `span.outcome_evaluation_*` events reference. - `id: string` Unique identifier for this event. - `description: string` What the agent should produce. Copied from the input event. - `max_iterations: number` Evaluate-then-revise cycles before giving up. Default 3, max 20. - `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` A timestamp in RFC 3339 format - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric` Rubric for grading the quality of an outcome. - `beta_managed_agents_file_rubric: object { file_id, type }` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` - `beta_managed_agents_text_rubric: object { content, type }` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `type: "text"` - `"text"` - `type: "user.define_outcome"` - `"user.define_outcome"` - `beta_managed_agents_session_deleted_event: object { id, processed_at, type }` Emitted when a session has been deleted. Terminates any active event stream — no further events will be emitted for this session. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.deleted"` - `"session.deleted"` - `beta_managed_agents_session_thread_status_running_event: object { id, agent_name, processed_at, 2 more }` A session thread has begun executing. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that started running. - `type: "session.thread_status_running"` - `"session.thread_status_running"` - `beta_managed_agents_session_thread_status_idle_event: object { id, agent_name, processed_at, 3 more }` A session thread has yielded and is awaiting input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that went idle. - `stop_reason: BetaManagedAgentsSessionEndTurn or BetaManagedAgentsSessionRequiresAction or BetaManagedAgentsSessionRetriesExhausted` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_end_turn: object { type }` The agent completed its turn naturally and is ready for the next user message. - `beta_managed_agents_session_requires_action: object { event_ids, type }` 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. - `beta_managed_agents_session_retries_exhausted: object { type }` The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`). - `type: "session.thread_status_idle"` - `"session.thread_status_idle"` - `beta_managed_agents_session_thread_status_terminated_event: object { id, agent_name, processed_at, 2 more }` A session thread has terminated and will accept no further input. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that terminated. - `type: "session.thread_status_terminated"` - `"session.thread_status_terminated"` - `beta_managed_agents_user_tool_result_event: object { id, tool_use_id, type, 4 more }` Event sent by the client providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. - `id: string` Unique identifier for this event. - `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#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. - `type: "user.tool_result"` - `"user.tool_result"` - `content: optional array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsSearchResultBlock` The result content returned by the tool. - `beta_managed_agents_text_block: object { text, type }` Regular text content. - `beta_managed_agents_image_block: object { source, type }` Image content specified directly as base64 data or as a reference via a URL. - `beta_managed_agents_document_block: object { source, type, context, title }` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `beta_managed_agents_search_result_block: object { citations, content, source, 2 more }` A block containing a web search result. - `is_error: optional boolean` Whether the tool execution resulted in an error. - `processed_at: optional string` A timestamp in RFC 3339 format - `session_thread_id: optional string` Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - `beta_managed_agents_session_thread_status_rescheduled_event: object { id, agent_name, processed_at, 2 more }` A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. - `id: string` Unique identifier for this event. - `agent_name: string` Name of the agent the thread runs. - `processed_at: string` A timestamp in RFC 3339 format - `session_thread_id: string` Public sthr_ ID of the thread that is retrying. - `type: "session.thread_status_rescheduled"` - `"session.thread_status_rescheduled"` - `beta_managed_agents_session_updated_event: object { id, processed_at, type, 3 more }` Emitted when an UpdateSession request changed at least one field. Carries only the fields that changed; absent fields were not part of the update. The new configuration applies from the next turn. - `id: string` Unique identifier for this event. - `processed_at: string` A timestamp in RFC 3339 format - `type: "session.updated"` - `"session.updated"` - `agent: optional object { id, description, mcp_servers, 8 more }` Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `"url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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-opus-4-8"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-7"` Frontier intelligence for long-running agents and coding - `"claude-opus-4-6"` Most intelligent model for building agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` Fastest model with near-frontier intelligence - `"claude-haiku-4-5-20251001"` Fastest model with near-frontier intelligence - `"claude-opus-4-5"` Premium model combining maximum intelligence with practical performance - `"claude-opus-4-5-20251101"` Premium model combining maximum intelligence with practical performance - `"claude-sonnet-4-5"` High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` High-performance model for agents and coding - `speed: optional "standard" or "fast"` 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"` - `multiagent: object { agents, type }` Resolved coordinator topology with full agent definitions for each roster member. - `agents: array of BetaManagedAgentsSessionThreadAgent` Full `agent` definitions the coordinator may spawn as session threads. - `id: string` - `description: string` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - `name: string` - `type: "url"` - `url: string` - `model: object { id, speed }` Model identifier and configuration. - `id: "claude-opus-4-8" or "claude-opus-4-7" or "claude-opus-4-6" or 7 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. - `speed: optional "standard" or "fast"` 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. - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `skill_id: string` - `type: "anthropic"` - `"anthropic"` - `version: string` - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `skill_id: string` - `type: "custom"` - `"custom"` - `version: string` - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `configs: array of BetaManagedAgentsAgentToolConfig` - `enabled: boolean` - `name: "bash" or "edit" or "read" or 5 more` Built-in agent tool identifier. - `"bash"` - `"edit"` - `"read"` - `"write"` - `"glob"` - `"grep"` - `"web_fetch"` - `"web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `"always_allow"` - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "always_ask"` - `"always_ask"` - `default_config: object { enabled, permission_policy }` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - `"agent_toolset_20260401"` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `default_config: object { enabled, permission_policy }` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - `beta_managed_agents_always_allow_policy: object { type }` Tool calls are automatically approved without user confirmation. - `beta_managed_agents_always_ask_policy: object { type }` Tool calls require user confirmation before execution. - `mcp_server_name: string` - `type: "mcp_toolset"` - `"mcp_toolset"` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `description: string` - `input_schema: object { properties, required, type }` JSON Schema for custom tool input parameters. - `properties: optional map[unknown]` JSON Schema properties defining the tool's input parameters. - `required: optional array of string` List of required property names. - `type: optional "object"` Must be 'object' for tool input schemas. - `"object"` - `name: string` - `type: "custom"` - `"custom"` - `type: "agent"` - `"agent"` - `version: number` - `type: "coordinator"` - `"coordinator"` - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `beta_managed_agents_anthropic_skill: object { skill_id, type, version }` A resolved Anthropic-managed skill. - `beta_managed_agents_custom_skill: object { skill_id, type, version }` A resolved user-created custom skill. - `system: string` - `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - `beta_managed_agents_agent_toolset20260401: object { configs, default_config, type }` - `beta_managed_agents_mcp_toolset: object { configs, default_config, mcp_server_name, type }` - `beta_managed_agents_custom_tool: object { description, input_schema, name, type }` A custom tool as returned in API responses. - `type: "agent"` - `"agent"` - `version: number` - `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` The session's new title. Present only when the update changed it. ### Example ```cli ant beta:sessions:threads:events stream \ --api-key my-anthropic-api-key \ --session-id sesn_011CZkZAtmR3yMPDzynEDxu7 \ --thread-id sthr_011CZkZVWa6oIjw0rgXZpnBt ``` #### Response ```json { "id": "sevt_011CZkZGOp0iBcp4kaQSihUmy", "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message", "processed_at": "2026-03-15T10:00:00Z" } ``` # Vaults ## Create Vault `$ ant beta:vaults create` **post** `/v1/vaults` Create Vault ### Parameters - `--display-name: string` Body param: Human-readable name for the vault. 1-255 characters. - `--metadata: optional map[string]` Body param: Arbitrary key-value metadata to attach to the vault. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_vault: object { id, archived_at, created_at, 4 more }` A vault that stores credentials for use by agents during sessions. - `id: string` Unique identifier for the vault. - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `display_name: string` Human-readable name for the vault. - `metadata: map[string]` Arbitrary key-value metadata attached to the vault. - `type: "vault"` - `"vault"` - `updated_at: string` A timestamp in RFC 3339 format ### Example ```cli ant beta:vaults create \ --api-key my-anthropic-api-key \ --display-name 'Example vault' ``` #### Response ```json { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } ``` ## List Vaults `$ ant beta:vaults list` **get** `/v1/vaults` List Vaults ### Parameters - `--include-archived: optional boolean` Query param: Whether to include archived vaults in the results. - `--limit: optional number` Query param: Maximum number of vaults to return per page. Defaults to 20, maximum 100. - `--page: optional string` Query param: Opaque pagination token from a previous `list_vaults` response. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaManagedAgentsListVaultsResponse: object { data, next_page }` Response containing a paginated list of vaults. - `data: optional array of BetaManagedAgentsVault` List of vaults. - `id: string` Unique identifier for the vault. - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `display_name: string` Human-readable name for the vault. - `metadata: map[string]` Arbitrary key-value metadata attached to the vault. - `type: "vault"` - `"vault"` - `updated_at: string` A timestamp in RFC 3339 format - `next_page: optional string` Pagination token for the next page, or null if no more results. ### Example ```cli ant beta:vaults list \ --api-key my-anthropic-api-key ``` #### Response ```json { "data": [ { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Vault `$ ant beta:vaults retrieve` **get** `/v1/vaults/{vault_id}` Get Vault ### Parameters - `--vault-id: string` Path parameter vault_id - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_vault: object { id, archived_at, created_at, 4 more }` A vault that stores credentials for use by agents during sessions. - `id: string` Unique identifier for the vault. - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `display_name: string` Human-readable name for the vault. - `metadata: map[string]` Arbitrary key-value metadata attached to the vault. - `type: "vault"` - `"vault"` - `updated_at: string` A timestamp in RFC 3339 format ### Example ```cli ant beta:vaults retrieve \ --api-key my-anthropic-api-key \ --vault-id vlt_011CZkZDLs7fYzm1hXNPeRjv ``` #### Response ```json { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } ``` ## Update Vault `$ ant beta:vaults update` **post** `/v1/vaults/{vault_id}` Update Vault ### Parameters - `--vault-id: string` Path param: Path parameter vault_id - `--display-name: optional string` Body param: Updated human-readable name for the vault. 1-255 characters. - `--metadata: optional map[string]` Body param: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omitted keys are preserved. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_vault: object { id, archived_at, created_at, 4 more }` A vault that stores credentials for use by agents during sessions. - `id: string` Unique identifier for the vault. - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `display_name: string` Human-readable name for the vault. - `metadata: map[string]` Arbitrary key-value metadata attached to the vault. - `type: "vault"` - `"vault"` - `updated_at: string` A timestamp in RFC 3339 format ### Example ```cli ant beta:vaults update \ --api-key my-anthropic-api-key \ --vault-id vlt_011CZkZDLs7fYzm1hXNPeRjv ``` #### Response ```json { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } ``` ## Delete Vault `$ ant beta:vaults delete` **delete** `/v1/vaults/{vault_id}` Delete Vault ### Parameters - `--vault-id: string` Path parameter vault_id - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_deleted_vault: object { id, type }` Confirmation of a deleted vault. - `id: string` Unique identifier of the deleted vault. - `type: "vault_deleted"` - `"vault_deleted"` ### Example ```cli ant beta:vaults delete \ --api-key my-anthropic-api-key \ --vault-id vlt_011CZkZDLs7fYzm1hXNPeRjv ``` #### Response ```json { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "type": "vault_deleted" } ``` ## Archive Vault `$ ant beta:vaults archive` **post** `/v1/vaults/{vault_id}/archive` Archive Vault ### Parameters - `--vault-id: string` Path parameter vault_id - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_vault: object { id, archived_at, created_at, 4 more }` A vault that stores credentials for use by agents during sessions. - `id: string` Unique identifier for the vault. - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `display_name: string` Human-readable name for the vault. - `metadata: map[string]` Arbitrary key-value metadata attached to the vault. - `type: "vault"` - `"vault"` - `updated_at: string` A timestamp in RFC 3339 format ### Example ```cli ant beta:vaults archive \ --api-key my-anthropic-api-key \ --vault-id vlt_011CZkZDLs7fYzm1hXNPeRjv ``` #### Response ```json { "id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "display_name": "Example vault", "metadata": { "environment": "production" }, "type": "vault", "updated_at": "2026-03-15T10:00:00Z" } ``` ## Domain Types ### Beta Managed Agents Deleted Vault - `beta_managed_agents_deleted_vault: object { id, type }` Confirmation of a deleted vault. - `id: string` Unique identifier of the deleted vault. - `type: "vault_deleted"` - `"vault_deleted"` ### Beta Managed Agents Vault - `beta_managed_agents_vault: object { id, archived_at, created_at, 4 more }` A vault that stores credentials for use by agents during sessions. - `id: string` Unique identifier for the vault. - `archived_at: string` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `display_name: string` Human-readable name for the vault. - `metadata: map[string]` Arbitrary key-value metadata attached to the vault. - `type: "vault"` - `"vault"` - `updated_at: string` A timestamp in RFC 3339 format # Credentials ## Create Credential `$ ant beta:vaults:credentials create` **post** `/v1/vaults/{vault_id}/credentials` Create Credential ### Parameters - `--vault-id: string` Path param: Path parameter vault_id - `--auth: BetaManagedAgentsMCPOAuthCreateParams or BetaManagedAgentsStaticBearerCreateParams` Body param: Authentication details for creating a credential. - `--display-name: optional string` Body param: Human-readable name for the credential. Up to 255 characters. - `--metadata: optional map[string]` Body param: Arbitrary key-value metadata to attach to the credential. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_credential: object { id, archived_at, auth, 6 more }` A credential stored in a vault. Sensitive fields are never returned in responses. - `id: string` Unique identifier for the credential. - `archived_at: string` A timestamp in RFC 3339 format - `auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse` Authentication details for a credential. - `beta_managed_agents_mcp_oauth_auth_response: object { mcp_server_url, type, expires_at, refresh }` OAuth credential details for an MCP server. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "mcp_oauth"` - `"mcp_oauth"` - `expires_at: optional string` A timestamp in RFC 3339 format - `refresh: optional object { client_id, token_endpoint, token_endpoint_auth, 2 more }` OAuth refresh token configuration returned in credential responses. - `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` Token endpoint requires no client authentication. - `beta_managed_agents_token_endpoint_auth_none_response: object { type }` Token endpoint requires no client authentication. - `type: "none"` - `"none"` - `beta_managed_agents_token_endpoint_auth_basic_response: object { type }` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `"client_secret_basic"` - `beta_managed_agents_token_endpoint_auth_post_response: object { type }` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `"client_secret_post"` - `resource: optional string` OAuth resource indicator. - `scope: optional string` OAuth scope for the refresh request. - `beta_managed_agents_static_bearer_auth_response: object { mcp_server_url, type }` Static bearer token credential details for an MCP server. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "static_bearer"` - `"static_bearer"` - `created_at: string` A timestamp in RFC 3339 format - `metadata: map[string]` Arbitrary key-value metadata attached to the credential. - `type: "vault_credential"` - `"vault_credential"` - `updated_at: string` A timestamp in RFC 3339 format - `vault_id: string` Identifier of the vault this credential belongs to. - `display_name: optional string` Human-readable name for the credential. ### Example ```cli ant beta:vaults:credentials create \ --api-key my-anthropic-api-key \ --vault-id vlt_011CZkZDLs7fYzm1hXNPeRjv \ --auth '{token: bearer_exampletoken, mcp_server_url: https://example-server.modelcontextprotocol.io/sse, type: static_bearer}' ``` #### Response ```json { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } ``` ## List Credentials `$ ant beta:vaults:credentials list` **get** `/v1/vaults/{vault_id}/credentials` List Credentials ### Parameters - `--vault-id: string` Path param: Path parameter vault_id - `--include-archived: optional boolean` Query param: Whether to include archived credentials in the results. - `--limit: optional number` Query param: Maximum number of credentials to return per page. Defaults to 20, maximum 100. - `--page: optional string` Query param: Opaque pagination token from a previous `list_credentials` response. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaManagedAgentsListCredentialsResponse: object { data, next_page }` Response containing a paginated list of credentials. - `data: optional array of BetaManagedAgentsCredential` List of credentials. - `id: string` Unique identifier for the credential. - `archived_at: string` A timestamp in RFC 3339 format - `auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse` Authentication details for a credential. - `beta_managed_agents_mcp_oauth_auth_response: object { mcp_server_url, type, expires_at, refresh }` OAuth credential details for an MCP server. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "mcp_oauth"` - `"mcp_oauth"` - `expires_at: optional string` A timestamp in RFC 3339 format - `refresh: optional object { client_id, token_endpoint, token_endpoint_auth, 2 more }` OAuth refresh token configuration returned in credential responses. - `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` Token endpoint requires no client authentication. - `beta_managed_agents_token_endpoint_auth_none_response: object { type }` Token endpoint requires no client authentication. - `type: "none"` - `"none"` - `beta_managed_agents_token_endpoint_auth_basic_response: object { type }` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `"client_secret_basic"` - `beta_managed_agents_token_endpoint_auth_post_response: object { type }` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `"client_secret_post"` - `resource: optional string` OAuth resource indicator. - `scope: optional string` OAuth scope for the refresh request. - `beta_managed_agents_static_bearer_auth_response: object { mcp_server_url, type }` Static bearer token credential details for an MCP server. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "static_bearer"` - `"static_bearer"` - `created_at: string` A timestamp in RFC 3339 format - `metadata: map[string]` Arbitrary key-value metadata attached to the credential. - `type: "vault_credential"` - `"vault_credential"` - `updated_at: string` A timestamp in RFC 3339 format - `vault_id: string` Identifier of the vault this credential belongs to. - `display_name: optional string` Human-readable name for the credential. - `next_page: optional string` Pagination token for the next page, or null if no more results. ### Example ```cli ant beta:vaults:credentials list \ --api-key my-anthropic-api-key \ --vault-id vlt_011CZkZDLs7fYzm1hXNPeRjv ``` #### Response ```json { "data": [ { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Credential `$ ant beta:vaults:credentials retrieve` **get** `/v1/vaults/{vault_id}/credentials/{credential_id}` Get Credential ### Parameters - `--vault-id: string` Path param: Path parameter vault_id - `--credential-id: string` Path param: Path parameter credential_id - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_credential: object { id, archived_at, auth, 6 more }` A credential stored in a vault. Sensitive fields are never returned in responses. - `id: string` Unique identifier for the credential. - `archived_at: string` A timestamp in RFC 3339 format - `auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse` Authentication details for a credential. - `beta_managed_agents_mcp_oauth_auth_response: object { mcp_server_url, type, expires_at, refresh }` OAuth credential details for an MCP server. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "mcp_oauth"` - `"mcp_oauth"` - `expires_at: optional string` A timestamp in RFC 3339 format - `refresh: optional object { client_id, token_endpoint, token_endpoint_auth, 2 more }` OAuth refresh token configuration returned in credential responses. - `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` Token endpoint requires no client authentication. - `beta_managed_agents_token_endpoint_auth_none_response: object { type }` Token endpoint requires no client authentication. - `type: "none"` - `"none"` - `beta_managed_agents_token_endpoint_auth_basic_response: object { type }` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `"client_secret_basic"` - `beta_managed_agents_token_endpoint_auth_post_response: object { type }` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `"client_secret_post"` - `resource: optional string` OAuth resource indicator. - `scope: optional string` OAuth scope for the refresh request. - `beta_managed_agents_static_bearer_auth_response: object { mcp_server_url, type }` Static bearer token credential details for an MCP server. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "static_bearer"` - `"static_bearer"` - `created_at: string` A timestamp in RFC 3339 format - `metadata: map[string]` Arbitrary key-value metadata attached to the credential. - `type: "vault_credential"` - `"vault_credential"` - `updated_at: string` A timestamp in RFC 3339 format - `vault_id: string` Identifier of the vault this credential belongs to. - `display_name: optional string` Human-readable name for the credential. ### Example ```cli ant beta:vaults:credentials retrieve \ --api-key my-anthropic-api-key \ --vault-id vlt_011CZkZDLs7fYzm1hXNPeRjv \ --credential-id vcrd_011CZkZEMt8gZan2iYOQfSkw ``` #### Response ```json { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } ``` ## Update Credential `$ ant beta:vaults:credentials update` **post** `/v1/vaults/{vault_id}/credentials/{credential_id}` Update Credential ### Parameters - `--vault-id: string` Path param: Path parameter vault_id - `--credential-id: string` Path param: Path parameter credential_id - `--auth: optional BetaManagedAgentsMCPOAuthUpdateParams or BetaManagedAgentsStaticBearerUpdateParams` Body param: Updated authentication details for a credential. - `--display-name: optional string` Body param: Updated human-readable name for the credential. 1-255 characters. - `--metadata: optional map[string]` Body param: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omitted keys are preserved. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_credential: object { id, archived_at, auth, 6 more }` A credential stored in a vault. Sensitive fields are never returned in responses. - `id: string` Unique identifier for the credential. - `archived_at: string` A timestamp in RFC 3339 format - `auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse` Authentication details for a credential. - `beta_managed_agents_mcp_oauth_auth_response: object { mcp_server_url, type, expires_at, refresh }` OAuth credential details for an MCP server. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "mcp_oauth"` - `"mcp_oauth"` - `expires_at: optional string` A timestamp in RFC 3339 format - `refresh: optional object { client_id, token_endpoint, token_endpoint_auth, 2 more }` OAuth refresh token configuration returned in credential responses. - `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` Token endpoint requires no client authentication. - `beta_managed_agents_token_endpoint_auth_none_response: object { type }` Token endpoint requires no client authentication. - `type: "none"` - `"none"` - `beta_managed_agents_token_endpoint_auth_basic_response: object { type }` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `"client_secret_basic"` - `beta_managed_agents_token_endpoint_auth_post_response: object { type }` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `"client_secret_post"` - `resource: optional string` OAuth resource indicator. - `scope: optional string` OAuth scope for the refresh request. - `beta_managed_agents_static_bearer_auth_response: object { mcp_server_url, type }` Static bearer token credential details for an MCP server. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "static_bearer"` - `"static_bearer"` - `created_at: string` A timestamp in RFC 3339 format - `metadata: map[string]` Arbitrary key-value metadata attached to the credential. - `type: "vault_credential"` - `"vault_credential"` - `updated_at: string` A timestamp in RFC 3339 format - `vault_id: string` Identifier of the vault this credential belongs to. - `display_name: optional string` Human-readable name for the credential. ### Example ```cli ant beta:vaults:credentials update \ --api-key my-anthropic-api-key \ --vault-id vlt_011CZkZDLs7fYzm1hXNPeRjv \ --credential-id vcrd_011CZkZEMt8gZan2iYOQfSkw ``` #### Response ```json { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } ``` ## Delete Credential `$ ant beta:vaults:credentials delete` **delete** `/v1/vaults/{vault_id}/credentials/{credential_id}` Delete Credential ### Parameters - `--vault-id: string` Path param: Path parameter vault_id - `--credential-id: string` Path param: Path parameter credential_id - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_deleted_credential: object { id, type }` Confirmation of a deleted credential. - `id: string` Unique identifier of the deleted credential. - `type: "vault_credential_deleted"` - `"vault_credential_deleted"` ### Example ```cli ant beta:vaults:credentials delete \ --api-key my-anthropic-api-key \ --vault-id vlt_011CZkZDLs7fYzm1hXNPeRjv \ --credential-id vcrd_011CZkZEMt8gZan2iYOQfSkw ``` #### Response ```json { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "type": "vault_credential_deleted" } ``` ## Archive Credential `$ ant beta:vaults:credentials archive` **post** `/v1/vaults/{vault_id}/credentials/{credential_id}/archive` Archive Credential ### Parameters - `--vault-id: string` Path param: Path parameter vault_id - `--credential-id: string` Path param: Path parameter credential_id - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_credential: object { id, archived_at, auth, 6 more }` A credential stored in a vault. Sensitive fields are never returned in responses. - `id: string` Unique identifier for the credential. - `archived_at: string` A timestamp in RFC 3339 format - `auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse` Authentication details for a credential. - `beta_managed_agents_mcp_oauth_auth_response: object { mcp_server_url, type, expires_at, refresh }` OAuth credential details for an MCP server. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "mcp_oauth"` - `"mcp_oauth"` - `expires_at: optional string` A timestamp in RFC 3339 format - `refresh: optional object { client_id, token_endpoint, token_endpoint_auth, 2 more }` OAuth refresh token configuration returned in credential responses. - `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` Token endpoint requires no client authentication. - `beta_managed_agents_token_endpoint_auth_none_response: object { type }` Token endpoint requires no client authentication. - `type: "none"` - `"none"` - `beta_managed_agents_token_endpoint_auth_basic_response: object { type }` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `"client_secret_basic"` - `beta_managed_agents_token_endpoint_auth_post_response: object { type }` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `"client_secret_post"` - `resource: optional string` OAuth resource indicator. - `scope: optional string` OAuth scope for the refresh request. - `beta_managed_agents_static_bearer_auth_response: object { mcp_server_url, type }` Static bearer token credential details for an MCP server. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "static_bearer"` - `"static_bearer"` - `created_at: string` A timestamp in RFC 3339 format - `metadata: map[string]` Arbitrary key-value metadata attached to the credential. - `type: "vault_credential"` - `"vault_credential"` - `updated_at: string` A timestamp in RFC 3339 format - `vault_id: string` Identifier of the vault this credential belongs to. - `display_name: optional string` Human-readable name for the credential. ### Example ```cli ant beta:vaults:credentials archive \ --api-key my-anthropic-api-key \ --vault-id vlt_011CZkZDLs7fYzm1hXNPeRjv \ --credential-id vcrd_011CZkZEMt8gZan2iYOQfSkw ``` #### Response ```json { "id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "archived_at": null, "auth": { "mcp_server_url": "https://example-server.modelcontextprotocol.io/sse", "type": "static_bearer" }, "created_at": "2026-03-15T10:00:00Z", "metadata": { "environment": "production" }, "type": "vault_credential", "updated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv", "display_name": "Example credential" } ``` ## Validate Credential `$ ant beta:vaults:credentials mcp-oauth-validate` **post** `/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate` Validate Credential ### Parameters - `--vault-id: string` Path param: Path parameter vault_id - `--credential-id: string` Path param: Path parameter credential_id - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_credential_validation: object { credential_id, has_refresh_token, mcp_probe, 5 more }` Result of live-probing a credential against its configured MCP server. - `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: object { http_response, method }` The failing step of an MCP validation probe. - `http_response: object { body, body_truncated, content_type, status_code }` An HTTP response captured during a credential validation probe. - `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. - `method: string` The MCP method that failed (for example `initialize` or `tools/list`). - `refresh: object { http_response, status }` Outcome of a refresh-token exchange attempted during credential validation. - `http_response: object { body, body_truncated, content_type, status_code }` An HTTP response captured during a credential validation probe. - `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. - `status: "succeeded" or "failed" or "connect_error" or "no_refresh_token"` Outcome of a refresh-token exchange attempted during credential validation. - `"succeeded"` - `"failed"` - `"connect_error"` - `"no_refresh_token"` - `status: "valid" or "invalid" or "unknown"` Overall verdict of a credential validation probe. - `"valid"` - `"invalid"` - `"unknown"` - `type: "vault_credential_validation"` - `"vault_credential_validation"` - `validated_at: string` A timestamp in RFC 3339 format - `vault_id: string` Identifier of the vault containing the credential. ### Example ```cli ant beta:vaults:credentials mcp-oauth-validate \ --api-key my-anthropic-api-key \ --vault-id vlt_011CZkZDLs7fYzm1hXNPeRjv \ --credential-id vcrd_011CZkZEMt8gZan2iYOQfSkw ``` #### Response ```json { "credential_id": "vcrd_011CZkZEMt8gZan2iYOQfSkw", "has_refresh_token": true, "mcp_probe": { "http_response": { "body": "body", "body_truncated": true, "content_type": "content_type", "status_code": 0 }, "method": "method" }, "refresh": { "http_response": { "body": "body", "body_truncated": true, "content_type": "content_type", "status_code": 0 }, "status": "succeeded" }, "status": "valid", "type": "vault_credential_validation", "validated_at": "2026-03-15T10:00:00Z", "vault_id": "vlt_011CZkZDLs7fYzm1hXNPeRjv" } ``` ## Domain Types ### Beta Managed Agents Credential - `beta_managed_agents_credential: object { id, archived_at, auth, 6 more }` A credential stored in a vault. Sensitive fields are never returned in responses. - `id: string` Unique identifier for the credential. - `archived_at: string` A timestamp in RFC 3339 format - `auth: BetaManagedAgentsMCPOAuthAuthResponse or BetaManagedAgentsStaticBearerAuthResponse` Authentication details for a credential. - `beta_managed_agents_mcp_oauth_auth_response: object { mcp_server_url, type, expires_at, refresh }` OAuth credential details for an MCP server. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "mcp_oauth"` - `"mcp_oauth"` - `expires_at: optional string` A timestamp in RFC 3339 format - `refresh: optional object { client_id, token_endpoint, token_endpoint_auth, 2 more }` OAuth refresh token configuration returned in credential responses. - `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` Token endpoint requires no client authentication. - `beta_managed_agents_token_endpoint_auth_none_response: object { type }` Token endpoint requires no client authentication. - `type: "none"` - `"none"` - `beta_managed_agents_token_endpoint_auth_basic_response: object { type }` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `"client_secret_basic"` - `beta_managed_agents_token_endpoint_auth_post_response: object { type }` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `"client_secret_post"` - `resource: optional string` OAuth resource indicator. - `scope: optional string` OAuth scope for the refresh request. - `beta_managed_agents_static_bearer_auth_response: object { mcp_server_url, type }` Static bearer token credential details for an MCP server. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "static_bearer"` - `"static_bearer"` - `created_at: string` A timestamp in RFC 3339 format - `metadata: map[string]` Arbitrary key-value metadata attached to the credential. - `type: "vault_credential"` - `"vault_credential"` - `updated_at: string` A timestamp in RFC 3339 format - `vault_id: string` Identifier of the vault this credential belongs to. - `display_name: optional string` Human-readable name for the credential. ### Beta Managed Agents Credential Validation - `beta_managed_agents_credential_validation: object { credential_id, has_refresh_token, mcp_probe, 5 more }` Result of live-probing a credential against its configured MCP server. - `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: object { http_response, method }` The failing step of an MCP validation probe. - `http_response: object { body, body_truncated, content_type, status_code }` An HTTP response captured during a credential validation probe. - `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. - `method: string` The MCP method that failed (for example `initialize` or `tools/list`). - `refresh: object { http_response, status }` Outcome of a refresh-token exchange attempted during credential validation. - `http_response: object { body, body_truncated, content_type, status_code }` An HTTP response captured during a credential validation probe. - `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. - `status: "succeeded" or "failed" or "connect_error" or "no_refresh_token"` Outcome of a refresh-token exchange attempted during credential validation. - `"succeeded"` - `"failed"` - `"connect_error"` - `"no_refresh_token"` - `status: "valid" or "invalid" or "unknown"` Overall verdict of a credential validation probe. - `"valid"` - `"invalid"` - `"unknown"` - `type: "vault_credential_validation"` - `"vault_credential_validation"` - `validated_at: string` A timestamp in RFC 3339 format - `vault_id: string` Identifier of the vault containing the credential. ### Beta Managed Agents Credential Validation Status - `beta_managed_agents_credential_validation_status: "valid" or "invalid" or "unknown"` Overall verdict of a credential validation probe. - `"valid"` - `"invalid"` - `"unknown"` ### Beta Managed Agents Deleted Credential - `beta_managed_agents_deleted_credential: object { id, type }` Confirmation of a deleted credential. - `id: string` Unique identifier of the deleted credential. - `type: "vault_credential_deleted"` - `"vault_credential_deleted"` ### Beta Managed Agents MCP OAuth Auth Response - `beta_managed_agents_mcp_oauth_auth_response: object { mcp_server_url, type, expires_at, refresh }` OAuth credential details for an MCP server. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "mcp_oauth"` - `"mcp_oauth"` - `expires_at: optional string` A timestamp in RFC 3339 format - `refresh: optional object { client_id, token_endpoint, token_endpoint_auth, 2 more }` OAuth refresh token configuration returned in credential responses. - `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` Token endpoint requires no client authentication. - `beta_managed_agents_token_endpoint_auth_none_response: object { type }` Token endpoint requires no client authentication. - `type: "none"` - `"none"` - `beta_managed_agents_token_endpoint_auth_basic_response: object { type }` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `"client_secret_basic"` - `beta_managed_agents_token_endpoint_auth_post_response: object { type }` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `"client_secret_post"` - `resource: optional string` OAuth resource indicator. - `scope: optional string` OAuth scope for the refresh request. ### Beta Managed Agents MCP OAuth Create Params - `beta_managed_agents_mcp_oauth_create_params: object { access_token, mcp_server_url, type, 2 more }` Parameters for creating an MCP OAuth credential. - `access_token: string` OAuth access token. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "mcp_oauth"` - `"mcp_oauth"` - `expires_at: optional string` A timestamp in RFC 3339 format - `refresh: optional object { client_id, refresh_token, token_endpoint, 3 more }` OAuth refresh token parameters for creating a credential with refresh support. - `client_id: string` OAuth client ID. - `refresh_token: string` OAuth refresh token. - `token_endpoint: string` Token endpoint URL used to refresh the access token. - `token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneParam or BetaManagedAgentsTokenEndpointAuthBasicParam or BetaManagedAgentsTokenEndpointAuthPostParam` Token endpoint requires no client authentication. - `beta_managed_agents_token_endpoint_auth_none_param: object { type }` Token endpoint requires no client authentication. - `type: "none"` - `"none"` - `beta_managed_agents_token_endpoint_auth_basic_param: object { client_secret, type }` Token endpoint uses HTTP Basic authentication with client credentials. - `client_secret: string` OAuth client secret. - `type: "client_secret_basic"` - `"client_secret_basic"` - `beta_managed_agents_token_endpoint_auth_post_param: object { client_secret, type }` Token endpoint uses POST body authentication with client credentials. - `client_secret: string` OAuth client secret. - `type: "client_secret_post"` - `"client_secret_post"` - `resource: optional string` OAuth resource indicator. - `scope: optional string` OAuth scope for the refresh request. ### Beta Managed Agents MCP OAuth Refresh Params - `beta_managed_agents_mcp_oauth_refresh_params: object { client_id, refresh_token, token_endpoint, 3 more }` OAuth refresh token parameters for creating a credential with refresh support. - `client_id: string` OAuth client ID. - `refresh_token: string` OAuth refresh token. - `token_endpoint: string` Token endpoint URL used to refresh the access token. - `token_endpoint_auth: BetaManagedAgentsTokenEndpointAuthNoneParam or BetaManagedAgentsTokenEndpointAuthBasicParam or BetaManagedAgentsTokenEndpointAuthPostParam` Token endpoint requires no client authentication. - `beta_managed_agents_token_endpoint_auth_none_param: object { type }` Token endpoint requires no client authentication. - `type: "none"` - `"none"` - `beta_managed_agents_token_endpoint_auth_basic_param: object { client_secret, type }` Token endpoint uses HTTP Basic authentication with client credentials. - `client_secret: string` OAuth client secret. - `type: "client_secret_basic"` - `"client_secret_basic"` - `beta_managed_agents_token_endpoint_auth_post_param: object { client_secret, type }` Token endpoint uses POST body authentication with client credentials. - `client_secret: string` OAuth client secret. - `type: "client_secret_post"` - `"client_secret_post"` - `resource: optional string` OAuth resource indicator. - `scope: optional string` OAuth scope for the refresh request. ### Beta Managed Agents MCP OAuth Refresh Response - `beta_managed_agents_mcp_oauth_refresh_response: object { client_id, token_endpoint, token_endpoint_auth, 2 more }` OAuth refresh token configuration returned in credential responses. - `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` Token endpoint requires no client authentication. - `beta_managed_agents_token_endpoint_auth_none_response: object { type }` Token endpoint requires no client authentication. - `type: "none"` - `"none"` - `beta_managed_agents_token_endpoint_auth_basic_response: object { type }` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `"client_secret_basic"` - `beta_managed_agents_token_endpoint_auth_post_response: object { type }` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `"client_secret_post"` - `resource: optional string` OAuth resource indicator. - `scope: optional string` OAuth scope for the refresh request. ### Beta Managed Agents MCP OAuth Refresh Update Params - `beta_managed_agents_mcp_oauth_refresh_update_params: object { refresh_token, scope, token_endpoint_auth }` Parameters for updating OAuth refresh token configuration. - `refresh_token: optional string` Updated OAuth refresh token. - `scope: optional string` Updated OAuth scope for the refresh request. - `token_endpoint_auth: optional BetaManagedAgentsTokenEndpointAuthBasicUpdateParam or BetaManagedAgentsTokenEndpointAuthPostUpdateParam` Updated HTTP Basic authentication parameters for the token endpoint. - `beta_managed_agents_token_endpoint_auth_basic_update_param: object { type, client_secret }` Updated HTTP Basic authentication parameters for the token endpoint. - `type: "client_secret_basic"` - `"client_secret_basic"` - `client_secret: optional string` Updated OAuth client secret. - `beta_managed_agents_token_endpoint_auth_post_update_param: object { type, client_secret }` Updated POST body authentication parameters for the token endpoint. - `type: "client_secret_post"` - `"client_secret_post"` - `client_secret: optional string` Updated OAuth client secret. ### Beta Managed Agents MCP OAuth Update Params - `beta_managed_agents_mcp_oauth_update_params: object { type, access_token, expires_at, refresh }` Parameters for updating an MCP OAuth credential. The `mcp_server_url` is immutable. - `type: "mcp_oauth"` - `"mcp_oauth"` - `access_token: optional string` Updated OAuth access token. - `expires_at: optional string` A timestamp in RFC 3339 format - `refresh: optional object { refresh_token, scope, token_endpoint_auth }` Parameters for updating OAuth refresh token configuration. - `refresh_token: optional string` Updated OAuth refresh token. - `scope: optional string` Updated OAuth scope for the refresh request. - `token_endpoint_auth: optional BetaManagedAgentsTokenEndpointAuthBasicUpdateParam or BetaManagedAgentsTokenEndpointAuthPostUpdateParam` Updated HTTP Basic authentication parameters for the token endpoint. - `beta_managed_agents_token_endpoint_auth_basic_update_param: object { type, client_secret }` Updated HTTP Basic authentication parameters for the token endpoint. - `type: "client_secret_basic"` - `"client_secret_basic"` - `client_secret: optional string` Updated OAuth client secret. - `beta_managed_agents_token_endpoint_auth_post_update_param: object { type, client_secret }` Updated POST body authentication parameters for the token endpoint. - `type: "client_secret_post"` - `"client_secret_post"` - `client_secret: optional string` Updated OAuth client secret. ### Beta Managed Agents MCP Probe - `beta_managed_agents_mcp_probe: object { http_response, method }` The failing step of an MCP validation probe. - `http_response: object { body, body_truncated, content_type, status_code }` An HTTP response captured during a credential validation probe. - `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. - `method: string` The MCP method that failed (for example `initialize` or `tools/list`). ### Beta Managed Agents Refresh HTTP Response - `beta_managed_agents_refresh_http_response: object { body, body_truncated, content_type, status_code }` An HTTP response captured during a credential validation probe. - `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. ### Beta Managed Agents Refresh Object - `beta_managed_agents_refresh_object: object { http_response, status }` Outcome of a refresh-token exchange attempted during credential validation. - `http_response: object { body, body_truncated, content_type, status_code }` An HTTP response captured during a credential validation probe. - `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. - `status: "succeeded" or "failed" or "connect_error" or "no_refresh_token"` Outcome of a refresh-token exchange attempted during credential validation. - `"succeeded"` - `"failed"` - `"connect_error"` - `"no_refresh_token"` ### Beta Managed Agents Static Bearer Auth Response - `beta_managed_agents_static_bearer_auth_response: object { mcp_server_url, type }` Static bearer token credential details for an MCP server. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "static_bearer"` - `"static_bearer"` ### Beta Managed Agents Static Bearer Create Params - `beta_managed_agents_static_bearer_create_params: object { token, mcp_server_url, type }` Parameters for creating a static bearer token credential. - `token: string` Static bearer token value. - `mcp_server_url: string` URL of the MCP server this credential authenticates against. - `type: "static_bearer"` - `"static_bearer"` ### Beta Managed Agents Static Bearer Update Params - `beta_managed_agents_static_bearer_update_params: object { type, token }` Parameters for updating a static bearer token credential. The `mcp_server_url` is immutable. - `type: "static_bearer"` - `"static_bearer"` - `token: optional string` Updated static bearer token value. ### Beta Managed Agents Token Endpoint Auth Basic Param - `beta_managed_agents_token_endpoint_auth_basic_param: object { client_secret, type }` Token endpoint uses HTTP Basic authentication with client credentials. - `client_secret: string` OAuth client secret. - `type: "client_secret_basic"` - `"client_secret_basic"` ### Beta Managed Agents Token Endpoint Auth Basic Response - `beta_managed_agents_token_endpoint_auth_basic_response: object { type }` Token endpoint uses HTTP Basic authentication with client credentials. - `type: "client_secret_basic"` - `"client_secret_basic"` ### Beta Managed Agents Token Endpoint Auth Basic Update Param - `beta_managed_agents_token_endpoint_auth_basic_update_param: object { type, client_secret }` Updated HTTP Basic authentication parameters for the token endpoint. - `type: "client_secret_basic"` - `"client_secret_basic"` - `client_secret: optional string` Updated OAuth client secret. ### Beta Managed Agents Token Endpoint Auth None Param - `beta_managed_agents_token_endpoint_auth_none_param: object { type }` Token endpoint requires no client authentication. - `type: "none"` - `"none"` ### Beta Managed Agents Token Endpoint Auth None Response - `beta_managed_agents_token_endpoint_auth_none_response: object { type }` Token endpoint requires no client authentication. - `type: "none"` - `"none"` ### Beta Managed Agents Token Endpoint Auth Post Param - `beta_managed_agents_token_endpoint_auth_post_param: object { client_secret, type }` Token endpoint uses POST body authentication with client credentials. - `client_secret: string` OAuth client secret. - `type: "client_secret_post"` - `"client_secret_post"` ### Beta Managed Agents Token Endpoint Auth Post Response - `beta_managed_agents_token_endpoint_auth_post_response: object { type }` Token endpoint uses POST body authentication with client credentials. - `type: "client_secret_post"` - `"client_secret_post"` ### Beta Managed Agents Token Endpoint Auth Post Update Param - `beta_managed_agents_token_endpoint_auth_post_update_param: object { type, client_secret }` Updated POST body authentication parameters for the token endpoint. - `type: "client_secret_post"` - `"client_secret_post"` - `client_secret: optional string` Updated OAuth client secret. # Memory Stores ## Create a memory store `$ ant beta:memory-stores create` **post** `/v1/memory_stores` Create a memory store ### Parameters - `--name: string` Body param: Human-readable name for the store. Required; 1–255 characters; no control characters. The mount-path slug under `/mnt/memory/` is derived from this name (lowercased, non-alphanumeric runs collapsed to a hyphen). Names need not be unique within a workspace. - `--description: optional string` Body param: Free-text description of what the store contains, up to 1024 characters. Included in the agent's system prompt when the store is attached, so word it to be useful to the agent. - `--metadata: optional map[string]` Body param: Arbitrary key-value tags for your own bookkeeping (such as the end user a store belongs to). Up to 16 pairs; keys 1–64 characters; values up to 512 characters. Not visible to the agent. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_memory_store: object { id, created_at, name, 5 more }` A `memory_store`: a named container for agent memories, scoped to a workspace. Attach a store to a session via `resources[]` to mount it as a directory the agent can read and write. - `id: string` Unique identifier for the memory store (a `memstore_...` tagged ID). Use this when attaching the store to a session, or in the `{memory_store_id}` path parameter of subsequent calls. - `created_at: string` A timestamp in RFC 3339 format - `name: string` Human-readable name for the store. 1–255 characters. The store's mount-path slug under `/mnt/memory/` is derived from this name. - `type: "memory_store"` - `"memory_store"` - `updated_at: string` A timestamp in RFC 3339 format - `archived_at: optional string` A timestamp in RFC 3339 format - `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. Empty string when unset. - `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. Returned on retrieve/list but not filterable. ### Example ```cli ant beta:memory-stores create \ --api-key my-anthropic-api-key \ --name x ``` #### Response ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } ``` ## List memory stores `$ ant beta:memory-stores list` **get** `/v1/memory_stores` List memory stores ### Parameters - `--created-at-gte: optional string` Query param: Return only stores whose `created_at` is at or after this time (inclusive). Sent on the wire as `created_at[gte]`. - `--created-at-lte: optional string` Query param: Return only stores whose `created_at` is at or before this time (inclusive). Sent on the wire as `created_at[lte]`. - `--include-archived: optional boolean` Query param: When `true`, archived stores are included in the results. Defaults to `false` (archived stores are excluded). - `--limit: optional number` Query param: Maximum number of stores to return per page. Must be between 1 and 100. Defaults to 20 when omitted. - `--page: optional string` Query param: Opaque pagination cursor (a `page_...` value). Pass the `next_page` value from a previous response to fetch the next page; omit for the first page. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaManagedAgentsListMemoryStoresResponse: object { data, next_page }` A page of `memory_store` results, ordered by `created_at` descending (newest first). - `data: optional array of BetaManagedAgentsMemoryStore` Memory stores on this page, newest first. Empty when there are no stores matching the filters. - `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. - `created_at: string` A timestamp in RFC 3339 format - `name: string` Human-readable name for the store. 1–255 characters. The store's mount-path slug under `/mnt/memory/` is derived from this name. - `type: "memory_store"` - `"memory_store"` - `updated_at: string` A timestamp in RFC 3339 format - `archived_at: optional string` A timestamp in RFC 3339 format - `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. Empty string when unset. - `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. Returned on retrieve/list but not filterable. - `next_page: optional string` Opaque cursor for the next page (a `page_...` value). Pass as `page` on the next request. `null` when there are no more results. ### Example ```cli ant beta:memory-stores list \ --api-key my-anthropic-api-key ``` #### Response ```json { "data": [ { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } ], "next_page": "next_page" } ``` ## Retrieve a memory store `$ ant beta:memory-stores retrieve` **get** `/v1/memory_stores/{memory_store_id}` Retrieve a memory store ### Parameters - `--memory-store-id: string` Path parameter memory_store_id - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_memory_store: object { id, created_at, name, 5 more }` A `memory_store`: a named container for agent memories, scoped to a workspace. Attach a store to a session via `resources[]` to mount it as a directory the agent can read and write. - `id: string` Unique identifier for the memory store (a `memstore_...` tagged ID). Use this when attaching the store to a session, or in the `{memory_store_id}` path parameter of subsequent calls. - `created_at: string` A timestamp in RFC 3339 format - `name: string` Human-readable name for the store. 1–255 characters. The store's mount-path slug under `/mnt/memory/` is derived from this name. - `type: "memory_store"` - `"memory_store"` - `updated_at: string` A timestamp in RFC 3339 format - `archived_at: optional string` A timestamp in RFC 3339 format - `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. Empty string when unset. - `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. Returned on retrieve/list but not filterable. ### Example ```cli ant beta:memory-stores retrieve \ --api-key my-anthropic-api-key \ --memory-store-id memory_store_id ``` #### Response ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } ``` ## Update a memory store `$ ant beta:memory-stores update` **post** `/v1/memory_stores/{memory_store_id}` Update a memory store ### Parameters - `--memory-store-id: string` Path param: Path parameter memory_store_id - `--description: optional string` Body param: New description for the store, up to 1024 characters. Pass an empty string to clear it. - `--metadata: optional map[string]` Body param: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars. - `--name: optional string` Body param: New human-readable name for the store. 1–255 characters; no control characters. Renaming changes the slug used for the store's `mount_path` in sessions created after the update. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_memory_store: object { id, created_at, name, 5 more }` A `memory_store`: a named container for agent memories, scoped to a workspace. Attach a store to a session via `resources[]` to mount it as a directory the agent can read and write. - `id: string` Unique identifier for the memory store (a `memstore_...` tagged ID). Use this when attaching the store to a session, or in the `{memory_store_id}` path parameter of subsequent calls. - `created_at: string` A timestamp in RFC 3339 format - `name: string` Human-readable name for the store. 1–255 characters. The store's mount-path slug under `/mnt/memory/` is derived from this name. - `type: "memory_store"` - `"memory_store"` - `updated_at: string` A timestamp in RFC 3339 format - `archived_at: optional string` A timestamp in RFC 3339 format - `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. Empty string when unset. - `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. Returned on retrieve/list but not filterable. ### Example ```cli ant beta:memory-stores update \ --api-key my-anthropic-api-key \ --memory-store-id memory_store_id ``` #### Response ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } ``` ## Delete a memory store `$ ant beta:memory-stores delete` **delete** `/v1/memory_stores/{memory_store_id}` Delete a memory store ### Parameters - `--memory-store-id: string` Path parameter memory_store_id - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_deleted_memory_store: object { id, type }` Confirmation that a `memory_store` was deleted. - `id: string` ID of the deleted memory store (a `memstore_...` identifier). The store and all its memories and versions are no longer retrievable. - `type: "memory_store_deleted"` - `"memory_store_deleted"` ### Example ```cli ant beta:memory-stores delete \ --api-key my-anthropic-api-key \ --memory-store-id memory_store_id ``` #### Response ```json { "id": "id", "type": "memory_store_deleted" } ``` ## Archive a memory store `$ ant beta:memory-stores archive` **post** `/v1/memory_stores/{memory_store_id}/archive` Archive a memory store ### Parameters - `--memory-store-id: string` Path parameter memory_store_id - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_memory_store: object { id, created_at, name, 5 more }` A `memory_store`: a named container for agent memories, scoped to a workspace. Attach a store to a session via `resources[]` to mount it as a directory the agent can read and write. - `id: string` Unique identifier for the memory store (a `memstore_...` tagged ID). Use this when attaching the store to a session, or in the `{memory_store_id}` path parameter of subsequent calls. - `created_at: string` A timestamp in RFC 3339 format - `name: string` Human-readable name for the store. 1–255 characters. The store's mount-path slug under `/mnt/memory/` is derived from this name. - `type: "memory_store"` - `"memory_store"` - `updated_at: string` A timestamp in RFC 3339 format - `archived_at: optional string` A timestamp in RFC 3339 format - `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. Empty string when unset. - `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. Returned on retrieve/list but not filterable. ### Example ```cli ant beta:memory-stores archive \ --api-key my-anthropic-api-key \ --memory-store-id memory_store_id ``` #### Response ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "name": "name", "type": "memory_store", "updated_at": "2019-12-27T18:11:19.117Z", "archived_at": "2019-12-27T18:11:19.117Z", "description": "description", "metadata": { "foo": "string" } } ``` ## Domain Types ### Beta Managed Agents Deleted Memory Store - `beta_managed_agents_deleted_memory_store: object { id, type }` Confirmation that a `memory_store` was deleted. - `id: string` ID of the deleted memory store (a `memstore_...` identifier). The store and all its memories and versions are no longer retrievable. - `type: "memory_store_deleted"` - `"memory_store_deleted"` ### Beta Managed Agents Memory Store - `beta_managed_agents_memory_store: object { id, created_at, name, 5 more }` A `memory_store`: a named container for agent memories, scoped to a workspace. Attach a store to a session via `resources[]` to mount it as a directory the agent can read and write. - `id: string` Unique identifier for the memory store (a `memstore_...` tagged ID). Use this when attaching the store to a session, or in the `{memory_store_id}` path parameter of subsequent calls. - `created_at: string` A timestamp in RFC 3339 format - `name: string` Human-readable name for the store. 1–255 characters. The store's mount-path slug under `/mnt/memory/` is derived from this name. - `type: "memory_store"` - `"memory_store"` - `updated_at: string` A timestamp in RFC 3339 format - `archived_at: optional string` A timestamp in RFC 3339 format - `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. Empty string when unset. - `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. Returned on retrieve/list but not filterable. # Memories ## Create a memory `$ ant beta:memory-stores:memories create` **post** `/v1/memory_stores/{memory_store_id}/memories` Create a memory ### Parameters - `--memory-store-id: string` Path param: Path parameter memory_store_id - `--content: string` Body param: UTF-8 text content for the new memory. Maximum 100 kB (102,400 bytes). Required; pass `""` explicitly to create an empty memory. - `--path: string` Body param: Hierarchical path for the new memory, e.g. `/projects/foo/notes.md`. Must start with `/`, contain at least one non-empty segment, and be at most 1,024 bytes. Must not contain empty segments, `.` or `..` segments, control or format characters, and must be NFC-normalized. Paths are case-sensitive. - `--view: optional "basic" or "full"` Query param: Query parameter for view - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_memory: object { id, content_sha256, content_size_bytes, 7 more }` A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update. - `id: string` Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory. - `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`. - `created_at: string` A timestamp in RFC 3339 format - `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 full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes. - `type: "memory"` - `"memory"` - `updated_at: string` A timestamp in RFC 3339 format - `content: optional string` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). ### Example ```cli ant beta:memory-stores:memories create \ --api-key my-anthropic-api-key \ --memory-store-id memory_store_id \ --content content \ --path xx ``` #### Response ```json { "id": "id", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_at": "2019-12-27T18:11:19.117Z", "memory_store_id": "memory_store_id", "memory_version_id": "memory_version_id", "path": "path", "type": "memory", "updated_at": "2019-12-27T18:11:19.117Z", "content": "content" } ``` ## List memories `$ ant beta:memory-stores:memories list` **get** `/v1/memory_stores/{memory_store_id}/memories` List memories ### Parameters - `--memory-store-id: string` Path param: Path parameter memory_store_id - `--depth: optional number` Query param: Query parameter for depth - `--limit: optional number` Query param: Query parameter for limit - `--order: optional "asc" or "desc"` Query param: Query parameter for order - `--order-by: optional string` Query param: Query parameter for order_by - `--page: optional string` Query param: Query parameter for page - `--path-prefix: optional string` Query param: Optional path prefix filter (raw string-prefix match; include a trailing slash for directory-scoped lists). This value appears in request URLs. Do not include secrets or personally identifiable information. - `--view: optional "basic" or "full"` Query param: Query parameter for view - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaManagedAgentsListMemoriesResult: object { data, next_page }` Response payload for [List memories](/docs/en/api/beta/memory_stores/memories/list). - `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 appear in the requested `order_by`/`order`. - `beta_managed_agents_memory: object { id, content_sha256, content_size_bytes, 7 more }` A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update. - `id: string` Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory. - `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`. - `created_at: string` A timestamp in RFC 3339 format - `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 full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes. - `type: "memory"` - `"memory"` - `updated_at: string` A timestamp in RFC 3339 format - `content: optional string` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). - `beta_managed_agents_memory_prefix: object { path, type }` A rolled-up directory marker returned by [List memories](/docs/en/api/beta/memory_stores/memories/list) when `depth` is set. Indicates that one or more memories exist deeper than the requested depth under this prefix. This is a list-time rollup, not a stored resource; it has no ID and no lifecycle. Each prefix counts toward the page `limit` and interleaves with `memory` items in path order. - `path: string` The rolled-up path prefix, including a trailing `/` (e.g. `/projects/foo/`). Pass this value as `path_prefix` on a subsequent list call to drill into the directory. - `type: "memory_prefix"` - `"memory_prefix"` - `next_page: optional string` 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 ```cli ant beta:memory-stores:memories list \ --api-key my-anthropic-api-key \ --memory-store-id memory_store_id ``` #### Response ```json { "data": [ { "id": "id", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_at": "2019-12-27T18:11:19.117Z", "memory_store_id": "memory_store_id", "memory_version_id": "memory_version_id", "path": "path", "type": "memory", "updated_at": "2019-12-27T18:11:19.117Z", "content": "content" } ], "next_page": "next_page" } ``` ## Retrieve a memory `$ ant beta:memory-stores:memories retrieve` **get** `/v1/memory_stores/{memory_store_id}/memories/{memory_id}` Retrieve a memory ### Parameters - `--memory-store-id: string` Path param: Path parameter memory_store_id - `--memory-id: string` Path param: Path parameter memory_id - `--view: optional "basic" or "full"` Query param: Query parameter for view - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_memory: object { id, content_sha256, content_size_bytes, 7 more }` A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update. - `id: string` Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory. - `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`. - `created_at: string` A timestamp in RFC 3339 format - `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 full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes. - `type: "memory"` - `"memory"` - `updated_at: string` A timestamp in RFC 3339 format - `content: optional string` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). ### Example ```cli ant beta:memory-stores:memories retrieve \ --api-key my-anthropic-api-key \ --memory-store-id memory_store_id \ --memory-id memory_id ``` #### Response ```json { "id": "id", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_at": "2019-12-27T18:11:19.117Z", "memory_store_id": "memory_store_id", "memory_version_id": "memory_version_id", "path": "path", "type": "memory", "updated_at": "2019-12-27T18:11:19.117Z", "content": "content" } ``` ## Update a memory `$ ant beta:memory-stores:memories update` **post** `/v1/memory_stores/{memory_store_id}/memories/{memory_id}` Update a memory ### Parameters - `--memory-store-id: string` Path param: Path parameter memory_store_id - `--memory-id: string` Path param: Path parameter memory_id - `--view: optional "basic" or "full"` Query param: Query parameter for view - `--content: optional string` Body param: New UTF-8 text content for the memory. Maximum 100 kB (102,400 bytes). Omit to leave the content unchanged (e.g., for a rename-only update). - `--path: optional string` Body param: New path for the memory (a rename). Must start with `/`, contain at least one non-empty segment, and be at most 1,024 bytes. Must not contain empty segments, `.` or `..` segments, control or format characters, and must be NFC-normalized. Paths are case-sensitive. The memory's `id` is preserved across renames. Omit to leave the path unchanged. - `--precondition: optional object { type, content_sha256 }` Body param: Optimistic-concurrency precondition: the update applies only if the memory's stored `content_sha256` equals the supplied value. On mismatch, the request returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and retry against the fresh state. If the precondition fails but the stored state already exactly matches the requested `content` and `path`, the server returns 200 instead of 409. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_memory: object { id, content_sha256, content_size_bytes, 7 more }` A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update. - `id: string` Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory. - `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`. - `created_at: string` A timestamp in RFC 3339 format - `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 full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes. - `type: "memory"` - `"memory"` - `updated_at: string` A timestamp in RFC 3339 format - `content: optional string` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). ### Example ```cli ant beta:memory-stores:memories update \ --api-key my-anthropic-api-key \ --memory-store-id memory_store_id \ --memory-id memory_id ``` #### Response ```json { "id": "id", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_at": "2019-12-27T18:11:19.117Z", "memory_store_id": "memory_store_id", "memory_version_id": "memory_version_id", "path": "path", "type": "memory", "updated_at": "2019-12-27T18:11:19.117Z", "content": "content" } ``` ## Delete a memory `$ ant beta:memory-stores:memories delete` **delete** `/v1/memory_stores/{memory_store_id}/memories/{memory_id}` Delete a memory ### Parameters - `--memory-store-id: string` Path param: Path parameter memory_store_id - `--memory-id: string` Path param: Path parameter memory_id - `--expected-content-sha256: optional string` Query param: Query parameter for expected_content_sha256 - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_deleted_memory: object { id, type }` Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. - `id: string` ID of the deleted memory (a `mem_...` value). - `type: "memory_deleted"` - `"memory_deleted"` ### Example ```cli ant beta:memory-stores:memories delete \ --api-key my-anthropic-api-key \ --memory-store-id memory_store_id \ --memory-id memory_id ``` #### Response ```json { "id": "id", "type": "memory_deleted" } ``` ## Domain Types ### Beta Managed Agents Conflict Error - `beta_managed_agents_conflict_error: object { type, message }` - `type: "conflict_error"` - `"conflict_error"` - `message: optional string` ### Beta Managed Agents Content Sha256 Precondition - `beta_managed_agents_content_sha256_precondition: object { type, content_sha256 }` Optimistic-concurrency precondition: the update applies only if the memory's stored `content_sha256` equals the supplied value. On mismatch, the request returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and retry against the fresh state. If the precondition fails but the stored state already exactly matches the requested `content` and `path`, the server returns 200 instead of 409. - `type: "content_sha256"` - `"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. ### Beta Managed Agents Deleted Memory - `beta_managed_agents_deleted_memory: object { id, type }` Tombstone returned by [Delete a memory](/docs/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. - `id: string` ID of the deleted memory (a `mem_...` value). - `type: "memory_deleted"` - `"memory_deleted"` ### Beta Managed Agents Error - `beta_managed_agents_error: BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 9 more` - `beta_invalid_request_error: object { message, type }` - `message: string` - `type: "invalid_request_error"` - `beta_authentication_error: object { message, type }` - `message: string` - `type: "authentication_error"` - `beta_billing_error: object { message, type }` - `message: string` - `type: "billing_error"` - `beta_permission_error: object { message, type }` - `message: string` - `type: "permission_error"` - `beta_not_found_error: object { message, type }` - `message: string` - `type: "not_found_error"` - `beta_rate_limit_error: object { message, type }` - `message: string` - `type: "rate_limit_error"` - `beta_gateway_timeout_error: object { message, type }` - `message: string` - `type: "timeout_error"` - `beta_api_error: object { message, type }` - `message: string` - `type: "api_error"` - `beta_overloaded_error: object { message, type }` - `message: string` - `type: "overloaded_error"` - `beta_managed_agents_memory_precondition_failed_error: object { type, message }` - `type: "memory_precondition_failed_error"` - `"memory_precondition_failed_error"` - `message: optional string` - `beta_managed_agents_memory_path_conflict_error: object { type, conflicting_memory_id, conflicting_path, message }` - `type: "memory_path_conflict_error"` - `"memory_path_conflict_error"` - `conflicting_memory_id: optional string` - `conflicting_path: optional string` - `message: optional string` - `beta_managed_agents_conflict_error: object { type, message }` - `type: "conflict_error"` - `"conflict_error"` - `message: optional string` ### Beta Managed Agents Memory - `beta_managed_agents_memory: object { id, content_sha256, content_size_bytes, 7 more }` A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update. - `id: string` Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory. - `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`. - `created_at: string` A timestamp in RFC 3339 format - `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 full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes. - `type: "memory"` - `"memory"` - `updated_at: string` A timestamp in RFC 3339 format - `content: optional string` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). ### Beta Managed Agents Memory List Item - `beta_managed_agents_memory_list_item: BetaManagedAgentsMemory or BetaManagedAgentsMemoryPrefix` One item in a [List memories](/docs/en/api/beta/memory_stores/memories/list) response: either a `memory` object or, when `depth` is set, a `memory_prefix` rollup marker. - `beta_managed_agents_memory: object { id, content_sha256, content_size_bytes, 7 more }` A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update. - `id: string` Unique identifier for this memory (a `mem_...` value). Stable across renames; use this ID, not the path, to read, update, or delete the memory. - `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`. - `created_at: string` A timestamp in RFC 3339 format - `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 full history via [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `path: string` Hierarchical path of the memory within the store, e.g. `/projects/foo/notes.md`. Always starts with `/`. Paths are case-sensitive and unique within a store. Maximum 1,024 bytes. - `type: "memory"` - `"memory"` - `updated_at: string` A timestamp in RFC 3339 format - `content: optional string` The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). - `beta_managed_agents_memory_prefix: object { path, type }` A rolled-up directory marker returned by [List memories](/docs/en/api/beta/memory_stores/memories/list) when `depth` is set. Indicates that one or more memories exist deeper than the requested depth under this prefix. This is a list-time rollup, not a stored resource; it has no ID and no lifecycle. Each prefix counts toward the page `limit` and interleaves with `memory` items in path order. - `path: string` The rolled-up path prefix, including a trailing `/` (e.g. `/projects/foo/`). Pass this value as `path_prefix` on a subsequent list call to drill into the directory. - `type: "memory_prefix"` - `"memory_prefix"` ### Beta Managed Agents Memory Path Conflict Error - `beta_managed_agents_memory_path_conflict_error: object { type, conflicting_memory_id, conflicting_path, message }` - `type: "memory_path_conflict_error"` - `"memory_path_conflict_error"` - `conflicting_memory_id: optional string` - `conflicting_path: optional string` - `message: optional string` ### Beta Managed Agents Memory Precondition Failed Error - `beta_managed_agents_memory_precondition_failed_error: object { type, message }` - `type: "memory_precondition_failed_error"` - `"memory_precondition_failed_error"` - `message: optional string` ### Beta Managed Agents Memory Prefix - `beta_managed_agents_memory_prefix: object { path, type }` A rolled-up directory marker returned by [List memories](/docs/en/api/beta/memory_stores/memories/list) when `depth` is set. Indicates that one or more memories exist deeper than the requested depth under this prefix. This is a list-time rollup, not a stored resource; it has no ID and no lifecycle. Each prefix counts toward the page `limit` and interleaves with `memory` items in path order. - `path: string` The rolled-up path prefix, including a trailing `/` (e.g. `/projects/foo/`). Pass this value as `path_prefix` on a subsequent list call to drill into the directory. - `type: "memory_prefix"` - `"memory_prefix"` ### Beta Managed Agents Memory View - `beta_managed_agents_memory_view: "basic" or "full"` 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"` - `"full"` ### Beta Managed Agents Precondition - `beta_managed_agents_precondition: object { type, content_sha256 }` Optimistic-concurrency precondition: the update applies only if the memory's stored `content_sha256` equals the supplied value. On mismatch, the request returns `memory_precondition_failed_error` (HTTP 409); re-read the memory and retry against the fresh state. If the precondition fails but the stored state already exactly matches the requested `content` and `path`, the server returns 200 instead of 409. - `type: "content_sha256"` - `"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. # Memory Versions ## List memory versions `$ ant beta:memory-stores:memory-versions list` **get** `/v1/memory_stores/{memory_store_id}/memory_versions` List memory versions ### Parameters - `--memory-store-id: string` Path param: Path parameter memory_store_id - `--api-key-id: optional string` Query param: Query parameter for api_key_id - `--created-at-gte: optional string` Query param: Return versions created at or after this time (inclusive). - `--created-at-lte: optional string` Query param: Return versions created at or before this time (inclusive). - `--limit: optional number` Query param: Query parameter for limit - `--memory-id: optional string` Query param: Query parameter for memory_id - `--operation: optional "created" or "modified" or "deleted"` Query param: Query parameter for operation - `--page: optional string` Query param: Query parameter for page - `--session-id: optional string` Query param: Query parameter for session_id - `--view: optional "basic" or "full"` Query param: Query parameter for view - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaManagedAgentsListMemoryVersionsResult: object { data, next_page }` Response payload for [List memory versions](/docs/en/api/beta/memory_stores/memory_versions/list). - `data: optional array of BetaManagedAgentsMemoryVersion` One page of `memory_version` objects, ordered by `created_at` descending (newest first), with `id` as tiebreak. - `id: string` Unique identifier for this version (a `memver_...` value). - `created_at: string` A timestamp in RFC 3339 format - `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](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. - `memory_store_id: string` ID of the memory store this version belongs to (a `memstore_...` value). - `operation: "created" or "modified" or "deleted"` The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values. - `"created"` - `"modified"` - `"deleted"` - `type: "memory_version"` - `"memory_version"` - `content: optional string` The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set. - `content_sha256: optional string` Lowercase hex SHA-256 digest of `content` as of this version (64 characters). `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `content_size_bytes: optional number` Size of `content` in bytes as of this version. `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `created_by: optional BetaManagedAgentsSessionActor or BetaManagedAgentsAPIActor or BetaManagedAgentsUserActor` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). - `beta_managed_agents_session_actor: object { session_id, type }` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `session_id: string` ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/docs/en/api/sessions-retrieve) for further provenance. - `type: "session_actor"` - `"session_actor"` - `beta_managed_agents_api_actor: object { api_key_id, type }` Attribution for a write made directly via the public API (outside of any session). - `api_key_id: string` ID of the API key that performed the write. This identifies the key, not the secret. - `type: "api_actor"` - `"api_actor"` - `beta_managed_agents_user_actor: object { type, user_id }` Attribution for a write made by a human user through the Anthropic Console. - `type: "user_actor"` - `"user_actor"` - `user_id: string` ID of the user who performed the write (a `user_...` value). - `path: optional string` The memory's path at the time of this write. `null` if and only if `redacted_at` is set. - `redacted_at: optional string` A timestamp in RFC 3339 format - `redacted_by: optional BetaManagedAgentsSessionActor or BetaManagedAgentsAPIActor or BetaManagedAgentsUserActor` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). - `beta_managed_agents_session_actor: object { session_id, type }` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `beta_managed_agents_api_actor: object { api_key_id, type }` Attribution for a write made directly via the public API (outside of any session). - `beta_managed_agents_user_actor: object { type, user_id }` Attribution for a write made by a human user through the Anthropic Console. - `next_page: optional string` 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 ```cli ant beta:memory-stores:memory-versions list \ --api-key my-anthropic-api-key \ --memory-store-id memory_store_id ``` #### Response ```json { "data": [ { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "memory_id": "memory_id", "memory_store_id": "memory_store_id", "operation": "created", "type": "memory_version", "content": "content", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_by": { "session_id": "x", "type": "session_actor" }, "path": "path", "redacted_at": "2019-12-27T18:11:19.117Z", "redacted_by": { "session_id": "x", "type": "session_actor" } } ], "next_page": "next_page" } ``` ## Retrieve a memory version `$ ant beta:memory-stores:memory-versions retrieve` **get** `/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}` Retrieve a memory version ### Parameters - `--memory-store-id: string` Path param: Path parameter memory_store_id - `--memory-version-id: string` Path param: Path parameter memory_version_id - `--view: optional "basic" or "full"` Query param: Query parameter for view - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_memory_version: object { id, created_at, memory_id, 10 more }` A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` Unique identifier for this version (a `memver_...` value). - `created_at: string` A timestamp in RFC 3339 format - `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](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. - `memory_store_id: string` ID of the memory store this version belongs to (a `memstore_...` value). - `operation: "created" or "modified" or "deleted"` The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values. - `"created"` - `"modified"` - `"deleted"` - `type: "memory_version"` - `"memory_version"` - `content: optional string` The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set. - `content_sha256: optional string` Lowercase hex SHA-256 digest of `content` as of this version (64 characters). `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `content_size_bytes: optional number` Size of `content` in bytes as of this version. `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `created_by: optional BetaManagedAgentsSessionActor or BetaManagedAgentsAPIActor or BetaManagedAgentsUserActor` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). - `beta_managed_agents_session_actor: object { session_id, type }` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `session_id: string` ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/docs/en/api/sessions-retrieve) for further provenance. - `type: "session_actor"` - `"session_actor"` - `beta_managed_agents_api_actor: object { api_key_id, type }` Attribution for a write made directly via the public API (outside of any session). - `api_key_id: string` ID of the API key that performed the write. This identifies the key, not the secret. - `type: "api_actor"` - `"api_actor"` - `beta_managed_agents_user_actor: object { type, user_id }` Attribution for a write made by a human user through the Anthropic Console. - `type: "user_actor"` - `"user_actor"` - `user_id: string` ID of the user who performed the write (a `user_...` value). - `path: optional string` The memory's path at the time of this write. `null` if and only if `redacted_at` is set. - `redacted_at: optional string` A timestamp in RFC 3339 format - `redacted_by: optional BetaManagedAgentsSessionActor or BetaManagedAgentsAPIActor or BetaManagedAgentsUserActor` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). - `beta_managed_agents_session_actor: object { session_id, type }` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `beta_managed_agents_api_actor: object { api_key_id, type }` Attribution for a write made directly via the public API (outside of any session). - `beta_managed_agents_user_actor: object { type, user_id }` Attribution for a write made by a human user through the Anthropic Console. ### Example ```cli ant beta:memory-stores:memory-versions retrieve \ --api-key my-anthropic-api-key \ --memory-store-id memory_store_id \ --memory-version-id memory_version_id ``` #### Response ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "memory_id": "memory_id", "memory_store_id": "memory_store_id", "operation": "created", "type": "memory_version", "content": "content", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_by": { "session_id": "x", "type": "session_actor" }, "path": "path", "redacted_at": "2019-12-27T18:11:19.117Z", "redacted_by": { "session_id": "x", "type": "session_actor" } } ``` ## Redact a memory version `$ ant beta:memory-stores:memory-versions redact` **post** `/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact` Redact a memory version ### Parameters - `--memory-store-id: string` Path param: Path parameter memory_store_id - `--memory-version-id: string` Path param: Path parameter memory_version_id - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_managed_agents_memory_version: object { id, created_at, memory_id, 10 more }` A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` Unique identifier for this version (a `memver_...` value). - `created_at: string` A timestamp in RFC 3339 format - `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](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. - `memory_store_id: string` ID of the memory store this version belongs to (a `memstore_...` value). - `operation: "created" or "modified" or "deleted"` The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values. - `"created"` - `"modified"` - `"deleted"` - `type: "memory_version"` - `"memory_version"` - `content: optional string` The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set. - `content_sha256: optional string` Lowercase hex SHA-256 digest of `content` as of this version (64 characters). `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `content_size_bytes: optional number` Size of `content` in bytes as of this version. `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `created_by: optional BetaManagedAgentsSessionActor or BetaManagedAgentsAPIActor or BetaManagedAgentsUserActor` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). - `beta_managed_agents_session_actor: object { session_id, type }` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `session_id: string` ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/docs/en/api/sessions-retrieve) for further provenance. - `type: "session_actor"` - `"session_actor"` - `beta_managed_agents_api_actor: object { api_key_id, type }` Attribution for a write made directly via the public API (outside of any session). - `api_key_id: string` ID of the API key that performed the write. This identifies the key, not the secret. - `type: "api_actor"` - `"api_actor"` - `beta_managed_agents_user_actor: object { type, user_id }` Attribution for a write made by a human user through the Anthropic Console. - `type: "user_actor"` - `"user_actor"` - `user_id: string` ID of the user who performed the write (a `user_...` value). - `path: optional string` The memory's path at the time of this write. `null` if and only if `redacted_at` is set. - `redacted_at: optional string` A timestamp in RFC 3339 format - `redacted_by: optional BetaManagedAgentsSessionActor or BetaManagedAgentsAPIActor or BetaManagedAgentsUserActor` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). - `beta_managed_agents_session_actor: object { session_id, type }` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `beta_managed_agents_api_actor: object { api_key_id, type }` Attribution for a write made directly via the public API (outside of any session). - `beta_managed_agents_user_actor: object { type, user_id }` Attribution for a write made by a human user through the Anthropic Console. ### Example ```cli ant beta:memory-stores:memory-versions redact \ --api-key my-anthropic-api-key \ --memory-store-id memory_store_id \ --memory-version-id memory_version_id ``` #### Response ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "memory_id": "memory_id", "memory_store_id": "memory_store_id", "operation": "created", "type": "memory_version", "content": "content", "content_sha256": "content_sha256", "content_size_bytes": 0, "created_by": { "session_id": "x", "type": "session_actor" }, "path": "path", "redacted_at": "2019-12-27T18:11:19.117Z", "redacted_by": { "session_id": "x", "type": "session_actor" } } ``` ## Domain Types ### Beta Managed Agents Actor - `beta_managed_agents_actor: BetaManagedAgentsSessionActor or BetaManagedAgentsAPIActor or BetaManagedAgentsUserActor` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). - `beta_managed_agents_session_actor: object { session_id, type }` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `session_id: string` ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/docs/en/api/sessions-retrieve) for further provenance. - `type: "session_actor"` - `"session_actor"` - `beta_managed_agents_api_actor: object { api_key_id, type }` Attribution for a write made directly via the public API (outside of any session). - `api_key_id: string` ID of the API key that performed the write. This identifies the key, not the secret. - `type: "api_actor"` - `"api_actor"` - `beta_managed_agents_user_actor: object { type, user_id }` Attribution for a write made by a human user through the Anthropic Console. - `type: "user_actor"` - `"user_actor"` - `user_id: string` ID of the user who performed the write (a `user_...` value). ### Beta Managed Agents API Actor - `beta_managed_agents_api_actor: object { api_key_id, type }` Attribution for a write made directly via the public API (outside of any session). - `api_key_id: string` ID of the API key that performed the write. This identifies the key, not the secret. - `type: "api_actor"` - `"api_actor"` ### Beta Managed Agents Memory Version - `beta_managed_agents_memory_version: object { id, created_at, memory_id, 10 more }` A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status. - `id: string` Unique identifier for this version (a `memver_...` value). - `created_at: string` A timestamp in RFC 3339 format - `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](/docs/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. - `memory_store_id: string` ID of the memory store this version belongs to (a `memstore_...` value). - `operation: "created" or "modified" or "deleted"` The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values. - `"created"` - `"modified"` - `"deleted"` - `type: "memory_version"` - `"memory_version"` - `content: optional string` The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set. - `content_sha256: optional string` Lowercase hex SHA-256 digest of `content` as of this version (64 characters). `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `content_size_bytes: optional number` Size of `content` in bytes as of this version. `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - `created_by: optional BetaManagedAgentsSessionActor or BetaManagedAgentsAPIActor or BetaManagedAgentsUserActor` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). - `beta_managed_agents_session_actor: object { session_id, type }` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `session_id: string` ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/docs/en/api/sessions-retrieve) for further provenance. - `type: "session_actor"` - `"session_actor"` - `beta_managed_agents_api_actor: object { api_key_id, type }` Attribution for a write made directly via the public API (outside of any session). - `api_key_id: string` ID of the API key that performed the write. This identifies the key, not the secret. - `type: "api_actor"` - `"api_actor"` - `beta_managed_agents_user_actor: object { type, user_id }` Attribution for a write made by a human user through the Anthropic Console. - `type: "user_actor"` - `"user_actor"` - `user_id: string` ID of the user who performed the write (a `user_...` value). - `path: optional string` The memory's path at the time of this write. `null` if and only if `redacted_at` is set. - `redacted_at: optional string` A timestamp in RFC 3339 format - `redacted_by: optional BetaManagedAgentsSessionActor or BetaManagedAgentsAPIActor or BetaManagedAgentsUserActor` Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/docs/en/api/sessions-retrieve). - `beta_managed_agents_session_actor: object { session_id, type }` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `beta_managed_agents_api_actor: object { api_key_id, type }` Attribution for a write made directly via the public API (outside of any session). - `beta_managed_agents_user_actor: object { type, user_id }` Attribution for a write made by a human user through the Anthropic Console. ### Beta Managed Agents Memory Version Operation - `beta_managed_agents_memory_version_operation: "created" or "modified" or "deleted"` The kind of mutation a `memory_version` records. Every non-no-op mutation to a memory appends exactly one version row with one of these values. - `"created"` - `"modified"` - `"deleted"` ### Beta Managed Agents Session Actor - `beta_managed_agents_session_actor: object { session_id, type }` Attribution for a write made by an agent during a session, through the mounted filesystem at `/mnt/memory/`. - `session_id: string` ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/docs/en/api/sessions-retrieve) for further provenance. - `type: "session_actor"` - `"session_actor"` ### Beta Managed Agents User Actor - `beta_managed_agents_user_actor: object { type, user_id }` Attribution for a write made by a human user through the Anthropic Console. - `type: "user_actor"` - `"user_actor"` - `user_id: string` ID of the user who performed the write (a `user_...` value). # Files ## Upload File `$ ant beta:files upload` **post** `/v1/files` Upload File ### Parameters - `--file: string` Body param: The file to upload - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `file_metadata: object { id, created_at, filename, 5 more }` - `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. - `filename: string` Original filename of the uploaded file. - `mime_type: string` MIME type of the file. - `size_bytes: number` Size of the file in bytes. - `type: "file"` Object type. For files, this is always `"file"`. - `downloadable: optional boolean` Whether the file can be downloaded. - `scope: optional object { id, type }` The scope of this file, indicating the context in which it was created (e.g., a session). - `id: string` The ID of the scoping resource (e.g., the session ID). - `type: "session"` The type of scope (e.g., `"session"`). ### Example ```cli ant beta:files upload \ --api-key my-anthropic-api-key \ --file 'Example data' ``` #### Response ```json { "id": "file_011CNha8iCJcU1wXNR6q4V8w", "created_at": "2025-04-15T18:37:24.100435Z", "filename": "document.pdf", "mime_type": "application/pdf", "size_bytes": 102400, "type": "file", "downloadable": false, "scope": { "id": "id", "type": "session" } } ``` ## List Files `$ ant beta:files list` **get** `/v1/files` List Files ### Parameters - `--after-id: optional string` Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `--before-id: optional string` Query param: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `--limit: optional number` Query param: Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. - `--scope-id: optional string` Query param: Filter by scope ID. Only returns files associated with the specified scope (e.g., a session ID). - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaFileListResponse: object { data, first_id, has_more, last_id }` - `data: array of FileMetadata` List of file metadata objects. - `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. - `filename: string` Original filename of the uploaded file. - `mime_type: string` MIME type of the file. - `size_bytes: number` Size of the file in bytes. - `type: "file"` Object type. For files, this is always `"file"`. - `downloadable: optional boolean` Whether the file can be downloaded. - `scope: optional object { id, type }` The scope of this file, indicating the context in which it was created (e.g., a session). - `id: string` The ID of the scoping resource (e.g., the session ID). - `type: "session"` The type of scope (e.g., `"session"`). - `first_id: optional string` ID of the first file in this page of results. - `has_more: optional boolean` Whether there are more results available. - `last_id: optional string` ID of the last file in this page of results. ### Example ```cli ant beta:files list \ --api-key my-anthropic-api-key ``` #### Response ```json { "data": [ { "id": "file_011CNha8iCJcU1wXNR6q4V8w", "created_at": "2025-04-15T18:37:24.100435Z", "filename": "document.pdf", "mime_type": "application/pdf", "size_bytes": 102400, "type": "file", "downloadable": false, "scope": { "id": "id", "type": "session" } } ], "first_id": "file_011CNha8iCJcU1wXNR6q4V8w", "has_more": true, "last_id": "file_013Zva2CMHLNnXjNJJKqJ2EF" } ``` ## Download File `$ ant beta:files download` **get** `/v1/files/{file_id}/content` Download File ### Parameters - `--file-id: string` ID of the File. - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `unnamed_schema_0: file path` ### Example ```cli ant beta:files download \ --api-key my-anthropic-api-key \ --file-id file_id ``` ## Get File Metadata `$ ant beta:files retrieve-metadata` **get** `/v1/files/{file_id}` Get File Metadata ### Parameters - `--file-id: string` ID of the File. - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `file_metadata: object { id, created_at, filename, 5 more }` - `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. - `filename: string` Original filename of the uploaded file. - `mime_type: string` MIME type of the file. - `size_bytes: number` Size of the file in bytes. - `type: "file"` Object type. For files, this is always `"file"`. - `downloadable: optional boolean` Whether the file can be downloaded. - `scope: optional object { id, type }` The scope of this file, indicating the context in which it was created (e.g., a session). - `id: string` The ID of the scoping resource (e.g., the session ID). - `type: "session"` The type of scope (e.g., `"session"`). ### Example ```cli ant beta:files retrieve-metadata \ --api-key my-anthropic-api-key \ --file-id file_id ``` #### Response ```json { "id": "file_011CNha8iCJcU1wXNR6q4V8w", "created_at": "2025-04-15T18:37:24.100435Z", "filename": "document.pdf", "mime_type": "application/pdf", "size_bytes": 102400, "type": "file", "downloadable": false, "scope": { "id": "id", "type": "session" } } ``` ## Delete File `$ ant beta:files delete` **delete** `/v1/files/{file_id}` Delete File ### Parameters - `--file-id: string` ID of the File. - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `deleted_file: object { id, type }` - `id: string` ID of the deleted file. - `type: optional "file_deleted"` Deleted object type. For file deletion, this is always `"file_deleted"`. - `"file_deleted"` ### Example ```cli ant beta:files delete \ --api-key my-anthropic-api-key \ --file-id file_id ``` #### Response ```json { "id": "file_011CNha8iCJcU1wXNR6q4V8w", "type": "file_deleted" } ``` ## Domain Types ### Beta File Scope - `beta_file_scope: object { id, type }` - `id: string` The ID of the scoping resource (e.g., the session ID). - `type: "session"` The type of scope (e.g., `"session"`). ### Deleted File - `deleted_file: object { id, type }` - `id: string` ID of the deleted file. - `type: optional "file_deleted"` Deleted object type. For file deletion, this is always `"file_deleted"`. - `"file_deleted"` ### File Metadata - `file_metadata: object { id, created_at, filename, 5 more }` - `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. - `filename: string` Original filename of the uploaded file. - `mime_type: string` MIME type of the file. - `size_bytes: number` Size of the file in bytes. - `type: "file"` Object type. For files, this is always `"file"`. - `downloadable: optional boolean` Whether the file can be downloaded. - `scope: optional object { id, type }` The scope of this file, indicating the context in which it was created (e.g., a session). - `id: string` The ID of the scoping resource (e.g., the session ID). - `type: "session"` The type of scope (e.g., `"session"`). # Skills ## Create Skill `$ ant beta:skills create` **post** `/v1/skills` Create Skill ### Parameters - `--display-title: optional string` Body param: Display title for the skill. This is a human-readable label that is not included in the prompt sent to the model. - `--file: optional array of string` Body param: Files to upload for the skill. All files must be in the same top-level directory and must include a SKILL.md file at the root of that directory. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaSkillNewResponse: object { id, created_at, display_title, 4 more }` - `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. - `display_title: string` Display title for the skill. This is a human-readable label that is not included in the prompt sent to the model. - `latest_version: string` The latest version identifier for the skill. This represents the most recent version of the skill that has been created. - `source: string` Source of the skill. This may be one of the following values: * `"custom"`: the skill was created by a user * `"anthropic"`: the skill was created by Anthropic - `type: string` Object type. For Skills, this is always `"skill"`. - `updated_at: string` ISO 8601 timestamp of when the skill was last updated. ### Example ```cli ant beta:skills create \ --api-key my-anthropic-api-key ``` #### Response ```json { "id": "skill_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "display_title": "My Custom Skill", "latest_version": "1759178010641129", "source": "custom", "type": "type", "updated_at": "2024-10-30T23:58:27.427722Z" } ``` ## List Skills `$ ant beta:skills list` **get** `/v1/skills` List Skills ### Parameters - `--limit: optional number` Query param: Number of results to return per page. Maximum value is 100. Defaults to 20. - `--page: optional string` Query param: Pagination token for fetching a specific page of results. Pass the value from a previous response's `next_page` field to get the next page of results. - `--source: optional string` Query param: Filter skills by source. If provided, only skills from the specified source will be returned: * `"custom"`: only return user-created skills * `"anthropic"`: only return Anthropic-created skills - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaListSkillsResponse: object { data, has_more, next_page }` - `data: array of object { id, created_at, display_title, 4 more }` List of skills. - `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. - `display_title: string` Display title for the skill. This is a human-readable label that is not included in the prompt sent to the model. - `latest_version: string` The latest version identifier for the skill. This represents the most recent version of the skill that has been created. - `source: string` Source of the skill. This may be one of the following values: * `"custom"`: the skill was created by a user * `"anthropic"`: the skill was created by Anthropic - `type: string` Object type. For Skills, this is always `"skill"`. - `updated_at: string` ISO 8601 timestamp of when the skill was last updated. - `has_more: boolean` Whether there are more results available. If `true`, there are additional results that can be fetched using the `next_page` token. - `next_page: string` Token for fetching the next page of results. If `null`, there are no more results available. Pass this value to the `page_token` parameter in the next request to get the next page. ### Example ```cli ant beta:skills list \ --api-key my-anthropic-api-key ``` #### Response ```json { "data": [ { "id": "skill_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "display_title": "My Custom Skill", "latest_version": "1759178010641129", "source": "custom", "type": "type", "updated_at": "2024-10-30T23:58:27.427722Z" } ], "has_more": true, "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get Skill `$ ant beta:skills retrieve` **get** `/v1/skills/{skill_id}` Get Skill ### Parameters - `--skill-id: string` Unique identifier for the skill. The format and length of IDs may change over time. - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `BetaSkillGetResponse: object { id, created_at, display_title, 4 more }` - `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. - `display_title: string` Display title for the skill. This is a human-readable label that is not included in the prompt sent to the model. - `latest_version: string` The latest version identifier for the skill. This represents the most recent version of the skill that has been created. - `source: string` Source of the skill. This may be one of the following values: * `"custom"`: the skill was created by a user * `"anthropic"`: the skill was created by Anthropic - `type: string` Object type. For Skills, this is always `"skill"`. - `updated_at: string` ISO 8601 timestamp of when the skill was last updated. ### Example ```cli ant beta:skills retrieve \ --api-key my-anthropic-api-key \ --skill-id skill_id ``` #### Response ```json { "id": "skill_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "display_title": "My Custom Skill", "latest_version": "1759178010641129", "source": "custom", "type": "type", "updated_at": "2024-10-30T23:58:27.427722Z" } ``` ## Delete Skill `$ ant beta:skills delete` **delete** `/v1/skills/{skill_id}` Delete Skill ### Parameters - `--skill-id: string` Unique identifier for the skill. The format and length of IDs may change over time. - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `BetaSkillDeleteResponse: object { id, type }` - `id: string` Unique identifier for the skill. The format and length of IDs may change over time. - `type: string` Deleted object type. For Skills, this is always `"skill_deleted"`. ### Example ```cli ant beta:skills delete \ --api-key my-anthropic-api-key \ --skill-id skill_id ``` #### Response ```json { "id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "type" } ``` # Versions ## Create Skill Version `$ ant beta:skills:versions create` **post** `/v1/skills/{skill_id}/versions` Create Skill Version ### Parameters - `--skill-id: string` Path param: Unique identifier for the skill. The format and length of IDs may change over time. - `--file: optional array of string` Body param: Files to upload for the skill. All files must be in the same top-level directory and must include a SKILL.md file at the root of that directory. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaSkillVersionNewResponse: object { id, created_at, description, 5 more }` - `id: string` Unique identifier for the skill version. The format and length of IDs may change over time. - `created_at: string` ISO 8601 timestamp of when the skill version was created. - `description: string` Description of the skill version. This is extracted from the SKILL.md file in the skill upload. - `directory: string` Directory name of the skill version. This is the top-level directory name that was extracted from the uploaded files. - `name: string` Human-readable name of the skill version. This is extracted from the SKILL.md file in the skill upload. - `skill_id: string` Identifier for the skill that this version belongs to. - `type: string` Object type. For Skill Versions, this is always `"skill_version"`. - `version: string` Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). ### Example ```cli ant beta:skills:versions create \ --api-key my-anthropic-api-key \ --skill-id skill_id ``` #### Response ```json { "id": "skillver_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "description": "A custom skill for doing something useful", "directory": "my-skill", "name": "my-skill", "skill_id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "type", "version": "1759178010641129" } ``` ## List Skill Versions `$ ant beta:skills:versions list` **get** `/v1/skills/{skill_id}/versions` List Skill Versions ### Parameters - `--skill-id: string` Path param: Unique identifier for the skill. The format and length of IDs may change over time. - `--limit: optional number` Query param: Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. - `--page: optional string` Query param: Optionally set to the `next_page` token from the previous response. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaListSkillVersionsResponse: object { data, has_more, next_page }` - `data: array of object { id, created_at, description, 5 more }` List of skill versions. - `id: string` Unique identifier for the skill version. The format and length of IDs may change over time. - `created_at: string` ISO 8601 timestamp of when the skill version was created. - `description: string` Description of the skill version. This is extracted from the SKILL.md file in the skill upload. - `directory: string` Directory name of the skill version. This is the top-level directory name that was extracted from the uploaded files. - `name: string` Human-readable name of the skill version. This is extracted from the SKILL.md file in the skill upload. - `skill_id: string` Identifier for the skill that this version belongs to. - `type: string` Object type. For Skill Versions, this is always `"skill_version"`. - `version: string` Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - `has_more: boolean` Indicates if there are more results in the requested page direction. - `next_page: string` Token to provide in as `page` in the subsequent request to retrieve the next page of data. ### Example ```cli ant beta:skills:versions list \ --api-key my-anthropic-api-key \ --skill-id skill_id ``` #### Response ```json { "data": [ { "id": "skillver_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "description": "A custom skill for doing something useful", "directory": "my-skill", "name": "my-skill", "skill_id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "type", "version": "1759178010641129" } ], "has_more": true, "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Download Skill Version Content `$ ant beta:skills:versions download` **get** `/v1/skills/{skill_id}/versions/{version}/content` Download a skill version's content as a zip archive. ### Parameters - `--skill-id: string` Path param: Unique identifier for the skill. The format and length of IDs may change over time. - `--version: string` Path param: Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `unnamed_schema_1: file path` ### Example ```cli ant beta:skills:versions download \ --api-key my-anthropic-api-key \ --skill-id skill_id \ --version version ``` ## Get Skill Version `$ ant beta:skills:versions retrieve` **get** `/v1/skills/{skill_id}/versions/{version}` Get Skill Version ### Parameters - `--skill-id: string` Path param: Unique identifier for the skill. The format and length of IDs may change over time. - `--version: string` Path param: Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaSkillVersionGetResponse: object { id, created_at, description, 5 more }` - `id: string` Unique identifier for the skill version. The format and length of IDs may change over time. - `created_at: string` ISO 8601 timestamp of when the skill version was created. - `description: string` Description of the skill version. This is extracted from the SKILL.md file in the skill upload. - `directory: string` Directory name of the skill version. This is the top-level directory name that was extracted from the uploaded files. - `name: string` Human-readable name of the skill version. This is extracted from the SKILL.md file in the skill upload. - `skill_id: string` Identifier for the skill that this version belongs to. - `type: string` Object type. For Skill Versions, this is always `"skill_version"`. - `version: string` Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). ### Example ```cli ant beta:skills:versions retrieve \ --api-key my-anthropic-api-key \ --skill-id skill_id \ --version version ``` #### Response ```json { "id": "skillver_01JAbcdefghijklmnopqrstuvw", "created_at": "2024-10-30T23:58:27.427722Z", "description": "A custom skill for doing something useful", "directory": "my-skill", "name": "my-skill", "skill_id": "skill_01JAbcdefghijklmnopqrstuvw", "type": "type", "version": "1759178010641129" } ``` ## Delete Skill Version `$ ant beta:skills:versions delete` **delete** `/v1/skills/{skill_id}/versions/{version}` Delete Skill Version ### Parameters - `--skill-id: string` Path param: Unique identifier for the skill. The format and length of IDs may change over time. - `--version: string` Path param: Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaSkillVersionDeleteResponse: object { id, type }` - `id: string` Version identifier for the skill. Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - `type: string` Deleted object type. For Skill Versions, this is always `"skill_version_deleted"`. ### Example ```cli ant beta:skills:versions delete \ --api-key my-anthropic-api-key \ --skill-id skill_id \ --version version ``` #### Response ```json { "id": "1759178010641129", "type": "type" } ``` # User Profiles ## Create User Profile `$ ant beta:user-profiles create` **post** `/v1/user_profiles` Create User Profile ### Parameters - `--external-id: optional string` Body param: Platform's own identifier for this user. Not enforced unique. Maximum 255 characters. - `--metadata: optional map[string]` Body param: Free-form key-value data to attach to this user profile. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. Values must be non-empty strings. - `--name: optional string` Body param: Display name of the entity this profile represents. Required when relationship is `resold` (the resold-to company's name); optional otherwise. Maximum 255 characters. - `--relationship: optional "external" or "resold" or "internal"` Body param: How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_user_profile: object { id, created_at, metadata, 6 more }` - `id: string` Unique identifier for this user profile, prefixed `uprof_`. - `created_at: string` A timestamp in RFC 3339 format - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `relationship: "external" or "resold" or "internal"` How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. - `"external"` - `"resold"` - `"internal"` - `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"` - `type: "user_profile"` Object type. Always `user_profile`. - `"user_profile"` - `updated_at: string` A timestamp in RFC 3339 format - `external_id: optional string` Platform's own identifier for this user. Not enforced unique. - `name: optional string` Display name of the entity this profile represents. For `resold` this is the resold-to company's name. ### Example ```cli ant beta:user-profiles create \ --api-key my-anthropic-api-key ``` #### Response ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "relationship": "external", "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "external_id": "user_12345", "name": "Example User" } ``` ## List User Profiles `$ ant beta:user-profiles list` **get** `/v1/user_profiles` List User Profiles ### Parameters - `--limit: optional number` Query param: Query parameter for limit - `--order: optional "asc" or "desc"` Query param: Query parameter for order - `--page: optional string` Query param: Query parameter for page - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `BetaListUserProfilesResponse: object { data, next_page }` - `data: array of BetaUserProfile` User profiles on this page. - `id: string` Unique identifier for this user profile, prefixed `uprof_`. - `created_at: string` A timestamp in RFC 3339 format - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `relationship: "external" or "resold" or "internal"` How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. - `"external"` - `"resold"` - `"internal"` - `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"` - `type: "user_profile"` Object type. Always `user_profile`. - `"user_profile"` - `updated_at: string` A timestamp in RFC 3339 format - `external_id: optional string` Platform's own identifier for this user. Not enforced unique. - `name: optional string` Display name of the entity this profile represents. For `resold` this is the resold-to company's name. - `next_page: string` Cursor for the next page, or `null` when there are no more results. ### Example ```cli ant beta:user-profiles list \ --api-key my-anthropic-api-key ``` #### Response ```json { "data": [ { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "relationship": "external", "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "external_id": "user_12345", "name": "Example User" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get User Profile `$ ant beta:user-profiles retrieve` **get** `/v1/user_profiles/{user_profile_id}` Get User Profile ### Parameters - `--user-profile-id: string` Path parameter user_profile_id - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_user_profile: object { id, created_at, metadata, 6 more }` - `id: string` Unique identifier for this user profile, prefixed `uprof_`. - `created_at: string` A timestamp in RFC 3339 format - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `relationship: "external" or "resold" or "internal"` How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. - `"external"` - `"resold"` - `"internal"` - `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"` - `type: "user_profile"` Object type. Always `user_profile`. - `"user_profile"` - `updated_at: string` A timestamp in RFC 3339 format - `external_id: optional string` Platform's own identifier for this user. Not enforced unique. - `name: optional string` Display name of the entity this profile represents. For `resold` this is the resold-to company's name. ### Example ```cli ant beta:user-profiles retrieve \ --api-key my-anthropic-api-key \ --user-profile-id uprof_011CZkZCu8hGbp5mYRQgUmz9 ``` #### Response ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "relationship": "external", "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "external_id": "user_12345", "name": "Example User" } ``` ## Update User Profile `$ ant beta:user-profiles update` **post** `/v1/user_profiles/{user_profile_id}` Update User Profile ### Parameters - `--user-profile-id: string` Path param: Path parameter user_profile_id - `--external-id: optional string` Body param: If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. - `--metadata: optional map[string]` Body param: Key-value pairs to merge into the stored metadata. Keys provided overwrite existing values. To remove a key, set its value to an empty string. Keys not provided are left unchanged. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. - `--name: optional string` Body param: If present, replaces the stored name. Omit to leave unchanged. Maximum 255 characters. - `--relationship: optional "external" or "resold" or "internal"` Body param: How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. - `--beta: optional array of AnthropicBeta` Header param: Optional header to specify the beta version(s) you want to use. ### Returns - `beta_user_profile: object { id, created_at, metadata, 6 more }` - `id: string` Unique identifier for this user profile, prefixed `uprof_`. - `created_at: string` A timestamp in RFC 3339 format - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `relationship: "external" or "resold" or "internal"` How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. - `"external"` - `"resold"` - `"internal"` - `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"` - `type: "user_profile"` Object type. Always `user_profile`. - `"user_profile"` - `updated_at: string` A timestamp in RFC 3339 format - `external_id: optional string` Platform's own identifier for this user. Not enforced unique. - `name: optional string` Display name of the entity this profile represents. For `resold` this is the resold-to company's name. ### Example ```cli ant beta:user-profiles update \ --api-key my-anthropic-api-key \ --user-profile-id uprof_011CZkZCu8hGbp5mYRQgUmz9 ``` #### Response ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "relationship": "external", "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "external_id": "user_12345", "name": "Example User" } ``` ## Create Enrollment URL `$ ant beta:user-profiles create-enrollment-url` **post** `/v1/user_profiles/{user_profile_id}/enrollment_url` Create Enrollment URL ### Parameters - `--user-profile-id: string` Path parameter user_profile_id - `--beta: optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use. ### Returns - `beta_user_profile_enrollment_url: object { expires_at, type, url }` - `expires_at: string` A timestamp in RFC 3339 format - `type: "enrollment_url"` Object type. Always `enrollment_url`. - `"enrollment_url"` - `url: string` Enrollment URL to send to the end user. Valid until `expires_at`. ### Example ```cli ant beta:user-profiles create-enrollment-url \ --api-key my-anthropic-api-key \ --user-profile-id uprof_011CZkZCu8hGbp5mYRQgUmz9 ``` #### Response ```json { "expires_at": "2026-03-15T10:15:00Z", "type": "enrollment_url", "url": "https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1" } ``` ## Domain Types ### Beta User Profile - `beta_user_profile: object { id, created_at, metadata, 6 more }` - `id: string` Unique identifier for this user profile, prefixed `uprof_`. - `created_at: string` A timestamp in RFC 3339 format - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `relationship: "external" or "resold" or "internal"` How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage. - `"external"` - `"resold"` - `"internal"` - `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"` - `type: "user_profile"` Object type. Always `user_profile`. - `"user_profile"` - `updated_at: string` A timestamp in RFC 3339 format - `external_id: optional string` Platform's own identifier for this user. Not enforced unique. - `name: optional string` Display name of the entity this profile represents. For `resold` this is the resold-to company's name. ### Beta User Profile Enrollment URL - `beta_user_profile_enrollment_url: object { expires_at, type, url }` - `expires_at: string` A timestamp in RFC 3339 format - `type: "enrollment_url"` Object type. Always `enrollment_url`. - `"enrollment_url"` - `url: string` Enrollment URL to send to the end user. Valid until `expires_at`. ### Beta User Profile Trust Grant - `beta_user_profile_trust_grant: object { status }` - `status: "active" or "pending" or "rejected"` Status of the trust grant. - `"active"` - `"pending"` - `"rejected"` # Webhooks ## Domain Types ### Beta Webhook Event - `beta_webhook_event: object { id, created_at, data, type }` - `id: string` Unique event identifier for idempotency. - `created_at: string` RFC 3339 timestamp when the event occurred. - `data: BetaWebhookSessionCreatedEventData or BetaWebhookSessionPendingEventData or BetaWebhookSessionRunningEventData or 19 more` - `beta_webhook_session_created_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.created"` - `workspace_id: string` - `beta_webhook_session_pending_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.pending"` - `workspace_id: string` - `beta_webhook_session_running_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.running"` - `workspace_id: string` - `beta_webhook_session_idled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.idled"` - `workspace_id: string` - `beta_webhook_session_requires_action_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.requires_action"` - `workspace_id: string` - `beta_webhook_session_archived_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.archived"` - `workspace_id: string` - `beta_webhook_session_deleted_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.deleted"` - `workspace_id: string` - `beta_webhook_session_status_rescheduled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_rescheduled"` - `workspace_id: string` - `beta_webhook_session_status_run_started_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_run_started"` - `workspace_id: string` - `beta_webhook_session_status_idled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_idled"` - `workspace_id: string` - `beta_webhook_session_status_terminated_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_terminated"` - `workspace_id: string` - `beta_webhook_session_thread_created_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.thread_created"` - `workspace_id: string` - `beta_webhook_session_thread_idled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.thread_idled"` - `workspace_id: string` - `beta_webhook_session_thread_terminated_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.thread_terminated"` - `workspace_id: string` - `beta_webhook_session_outcome_evaluation_ended_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.outcome_evaluation_ended"` - `workspace_id: string` - `beta_webhook_vault_created_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault.created"` - `workspace_id: string` - `beta_webhook_vault_archived_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault.archived"` - `workspace_id: string` - `beta_webhook_vault_deleted_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault.deleted"` - `workspace_id: string` - `beta_webhook_vault_credential_created_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.created"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` - `beta_webhook_vault_credential_archived_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.archived"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` - `beta_webhook_vault_credential_deleted_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.deleted"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` - `beta_webhook_vault_credential_refresh_failed_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.refresh_failed"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` - `type: "event"` Object type. Always `event` for webhook payloads. ### Beta Webhook Event Data - `beta_webhook_event_data: BetaWebhookSessionCreatedEventData or BetaWebhookSessionPendingEventData or BetaWebhookSessionRunningEventData or 19 more` - `beta_webhook_session_created_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.created"` - `workspace_id: string` - `beta_webhook_session_pending_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.pending"` - `workspace_id: string` - `beta_webhook_session_running_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.running"` - `workspace_id: string` - `beta_webhook_session_idled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.idled"` - `workspace_id: string` - `beta_webhook_session_requires_action_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.requires_action"` - `workspace_id: string` - `beta_webhook_session_archived_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.archived"` - `workspace_id: string` - `beta_webhook_session_deleted_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.deleted"` - `workspace_id: string` - `beta_webhook_session_status_rescheduled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_rescheduled"` - `workspace_id: string` - `beta_webhook_session_status_run_started_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_run_started"` - `workspace_id: string` - `beta_webhook_session_status_idled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_idled"` - `workspace_id: string` - `beta_webhook_session_status_terminated_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_terminated"` - `workspace_id: string` - `beta_webhook_session_thread_created_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.thread_created"` - `workspace_id: string` - `beta_webhook_session_thread_idled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.thread_idled"` - `workspace_id: string` - `beta_webhook_session_thread_terminated_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.thread_terminated"` - `workspace_id: string` - `beta_webhook_session_outcome_evaluation_ended_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.outcome_evaluation_ended"` - `workspace_id: string` - `beta_webhook_vault_created_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault.created"` - `workspace_id: string` - `beta_webhook_vault_archived_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault.archived"` - `workspace_id: string` - `beta_webhook_vault_deleted_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault.deleted"` - `workspace_id: string` - `beta_webhook_vault_credential_created_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.created"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` - `beta_webhook_vault_credential_archived_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.archived"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` - `beta_webhook_vault_credential_deleted_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.deleted"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` - `beta_webhook_vault_credential_refresh_failed_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.refresh_failed"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` ### Beta Webhook Session Archived Event Data - `beta_webhook_session_archived_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.archived"` - `workspace_id: string` ### Beta Webhook Session Created Event Data - `beta_webhook_session_created_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.created"` - `workspace_id: string` ### Beta Webhook Session Deleted Event Data - `beta_webhook_session_deleted_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.deleted"` - `workspace_id: string` ### Beta Webhook Session Idled Event Data - `beta_webhook_session_idled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.idled"` - `workspace_id: string` ### Beta Webhook Session Outcome Evaluation Ended Event Data - `beta_webhook_session_outcome_evaluation_ended_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.outcome_evaluation_ended"` - `workspace_id: string` ### Beta Webhook Session Pending Event Data - `beta_webhook_session_pending_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.pending"` - `workspace_id: string` ### Beta Webhook Session Requires Action Event Data - `beta_webhook_session_requires_action_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.requires_action"` - `workspace_id: string` ### Beta Webhook Session Running Event Data - `beta_webhook_session_running_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.running"` - `workspace_id: string` ### Beta Webhook Session Status Idled Event Data - `beta_webhook_session_status_idled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_idled"` - `workspace_id: string` ### Beta Webhook Session Status Rescheduled Event Data - `beta_webhook_session_status_rescheduled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_rescheduled"` - `workspace_id: string` ### Beta Webhook Session Status Run Started Event Data - `beta_webhook_session_status_run_started_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_run_started"` - `workspace_id: string` ### Beta Webhook Session Status Terminated Event Data - `beta_webhook_session_status_terminated_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_terminated"` - `workspace_id: string` ### Beta Webhook Session Thread Created Event Data - `beta_webhook_session_thread_created_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.thread_created"` - `workspace_id: string` ### Beta Webhook Session Thread Idled Event Data - `beta_webhook_session_thread_idled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.thread_idled"` - `workspace_id: string` ### Beta Webhook Session Thread Terminated Event Data - `beta_webhook_session_thread_terminated_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.thread_terminated"` - `workspace_id: string` ### Beta Webhook Vault Archived Event Data - `beta_webhook_vault_archived_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault.archived"` - `workspace_id: string` ### Beta Webhook Vault Created Event Data - `beta_webhook_vault_created_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault.created"` - `workspace_id: string` ### Beta Webhook Vault Credential Archived Event Data - `beta_webhook_vault_credential_archived_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.archived"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` ### Beta Webhook Vault Credential Created Event Data - `beta_webhook_vault_credential_created_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.created"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` ### Beta Webhook Vault Credential Deleted Event Data - `beta_webhook_vault_credential_deleted_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.deleted"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` ### Beta Webhook Vault Credential Refresh Failed Event Data - `beta_webhook_vault_credential_refresh_failed_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.refresh_failed"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` ### Beta Webhook Vault Deleted Event Data - `beta_webhook_vault_deleted_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault.deleted"` - `workspace_id: string` ### Unwrap Webhook Event - `unwrap_webhook_event: object { id, created_at, data, type }` - `id: string` Unique event identifier for idempotency. - `created_at: string` RFC 3339 timestamp when the event occurred. - `data: BetaWebhookSessionCreatedEventData or BetaWebhookSessionPendingEventData or BetaWebhookSessionRunningEventData or 19 more` - `beta_webhook_session_created_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.created"` - `workspace_id: string` - `beta_webhook_session_pending_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.pending"` - `workspace_id: string` - `beta_webhook_session_running_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.running"` - `workspace_id: string` - `beta_webhook_session_idled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.idled"` - `workspace_id: string` - `beta_webhook_session_requires_action_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.requires_action"` - `workspace_id: string` - `beta_webhook_session_archived_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.archived"` - `workspace_id: string` - `beta_webhook_session_deleted_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.deleted"` - `workspace_id: string` - `beta_webhook_session_status_rescheduled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_rescheduled"` - `workspace_id: string` - `beta_webhook_session_status_run_started_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_run_started"` - `workspace_id: string` - `beta_webhook_session_status_idled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_idled"` - `workspace_id: string` - `beta_webhook_session_status_terminated_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.status_terminated"` - `workspace_id: string` - `beta_webhook_session_thread_created_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.thread_created"` - `workspace_id: string` - `beta_webhook_session_thread_idled_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.thread_idled"` - `workspace_id: string` - `beta_webhook_session_thread_terminated_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.thread_terminated"` - `workspace_id: string` - `beta_webhook_session_outcome_evaluation_ended_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "session.outcome_evaluation_ended"` - `workspace_id: string` - `beta_webhook_vault_created_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault.created"` - `workspace_id: string` - `beta_webhook_vault_archived_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault.archived"` - `workspace_id: string` - `beta_webhook_vault_deleted_event_data: object { id, organization_id, type, workspace_id }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault.deleted"` - `workspace_id: string` - `beta_webhook_vault_credential_created_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.created"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` - `beta_webhook_vault_credential_archived_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.archived"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` - `beta_webhook_vault_credential_deleted_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.deleted"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` - `beta_webhook_vault_credential_refresh_failed_event_data: object { id, organization_id, type, 2 more }` - `id: string` ID of the resource that triggered the event. - `organization_id: string` - `type: "vault_credential.refresh_failed"` - `vault_id: string` ID of the vault that owns this credential. - `workspace_id: string` - `type: "event"` Object type. Always `event` for webhook payloads.