Capture
One read of Claude Developer Platform
123 pages moved out of 584 read.
managed-agents/events-and-streaming Changed · +2 / -2 lines
from line 17
* **User events** and **system events** are what you send to the agent: `user.*` events start a session and steer it as it progresses; `system.message` appends system-level context that applies to the accompanying turn and all subsequent turns. * **Session events**, **span events**, and **agent events** are sent to you for observability into your session state and agent progress. Stream connections that opt in also receive [event deltas](https://platform.claude.com/docs/en/managed-agents/events-and-streaming#event-deltas). -Session, span, agent, user, and system event type strings follow a `{domain}.{action}` naming convention. The stream-only delta preview events (`event_start`, `event_delta`) are the exception. See [Event types](https://platform.claude.com/docs/en/managed-agents/reference#event-types) in the reference for the full catalog. +Session, span, agent, user, and system event type strings follow a `{domain}.{action}` naming convention. The stream-only delta preview events (`event_start`, `event_delta`) are the exception. See [Event types](https://platform.claude.com/docs/en/managed-agents/reference#event-types) in the reference for the full catalog. [Webhook event types](https://platform.claude.com/docs/en/managed-agents/webhooks#supported-event-types) are separate, and some of their names differ from the stream's (for example, `session.status_idled` rather than `session.status_idle`). Every persisted event includes a `processed_at` timestamp set when the event finishes processing. On events you send, `processed_at` is null while the event is still queued behind earlier events. The exceptions are `user.define_outcome`, `user.custom_tool_result`, and `user.tool_result`, which are processed on receipt and echoed back with `processed_at` already populated.
from line 362
``` </CodeGroup> - The agent acknowledges the interruption and switches to the new task. The interrupted turn ends with a `session.status_idle` event whose `stop_reason` is `end_turn`, the same value as a turn that finishes on its own; there is no stop reason specific to interruption. + The call returns as soon as the events are queued, and the interrupt's `processed_at` stays null until the agent applies it. A model response in progress stops immediately. The interrupt can take longer to apply while tool calls are running, and the session stays `running` until it does. The `user.interrupt` event then appears on the stream, and the interrupted turn ends with a `session.status_idle` event. Its `stop_reason` is `end_turn`, the same value as a turn that finishes on its own; there is no stop reason specific to interruption. The agent starts its next turn with the `user.message` you sent after the interrupt. </Tab> <Tab title="Streaming events">
managed-agents/tools Changed · +1 / -0 lines
from line 648
* Each list is capped at 64 domains. * Domains listed for `web_fetch` cannot include a path. +* Domains must be ASCII: use the `xn--` (Punycode) form for internationalized domain names. The Messages API accepts Unicode entries, though it recommends against them. * `max_uses`, `citations`, and `cache_control` are not available on the toolset. ## Custom tools
home Changed · +2 / -2 lines
from line 37
API reference </HomeCardLink> - <HomeCardLink icon="code-brackets" href="https://platform.claude.com/docs/en/api/client-sdks"> + <HomeCardLink icon="code-brackets" href="https://platform.claude.com/docs/en/cli-sdks-libraries/overview"> Client SDKs </HomeCardLink> </HomePlatformCard>
from line 90
Choose a model </HomeJourneyLink> - <HomeJourneyLink icon="code-brackets" href="https://platform.claude.com/docs/en/api/client-sdks"> + <HomeJourneyLink icon="code-brackets" href="https://platform.claude.com/docs/en/cli-sdks-libraries/overview"> Install an SDK </HomeJourneyLink>
manage-claude/inference-hooks-endpoint Changed · +1 / -1 lines
from line 5
--- <Note> - Inference hooks are in beta and available to Claude Enterprise organizations. Field names, request shapes, and headers may change before general availability. + Inference hooks are in beta and available to Claude Enterprise organizations. Field names, request shapes, and headers may change during the beta. </Note> An Inference hooks integration is an AI security server: an HTTPS service that Anthropic calls. For each governed request, your server receives a signed `POST` carrying the conversation transcript and responds with an allow or deny verdict. This page documents the protocol for building that server: the request and verdict schemas, signature verification, and the operational contract.
build-with-claude/handling-stop-reasons Changed · +1 / -2 lines
from line 897
<CodeGroup exclude="shell:cURL"> ```bash CLI - RESPONSE=$(ant messages create --max-tokens 1024 \ - --format jsonl < request.yaml) + RESPONSE=$(ant messages create --max-tokens 1024 --format jsonl < request.yaml) # Check if the response was truncated mid tool use STOP_REASON=$(jq -r '.stop_reason' <<<"$RESPONSE")
build-with-claude/structured-outputs Changed · +1 / -1 lines
from line 19
You can use these features independently or together in the same request. <Tip> - **Migrating from beta?** The `output_format` parameter has moved to `output_config.format`, and beta headers are no longer required. The old beta header (`structured-outputs-2025-11-13`) and `output_format` parameter will continue working for a transition period. See the following code examples for the updated API shape. + **Migrating from beta?** The `output_format` parameter has moved to `output_config.format`, and beta headers are no longer required. The API continues to accept the old beta header (`structured-outputs-2025-11-13`) and the `output_format` request field for a transition period, but the Python SDK (v1.0 and later) does not accept `output_format={...}` on `client.beta.messages.create()` or `count_tokens()` and raises a `TypeError`; use `output_config` instead. See the following code examples for the updated API shape. </Tip> ## Why use structured outputs
agents-and-tools/mcp-connector Changed · +1 / -2 lines
from line 1317
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. // As a content block in a message $resource = $mcp->readResource('file:///path/to/doc.txt');
from line 1338
// As a file upload $fileResource = $mcp->readResource('file:///path/to/data.json'); - $file = $anthropic->beta->files->upload(file: BetaMcp::resourceToFile($fileResource)); + $file = $anthropic->files->upload(file: BetaMcp::resourceToFile($fileResource)); echo $file->id, "\n"; ```
api/service-tiers Changed · +1 / -3 lines
from line 75
``` ```bash CLI - ant messages create \ - --transform usage.service_tier \ - --raw-output <<'YAML' + ant messages create --transform usage.service_tier --raw-output <<'YAML' model: claude-opus-4-8 max_tokens: 1024 messages:
about-claude/use-case-guides/ticket-routing Changed · +1 / -3 lines
from line 342
message = client.messages.create( model=DEFAULT_MODEL, max_tokens=500, - temperature=0, messages=[{"role": "user", "content": classification_prompt}], stream=False, )
from line 408
message = client.messages.create( model=DEFAULT_MODEL, max_tokens=500, - temperature=0, messages=[{"role": "user", "content": classification_prompt}], ) usage = message.usage # Get the usage statistics for the API call for how many input and output tokens were used.
from line 459
For example, you might have a top-level classifier that broadly categorizes tickets into "Technical Issues," "Billing Questions," and "General Inquiries." Each of these categories can then have its own sub-classifier to further refine the classification. - + * **Pros - greater nuance and accuracy:** You can create different prompts for each parent path, allowing for more targeted and context-specific classification. This can lead to improved accuracy and more nuanced handling of customer requests.
agents-and-tools/agent-skills/claude-api-skill Changed · +1 / -1 lines
from line 120
* **Cloud platform detection**, preserving platform-specific model ID formats (for example, the `anthropic.` prefix on Amazon Bedrock) and skipping changes for features that are unavailable on partner-operated platforms * **Breaking parameter changes**, such as removing `temperature`, `top_p`, and `top_k` for Claude Opus 4.8 and Claude Opus 4.7, and converting `thinking: {type: "enabled", budget_tokens: N}` to `thinking: {type: "adaptive"}` * **Prefill replacement**, converting assistant-message prefill patterns to [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) where applicable -* **Beta header cleanup**, removing headers that are GA on the target model (for example, `effort-2025-11-24`, `fine-grained-tool-streaming-2025-05-14`, `interleaved-thinking-2025-05-14`) and switching back from `client.beta.messages.create` to `client.messages.create` +* **Beta header cleanup**, removing beta headers that the target model doesn't require (for example, `effort-2025-11-24`, `fine-grained-tool-streaming-2025-05-14`, `interleaved-thinking-2025-05-14`) and switching back from `client.beta.messages.create` to `client.messages.create` * **Effort calibration**, recommending an `output_config.effort` starting point for the target model (for example, the default `high` on Claude Opus 5, and `xhigh` for coding and agentic use cases on Claude Opus 4.8 and Claude Opus 4.7) * **Prompt-behavior tuning**, flagging length-control, tool-triggering, subagent, and instruction-following prompts that may behave differently on the target model * **Silent default handling**, opting back into thinking summarization (`thinking.display: "summarized"`) when reasoning is surfaced to users on Claude Opus 4.8 and Claude Opus 4.7
about-claude/use-case-guides/customer-support-chat Changed · +1 / -1 lines
from line 9
To follow this guide, you need: * A Claude API key (set as the `ANTHROPIC_API_KEY` environment variable) -* Python 3.9 or later +* Python 3.10 or later Install the required packages:
about-claude/models/whats-new-sonnet-5 Changed · +1 / -1 lines
from line 12
| --------------- | ----------------- | ---------------------------------------------- | | Claude Sonnet 5 | `claude-sonnet-5` | The best combination of speed and intelligence | -Claude Sonnet 5 supports the [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) by default (1M tokens is both the default and the maximum; there is no smaller context variant), 128k max output tokens, [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking), and the same set of tools and platform features as Claude Sonnet 4.6, except [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models), which is not available on Claude Sonnet 5. On the Claude API, Claude Sonnet 5 also supports the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) and the generally available `computer_toolset_20260801` version of the [computer use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool), neither of which Claude Sonnet 4.6 supports; the earlier `computer_20251124` version is still accepted on both models. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). +Claude Sonnet 5 supports the [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) by default (1M tokens is both the default and the maximum; there is no smaller context variant), 128k max output tokens, [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking), and the same set of tools and platform features as Claude Sonnet 4.6, except [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models), which is not available on Claude Sonnet 5. On the Claude API, Claude Sonnet 5 also supports the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) and the stable `computer_toolset_20260801` version of the [computer use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool), neither of which Claude Sonnet 4.6 supports; the earlier `computer_20251124` version is still accepted on both models. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). For complete pricing and specs, see the [models overview](https://platform.claude.com/docs/en/about-claude/models/overview).
about-claude/models/overview Changed · +1 / -1 lines
from line 16
Claude Fable 5 (`claude-fable-5`) is Anthropic's most capable widely released model. Claude Mythos 5 (`claude-mythos-5`) shares Claude Fable 5's specs and pricing and joins the invitation-only Claude Mythos Preview (`claude-mythos-preview`) within [Project Glasswing](https://anthropic.com/glasswing). See [Introducing Claude Fable 5 and Claude Mythos 5](https://platform.claude.com/docs/en/about-claude/models/introducing-claude-fable-5-and-claude-mythos-5) for launch details and API changes. -Claude Fable 5 is generally available on the Claude API, Amazon Bedrock, Claude Platform on AWS, Google Cloud, and Microsoft Foundry beginning June 9, 2026. Claude Mythos 5 is not generally available: it is offered in limited availability to approved customers in [Project Glasswing](https://anthropic.com/glasswing), beginning the same day. For access, contact your Anthropic, AWS, or Google Cloud account team. +Claude Fable 5 is available on the Claude API, Amazon Bedrock, Claude Platform on AWS, Google Cloud, and Microsoft Foundry beginning June 9, 2026. Claude Mythos 5 is offered only to approved customers in [Project Glasswing](https://anthropic.com/glasswing), beginning the same day. For access, contact your Anthropic, AWS, or Google Cloud account team. ### Latest models comparison
api/messages/batches/results Changed · +1 / -1 lines
from line 77
- `version: string` - Skill version or 'latest' for most recent version + The resolved version: a skill version ID for custom skills. - `content: array of ContentBlock`
agents-and-tools/tool-use/memory-tool Changed · +2 / -2 lines
from line 104
## Getting started -The memory tool is generally available on the Messages API: no beta header is required. Using it takes two steps: +Using the memory tool takes two steps: 1. Add the memory tool to your request. The `tools` entry `{"type": "memory_20250818", "name": "memory"}` is the entire configuration: the `name` must be `memory`, and you don't define an input schema for an Anthropic-provided tool. 2. Implement a client-side handler for each memory command. Your handler must reject paths outside `/memories`, so read [Path traversal protection](https://platform.claude.com/docs/en/agents-and-tools/tool-use/memory-tool#path-traversal-protection) before you write it.
from line 285
Claude's reply to a request like the previous one ends with a `tool_use` block that requests a memory operation, such as `view /memories`. Your application executes the operation and returns the result in a `tool_result` block, then sends the conversation back so Claude can continue: the standard [tool-use loop](https://platform.claude.com/docs/en/agents-and-tools/tool-use/handle-tool-calls). -Four SDKs provide memory tool helpers that handle the tool interface and the loop. Subclass `BetaAbstractMemoryTool` (Python and C#), use `betaMemoryTool` (TypeScript), or implement `BetaMemoryToolHandler` (Java) to back memory with your own storage, such as files on disk, a database, cloud storage, or encrypted files. Python and TypeScript also ship a ready-made local-filesystem implementation, `BetaLocalFilesystemMemoryTool`. The helper and tool-runner surfaces live in each SDK's beta namespace even though the memory tool itself is generally available. The Go and Ruby SDKs have no memory helper, so those examples run the tool-use loop themselves, and PHP wraps your handler closure in its generic `BetaRunnableTool`. All three use an in-memory store that you replace with your own storage. +Four SDKs provide memory tool helpers that handle the tool interface and the loop. Subclass `BetaAbstractMemoryTool` (Python and C#), use `betaMemoryTool` (TypeScript), or implement `BetaMemoryToolHandler` (Java) to back memory with your own storage, such as files on disk, a database, cloud storage, or encrypted files. Python and TypeScript also ship a ready-made local-filesystem implementation, `BetaLocalFilesystemMemoryTool`. The helper and tool-runner surfaces live in each SDK's beta namespace even though the memory tool itself doesn't require a beta header. The Go and Ruby SDKs have no memory helper, so those examples run the tool-use loop themselves, and PHP wraps your handler closure in its generic `BetaRunnableTool`. All three use an in-memory store that you replace with your own storage. <CodeGroup exclude="shell"> ```python Python
api/overview Changed · +1 / -3 lines
from line 23
The Claude API includes the following APIs: -**General Availability:** - * **[Messages API](https://platform.claude.com/docs/en/api/messages/create)**: Send messages to Claude for conversational interactions (`POST /v1/messages`) * **[Message Batches API](https://platform.claude.com/docs/en/api/messages/batches/create)**: Process large volumes of Messages requests asynchronously with 50% cost reduction (`POST /v1/messages/batches`) * **[Token Counting API](https://platform.claude.com/docs/en/api/messages-count-tokens)**: Count tokens in a message before sending to manage costs and rate limits (`POST /v1/messages/count_tokens`)
from line 30
* **[Files API](https://platform.claude.com/docs/en/api/files/upload)**: Upload and manage files for use across multiple API calls (`POST /v1/files`, `GET /v1/files`) * **[Skills API](https://platform.claude.com/docs/en/api/skills/create)**: Create and manage custom agent skills (`POST /v1/skills`, `GET /v1/skills`) -**Beta:** +The following APIs are in beta: * **[Agents API](https://platform.claude.com/docs/en/managed-agents/agent-setup)**: Define reusable, versioned agent configurations for Claude Managed Agents (`POST /v1/agents`, `GET /v1/agents`) * **[Sessions API](https://platform.claude.com/docs/en/managed-agents/sessions)**: Run stateful agent sessions in managed cloud sandboxes (`POST /v1/sessions`, `GET /v1/sessions/{id}/events/stream`)
agents-and-tools/tool-use/tool-runner Changed · +1 / -1 lines
from line 1088
### Automatic context management -For long-running agentic tasks, the Python, TypeScript, and Ruby tool runners support automatic [compaction](https://platform.claude.com/docs/en/build-with-claude/context-editing#client-side-compaction-sdk), which generates summaries when token usage exceeds a threshold so the conversation can continue beyond context window limits. All three SDKs have deprecated this client-side option in favor of server-side [context editing](https://platform.claude.com/docs/en/build-with-claude/context-editing), which is available in every SDK. The Go, Java, C#, and PHP tool runners don't include client-side compaction. +For long-running agentic tasks, the TypeScript and Ruby tool runners support automatic [compaction](https://platform.claude.com/docs/en/build-with-claude/context-editing#client-side-compaction-sdk), which generates summaries when token usage exceeds a threshold so the conversation can continue beyond context window limits. Both SDKs have deprecated this client-side option in favor of [server-side compaction](https://platform.claude.com/docs/en/build-with-claude/compaction), which works with every SDK's tool runner through the `context_management` request parameter. The Python SDK (v1.0 and later) and the Go, Java, C#, and PHP tool runners don't include client-side compaction. ### Debugging tool execution
build-with-claude/embeddings Changed · +1 / -2 lines
from line 278
> * Example > > * When `input_type="query"`, a query like "When is Apple's conference call scheduled?" will become "**Represent the query for retrieving supporting documents:** When is Apple's conference call scheduled?" - > - > * When `input_type="document"`, a query like "Apple's conference call to discuss fourth fiscal quarter results and business updates is scheduled for Thursday, November 2, 2023 at 2p.m. PT / 5p.m. ET." will become "**Represent the document for retrieval:** Apple's conference call to discuss fourth fiscal quarter results and business updates is scheduled for Thursday, November 2, 2023 at 2p.m. PT / 5p.m. ET." + > * When `input_type="document"`, a query like "Apple's conference call to discuss fourth fiscal quarter results and business updates is scheduled for Thursday, November 2, 2023 at 2:00 p.m. PT / 5:00 p.m. ET." will become "**Represent the document for retrieval:** Apple's conference call to discuss fourth fiscal quarter results and business updates is scheduled for Thursday, November 2, 2023 at 2:00 p.m. PT / 5:00 p.m. ET." `voyage-large-2-instruct`, as the name suggests, is trained to be responsive to additional instructions that are prepended to the input text. For classification, clustering, or other [MTEB](https://huggingface.co/mteb) subtasks, use the [voyage-large-2-instruct instructions](https://github.com/voyage-ai/voyage-large-2-instruct). </Accordion>
api/admin/analytics/artifacts Changed · +1 / -1 lines
from line 100
```http curl https://api.anthropic.com/v1/organizations/analytics/artifacts \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
build-with-claude/prompt-caching Changed · +1 / -1 lines
from line 659
| **Non-tool results passed to extended thinking requests** | ✓ | ✓ | Model-specific | On Opus 4.5+ and Sonnet 4.6+, thinking blocks are preserved by default, so the cache remains valid (✓). On earlier Opus/Sonnet models and all Haiku models, all previously-cached thinking blocks are stripped from context, and any messages that follow those thinking blocks are removed from the cache (✘). For more details, see [Caching with thinking blocks](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#caching-with-thinking-blocks). | <Note> - On Claude Fable 5, [Claude Mythos 5](https://anthropic.com/glasswing), Claude Opus 4.8, Claude Opus 5, and Claude Sonnet 5, you can add a new system instruction partway through a conversation without invalidating the system or message caches. Append a `{"role": "system"}` message to `messages` instead of editing the top-level `system` field, so the cached prefix stays unchanged. See [Mid-conversation system messages](https://platform.claude.com/docs/en/build-with-claude/mid-conversation-system-messages). + On Claude Fable 5, [Claude Mythos 5](https://anthropic.com/glasswing), Claude Opus 4.8, and Claude Opus 5, you can add a new system instruction partway through a conversation without invalidating the system or message caches. Append a `{"role": "system"}` message to `messages` instead of editing the top-level `system` field, so the cached prefix stays unchanged. This feature is not available on Claude Sonnet 5; use the top-level `system` field instead. See [Mid-conversation system messages](https://platform.claude.com/docs/en/build-with-claude/mid-conversation-system-messages). </Note> ### Tracking cache performance
api/admin/analytics/artifacts/list Changed · +1 / -1 lines
from line 98
```http curl https://api.anthropic.com/v1/organizations/analytics/artifacts \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
cli-sdks-libraries/cli/scripting Changed · +1 / -2 lines
from line 148
`--transform id --raw-output` on a list endpoint emits one bare ID per line, so standard tools such as `head` and `xargs` apply directly. Capture the first result, then pass it to a follow-up command: ```bash -FIRST_AGENT=$(ant beta:agents list \ - --transform id --raw-output | head -1) +FIRST_AGENT=$(ant beta:agents list --transform id --raw-output | head -1) ant beta:agents:versions list \ --agent-id "$FIRST_AGENT" \
api/admin/analytics/chat_projects/list Changed · +1 / -1 lines
from line 136
```http curl https://api.anthropic.com/v1/organizations/analytics/apps/chat/projects \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
manage-claude/cmek Changed · +1 / -1 lines
from line 108
* Claude Code Desktop, Claude Code on the web, and Claude in Slack. Anthropic recommends disabling any of these that are not appropriate for your use case in the admin console. * Beta and research preview features may not be covered by CMEK and can break in CMEK organizations, for example, Claude Security and Claude Design. * On-demand data export under **Settings** > **Privacy**. -* [Personal preferences - Instructions for Claude section](https://claude.ai/new#settings/general). These are set at the account level and shared across all of a user's organizations. +* [Personal preferences - Instructions for Claude section](https://claude.ai/new#settings/general) and Cowork Global instructions. These are set at the account level and shared across all of a user's organizations. On both products, account data for users in your organization (such as names, email addresses, and profile pictures) is not encrypted under your key.
api/admin/analytics/connectors Changed · +1 / -1 lines
from line 181
```http curl https://api.anthropic.com/v1/organizations/analytics/connectors \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
manage-claude/user-management Changed · +2 / -2 lines
from line 7
This page covers managing the people in your **Claude Enterprise** (claude.ai) organization programmatically, using the [Admin API](https://platform.claude.com/docs/en/api/admin): list members and look them up by email address, change a member's role, remove members, send and withdraw invites, manage your enterprise's groups and their membership, and read your organization's custom roles. For Claude Console (Claude Platform) organizations, see the [Admin API guide for Claude Console](https://platform.claude.com/docs/en/manage-claude/admin-api). <Note> - **The endpoints on this page are generally available for Claude Enterprise organizations.** The [beta header](https://platform.claude.com/docs/en/api/beta-headers) `anthropic-beta: ce-user-management-2026-07-13` is no longer required on group and custom-role requests; requests that still send it are accepted and behave identically. + Group and custom-role requests don't require the `anthropic-beta: ce-user-management-2026-07-13` [beta header](https://platform.claude.com/docs/en/api/beta-headers). Requests that still send it are accepted and behave identically. </Note> ## Which endpoints can your organization use?
from line 458
`GET /v1/organizations/rbac_roles/{role_id}/permissions` returns the role's permissions. Each permission pairs a `resource` (what it applies to: the organization's product features, a connector tool, a connector OAuth scope, one connector, or every connector) with an `action` (what it grants on that resource). Rows for features not enabled for your organization are omitted, so a page might contain fewer than `limit` rows while `has_more` is `true`. Requires the `read:members` scope. -Two `action` values need special care: an `organization` permission whose action is `capability_access_all` (every product feature) or `capability_access_all_ga` (every generally available product feature) is a blanket grant (one that covers neither model access nor the `permission_`-prefixed admin-panel permissions) and is listed as that single row rather than expanded. When you tally what a role grants, treat a blanket row as covering everything its variant describes, not just the features named in other rows. +Two `action` values need special care: an `organization` permission whose action is `capability_access_all` (every product feature) or `capability_access_all_ga` (every stable product feature, that is, every feature not labeled beta or research preview) is a blanket grant (one that covers neither model access nor the `permission_`-prefixed admin-panel permissions) and is listed as that single row rather than expanded. When you tally what a role grants, treat a blanket row as covering everything its variant describes, not just the features named in other rows. For complete parameter details and response schemas, see [List role permissions](https://platform.claude.com/docs/en/api/admin/rbac_roles/permissions/list) in the API reference.
api/admin/analytics/connectors/list Changed · +1 / -1 lines
from line 179
```http curl https://api.anthropic.com/v1/organizations/analytics/connectors \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
managed-agents/scheduled-deployments Changed · +1 / -1 lines
from line 252
* **Expression:** Standard POSIX cron (`minute hour day-of-month month day-of-week`). You can generate and validate these cron expressions in the [Claude Console](https://platform.claude.com/workspaces/default/deployments). * **Timezone:** IANA timezone identifier (for example, `"America/Los_Angeles"`). -* **DST:** Cron schedules use literal wall-clock matching, so `"0 20 * * *"` in `America/New_York` fires at 8PM local time regardless of whether EST or EDT is in effect. +* **DST:** Cron schedules use literal wall-clock matching, so `"0 20 * * *"` in `America/New_York` fires at 8:00 PM local time regardless of whether EST or EDT is in effect. <Note> Wall-clock times that do not exist on a spring-forward day (such as 2 AM) are not triggered. Wall-clock times that occur twice on a fall-back day fire twice. Schedule outside the 1–3 AM local window, or use UTC, when missed or duplicate executions are unacceptable.
api/admin/analytics/cost Changed · +2 / -2 lines
from line 235
```http curl https://api.anthropic.com/v1/organizations/analytics/cost_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 547
```http curl https://api.anthropic.com/v1/organizations/analytics/user_cost_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
api/beta/messages/create Changed · +1 / -1 lines
from line 3998
- `version: string` - Skill version or 'latest' for most recent version + The resolved version: a skill version ID for custom skills. - `content: array of BetaContentBlock`
api/admin/analytics/cost/list Changed · +1 / -1 lines
from line 233
```http curl https://api.anthropic.com/v1/organizations/analytics/cost_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
api/messages/create Changed · +1 / -1 lines
from line 3071
- `version: string` - Skill version or 'latest' for most recent version + The resolved version: a skill version ID for custom skills. - `content: array of ContentBlock`
api/admin/analytics/cost/list_by_user Changed · +1 / -1 lines
from line 278
```http curl https://api.anthropic.com/v1/organizations/analytics/user_cost_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
api/rate-limits Changed · +1 / -1 lines
from line 44
### Reaching your spend cap -Once you reach your tier's spend cap, API usage pauses until 00UTC on the first day of the next month, unless you request a higher limit sooner. While usage is paused, API requests return HTTP 429: +Once you reach your tier's spend cap, API usage pauses until 00:00 UTC on the first day of the next month, unless you request a higher limit sooner. While usage is paused, API requests return HTTP 429: ```json {
api/admin/analytics/plugins Changed · +1 / -1 lines
from line 140
```http curl https://api.anthropic.com/v1/organizations/analytics/plugins \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
build-with-claude/compaction Changed · +1 / -3 lines
from line 749
# summary so you can adjust the messages before continuing. The continue # step doesn't translate well to a one-off CLI command; see the SDK tabs # for the full pause-and-continue flow. Single paused request: - ant beta:messages create \ - --beta compact-2026-01-12 \ - --format jsonl <<'YAML' + ant beta:messages create --beta compact-2026-01-12 --format jsonl <<'YAML' model: claude-opus-5 max_tokens: 4096 messages:
api/admin/analytics/plugins/list Changed · +1 / -1 lines
from line 138
```http curl https://api.anthropic.com/v1/organizations/analytics/plugins \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
build-with-claude/fast-mode Changed · +1 / -1 lines
from line 22
* Claude Opus 4.8 (claude-opus-4-8) <Note> - Fast mode for Claude Opus 5 and Claude Opus 4.8 is available as a research preview on the Claude API, including [Claude Managed Agents](https://platform.claude.com/docs/en/managed-agents/overview), only. It is not available on Amazon Bedrock, Google Cloud, or Microsoft Foundry. + Fast mode for Claude Opus 5 and Claude Opus 4.8 is available as a research preview on the Claude API, including [Claude Managed Agents](https://platform.claude.com/docs/en/managed-agents/overview), only. It is not available on Amazon Bedrock, Claude Platform on AWS, Google Cloud, or Microsoft Foundry. </Note> <Note>
api/admin/analytics/retrieve_summaries Changed · +1 / -1 lines
from line 160
```http curl https://api.anthropic.com/v1/organizations/analytics/summaries \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
build-with-claude/mid-conversation-system-messages Changed · +2 / -2 lines
from line 12
Mid-conversation system messages close that gap. You append a `{"role": "system"}` message at the point in the conversation where the new instruction becomes relevant, instead of editing the top-level `system` field. The cached prefix stays the same, so the next request still reads it from cache, and the new instruction is still applied as a system instruction rather than as ordinary user text. -This page covers two features: mid-conversation system messages, which are generally available, and [mid-conversation tool changes](https://platform.claude.com/docs/en/build-with-claude/mid-conversation-system-messages#mid-conversation-tool-changes), a beta introduced with Claude Opus 5 that applies the same approach to the `tools` array. +This page covers two features: mid-conversation system messages, and [mid-conversation tool changes](https://platform.claude.com/docs/en/build-with-claude/mid-conversation-system-messages#mid-conversation-tool-changes), a beta introduced with Claude Opus 5 that applies the same approach to the `tools` array. <Note> Mid-conversation system messages are available on the Claude API, [Claude in Amazon Bedrock](https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon-bedrock), and [Google Cloud](https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai). - This feature is available on Claude Fable 5, [Claude Mythos 5](https://anthropic.com/glasswing), Claude Opus 4.8, Claude Opus 5, and Claude Sonnet 5. No beta header is required for mid-conversation system messages. + This feature is available on Claude Fable 5, [Claude Mythos 5](https://anthropic.com/glasswing), Claude Opus 4.8, and Claude Opus 5. No beta header is required for mid-conversation system messages. This feature is not available on Claude Sonnet 5; use the top-level `system` field instead. Mid-conversation tool changes are in beta and require the `mid-conversation-tool-changes-2026-07-01` beta header. They are available on Claude Fable 5, Claude Mythos 5, Claude Opus 4.8, and Claude Opus 5, on the Claude API, Amazon Bedrock, and Google Cloud. They are not available on Claude Sonnet 5. </Note>
api/admin/analytics/skills Changed · +1 / -1 lines
from line 185
```http curl https://api.anthropic.com/v1/organizations/analytics/skills \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
build-with-claude/refusals-and-fallback Changed · +4 / -0 lines
from line 218
Set the `fallbacks` parameter to the string `"default"` and send the `server-side-fallback-2026-07-01` beta header. The API then applies the requested model's server-defined default routing, which selects a recommended fallback model based on the refusal category the classifier reports, so refused requests are served without you maintaining a model list as recommendations change. +Default routing never draws the up-front [oversized-image rejection](https://platform.claude.com/docs/en/build-with-claude/vision-coordinates#oversized-image-error) for models you did not choose: a routed model that would resize an image marked `"oversized_image": "error"` is dropped from the routing instead, so a marked image is never served resized. + <CodeGroup> ```bash cURL curl --fail-with-body -sS https://api.anthropic.com/v1/messages \
from line 486
### Naming your own fallback models Instead of default routing, you can set `fallbacks` to a list of up to three models. When the requested model declines, the API runs the next model in the chain on the same request. Use this form when you want to control exactly which models serve refused requests, such as pinning a model your application has qualified. + +Named fallback models count toward the [oversized-image check](https://platform.claude.com/docs/en/build-with-claude/vision-coordinates#oversized-image-error): a request whose image block sets `"oversized_image": "error"` is checked up front against the requested model and every named fallback, is rejected if any of them would resize that image, and the rejection's reported rescale target fits them all. <CodeGroup> ```bash cURL
api/admin/analytics/skills/list Changed · +1 / -1 lines
from line 183
```http curl https://api.anthropic.com/v1/organizations/analytics/skills \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
build-with-claude/working-with-messages Changed · +2 / -2 lines
from line 592
```python Python import base64 - import httpx + import httpx2 # Option 1: Base64-encoded image image_url = "https://platform.claude.com/docs/images/vision-example.jpg" image_media_type = "image/jpeg" - image_data = base64.standard_b64encode(httpx.get(image_url).content).decode("utf-8") + image_data = base64.standard_b64encode(httpx2.get(image_url).content).decode("utf-8") message = anthropic.Anthropic().messages.create( model="claude-opus-5",
api/admin/analytics/usage Changed · +2 / -2 lines
from line 225
```http curl https://api.anthropic.com/v1/organizations/analytics/usage_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 540
```http curl https://api.anthropic.com/v1/organizations/analytics/user_usage_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
cli-sdks-libraries/libraries/apple-foundation-models Changed · +1 / -1 lines
from line 9
Requests go directly from your app to the Claude API; Apple is not in the request path and does not see prompts or responses. Usage is billed to your Anthropic account at [standard API pricing](https://platform.claude.com/docs/en/about-claude/pricing), so your organization needs an available credit balance or an active billing method. Your app decides when to use Claude and when to use Apple's on-device model: pass whichever model you want to each session. <Note> - **Beta.** This package targets the Foundation Models server-side language model API introduced in the OS 27 betas. APIs might change before general availability. + **Beta.** This package targets the Foundation Models server-side language model API introduced in the OS 27 betas. APIs might change during the beta. </Note> <Info>
api/admin/analytics/usage/list Changed · +1 / -1 lines
from line 223
```http curl https://api.anthropic.com/v1/organizations/analytics/usage_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
manage-claude/analytics-api Changed · +1 / -1 lines
from line 81
Claude Enterprise Analytics API data is available for dates on or after January 1, 2026. -**Engagement and adoption endpoints** (user activity, summaries, projects, skills, connectors) return a per-day snapshot for the date you specify. Data for a given day is aggregated at 10UTC the following day and is typically available with a 1-day lag. Exact freshness varies by query, so rather than assuming a fixed lag, check the error response: requesting a date that is not yet available returns a 400 error naming the most recent available day. If data is not available well past the typical lag, it usually indicates a data pipeline failure on Anthropic's side; contact support if the gap persists. +**Engagement and adoption endpoints** (user activity, summaries, projects, skills, connectors) return a per-day snapshot for the date you specify. Data for a given day is aggregated at 10:00 UTC the following day and is typically available with a 1-day lag. Exact freshness varies by query, so rather than assuming a fixed lag, check the error response: requesting a date that is not yet available returns a 400 error naming the most recent available day. If data is not available well past the typical lag, it usually indicates a data pipeline failure on Anthropic's side; contact support if the gap persists. **Cost and usage endpoints** follow a different freshness model. Data is typically available within four hours of the underlying usage but may take up to 24 hours. Values for a given date can be revised for up to 30 days as late events arrive and reconciliation runs. For invoicing-grade totals, query dates at least 30 days in the past.
api/admin/analytics/usage/list_by_user Changed · +1 / -1 lines
from line 276
```http curl https://api.anthropic.com/v1/organizations/analytics/user_usage_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
manage-claude/compliance-faq Changed · +1 / -1 lines
from line 130
<AccordionGroup> <Accordion title="How do I correlate Compliance API records with my SIEM?"> - Join `Activity` records to your SIEM on `actor.user_id`, `actor.email_address`, `actor.ip_address`, and `created_at`. See [Design your compliance integration](https://platform.claude.com/docs/en/manage-claude/compliance-integration-patterns#correlate-with-your-siem) for the join-key table and consumption patterns. + Join `Activity` records to your SIEM on `actor.user_id`, `actor.email_address`, `actor.ip_address`, `actor.user_agent`, and `created_at`. See [Design your compliance integration](https://platform.claude.com/docs/en/manage-claude/compliance-integration-patterns#correlate-with-your-siem) for the join-key table and consumption patterns. </Accordion> <Accordion title="Can one customer have multiple organizations under one parent?">
api/admin/analytics/users Changed · +1 / -1 lines
from line 384
```http curl https://api.anthropic.com/v1/organizations/analytics/users \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
manage-claude/spend-limits-api Changed · +1 / -1 lines
from line 55
### Period -`period` is the recurring window over which the spend limit is enforced and spend resets. A spend limit is identified by its `(scope, period)` pair. Currently `monthly` is the only supported period; monthly spend resets at 00UTC on the first of each calendar month. Treat `period` as an open set. +`period` is the recurring window over which the spend limit is enforced and spend resets. A spend limit is identified by its `(scope, period)` pair. Currently `monthly` is the only supported period; monthly spend resets at 00:00 UTC on the first of each calendar month. Treat `period` as an open set. ### Amounts and currency
api/admin/analytics/users/list Changed · +1 / -1 lines
from line 382
```http curl https://api.anthropic.com/v1/organizations/analytics/users \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
manage-claude/wif-providers/okta Changed · +2 / -2 lines
from line 112
```python Python import os - import httpx + import httpx2 import anthropic from anthropic import WorkloadIdentityCredentials def fetch_okta_token() -> str: - response = httpx.post( + response = httpx2.post( f"{os.environ['OKTA_ISSUER']}/v1/token", data={ "grant_type": "client_credentials",
api/beta-headers Changed · +1 / -1 lines
from line 1
--- title: Beta headers url: https://platform.claude.com/docs/en/api/beta-headers -description: Access experimental features before general availability with the `anthropic-beta` header or the SDKs' `betas` parameter. +description: Access experimental features before they become part of the standard API with the `anthropic-beta` header or the SDKs' `betas` parameter. --- Beta headers allow you to access experimental features and new model capabilities before they become part of the standard API.
managed-agents/reference Changed · +1 / -1 lines
from line 12
## Event types -Persisted event type strings follow a `{domain}.{action}` naming convention; the stream-only event deltas (see the Event deltas tab) are the exception. See [Session event stream](https://platform.claude.com/docs/en/managed-agents/events-and-streaming) for sending, streaming, and listing events. +Persisted event type strings follow a `{domain}.{action}` naming convention; the stream-only event deltas (see the Event deltas tab) are the exception. See [Session event stream](https://platform.claude.com/docs/en/managed-agents/events-and-streaming) for sending, streaming, and listing events. Webhook event types are listed separately in [Subscribe to webhooks](https://platform.claude.com/docs/en/managed-agents/webhooks#supported-event-types), and some of their names differ from the stream's (for example, `session.status_idled` rather than `session.status_idle`). <Tabs> <Tab title="User events">
api/beta/messages/batches/results Changed · +1 / -1 lines
from line 155
- `version: string` - Skill version or 'latest' for most recent version + The resolved version: a skill version ID for custom skills. - `content: array of BetaContentBlock`
managed-agents/self-hosted-sandboxes-security Changed · +1 / -1 lines
from line 16
* **Tool-execution blast radius.** Tools run inside your sandbox with whatever permissions your process has. Apply least privilege to the process user and mount only the directories your tools require. * **Log retention and session content.** Conversation content and tool outputs pass through your worker and stay in your environment. You are responsible for retaining, redacting, or deleting that data in compliance with your own policies. Anthropic has no visibility into what your worker does with session content once delivered. * **Memory store contents.** [Memory stores](https://platform.claude.com/docs/en/managed-agents/memory) remain hosted by Anthropic, including their version history. When a session attaches one, the worker keeps a working copy under `/mnt/memory/` in your sandbox for the session's duration and syncs changes back. The worker deletes that copy when the session ends, but a worker that exits without running its teardown leaves it behind. Cleaning up leftover copies, the permissions on that path, and isolation between sessions that share a filesystem are your responsibility. -* **Read-only memory stores.** A store attached with `read_only` access is protected from upload, not from local modification. The worker's `write` and `edit` tools refuse to write under its directory, nothing there syncs back, and the memory store endpoints reject writes to it made with the session's `secret`. Other processes in the sandbox, including commands the agent runs through the `bash` tool, can still change the local copy, and later tool calls in that session read the changed copy until that memory next changes in the store. If the agent must not be able to alter even its local view of such a store, disable the `bash` tool for that agent. +* **Read-only memory stores.** A store attached with `read_only` access is protected from upload, not from local modification. The worker's `write` and `edit` tools refuse to write under its directory, nothing there syncs back, and the memory store endpoints reject writes to it made with the session's `secret`. Other processes in the sandbox can still change the local copy: commands the agent runs through the `bash` tool, and [custom tools](https://platform.claude.com/docs/en/managed-agents/self-hosted-sandboxes#serve-custom-tools-from-your-sandbox) or MCP servers you serve from the sandbox, which run with the worker's permissions. Later tool calls in that session read the changed copy until that memory next changes in the store. If the agent must not be able to alter even its local view of such a store, disable the `bash` tool for that agent and give it no custom tool that writes to the sandbox's filesystem. ## What Anthropic cannot do for you
managed-agents/webhooks Changed · +2 / -0 lines
from line 12
<Tabs> <Tab title="Session events"> + Some of these events are named differently from the matching events on the session's [event stream](https://platform.claude.com/docs/en/managed-agents/events-and-streaming). For example, the stream's `session.status_idle` and `session.status_running` correspond to the `session.status_idled` and `session.status_run_started` webhook events. + | Event | Trigger | | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `session.status_run_started` | Agent execution started. This triggers at every session status transition to `running`. |
about-claude/models/migration-guide Changed · +20 / -21 lines
from line 20
## Migrating to Claude Mythos 5 and Claude Fable 5 -[Claude Fable 5](https://platform.claude.com/docs/en/about-claude/models/introducing-claude-fable-5-and-claude-mythos-5) is Anthropic's most capable widely released model, generally available on the Claude API, [Amazon Bedrock](https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon-bedrock), [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws), [Google Cloud](https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai), and [Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry). [Claude Mythos 5](https://anthropic.com/glasswing) shares the same capabilities and is offered in limited availability to approved customers in Project Glasswing. +[Claude Fable 5](https://platform.claude.com/docs/en/about-claude/models/introducing-claude-fable-5-and-claude-mythos-5) is Anthropic's most capable widely released model, available on the Claude API, [Amazon Bedrock](https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon-bedrock), [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws), [Google Cloud](https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai), and [Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry). [Claude Mythos 5](https://anthropic.com/glasswing) shares the same capabilities and is offered only to approved customers in Project Glasswing. The baseline settings shared by `claude-fable-5` and `claude-mythos-5`:
from line 32
Where the two models diverge: -* **Availability:** Claude Fable 5 is generally available. Claude Mythos 5 is available only to approved customers in [Project Glasswing](https://anthropic.com/glasswing). +* **Availability:** Claude Fable 5 does not require access approval. Claude Mythos 5 is available only to approved customers in [Project Glasswing](https://anthropic.com/glasswing). * **Safety classifiers:** Claude Fable 5 runs safety classifiers that can decline requests with `stop_reason: "refusal"`. Claude Mythos 5 does not include these classifiers. See [Refusals and fallback](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback). * **Priority Tier:** [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models) is supported on Claude Fable 5 but not on Claude Mythos 5. ### Migrating to Claude Mythos 5 and Claude Fable 5 from Claude Mythos Preview -[Claude Mythos 5](https://anthropic.com/glasswing) is the access-gated successor to [Claude Mythos Preview](https://anthropic.com/glasswing), the invitation-only research preview. [Claude Fable 5](https://platform.claude.com/docs/en/about-claude/models/introducing-claude-fable-5-and-claude-mythos-5) is the generally available model with the same capabilities, and the changes in this section apply equally to both targets. +[Claude Mythos 5](https://anthropic.com/glasswing) is the access-gated successor to [Claude Mythos Preview](https://anthropic.com/glasswing), the invitation-only research preview. [Claude Fable 5](https://platform.claude.com/docs/en/about-claude/models/introducing-claude-fable-5-and-claude-mythos-5) offers the same capabilities and does not require access approval. The changes in this section apply equally to both targets. Migration is mostly drop-in. Claude Mythos 5 and Claude Fable 5 use the same [Messages API](https://platform.claude.com/docs/en/build-with-claude/working-with-messages) and the same [tool use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) patterns as Claude Mythos Preview, and token counts are roughly unchanged because all three models use the same tokenizer. The key changes to check are the features that are no longer available (listed in the next section) and thinking output. If you migrate to Claude Fable 5, also plan for safety classifier refusals, which Claude Mythos Preview and Claude Mythos 5 do not have; see [Refusals and fallback](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback).
from line 50
model = "claude-mythos-preview" # Before model = "claude-mythos-5" # After -# Or, for the generally available model with the same capabilities: +# Or, for the model with the same capabilities and no access approval requirement: model = "claude-fable-5" # After ```
from line 319
#### Migration checklist -* Update the model name from `claude-mythos-preview` to `claude-mythos-5`, or to `claude-fable-5` for the generally available model. +* Update the model name from `claude-mythos-preview` to `claude-mythos-5`, or to `claude-fable-5`, which offers the same capabilities and does not require access approval. * Remove manual extended thinking configuration (`thinking: {type: "enabled", budget_tokens: N}`). Adaptive thinking is always on, and no `thinking` field is required. * Remove any `thinking: {type: "disabled"}` configuration. Disabling thinking returns an error on `claude-mythos-5` and `claude-fable-5`. * Remove `budget_tokens`. It has no direct replacement: thinking is adaptive, and the `effort` parameter is a separate output-level control, not a thinking budget.
from line 794
### Migrating to Claude Opus 5 from Claude Opus 4.7 -Claude Opus 5 should have strong out-of-the-box performance on existing Claude Opus 4.7 prompts and evals, at the same pricing of $5 per million input tokens and $25 per million output tokens. It supports the same set of features as Claude Opus 4.7, including the [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows), [128k max output tokens](https://platform.claude.com/docs/en/about-claude/models/overview), [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking), [prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching), [batch processing](https://platform.claude.com/docs/en/build-with-claude/batch-processing), the [Files API](https://platform.claude.com/docs/en/build-with-claude/files), [PDF support](https://platform.claude.com/docs/en/build-with-claude/pdf-support), [vision](https://platform.claude.com/docs/en/build-with-claude/vision), and server-side and client-side [tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview), with two exceptions: [web fetch](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) is not available on Claude Opus 5, and [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models) is not supported on Claude Opus 5. It also adds [mid-conversation system messages](https://platform.claude.com/docs/en/build-with-claude/mid-conversation-system-messages) and publicly documents [refusal stop details](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback#refusal-response). On the Claude API, Claude Opus 5 also supports [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) as the generally available `computer_toolset_20260801` toolset and the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) for tasks inside webpages, neither of which Claude Opus 4.7 supports; existing integrations on the earlier `computer_20251124` version continue to work unchanged on both models. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). +Claude Opus 5 should have strong out-of-the-box performance on existing Claude Opus 4.7 prompts and evals, at the same pricing of $5 per million input tokens and $25 per million output tokens. It supports the same set of features as Claude Opus 4.7, including the [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows), [128k max output tokens](https://platform.claude.com/docs/en/about-claude/models/overview), [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking), [prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching), [batch processing](https://platform.claude.com/docs/en/build-with-claude/batch-processing), the [Files API](https://platform.claude.com/docs/en/build-with-claude/files), [PDF support](https://platform.claude.com/docs/en/build-with-claude/pdf-support), [vision](https://platform.claude.com/docs/en/build-with-claude/vision), and server-side and client-side [tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview), with two exceptions: [web fetch](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) is not available on Claude Opus 5, and [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models) is not supported on Claude Opus 5. It also adds [mid-conversation system messages](https://platform.claude.com/docs/en/build-with-claude/mid-conversation-system-messages) and publicly documents [refusal stop details](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback#refusal-response). On the Claude API, Claude Opus 5 also supports [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) as the stable `computer_toolset_20260801` toolset and the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) for tasks inside webpages, neither of which Claude Opus 4.7 supports; existing integrations on the earlier `computer_20251124` version continue to work unchanged on both models. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). <Note> If your code is on Claude Opus 4.6 or earlier, use [Migrating to Claude Opus 5 from Claude Opus 4.6 and earlier Opus models](https://platform.claude.com/docs/en/about-claude/models/migration-guide#migrating-from-claude-opus-46) instead. That section includes breaking changes (sampling parameters rejected, manual extended thinking rejected, new tokenizer) that the upgrade from Claude Opus 4.7 alone does not cover.
from line 855
The following items are not breaking changes; they describe behavior differences worth checking after you swap the model ID. -1. **Sampling parameters (unchanged):** Setting `temperature`, `top_p`, or `top_k` to a non-default value returns a 400 error on Claude Opus 5, the same as on Claude Opus 4.7. The SDK request types still define these fields for compatibility with earlier models, so code that sets them type-checks, but the API rejects the request server-side. If you removed these parameters when migrating to Opus 4.7, no further changes are needed. +1. **Sampling parameters (unchanged):** Setting `temperature`, `top_p`, or `top_k` to a non-default value returns a 400 error on Claude Opus 5, the same as on Claude Opus 4.7. Most SDKs still define these fields for compatibility with earlier models, so code that sets them type-checks even though the API rejects the request. The Python SDK (v1.0 and later) does not define them, and passing them raises a `TypeError`. If you removed these parameters when migrating to Opus 4.7, no further changes are needed. 2. **Effort default is `high`:** The [effort parameter](https://platform.claude.com/docs/en/build-with-claude/effort) default on Claude Opus 5 is `high` on the Claude API and Claude Code. If you already set effort explicitly, your setting is unchanged.
from line 915
* [Vision](https://platform.claude.com/docs/en/build-with-claude/vision) * Server-side and client-side [tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) ([bash](https://platform.claude.com/docs/en/agents-and-tools/tool-use/bash-tool), [code execution](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool), [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool), [text editor](https://platform.claude.com/docs/en/agents-and-tools/tool-use/text-editor-tool), [web search](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool), [MCP connector](https://platform.claude.com/docs/en/agents-and-tools/mcp-connector), [memory](https://platform.claude.com/docs/en/agents-and-tools/tool-use/memory-tool)) -Two exceptions: [web fetch](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) is not available on Claude Opus 5, and [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models) is not supported on Claude Opus 5. On the Claude API, Claude Opus 5 also supports [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) as the generally available `computer_toolset_20260801` toolset and the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) for tasks inside webpages, neither of which Claude Opus 4.6 or earlier Opus models support; existing integrations on the earlier `computer_20251124` version continue to work unchanged on Claude Opus 5. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). +Two exceptions: [web fetch](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) is not available on Claude Opus 5, and [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models) is not supported on Claude Opus 5. On the Claude API, Claude Opus 5 also supports [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) as the stable `computer_toolset_20260801` toolset and the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) for tasks inside webpages, neither of which Claude Opus 4.6 or earlier Opus models support; existing integrations on the earlier `computer_20251124` version continue to work unchanged on Claude Opus 5. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). #### Update your model name
from line 1216
3. **Disabling thinking is capped at `high` effort:** You can turn thinking off with `thinking: {type: "disabled"}`, but only at an [effort](https://platform.claude.com/docs/en/build-with-claude/effort) level of `high` or below. A request that combines `thinking: {type: "disabled"}` with effort `xhigh` or `max` returns a 400 error on Claude Opus 5, enforced on each request. Audit requests that disable thinking before you migrate: re-enable thinking or lower the effort to `high` or below. -4. **Sampling parameters removed:** Setting `temperature`, `top_p`, or `top_k` to any non-default value on Claude Opus 4.7 or later models, including Claude Opus 5, returns a 400 error. The safest migration path is to omit these parameters entirely from request payloads. Prompting is the recommended way to guide model behavior on Claude Opus 5. If you were using `temperature = 0` for determinism, note that it never guaranteed identical outputs on prior models. +4. **Sampling parameters removed:** Setting `temperature`, `top_p`, or `top_k` to any non-default value on Claude Opus 4.7 or later models, including Claude Opus 5, returns a 400 error. The Python SDK (v1.0 and later) does not define them, and passing them raises a `TypeError`. The safest migration path is to omit these parameters entirely from request payloads. Prompting is the recommended way to guide model behavior on Claude Opus 5. If you were using `temperature = 0` for determinism, note that it never guaranteed identical outputs on prior models. 5. **Thinking content omitted by default:** Thinking blocks still appear in the response stream on Claude Opus 4.7 and later models, but their `thinking` field is empty unless you explicitly opt in. This is a silent change from Claude Opus 4.6, where the default was to return summarized thinking text. To restore summarized thinking content, set `thinking.display` to `"summarized"`:
from line 1624
``` </CodeGroup> - Note that the migration also moves from `client.beta.messages.create` to `client.messages.create`. Adaptive thinking and effort are GA features and do not require the beta SDK namespace or any beta headers. + Note that the migration also moves from `client.beta.messages.create` to `client.messages.create`. Adaptive thinking and effort do not require the beta SDK namespace or any beta headers. -2. **Remove effort beta header:** The effort parameter is now GA. Remove `betas=["effort-2025-11-24"]` from your requests. +2. **Remove effort beta header:** The effort parameter does not require a beta header. Remove `betas=["effort-2025-11-24"]` from your requests. -3. **Remove fine-grained tool streaming beta header:** Fine-grained tool streaming is now GA. Remove `betas=["fine-grained-tool-streaming-2025-05-14"]` from your requests. +3. **Remove fine-grained tool streaming beta header:** Fine-grained tool streaming does not require a beta header. Remove `betas=["fine-grained-tool-streaming-2025-05-14"]` from your requests. 4. **Remove interleaved thinking beta header:** Adaptive thinking automatically enables interleaved thinking on Claude Opus 4.7, Opus 4.6, and Sonnet 4.6. Remove `betas=["interleaved-thinking-2025-05-14"]` from your requests. The header is still functional on Sonnet 4.6 with manual extended thinking, but manual mode is deprecated. -5. **Migrate to output\_config.format:** If using structured outputs, update `output_format={...}` to `output_config={"format": {...}}`. The old parameter remains functional but is deprecated and will be removed in a future model release. +5. **Migrate to output\_config.format:** If using structured outputs, update `output_format={...}` to `output_config={"format": {...}}`. The API still accepts the deprecated `output_format` parameter, but it will be removed in a future model release. The Python SDK (v1.0 and later) does not accept `output_format={...}` on `client.beta.messages.create()` or `count_tokens()`. The `output_format=Model` argument of the `parse()` and `stream()` helpers is unchanged. #### Migrating from Claude 4.1 or earlier
from line 1656
This is a breaking change when migrating from Claude 3.x models. </Warning> - Starting with Claude Opus 4.7, setting `temperature`, `top_p`, or `top_k` to any non-default value returns a 400 error. The safest migration path is to omit these parameters entirely from requests, and to use prompting to guide the model's behavior. If you were using `temperature = 0` for determinism, note that it never guaranteed identical outputs. + Starting with Claude Opus 4.7, setting `temperature`, `top_p`, or `top_k` to any non-default value returns a 400 error. The Python SDK (v1.0 and later) does not define them, and passing them raises a `TypeError`. The safest migration path is to omit these parameters entirely from requests, and to use prompting to guide the model's behavior. If you were using `temperature = 0` for determinism, note that it never guaranteed identical outputs. <CodeGroup exclude="shell"> ```python Python
from line 1997
* **BREAKING:** Remove assistant message prefills (returns 400 error); use structured outputs or `output_config.format` instead * **BREAKING on Opus 4.7:** Replace `thinking: {type: "enabled", budget_tokens: N}` with `thinking: {type: "adaptive"}` plus the [effort parameter](https://platform.claude.com/docs/en/build-with-claude/effort) (returns 400 on Opus 4.7) * Verify tool call JSON parsing uses a standard JSON parser -* Remove `effort-2025-11-24` beta header (effort is now GA) +* Remove `effort-2025-11-24` beta header (the effort parameter does not require it) * Remove `fine-grained-tool-streaming-2025-05-14` beta header * Remove `interleaved-thinking-2025-05-14` beta header (adaptive thinking enables interleaved thinking automatically) * Migrate `output_format` to `output_config.format` (if applicable)
from line 2027
2. **Disabling thinking is capped at `high` effort:** On Claude Sonnet 5, `thinking: {type: "disabled"}` is accepted at any effort level. On Claude Opus 5, it is accepted only at an [effort](https://platform.claude.com/docs/en/build-with-claude/effort) level of `high` or below; a request that combines `thinking: {type: "disabled"}` with effort `xhigh` or `max` returns a 400 error, enforced on each request. Audit requests that disable thinking before you migrate. -3. **Mid-conversation system messages:** Claude Opus 5 accepts `role: "system"` messages immediately after a user turn in the `messages` array (subject to [placement rules](https://platform.claude.com/docs/en/build-with-claude/mid-conversation-system-messages#limitations)); Claude Sonnet 5 does not. If you maintain code paths that rebuild the full message history to update instructions, you can simplify them and preserve [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) hits on earlier turns. +3. **Mid-conversation system messages:** Claude Opus 5 accepts `role: "system"` messages immediately after a user turn in the `messages` array (subject to [placement rules](https://platform.claude.com/docs/en/build-with-claude/mid-conversation-system-messages#limitations)). This feature is not available on Claude Sonnet 5; use the top-level `system` field instead. If you maintain code paths that rebuild the full message history to update instructions, you can simplify them and preserve [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) hits on earlier turns. 4. **Web fetch is not available:** The [web fetch](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) tool is available on Claude Sonnet 5 but not on Claude Opus 5.
from line 2044
Claude Sonnet 5 offers the best combination of speed and intelligence in the Claude model family. It builds on Claude Sonnet 4.6. -Claude Sonnet 5 is a drop-in upgrade for Claude Sonnet 4.6, priced at $2/$10 USD per million input/output tokens; see [Pricing](https://platform.claude.com/docs/en/about-claude/pricing) for details. There are two breaking API changes for code already running on Claude Sonnet 4.6: manual extended thinking (`thinking: {type: "enabled", budget_tokens: N}`) and sampling parameters (`temperature`, `top_p`, `top_k`) set to non-default values are no longer accepted and return a 400 error. Use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking) with the [effort parameter](https://platform.claude.com/docs/en/build-with-claude/effort) instead. Claude Sonnet 5 supports the same set of features as Claude Sonnet 4.6, including the [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows), [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking), [prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching), [batch processing](https://platform.claude.com/docs/en/build-with-claude/batch-processing), the [Files API](https://platform.claude.com/docs/en/build-with-claude/files), [PDF support](https://platform.claude.com/docs/en/build-with-claude/pdf-support), [vision](https://platform.claude.com/docs/en/build-with-claude/vision), and the full set of server-side and client-side [tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview). On the Claude API, Claude Sonnet 5 also supports [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) as the generally available `computer_toolset_20260801` toolset and the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) for tasks inside webpages, neither of which Claude Sonnet 4.6 supports; existing integrations on the earlier `computer_20251124` version continue to work unchanged on both models. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models) is not available on Claude Sonnet 5. Claude Sonnet 5 also uses a new tokenizer. +Claude Sonnet 5 is a drop-in upgrade for Claude Sonnet 4.6, priced at $2/$10 USD per million input/output tokens; see [Pricing](https://platform.claude.com/docs/en/about-claude/pricing) for details. There are two breaking API changes for code already running on Claude Sonnet 4.6: manual extended thinking (`thinking: {type: "enabled", budget_tokens: N}`) and sampling parameters (`temperature`, `top_p`, `top_k`) set to non-default values are no longer accepted and return a 400 error. Use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking) with the [effort parameter](https://platform.claude.com/docs/en/build-with-claude/effort) instead. Claude Sonnet 5 supports the same set of features as Claude Sonnet 4.6, including the [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows), [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking), [prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching), [batch processing](https://platform.claude.com/docs/en/build-with-claude/batch-processing), the [Files API](https://platform.claude.com/docs/en/build-with-claude/files), [PDF support](https://platform.claude.com/docs/en/build-with-claude/pdf-support), [vision](https://platform.claude.com/docs/en/build-with-claude/vision), and the full set of server-side and client-side [tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview). On the Claude API, Claude Sonnet 5 also supports [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) as the stable `computer_toolset_20260801` toolset and the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) for tasks inside webpages, neither of which Claude Sonnet 4.6 supports; existing integrations on the earlier `computer_20251124` version continue to work unchanged on both models. To upgrade an existing integration, see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). [Priority Tier](https://platform.claude.com/docs/en/api/service-tiers#supported-models) is not available on Claude Sonnet 5. Claude Sonnet 5 also uses a new tokenizer. ### Migrating to Claude Sonnet 5 from Claude Sonnet 4.6
from line 2104
``` ```bash CLI - ant messages create \ - --transform content --format yaml <<'YAML' + ant messages create --transform content --format yaml <<'YAML' model: claude-sonnet-5 max_tokens: 16000 thinking:
about-claude/models/optimizing-for-cost-and-intelligence Changed · +104 / -29 lines
from line 70
Those breakpoint placements follow the standard pattern in [Explicit cache breakpoints](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#explicit-cache-breakpoints). -Three settings can break your cache during a task. Changing [`effort`](https://platform.claude.com/docs/en/build-with-claude/effort) between requests invalidates the cached prefix, so change it only where you would re-cache anyway, such as at a [compaction](https://platform.claude.com/docs/en/build-with-claude/compaction) boundary. Changing a [task budget](https://platform.claude.com/docs/en/build-with-claude/task-budgets) partway through does the same, so set it once, on the first request. Every [context editing](https://platform.claude.com/docs/en/build-with-claude/context-editing#context-editing-and-prompt-caching) pass invalidates the prefix from the point it clears and the next request pays to re-cache everything after it, so clear in a few large batches rather than many small ones. Make all three changes at natural breaks, then confirm cache reads have not dropped; if they have, [cache diagnostics](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics) shows where the prefix diverged. +Four things can break your cache during a task. Anything that changes per request, such as a timestamp or a queue position, placed ahead of the stable prefix turns every request into a full cache write: on the triage run in [Trim input and context tokens](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#trim-input-and-context-tokens), a 25-token status line at the front of the system prompt cost $4.24 per run instead of $0.59, more than running with caching off. Keep per-request text in the newest user turn. Changing [`effort`](https://platform.claude.com/docs/en/build-with-claude/effort) between requests invalidates the cached prefix, so change it only where you would re-cache anyway, such as at a [compaction](https://platform.claude.com/docs/en/build-with-claude/compaction) boundary. Changing a [task budget](https://platform.claude.com/docs/en/build-with-claude/task-budgets) partway through does the same, so set it once, on the first request. Every [context editing](https://platform.claude.com/docs/en/build-with-claude/context-editing#context-editing-and-prompt-caching) pass invalidates the prefix from the point it clears and the next request pays to re-cache everything after it, so clear in a few large batches rather than many small ones. Make the last three changes at natural breaks, then confirm cache reads have not dropped; if they have, [cache diagnostics](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics) shows where the prefix diverged. ### Trim input and context tokens Most agent requests carry tokens that never influence the answer. Trimming them costs nothing in output quality, although not every lever here saved money when measured. Two places to look: -* **Input trimming.** [Dynamic filtering](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool#dynamic-filtering) in the web fetch tool keeps boilerplate out of fetched pages, [image resizing](https://platform.claude.com/docs/en/build-with-claude/vision#evaluate-image-size) right-sizes vision inputs, and [tool search with deferred loading](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-search-tool) loads tool definitions only when needed. [Programmatic tool calling](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling) lets Claude run several tool calls from code so only the filtered result enters the context; its documentation reports 24% fewer input tokens on agentic search benchmarks, with a higher score. [Manage tool context](https://platform.claude.com/docs/en/agents-and-tools/tool-use/manage-tool-context) compares tool search, programmatic tool calling, prompt caching, and context editing. +* **Input trimming.** [Dynamic filtering](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool#dynamic-filtering) in the web fetch tool keeps boilerplate out of fetched pages, [image resizing](https://platform.claude.com/docs/en/build-with-claude/vision#evaluate-image-size) right-sizes vision inputs, and [tool search with deferred loading](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-search-tool) loads tool definitions only when needed (measured later in this section). [Programmatic tool calling](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling) lets Claude run several tool calls from code so only the filtered result enters the context; its documentation reports 24% fewer input tokens on agentic search benchmarks, with a higher score. [Manage tool context](https://platform.claude.com/docs/en/agents-and-tools/tool-use/manage-tool-context) compares tool search, programmatic tool calling, prompt caching, and context editing. * **Context lifecycle.** [Context editing](https://platform.claude.com/docs/en/build-with-claude/context-editing) clears stale tool results, and [automatic compaction](https://platform.claude.com/docs/en/build-with-claude/compaction) with its threshold stops long loops from carrying their whole history forward. -The levers interact with the cache and each other, so judge them by net effect, and use [cache diagnostics](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics) to confirm your cached prefix survives each change. Anthropic turned the levers on one at a time for an issue-triage agent working through 20 real bug reports with screenshots from a public repository (and, for the second panel, a longer variant of the same job): +Defer tool definitions you are not using. Every tool definition attached to a request is input on every turn, and a few MCP servers add up to hundreds of them. Anthropic ran the triage agent with its own two tools plus a catalog of real tool definitions from public MCP servers, for a total of up to 502 tools, loading all of them or marking the extras `defer_loading` behind [tool search](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-search-tool): - + -Caching did almost all the work, and trimming took the total to 88%. Each bar is one run, so differences of $0.10 are noise; those shown here are not. Compaction needs a session long enough to trigger it: the 20-issue run never reached the 50,000-token floor once its inputs were trimmed, but on the second panel's longer variant it fired once and cut the bill a further 38%. +With every definition loaded, the run cost rose from $0.55 to $1.02, tracking the schema tokens on each request. With tool search, it stayed at $0.56 at every catalog size, 45% less at 502 tools. Accuracy was 15 to 18 of 20 in every cell either way, and the model never called a wrong tool, so at this scale the catalog costs money, not correctness. The same holds for tools that come through the [MCP connector](https://platform.claude.com/docs/en/agents-and-tools/mcp-connector): with a public GitHub MCP server attached, deferring its toolset (`default_config: {defer_loading: true}`) cut the run 20% at the same accuracy. -Context editing is the one lever here that is not free. Every clearing pass rewrites the cached conversation, which works against prompt caching; in this run, context editing cost more than it saved. Use it to make room in the context window, and [clear in a few large batches](https://platform.claude.com/docs/en/build-with-claude/context-editing#context-editing-and-prompt-caching). +Keep data files out of the prompt. When the model has to compute over a table, upload it with the [Files API](https://platform.claude.com/docs/en/build-with-claude/files) and let the model query it with [code execution](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool) instead of pasting it in. Anthropic asked 25 aggregate questions[15](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#refs) (sums, filtered counts, group-bys, and a date filter) over a 1,862-row public CSV, with the answers computed by pandas: + + +Pasted into the prompt, the table is about 91,000 input tokens on every request, and Claude Sonnet 5 answered 6 of 25 questions correctly at $5.01 per run. Uploaded, with code execution, it answered 25 of 25 at $0.40. Claude Opus 5 showed the same pattern (6 of 25 at $13.45 against 25 of 25 at $1.91). + +The levers interact with the cache and each other, so judge them by net effect, and use [cache diagnostics](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics) to confirm your cached prefix survives each change. Anthropic measured them on an issue-triage agent working through 20 real bug reports with screenshots from a public repository, and on a longer variant of the same job with 2.6 times the tokens. With caching on, input trimming (image resizing and tool search) took a further 26% off the short run and 21% off the long one. The context levers are where the two runs diverge: + + + +The context levers only pay on a session long enough to need them. On the 20-issue run, context editing cost 74% more, and compaction and the prune changed nothing. On the long run, context editing changed nothing, compaction saved 32%, and the prune saved 39%. The prune is a few lines you write yourself: at each task boundary, replace large stale tool results with a one-line extract. It caches well because the edits sit at the tail of the conversation, where the next task adds new content anyway: 89% cache reads on the first request after a boundary and 81% on the requests between boundaries. Run-wide, the prune and context editing cache equally well. The prune is cheaper because context editing rewrites content mid-task that the prune deletes (about two thirds of the gap) and because it keeps the context about half the size (the other third). If you use context editing, [clear in a few large batches](https://platform.claude.com/docs/en/build-with-claude/context-editing#context-editing-and-prompt-caching). The prune, adapted from the harness: + +```python +import re + +PRUNED = "[pruned at issue boundary]" + + +def prune_task_boundary(messages, tool_name_by_id, threshold=2000): + """Call once per task boundary. Replaces large, stale search results with a one-line extract.""" + for message in messages: + if message["role"] != "user" or not isinstance(message["content"], list): + continue + for block in message["content"]: + if not (isinstance(block, dict) and block.get("type") == "tool_result"): + continue + if tool_name_by_id.get(block.get("tool_use_id")) != "search_issues": + continue + result_text = block.get("content") + if not isinstance(result_text, str) or len(result_text) <= threshold: + continue + if result_text.startswith(PRUNED): + continue # already pruned on an earlier boundary + # cap single-line results so the extract stays short + first_line = result_text.split("\n", 1)[0].strip()[:200] + refs = re.findall(r"#(\d+)", result_text)[:5] + extract = f"{PRUNED} {first_line}" + if refs: + extract += " kept refs: " + " ".join("#" + r for r in refs) + block["content"] = extract +``` + ### Batch work that can wait The [Batch API](https://platform.claude.com/docs/en/build-with-claude/batch-processing) takes 50% off every token of a request, including cached ones, in exchange for results arriving any time within 24 hours. Route every request no one is waiting on through a batch, and keep the interactive path for the rest. Batching is the second-largest free lever after caching for unattended agent work: evaluation runs, backfills, and scheduled jobs such as a recurring run of the issue-triage agent from the [token-trimming measurement](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#trim-input-and-context-tokens). It combines with everything on this page except interactivity, but is not available for Claude Managed Agents sessions, which are interactive by design (see [Claude Managed Agents pricing](https://platform.claude.com/docs/en/about-claude/pricing#claude-managed-agents-pricing)).
from line 244
* **`max_tokens`** caps a single response, invisibly to the model, so lowering it does not make the model economize. The turns that needed the room are discarded and still billed. On an internal repository-task benchmark[12](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#refs), a 16,384-token cap ended 15% of Claude Opus 5's attempts and a third of Claude Fable 5's, none of them solved. Capped runs spent less per attempt but bought proportionally fewer solves, so cost per solved task was the same as at 64,000. At that setting nothing was cut off, and Fable solved 54.6% of tasks instead of 36.6% on the problems both runs scored (on a separate cut of the SWE-bench Pro[3](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#refs) subset, described in reference 12, 92% instead of 90%). Retrying capped attempts only adds cost: at the same cap they never succeeded, and at a higher one you also pay for the wasted attempt. Set `max_tokens` to 64,000 for agentic work (128,000, the maximum, at `xhigh` or `max` effort), [stream responses](https://platform.claude.com/docs/en/build-with-claude/streaming) that large, treat [`stop_reason: max_tokens`](https://platform.claude.com/docs/en/build-with-claude/handling-stop-reasons#max-tokens) as a failure, and save money with effort and task budgets, which the model can see. * **Session budgets on Claude Managed Agents** are the hard stop. A [session budget](https://platform.claude.com/docs/en/managed-agents/budgets) is a dollar cap on one session at list rates for tokens, searches, and session time. At the cap, the session pauses with `stop_reason: budget_reached`; raising the budget resumes it. It is platform-enforced, works on any model with a list price (including Claude Sonnet 5), and combines with the advisory task budget. Deployments apply the same field to every run. +Ask for shorter answers. Output tokens cost five times input tokens on Claude Sonnet 5, and in an agent loop every token the model writes comes back as input on every later turn, so you pay for a long answer again and again. Anthropic ran the triage job under three final-answer instructions, three runs each, with the same model and tools. The original asked for two lines: + +```text wrap +4. Finish with exactly two lines: +LABEL: <one of: bug-confirmed, needs-more-info, duplicate-candidate, feature-request, upstream-issue, perf, ui-polish> +SUMMARY: <one or two sentences for the engineering team> +``` + +The shorter variant asked for one: + +```text wrap +4. Finish with exactly one line in this form: +DECISION | LABEL | REASON +where DECISION is one of: triage-now, needs-info, close-duplicate; LABEL is one of: bug-confirmed, needs-more-info, duplicate-candidate, feature-request, upstream-issue, perf, ui-polish; REASON is one clause under 15 words. Output nothing after that line. +``` + +The longer variant asked for a memo with five headed sections: problem summary, evidence, duplicate check, recommended label, and next steps. For one issue, a queued prompt that never sends after a skipped question, the first two answers were: + +```text wrap +LABEL: bug-confirmed +SUMMARY: When a user submits a new prompt instead of answering an agent's pending question, the question is cancelled/skipped but the new prompt remains stuck in "QUEUED" state indefinitely since it's waiting on a response to the now-cancelled question; the queued prompt should be processed immediately after cancellation. +``` + +```text wrap +triage-now | bug-confirmed | Clear repro steps show prompt queues indefinitely after cancelled question. +``` + + + +The one-line answer used 39% fewer output tokens and cost $0.49 for the run against $0.57, with the same accuracy against the gold labels (78% compared with 80%, inside run-to-run noise). The memo used six times the output tokens of the original and cost $1.40, 2.8 times the one-line answer, for 85%, also inside the noise. The three formats are equally accurate; they differ in what you pay. Ask for the answer you will read, not the one that looks thorough. + The first of two `max_tokens` charts plots cost per attempt and per solved task at each cap: 
from line 306
The first is the gap between the models. The advisor can only hand over capability the executor lacks: on GPQA Diamond[9](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#refs) a Claude Haiku 4.5 executor gained a great deal from a Claude Opus 5 advisor, a Claude Sonnet 5 executor gained a few points, and a frontier executor almost nothing. -The second, and the fragile one, is whether the executor actually asks (the consult rate). An executor at low effort can stop noticing it is stuck: a pairing that consults on most tasks at the default effort can fall to consulting on almost none when effort is lowered, and then scores below the executor alone. The rate also varies by task: on DeepSWE[10](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#refs) a low-effort Sonnet 5 executor kept asking and gained 23 points; on SWE-bench Pro[3](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#refs) the same executor stopped. When the executor does ask, it gets most of the way there. Across the pairings in the following chart, the advisor closed 60% to 90% of the gap to the stronger model while that model was paid for only on the consultations, which makes the cost cases possible: +The second, and the fragile one, is whether the executor actually asks (the consult rate). An executor at low effort can stop detecting that it is stuck: a pairing that consults on most tasks at the default effort can fall to consulting on almost none when effort is lowered, and then scores below the executor alone. The rate also varies by task: on DeepSWE[10](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#refs) a low-effort Sonnet 5 executor kept asking and gained 23 points; on SWE-bench Pro[3](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#refs) the same executor stopped. When the executor does ask, it recovers most of the gap. Across the pairings in the following chart, the advisor closed 50% to 90% of the gap to the stronger model and you pay for the stronger model only on the consultations, which is what makes the cost cases possible: 
from line 599
The following table lists the levers in the order to try them: -| Lever | Saving in these runs | Quality cost | Latency | Where | -| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Prompt caching | Cost cut by a factor of 2.5 to 3.7 on agent loops; 83% on the triage run | None | Faster | [Cache repeated context](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#cache-repeated-context) | -| Input trimming | A further 5 percentage points on the triage run | None | Neutral | [Trim input and context tokens](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#trim-input-and-context-tokens) | -| Compaction | 38% on the long triage run; nothing on short loops | None measured | Neutral | [Trim input and context tokens](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#trim-input-and-context-tokens) | -| Batch API | 50% | None | Results within 24 hours | [Batch work that can wait](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#batch-work-that-can-wait) | -| Prompt audit against the current model | 14% on both migrations measured | None; a gain on one | Faster (fewer tool rounds) | [Audit prompts against the current model](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#audit-prompts-against-the-current-model) | -| Lower effort | Knowledge work: `medium` 15% to 30%, `low` a third to a half; long coding: `medium` about half, `low` about three quarters | 1 to 3 points on knowledge work, 2 to 8 on long coding | Faster | [Tune effort](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#tune-effort) | -| Re-run failures | About half, at the same pass rate | None | Two runs on the tasks that fail | [Re-run failures at higher effort](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#re-run-failures-at-higher-effort) | -| Task budget | 18% to 47% | 3 to 4 points | Faster | [Set budgets and output caps](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#set-budgets-and-output-caps) | -| Raising `max_tokens` | None per solved task, but more tasks solved | Gains of 2 to 18 points | Neutral | [Set budgets and output caps](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#set-budgets-and-output-caps) | -| Advisor | Depends on the capability gap and the consult rate; the chart-reading pairing scored above both models' effort curves, the coding pairing only marginally | Small gains | About two extra calls per task | [Advisor strategy](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#advisor-strategy-escalate-hard-decisions) | -| Orchestrator | More than 60% below the frontier model beyond one context window; about half on routine tails | 2 to 6 points below the frontier model | Much faster on large inputs | [Orchestrator strategy](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#orchestrator-strategy-delegate-bulk-work) | +| Lever | Saving in these runs | Quality cost | Latency | Where | +| ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Prompt caching | Cost cut by a factor of 2.5 to 3.7 on agent loops; 83% on the triage run | None | Faster | [Cache repeated context](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#cache-repeated-context) | +| Input trimming | A further 5 percentage points on the triage run | None | Neutral | [Trim input and context tokens](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#trim-input-and-context-tokens) | +| Prune stale tool results at task boundaries | 39% on the long triage run (compaction 32%); nothing on short loops | None measured | Neutral | [Trim input and context tokens](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#trim-input-and-context-tokens) | +| Tool search | 45% with 500 tool definitions attached; 20% with a GitHub MCP server | None | Neutral | [Trim input and context tokens](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#trim-input-and-context-tokens) | +| Data files through code execution | 92% on a 25-question data task | A gain, 25 of 25 instead of 6 of 25 | Faster | [Trim input and context tokens](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#trim-input-and-context-tokens) | +| Batch API | 50% | None | Results within 24 hours | [Batch work that can wait](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#batch-work-that-can-wait) | +| Prompt audit against the current model | 14% on both migrations measured | None; a gain on one | Faster (fewer tool rounds) | [Audit prompts against the current model](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#audit-prompts-against-the-current-model) | +| Lower effort | Knowledge work: `medium` 15% to 30%, `low` a third to a half; long coding: `medium` about half, `low` about three quarters | 1 to 3 points on knowledge work, 2 to 8 on long coding | Faster | [Tune effort](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#tune-effort) | +| Re-run failures | About half, at the same pass rate | None | Two runs on the tasks that fail | [Re-run failures at higher effort](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#re-run-failures-at-higher-effort) | +| Task budget | 18% to 47% | 3 to 4 points | Faster | [Set budgets and output caps](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#set-budgets-and-output-caps) | +| Ask for shorter answers | 39% of output tokens, 14% of cost on the triage run | None | Faster | [Set budgets and output caps](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#set-budgets-and-output-caps) | +| Raising `max_tokens` | None per solved task, but more tasks solved | Gains of 2 to 18 points | Neutral | [Set budgets and output caps](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#set-budgets-and-output-caps) | +| Advisor | Depends on the capability gap and the consult rate; the chart-reading pairing scored above both models' effort curves, the coding pairing only marginally | Small gains | About two extra calls per task | [Advisor strategy](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#advisor-strategy-escalate-hard-decisions) | +| Orchestrator | More than 60% below the frontier model beyond one context window; about half on routine tails | 2 to 6 points below the frontier model | Much faster on large inputs | [Orchestrator strategy](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#orchestrator-strategy-delegate-bulk-work) | ## Benchmarks referenced All measurements are Anthropic-internal runs of these benchmarks. Unless noted, costs are USD at August 2026 list prices; Claude Sonnet 5 figures use $2 and $10 per million input and output tokens. Charts labeled "notional USD" price each request's token counts at those rates rather than reporting invoices. -1. **WideSearch:** Wong et al., "WideSearch: Benchmarking Agentic Broad Info-Seeking," arXiv.07999, 2025. Broad web-research tasks graded on a many-row table's completeness and accuracy; 200 problems, 3 runs per configuration. The caching and effort charts come from separate runs, so per-problem costs differ slightly. The cost-concentration chart is a separate 20-problem run, 3 runs per problem, costed from per-request billing records. +1. **WideSearch:** Wong et al., "WideSearch: Benchmarking Agentic Broad Info-Seeking," arXiv:2508.07999, 2025. Broad web-research tasks graded on a many-row table's completeness and accuracy; 200 problems, 3 runs per configuration. The caching and effort charts come from separate runs, so per-problem costs differ slightly. The cost-concentration chart is a separate 20-problem run, 3 runs per problem, costed from per-request billing records. 2. **GDPval:** OpenAI, "GDPval: Evaluating AI Model Performance on Real-World Economically Valuable Tasks," 2025. Knowledge-work deliverables graded against task rubrics; a 210-task run of the released gold set, one attempt per task. A Claude model grades, so absolute scores may differ from published results. -3. **SWE-bench Pro:** Scale AI, "SWE-Bench Pro: Can AI Agents Solve Long-Horizon Software Engineering Tasks?", 2025. A 482-problem subset selected for compatibility with Anthropic's evaluation harness; scores are not comparable to the public leaderboard. Claude Opus 5 at the default effort averages two runs; reduced-effort settings are single runs. Escalation figures come task by task from those runs: `low` first, then the default on its failures, solved 92.5% to 93.6% across run pairings for about $0.70; `medium` first, 93.8% to 94.2% for about $0.95; the default re-run on its own failures, 94.0% for $1.58; everything at the default, 90.9% to 92.5% for $1.39. The Claude Sonnet 5 executor pairings on the advisor chart come from the same August 2026 series on this subset: the Sonnet-plus-Opus pairing was run twice (a run and an exact replication) and the low-effort pairing once; the task-budget figures are one run per budget on the same subset. The Claude Fable 5 figure in [Compare models](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#compare-models-on-cost-per-task) is a single July 2026 run, also the task-budget chart's unbudgeted baseline; every budgeted run completed all 482 problems without harness errors. +3. **SWE-bench Pro:** Scale AI, "SWE-Bench Pro: Can AI Agents Solve Long-Horizon Software Engineering Tasks?", 2025. A 482-problem subset selected for compatibility with Anthropic's evaluation harness; scores are not comparable to the public leaderboard. Claude Opus 5 at the default effort averages two runs; reduced-effort settings are single runs. Escalation figures come task by task from those runs: `low` first, then the default on its failures, solved 92.5% to 93.6% across run pairings for about $0.70; `medium` first, 93.8% to 94.2% for about $0.95; the default re-run on its own failures, 94.0% for $1.58; everything at the default, 90.9% to 92.5% for $1.39. The Claude Sonnet 5 executor pairings on the advisor chart come from the same August 2026 series on this subset: the Sonnet-plus-Opus pairing was run twice (a run and an exact replication), the low-effort pairing once, and Claude Sonnet 5 alone twice (77.4%, the baseline for both Pro rows); the task-budget figures are one run per budget on the same subset. The Claude Fable 5 figure in [Compare models](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#compare-models-on-cost-per-task) is a single July 2026 run, also the task-budget chart's unbudgeted baseline; every budgeted run completed all 482 problems without harness errors. 4. **BrowseComp:** Wei et al., "BrowseComp: A Simple Yet Challenging Benchmark for Browsing Agents," OpenAI, 2025. Effort figures use a 500-problem cut, one to three runs per setting. The cost-insurance chart uses 10 reliably solved problems from a 26-problem slice, 50 delegated and 70 solo runs ($6.45 compared with $11.99 per run in expectation); delegated figures carry a measurement band of about 20%. -5. **Agent-architecture scaling:** Kim et al., "Towards a Science of Scaling Agent Systems," arXiv.08296, 2025. Independent external study, cited only for the direction of the finding on when delegation does not pay, not for any figure. -6. **DeepWideSearch:** "DeepWideSearch: Benchmarking Depth and Width in Agentic Information Seeking," arXiv.20168, 2025. The 220 questions span 15 domains, each combining many-row collection with multi-hop retrieval; measured on the benchmark's standing row set, 3 runs per configuration. -7. **DeepResearch Bench II:** Li et al., "DeepResearch Bench II: Diagnosing Deep Research Agents via Rubrics from Expert Report," arXiv.08536, 2026. Its 132 research tasks across 22 domains are graded against expert-derived binary rubrics; measured on a 50-task subset stratified across all themes, one attempt per task, 3 runs, scored on tasks no configuration refused. Claude Opus 4.6 judges under the benchmark's rubric protocol; the original uses a different judge, and an Anthropic judge may favor the house style. The runs predate Claude Opus 5, hence its absence from the [Compare models](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#compare-models-on-cost-per-task) chart. The Sonnet 5 cost differs slightly between the caching chart (inference cost, with and without caching) and that chart (all-in cost, caching on); both come from the same runs. +5. **Agent-architecture scaling:** Kim et al., "Towards a Science of Scaling Agent Systems," arXiv:2512.08296, 2025. Independent external study, cited only for the direction of the finding on when delegation does not pay, not for any figure. +6. **DeepWideSearch:** "DeepWideSearch: Benchmarking Depth and Width in Agentic Information Seeking," arXiv:2510.20168, 2025. The 220 questions span 15 domains, each combining many-row collection with multi-hop retrieval; measured on the benchmark's standing row set, 3 runs per configuration. +7. **DeepResearch Bench II:** Li et al., "DeepResearch Bench II: Diagnosing Deep Research Agents via Rubrics from Expert Report," arXiv:2601.08536, 2026. Its 132 research tasks across 22 domains are graded against expert-derived binary rubrics; measured on a 50-task subset stratified across all themes, one attempt per task, 3 runs, scored on tasks no configuration refused. Claude Opus 4.6 judges under the benchmark's rubric protocol; the original uses a different judge, and an Anthropic judge may favor the house style. The runs predate Claude Opus 5, hence its absence from the [Compare models](https://platform.claude.com/docs/en/about-claude/models/optimizing-for-cost-and-intelligence#compare-models-on-cost-per-task) chart. The Sonnet 5 cost differs slightly between the caching chart (inference cost, with and without caching) and that chart (all-in cost, caching on); both come from the same runs. 8. **Corpus defect sweep:** Anthropic-internal, for work larger than one context window: a 21.6-million-token corpus from 14 public Python package sources with 130 planted defects and deterministic grading; protocol fixed before the runs and internally reviewed; three runs per configuration. Every configuration ran on Claude Managed Agents. The charted team configuration is an August 2026 run in which the Claude Fable 5 coordinator ran the whole sweep inside the platform at its documented limit of 25 concurrent Claude Sonnet 5 workers; its three episodes scored F1 0.842, 0.805, and 0.810 for $263, $299, and $261. The solo configurations are July 2026 runs on the same corpus build. Absolute F1 is specific to this corpus build, not comparable across benchmarks; configuration comparisons are like for like. 9. **GPQA Diamond:** Rein et al., "GPQA: A Graduate-Level Google-Proof Q\&A Benchmark," 2023. The 198-question Diamond subset, measured August 2026, two runs per configuration, model-graded against reference answers, advisor tokens metered per request. A platform safety check refused two biology questions on the Sonnet and Opus executors; excluding them changes no comparison by more than one point. -10. **DeepSWE:** Datacurve, "DeepSWE: Measuring Frontier Coding Agents on Original, Long-Horizon Engineering Tasks," arXiv.07946, 2026. Measured August 2026: 113 original tasks across five languages with program-based verifiers. Pairings are two runs each with advisor tokens metered per request, and used a client-side advisor loop rather than the advisor tool, with identical accounting. Single-model effort sweeps are single runs priced from token counts, a cache-aware approximation. Costs per task are run totals divided by 113. +10. **DeepSWE:** Datacurve, "DeepSWE: Measuring Frontier Coding Agents on Original, Long-Horizon Engineering Tasks," arXiv:2607.07946, 2026. Measured August 2026: 113 original tasks across five languages with program-based verifiers. Pairings are two runs each with advisor tokens metered per request, and used a client-side advisor loop rather than the advisor tool, with identical accounting. Single-model effort sweeps are single runs priced from token counts, a cache-aware approximation. Costs per task are run totals divided by 113. 11. **Internal agentic-coding benchmark:** Anthropic-internal: 370 repository tasks graded by the repositories' own tests. The API figures (Opus 5 alone, Fable 5 alone, and the pairing) were measured August 2026 at the default effort with a 128,000-token output cap, one run per configuration: five attempts per task at the default settings and for the pairing, one at `low` and `medium`; the pairing averaged about two advisor consultations per attempt; costs are per attempt. The Claude Code figures are July 2026 runs of the same tasks, one run per configuration, costs approximate. 12. **Internal repository-task benchmark (cap measurement):** A separate Anthropic-internal set of about 130 repository tasks, run August 2026 with a plain API agent loop, one attempt per task. The 16,384-token figures average two runs per model; the 64,000-token figures are single runs (124 tasks scored for Opus 5; 108 for Claude Fable 5, the environment having skipped the rest before the model ran). About half the Fable attempts the 16,384 cap had ended solved at 64,000; a further Fable run at 128,000 scored 56.1%, within noise of the 64,000 run. The SWE-bench Pro cap figures are one Claude Fable 5 run per cap at the default effort on a 100-problem subset stratified from reference 3's 482-problem set, not comparable to its scores. The chart's per-turn distributions come from the Opus run at 64,000 and the Fable run at 128,000, so neither is cut off by its own cap. 13. **Chartography:** Surge AI, "Chartography," 2026. The complete released 100-question set, measured August 2026 with Anthropic's implementation on Claude Managed Agents (standard cloud sandbox; advisor configurations use the Managed Agents advisor). Claude Sonnet 4.6 grades instead of the reference judge and the benchmark runs with tools, so scores compare across configurations here but not to the published leaderboard. Two runs per configuration, pooled; run-to-run spreads were 4 to 10 points. Costs exclude sandbox time, which added under 1%. The consult-rate comparison comes from rerunning the same configurations on the Messages API with a container tool set. 14. **Support-desk prompt-audit evaluation:** An Anthropic-constructed set of 44 support tickets with deterministic grading, run August 2026 under six system prompts, each adding to the same clean prompt one pattern common in prompts written for Claude Opus 4.8 and Claude Sonnet 4.6. Each chart point is one of three cases (older model, newer model on the same prompt, newer model after the audit) averaged over the six prompts and 44 tickets. The Opus 5 accuracy gain has a 95% confidence interval of 3 to 8 points; the Sonnet accuracy differences are within noise. +15. **Data-file question set:** An Anthropic-constructed set of 25 aggregate questions over a 1,862-row slice of a public liquor-sales CSV, with ground truth computed by pandas and exact-match grading, run August 2026 on Claude Sonnet 5 and Claude Opus 5 with thinking disabled (the in-context arm cannot complete at the default), a 4,000-token output cap, and no prompt caching, three runs per configuration. The file arm uploads the CSV through the Files API and uses the `code_execution_20260120` tool. ## Next steps
about-claude/models/whats-new-opus-5 Changed · +3 / -3 lines
from line 32
### Fast mode -[Fast mode](https://platform.claude.com/docs/en/build-with-claude/fast-mode) (research preview) is available for Claude Opus 5 on the Claude API only; it is not currently available on Amazon Bedrock, Google Cloud, or Microsoft Foundry. Fast mode for Claude Opus 5 is priced at $10 USD per million input tokens and $50 USD per million output tokens. See [Fast mode](https://platform.claude.com/docs/en/build-with-claude/fast-mode) for access, supported models, and pricing. +[Fast mode](https://platform.claude.com/docs/en/build-with-claude/fast-mode) (research preview) is available for Claude Opus 5 on the Claude API only; it is not currently available on Amazon Bedrock, Claude Platform on AWS, Google Cloud, or Microsoft Foundry. Fast mode for Claude Opus 5 is priced at $10 USD per million input tokens and $50 USD per million output tokens. See [Fast mode](https://platform.claude.com/docs/en/build-with-claude/fast-mode) for access, supported models, and pricing. ## Behavior changes
from line 234
### Disabling thinking requires effort `high` or below -On Claude Opus 5, `thinking: {"type": "disabled"}` is accepted only when the effort level is `high` or below. Setting `thinking: {"type": "disabled"}` with effort `xhigh` or `max` returns a 400 error. This is generally available behavior on Claude Opus 5 onward, enforced on each request, and it is a breaking change from Claude Opus 4.8, where disabling thinking was independent of the effort level. If you disable thinking at high effort levels today, either keep thinking disabled and set effort to `high` or below, or keep the effort level and remove the `thinking` field. +On Claude Opus 5, `thinking: {"type": "disabled"}` is accepted only when the effort level is `high` or below. Setting `thinking: {"type": "disabled"}` with effort `xhigh` or `max` returns a 400 error. This rule is enforced on every request to Claude Opus 5 and later models. It is a breaking change from Claude Opus 4.8, where disabling thinking was independent of the effort level. If you disable thinking at high effort levels today, either keep thinking disabled and set effort to `high` or below, or keep the effort level and remove the `thinking` field. With thinking disabled, Claude Opus 5 can occasionally write a tool call into its text output instead of emitting a `tool_use` block, or include internal XML tags in its visible response. Where possible, keep thinking enabled and control token cost with lower effort levels; for integrations that must keep thinking disabled, see [Running with thinking disabled](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/prompting-claude-opus-5#running-with-thinking-disabled) for prompting mitigations.
from line 269
Claude Opus 5 is available on: * **Claude API:** available to all customers, as `claude-opus-5`. -* **AWS:** available through [Claude in Amazon Bedrock](https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon-bedrock), as `anthropic.claude-opus-5`. Claude Opus 5 is also reachable through the `InvokeModel` API on `bedrock-runtime`, served by the same infrastructure; the [Claude on Amazon Bedrock (legacy)](https://platform.claude.com/docs/en/build-with-claude/claude-on-amazon-bedrock-legacy) integration does not include it in its ARN-versioned model ID table. +* **AWS:** available through [Claude in Amazon Bedrock](https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon-bedrock), as `anthropic.claude-opus-5`, and through [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws). On Amazon Bedrock, Claude Opus 5 is also reachable through the `InvokeModel` API on `bedrock-runtime`, served by the same infrastructure; the [Claude on Amazon Bedrock (legacy)](https://platform.claude.com/docs/en/build-with-claude/claude-on-amazon-bedrock-legacy) integration does not include it in its ARN-versioned model ID table. * **Google Cloud:** available through [Claude on Google Cloud](https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai), as `claude-opus-5`. * **Microsoft Foundry:** available through [Claude in Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry).
agents-and-tools/agent-skills/quickstart Changed · +16 / -26 lines
from line 95
``` ```php PHP - // The PHP SDK exposes the Skills API under the beta namespace; field names can differ from other SDKs. // List Anthropic-managed Skills - $skills = $client->beta->skills->list(source: 'anthropic'); + $skills = $client->skills->list(source: 'anthropic'); - foreach ($skills->data as $skill) { - echo "{$skill->id}: {$skill->displayTitle}\n"; + foreach ($skills->getItems() as $skill) { + echo "{$skill->id}: {$skill->displayName}\n"; } ```
from line 300
``` ```php PHP - // The PHP SDK supports container skills only through $client->beta->messages with the skills beta. // Create a message with the PowerPoint Skill - $response = $client->beta->messages->create( + $response = $client->messages->create( model: 'claude-opus-5', maxTokens: 16000, - betas: ['skills-2025-10-02'], container: [ - 'skills' => [['type' => 'anthropic', 'skill_id' => 'pptx', 'version' => 'latest']], + 'skills' => [['type' => 'anthropic', 'skillID' => 'pptx', 'version' => 'latest']], ], messages: [ [
from line 543
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. // Extract the file ID. The code execution tool runs the Skill's code through // its Bash sub-tool, and generated files appear as bash_code_execution_output // items inside the bash_code_execution_tool_result block.
from line 563
if ($fileId !== null) { // Download the file and save it $outputPath = sys_get_temp_dir() . '/renewable_energy.pptx'; - $fileContent = $client->beta->files->download($fileId); + $fileContent = $client->files->download($fileId); file_put_contents($outputPath, $fileContent); echo "Presentation saved to {$outputPath}\n"; }
from line 757
``` ```php PHP - // The PHP SDK supports container skills only through $client->beta->messages with the skills beta. - $response = $client->beta->messages->create( + $response = $client->messages->create( model: 'claude-opus-5', maxTokens: 16000, - betas: ['skills-2025-10-02'], container: [ 'skills' => [ - ['type' => 'anthropic', 'skill_id' => 'xlsx', 'version' => 'latest'], + ['type' => 'anthropic', 'skillID' => 'xlsx', 'version' => 'latest'], ], ], messages: [
from line 771
'content' => 'Create a quarterly sales tracking spreadsheet with sample data', ], ], - tools: [new BetaCodeExecutionTool20260521()], + tools: [['type' => 'code_execution_20260521', 'name' => 'code_execution']], ); ```
from line 950
``` ```php PHP - // The PHP SDK supports container skills only through $client->beta->messages with the skills beta. - $response = $client->beta->messages->create( + $response = $client->messages->create( model: 'claude-opus-5', maxTokens: 16000, - betas: ['skills-2025-10-02'], container: [ 'skills' => [ - ['type' => 'anthropic', 'skill_id' => 'docx', 'version' => 'latest'], + ['type' => 'anthropic', 'skillID' => 'docx', 'version' => 'latest'], ], ], messages: [
from line 964
'content' => 'Write a 2-page report on the benefits of renewable energy', ], ], - tools: [new BetaCodeExecutionTool20260521()], + tools: [['type' => 'code_execution_20260521', 'name' => 'code_execution']], ); ```
from line 1143
``` ```php PHP - // The PHP SDK supports container skills only through $client->beta->messages with the skills beta. - $response = $client->beta->messages->create( + $response = $client->messages->create( model: 'claude-opus-5', maxTokens: 16000, - betas: ['skills-2025-10-02'], container: [ 'skills' => [ - ['type' => 'anthropic', 'skill_id' => 'pdf', 'version' => 'latest'], + ['type' => 'anthropic', 'skillID' => 'pdf', 'version' => 'latest'], ], ], messages: [
from line 1157
'content' => 'Generate a PDF invoice template', ], ], - tools: [new BetaCodeExecutionTool20260521()], + tools: [['type' => 'code_execution_20260521', 'name' => 'code_execution']], ); ```
agents-and-tools/tool-use/browser-use-tool Changed · +2 / -3 lines
from line 17
## Quick start -The browser use tool is generally available on the Claude API with no beta header: add one entry of type `browser_toolset_20260801`, with no `name`, to the `tools` array of a [Messages API](https://platform.claude.com/docs/en/api/messages/create) request. +The browser use tool is available on the Claude API with no beta header: add one entry of type `browser_toolset_20260801`, with no `name`, to the `tools` array of a [Messages API](https://platform.claude.com/docs/en/api/messages/create) request. <CodeGroup> ```bash cURL
from line 976
$failed = false; foreach ($response->content as $block) { // This example declares only the browser toolset; route other tools here if you add them. - // Read toolset_name through array access: the SDK keeps it as raw data until a release types it. - if (!($block instanceof ToolUseBlock) || ($block['toolsetName'] ?? $block['toolset_name'] ?? null) !== 'browser') { + if (!($block instanceof ToolUseBlock) || $block->toolsetName !== 'browser') { continue; } $result = ['type' => 'tool_result', 'tool_use_id' => $block->id, 'toolset_name' => 'browser'];
agents-and-tools/tool-use/code-execution-tool Changed · +12 / -18 lines
from line 42
* `code_execution_20260120` adds REPL state persistence and [programmatic tool calling](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling) from within the sandbox. Claude Haiku 4.5 accepts the `code_execution_20260120` and `code_execution_20260521` tool types, but programmatic tool calling and the REPL state persistence that depends on it aren't available on it, so the newer versions behave like `code_execution_20250825` there. * `code_execution_20260521` is the same runtime as `code_execution_20260120`. The difference is that the tool description tells Claude about the 90-second wall-clock limit on each Python cell in programmatic tool calling, so Claude can budget long-running cells. A cell that exceeds the limit returns a normal code execution result with a non-zero `return_code` and a `detection_timeout` status message in its output. This is separate from the `execution_time_exceeded` [error code](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool#errors), which the API returns when a whole tool invocation exceeds the maximum execution time. -All three tool versions are generally available and don't require an `anthropic-beta` header. The legacy code execution beta headers remain valid opt-ins. +None of the three tool versions requires an `anthropic-beta` header. The legacy code execution beta headers remain valid opt-ins. The examples on this page use `code_execution_20250825`, which covers the Bash and file operations they demonstrate and behaves the same way on every model in the table; use `code_execution_20260120` or later when you need programmatic tool calling or REPL state persistence. The current [web search](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool) and [web fetch](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) tools (`web_search_20260209`, `web_fetch_20260209`, and later) require `code_execution_20260120` or later as their code execution version.
from line 324
```bash CLI # First, upload a file and capture the file ID - FILE_ID=$(ant files upload \ - --file ./data.csv \ - --transform id --raw-output) + FILE_ID=$(ant files upload --file ./data.csv --transform id --raw-output) # Then use the file_id with code execution ant messages create <<YAML
from line 503
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. $client = new Client(); // Upload a file - $fileObject = $client->beta->files->upload( + $fileObject = $client->files->upload( file: FileParam::fromResource(fopen('data.csv', 'r')), ); // Use the file_id with code execution - $response = $client->beta->messages->create( + $response = $client->messages->create( model: Model::CLAUDE_OPUS_5, maxTokens: 4096, - betas: [AnthropicBeta::FILES_API_2025_04_14], messages: [ [ 'role' => 'user', 'content' => [ - BetaTextBlockParam::with(text: 'Analyze this CSV data'), - BetaContainerUploadBlockParam::with(fileID: $fileObject->id), + TextBlockParam::with(text: 'Analyze this CSV data'), + ContainerUploadBlockParam::with(fileID: $fileObject->id), ], ], ], - tools: [new BetaCodeExecutionTool20250825()], + tools: [new CodeExecutionTool20250825()], ); echo json_encode($response), PHP_EOL;
from line 803
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. $client = new Client(); // Request code execution that creates files - $response = $client->beta->messages->create( + $response = $client->messages->create( maxTokens: 4096, messages: [ [
from line 815
], ], model: Model::CLAUDE_OPUS_5, - betas: [AnthropicBeta::FILES_API_2025_04_14], - tools: [new BetaCodeExecutionTool20250825()], + tools: [new CodeExecutionTool20250825()], ); /**
from line 823
* * @return list<string> */ - function extractFileIds(BetaMessage $response): array + function extractFileIds(Message $response): array { $fileIds = []; foreach ($response->content as $block) {
from line 843
// Download the created files foreach (extractFileIds($response) as $fileId) { - $fileMetadata = $client->beta->files->retrieveMetadata($fileId); - $fileContent = $client->beta->files->download($fileId); + $fileMetadata = $client->files->retrieveMetadata($fileId); + $fileContent = $client->files->download($fileId); file_put_contents($fileMetadata->filename, $fileContent); echo "Downloaded: {$fileMetadata->filename}\n";
agents-and-tools/tool-use/computer-use-tool Changed · +2 / -3 lines
from line 18
For tasks that stay inside webpages, the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) is the closer fit: its member tools read and act on the page itself, and it doesn't need a full desktop environment. <Note> - Computer use is generally available on the Claude API as the `computer_toolset_20260801` toolset, with no beta header; see [Compatibility](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#compatibility) for the supported models. + Computer use is available on the Claude API as the `computer_toolset_20260801` toolset, with no beta header; see [Compatibility](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#compatibility) for the supported models. Existing `computer_20251124` integrations keep working, and earlier tool versions remain available in beta for models and platforms that don't support the toolset. See [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124) to upgrade, or [Earlier tool versions](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#earlier-tool-versions) for the beta headers. </Note>
from line 1495
$failed = false; foreach ($response->content as $block) { // This example declares only the computer toolset; route other tools here if you add them. - // Read toolset_name through array access: the SDK keeps it as raw data until a release types it. - if (!($block instanceof ToolUseBlock) || ($block['toolsetName'] ?? $block['toolset_name'] ?? null) !== 'computer') { + if (!($block instanceof ToolUseBlock) || $block->toolsetName !== 'computer') { continue; } $result = ['type' => 'tool_result', 'tool_use_id' => $block->id, 'toolset_name' => 'computer'];
agents-and-tools/tool-use/tool-reference Changed · +14 / -14 lines
from line 10
Anthropic provides two kinds of tools: **server tools** that execute on Anthropic's infrastructure, and **client tools** where Anthropic defines the schema but your application handles execution. Both kinds appear in your request's `tools` array alongside any user-defined tools. -| Tool | `type` | Execution | Status | -| -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------ | -| [Web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool) | `web_search_20260318` `web_search_20260209` `web_search_20250305` | Server | GA | -| [Web fetch tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) | `web_fetch_20260318` `web_fetch_20260309` `web_fetch_20260209` `web_fetch_20250910` | Server | GA | -| [Code execution tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool) | `code_execution_20260521` `code_execution_20260120` `code_execution_20250825` | Server | GA | -| [Advisor tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/advisor-tool) | `advisor_20260301` | Server | Beta: `advisor-tool-2026-03-01` | -| [Tool search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-search-tool) | `tool_search_tool_regex_20251119` `tool_search_tool_bm25_20251119` | Server | GA | -| [MCP connector](https://platform.claude.com/docs/en/agents-and-tools/mcp-connector) | `mcp_toolset` | Server | Beta: `mcp-client-2025-11-20` | -| [Memory tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/memory-tool) | `memory_20250818` | Client | GA | -| [Bash tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/bash-tool) | `bash_20250124` | Client | GA | -| [Text editor tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/text-editor-tool) | `text_editor_20250728` `text_editor_20250124` | Client | GA | -| [Computer use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) | `computer_toolset_20260801` `computer_20251124` `computer_20250124` | Client | GA Beta: `computer-use-2025-11-24` Beta: `computer-use-2025-01-24` | -| [Browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) | `browser_toolset_20260801` | Client | GA | +| Tool | `type` | Execution | [Beta header](https://platform.claude.com/docs/en/api/beta-headers) | +| -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------- | +| [Web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool) | `web_search_20260318` `web_search_20260209` `web_search_20250305` | Server | None | +| [Web fetch tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool) | `web_fetch_20260318` `web_fetch_20260309` `web_fetch_20260209` `web_fetch_20250910` | Server | None | +| [Code execution tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool) | `code_execution_20260521` `code_execution_20260120` `code_execution_20250825` | Server | None | +| [Advisor tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/advisor-tool) | `advisor_20260301` | Server | `advisor-tool-2026-03-01` | +| [Tool search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-search-tool) | `tool_search_tool_regex_20251119` `tool_search_tool_bm25_20251119` | Server | None | +| [MCP connector](https://platform.claude.com/docs/en/agents-and-tools/mcp-connector) | `mcp_toolset` | Server | `mcp-client-2025-11-20` | +| [Memory tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/memory-tool) | `memory_20250818` | Client | None | +| [Bash tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/bash-tool) | `bash_20250124` | Client | None | +| [Text editor tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/text-editor-tool) | `text_editor_20250728` `text_editor_20250124` | Client | None | +| [Computer use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) | `computer_toolset_20260801` `computer_20251124` `computer_20250124` | Client | None `computer-use-2025-11-24` `computer-use-2025-01-24` | +| [Browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) | `browser_toolset_20260801` | Client | None | For model compatibility, see each tool's page. Supported models vary by tool and by tool version.
from line 40
* **Model-keyed:** `text_editor_20250728` is for Claude 4 and later models and `text_editor_20250124` is for earlier models. The version you use depends on the model you target. * **Variant, not version:** `tool_search_tool_regex_20251119` and `tool_search_tool_bm25_20251119` are two search algorithms released together. Neither supersedes the other. * **Legacy:** `code_execution_20250522` supports only Python. `code_execution_20250825` adds Bash and file operations. -* **Successor:** `computer_toolset_20260801` is the generally available successor to the beta `computer_20251124` and `computer_20250124` versions, which remain available for existing integrations and for models that don't support the toolset ([Earlier tool versions](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#earlier-tool-versions)). `browser_toolset_20260801` is the first version of the browser use tool. Both are [client toolsets](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-reference#client-toolsets). +* **Successor:** `computer_toolset_20260801` is the stable successor to the beta `computer_20251124` and `computer_20250124` versions, which remain available for existing integrations and for models that don't support the toolset ([Earlier tool versions](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#earlier-tool-versions)). `browser_toolset_20260801` is the first version of the browser use tool. Both are [client toolsets](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-reference#client-toolsets). The `mcp_toolset` type is not date-versioned; versioning is carried in the `anthropic-beta` header instead.
agents-and-tools/tool-use/tool-search-tool Changed · +5 / -5 lines
from line 11
* **Context bloat:** A typical multiserver setup (GitHub, Slack, Sentry, Grafana, and Splunk) can consume \~55k tokens in definitions before Claude does any work. Tool search typically reduces this by over 85 percent, loading only the 3–5 tools Claude needs for a given request. * **Tool selection accuracy:** Claude's ability to pick the right tool degrades once you exceed 30–50 available tools. Because tool search loads only a focused set of relevant tools on demand, selection accuracy stays high even across thousands of tools. -Tool search is generally available on the Claude API. For supported models, see [Model compatibility](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-search-tool#model-compatibility). +For the models that support tool search, see [Model compatibility](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-search-tool#model-compatibility). <Tip> For background on the scaling challenges that tool search solves, see [Advanced tool use](https://www.anthropic.com/engineering/advanced-tool-use). Tool search's on-demand loading is also an instance of the broader just-in-time retrieval principle described in [Effective context engineering](https://www.anthropic.com/engineering/effective-context-engineering-for-ai-agents).
from line 78
<CodeGroup> ```bash cURL curl https://api.anthropic.com/v1/messages \ - --header "x-api-key: $ANTHROPIC_API_KEY" \ - --header "anthropic-version: 2023-06-01" \ - --header "content-type: application/json" \ - --data '{ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "content-type: application/json" \ + -d '{ "model": "claude-opus-5", "max_tokens": 2048, "messages": [
api/admin Changed · +11 / -11 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 7312
```http curl https://api.anthropic.com/v1/organizations/analytics/summaries \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 7813
```http curl https://api.anthropic.com/v1/organizations/analytics/usage_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 8128
```http curl https://api.anthropic.com/v1/organizations/analytics/user_usage_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 8658
```http curl https://api.anthropic.com/v1/organizations/analytics/cost_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 8970
```http curl https://api.anthropic.com/v1/organizations/analytics/user_cost_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 9124
- `next_page: string or null` - Opaque cursor for the next page, or null when `has_more + Opaque cursor for the next page, or null when `has_more` is false. Pass it as the `page` parameter,
api/admin/analytics Changed · +11 / -11 lines
from line 162
```http curl https://api.anthropic.com/v1/organizations/analytics/summaries \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 663
```http curl https://api.anthropic.com/v1/organizations/analytics/usage_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 978
```http curl https://api.anthropic.com/v1/organizations/analytics/user_usage_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 1508
```http curl https://api.anthropic.com/v1/organizations/analytics/cost_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 1820
```http curl https://api.anthropic.com/v1/organizations/analytics/user_cost_report \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 2501
```http curl https://api.anthropic.com/v1/organizations/analytics/users \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 3136
```http curl https://api.anthropic.com/v1/organizations/analytics/skills \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 3481
```http curl https://api.anthropic.com/v1/organizations/analytics/connectors \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 3776
```http curl https://api.anthropic.com/v1/organizations/analytics/apps/chat/projects \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 4015
```http curl https://api.anthropic.com/v1/organizations/analytics/plugins \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
from line 4208
```http curl https://api.anthropic.com/v1/organizations/analytics/artifacts \ -H 'anthropic-version: 2023-06-01' \ - -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" + -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` #### Response
api/beta Changed · +19823 / -10786 lines
### Beta Managed Agents Bash Tool Config ### Beta Managed Agents Bash Tool Config Params ### Beta Managed Agents Edit Tool Config ### Beta Managed Agents Edit Tool Config Params ### Beta Managed Agents Glob Tool Config ### Beta Managed Agents Glob Tool Config Params ### Beta Managed Agents Grep Tool Config ### Beta Managed Agents Grep Tool Config Params ### Beta Managed Agents Read Tool Config ### Beta Managed Agents Read Tool Config Params ### Beta Managed Agents User Location ### Beta Managed Agents Web Fetch Tool Config ### Beta Managed Agents Web Fetch Tool Config Params ### Beta Managed Agents Web Search Tool Config ### Beta Managed Agents Web Search Tool Config Params ### Beta Managed Agents Write Tool Config ### Beta Managed Agents Write Tool Config Params
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 5363
- `version: string` - Skill version or 'latest' for most recent version + The resolved version: a skill version ID for custom skills. - `content: array of BetaContentBlock`
from line 8702
- `output_format: optional BetaJSONOutputFormat or null` - Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/ + Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.c
api/beta/agents Changed · +4525 / -701 lines
### Beta Managed Agents Bash Tool Config ### Beta Managed Agents Bash Tool Config Params ### Beta Managed Agents Edit Tool Config ### Beta Managed Agents Edit Tool Config Params ### Beta Managed Agents Glob Tool Config ### Beta Managed Agents Glob Tool Config Params ### Beta Managed Agents Grep Tool Config ### Beta Managed Agents Grep Tool Config Params ### Beta Managed Agents Read Tool Config ### Beta Managed Agents Read Tool Config Params ### Beta Managed Agents User Location ### Beta Managed Agents Web Fetch Tool Config ### Beta Managed Agents Web Fetch Tool Config Params ### Beta Managed Agents Web Search Tool Config ### Beta Managed Agents Web Search Tool Config Params ### Beta Managed Agents Write Tool Config ### Beta Managed Agents Write Tool Config Params
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
The two sides of this change are too far apart to line up, so this is the differ's own diff of it.
from line 375
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"` + - `BetaManagedAgentsBashToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the bash tool. + + - `name: "bash"` + + Must be "bash". + + - `"bash"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the edit tool. + + - `name: "edit"` + + Must be "edit". + + - `"edit"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the read tool. + + - `name: "read"` + + Must be "read". + + - `"read"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the write tool. + + - `name: "write"` + + Must be "write". + + - `"write"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the glob tool. + + - `name: "glob"` + + Must be "glob". + + - `"glob"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the grep tool. + + - `name: "grep"` + + Must be "grep". + + - `"grep"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_fetch tool. + + - `name: "web_fetch"` + + Must be "web_fetch". + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `max_content_tokens: optional number or null` + + Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_fetch"` + + - `"web_fetch"` + + - `BetaManagedAgentsWebSearchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_search tool. + + - `name: "web_search"` + + Must be "web_search". + + - `"web_search"` + + - `allowed_domains: optional array of string` + + Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_search"` + + - `"web_search"` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + + - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` + + Default configuration for all tools in a toolset. - `enabled: optional boolean or null` - Whether this tool is enabled and available to Claude. Overrides the default_config setting. + Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 685
Tool calls are automatically approved without user confirmation. - - `type: "always_allow"` - - - `"always_allow"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` Tool calls require user confirmation before execution. - - `type: "always_ask"` - - - `"always_ask"` - - - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` - - Default configuration for all tools in a toolset. + - `BetaManagedAgentsMCPToolsetParams 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 or null` - Whether tools are enabled and available to Claude by default. Defaults to true if not specified. + Whether this tool is enabled. Overrides the `default_config` setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 725
Tool calls require user confirmation before execution. - - `BetaManagedAgentsMCPToolsetParams 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. + - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` + + Default configuration for all tools from an MCP server. - `enabled: optional boolean or null` - Whether this tool is enabled. Overrides the `default_config` setting. + Whether tools are enabled by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 745
Tool calls require user confirmation before execution. - - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` - - Default configuration for all tools from an MCP server. - - - `enabled: optional boolean or null` - - Whether tools are enabled by default. Defaults to true if not specified. - - - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` - - Permission policy for tool execution. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - `BetaManagedAgentsCustomToolParams 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.
from line 1001
- `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. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
from line 1437
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
from line 1790
- `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. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
from line 2217
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
from line 2561
- `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. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
from line 2982
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
from line 3375
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"` + - `BetaManagedAgentsBashToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the bash tool. + + - `name: "bash"` + + Must be "bash". + + - `"bash"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the edit tool. + + - `name: "edit"` + + Must be "edit". + + - `"edit"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the read tool. + + - `name: "read"` + + Must be "read". + + - `"read"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the write tool. + + - `name: "write"` + + Must be "write". + + - `"write"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the glob tool. + + - `name: "glob"` + + Must be "glob". + + - `"glob"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the grep tool. + + - `name: "grep"` + + Must be "grep". + + - `"grep"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_fetch tool. + + - `name: "web_fetch"` + + Must be "web_fetch". + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `max_content_tokens: optional number or null` + + Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_fetch"` + + - `"web_fetch"` + + - `BetaManagedAgentsWebSearchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_search tool. + + - `name: "web_search"` + + Must be "web_search". + + - `"web_search"` + + - `allowed_domains: optional array of string` + + Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_search"` + + - `"web_search"` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + + - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` + + Default configuration for all tools in a toolset. - `enabled: optional boolean or null` - Whether this tool is enabled and available to Claude. Overrides the default_config setting. + Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 3685
Tool calls are automatically approved without user confirmation. - - `type: "always_allow"` - - - `"always_allow"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` Tool calls require user confirmation before execution. - - `type: "always_ask"` - - - `"always_ask"` - - - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` - - Default configuration for all tools in a toolset. + - `BetaManagedAgentsMCPToolsetParams 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 or null` - Whether tools are enabled and available to Claude by default. Defaults to true if not specified. + Whether this tool is enabled. Overrides the `default_config` setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 3725
Tool calls require user confirmation before execution. - - `BetaManagedAgentsMCPToolsetParams 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. + - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` + + Default configuration for all tools from an MCP server. - `enabled: optional boolean or null` - Whether this tool is enabled. Overrides the `default_config` setting. + Whether tools are enabled by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 3745
Tool calls require user confirmation before execution. - - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` - - Default configuration for all tools from an MCP server. - - - `enabled: optional boolean or null` - - Whether tools are enabled by default. Defaults to true if not specified. - - - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` - - Permission policy for tool execution. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - `BetaManagedAgentsCustomToolParams 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.
from line 4005
- `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. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
from line 4432
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
from line 4767
- `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. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
from line 5189
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
from line 5452
- `configs: array of BetaManagedAgentsAgentToolConfig` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + + - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` + + Resolved default configuration for agent tools. + - `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.
from line 5718
Tool calls are automatically approved without user confirmation. - - `type: "always_allow"` - - - `"always_allow"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` Tool calls require user confirmation before execution. - - `type: "always_ask"` - - - `"always_ask"` - - - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` - - Resolved default configuration for agent tools. + - `type: "agent_toolset_20260401"` + + - `"agent_toolset_20260401"` + + - `BetaManagedAgentsMCPToolset 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.
from line 5746
Tool calls require user confirmation before execution. - - `type: "agent_toolset_20260401"` - - - `"agent_toolset_20260401"` - - - `BetaManagedAgentsMCPToolset object { configs, default_config, mcp_server_name, type }` - - - `configs: array of BetaManagedAgentsMCPToolConfig` + - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` + + Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - - `name: string` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution.
from line 5764
Tool calls require user confirmation before execution. - - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` - - Resolved default configuration for all tools from an MCP server. - - - `enabled: boolean` - - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - Permission policy for tool execution. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - `mcp_server_name: string` - `type: "mcp_toolset"`
from line 5822
### Beta Managed Agents Agent Tool Config -- `BetaManagedAgentsAgentToolConfig object { enabled, name, permission_policy }` +- `BetaManagedAgentsAgentToolConfig = BetaManagedAgentsBashToolConfig or BetaManagedAgentsEditToolConfig or BetaManagedAgentsReadToolConfig or 5 more` Configuration for a specific agent tool. + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + +### Beta Managed Agents Agent Tool Config Params + +- `BetaManagedAgentsAgentToolConfigParams = BetaManagedAgentsBashToolConfigParams or BetaManagedAgentsEditToolConfigParams or BetaManagedAgentsReadToolConfigParams or 5 more` + + Configuration override for a specific tool within a toolset. + + - `BetaManagedAgentsBashToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the bash tool. + + - `name: "bash"` + + Must be "bash". + + - `"bash"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the edit tool. + + - `name: "edit"` + + Must be "edit". + + - `"edit"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the read tool. + + - `name: "read"` + + Must be "read". + + - `"read"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the write tool. + + - `name: "write"` + + Must be "write". + + - `"write"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the glob tool. + + - `name: "glob"` + + Must be "glob". + + - `"glob"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the grep tool. + + - `name: "grep"` + + Must be "grep". + + - `"grep"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_fetch tool. + + - `name: "web_fetch"` + + Must be "web_fetch". + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `max_content_tokens: optional number or null` + + Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_fetch"` + + - `"web_fetch"` + + - `BetaManagedAgentsWebSearchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_search tool. + + - `name: "web_search"` + + Must be "web_search". + + - `"web_search"` + + - `allowed_domains: optional array of string` + + Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_search"` + + - `"web_search"` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + +### Beta Managed Agents Agent Toolset Default Config + +- `BetaManagedAgentsAgentToolsetDefaultConfig object { enabled, permission_policy }` + + Resolved default configuration for agent tools. + - `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.
from line 6406
- `"always_ask"` -### Beta Managed Agents Agent Tool Config Params - -- `BetaManagedAgentsAgentToolConfigParams 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"` +### Beta Managed Agents Agent Toolset Default Config Params + +- `BetaManagedAgentsAgentToolsetDefaultConfigParams object { enabled, permission_policy }` + + Default configuration for all tools in a toolset. - `enabled: optional boolean or null` - Whether this tool is enabled and available to Claude. Overrides the default_config setting. + Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 6436
- `"always_ask"` -### Beta Managed Agents Agent Toolset Default Config - -- `BetaManagedAgentsAgentToolsetDefaultConfig object { enabled, permission_policy }` - - Resolved default configuration for agent tools. - - - `enabled: boolean` - - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - Permission policy for tool execution. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` - -### Beta Managed Agents Agent Toolset Default Config Params - -- `BetaManagedAgentsAgentToolsetDefaultConfigParams object { enabled, permission_policy }` - - Default configuration for all tools in a toolset. - - - `enabled: optional boolean or null` - - Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - - - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` - - Permission policy for tool execution. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` - ### Beta Managed Agents Agent Toolset20260401 - `BetaManagedAgentsAgentToolset20260401 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. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
from line 6813
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 or null` - - Whether this tool is enabled and available to Claude. Overrides the default_config setting. - - - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` - - Permission policy for tool execution. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` + - `BetaManagedAgentsBashToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the bash tool. + + - `name: "bash"` + + Must be "bash". + + - `"bash"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the edit tool. + + - `name: "edit"` + + Must be "edit". + + - `"edit"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the read tool. + + - `name: "read"` + + Must be "read". + + - `"read"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the write tool. + + - `name: "write"` + + Must be "write". + + - `"write"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the glob tool. + + - `name: "glob"` + + Must be "glob". + + - `"glob"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the grep tool. + + - `name: "grep"` + + Must be "grep". + + - `"grep"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_fetch tool. + + - `name: "web_fetch"` + + Must be "web_fetch". + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `max_content_tokens: optional number or null` + + Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_fetch"` + + - `"web_fetch"` + + - `BetaManagedAgentsWebSearchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_search tool. + + - `name: "web_search"` + + Must be "web_search". + + - `"web_search"` + + - `allowed_domains: optional array of string` + + Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_search"` + + - `"web_search"` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null`
from line 7212
Version to pin. Defaults to latest if omitted. +### Beta Managed Agents Bash Tool Config + +- `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + +### Beta Managed Agents Bash Tool Config Params + +- `BetaManagedAgentsBashToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the bash tool. + + - `name: "bash"` + + Must be "bash". + + - `"bash"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "bash"` + + - `"bash"` + ### Beta Managed Agents Custom Skill - `BetaManagedAgentsCustomSkill object { skill_id, type, version }`
from line 7390
- `"custom"` +### Beta Managed Agents Edit Tool Config + +- `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "edit"` + + - `"edit"` + +### Beta Managed Agents Edit Tool Config Params + +- `BetaManagedAgentsEditToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the edit tool. + + - `name: "edit"` + + Must be "edit". + + - `"edit"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "edit"` + + - `"edit"` + ### Beta Managed Agents Effort High - `BetaManagedAgentsEffortHigh object { type }`
from line 7516
- `"xhigh"` +### Beta Managed Agents Glob Tool Config + +- `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "glob"` + + - `"glob"` + +### Beta Managed Agents Glob Tool Config Params + +- `BetaManagedAgentsGlobToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the glob tool. + + - `name: "glob"` + + Must be "glob". + + - `"glob"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "glob"` + + - `"glob"` + +### Beta Managed Agents Grep Tool Config + +- `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "grep"` + + - `"grep"` + +### Beta Managed Agents Grep Tool Config Params + +- `BetaManagedAgentsGrepToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the grep tool. + + - `name: "grep"` + + Must be "grep". + + - `"grep"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "grep"` + + - `"grep"` + ### Beta Managed Agents MCP Server URL Definition - `BetaManagedAgentsMCPServerURLDefinition object { name, type, url }`
from line 8362
- `"self"` +### Beta Managed Agents Read Tool Config + +- `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "read"` + + - `"read"` + +### Beta Managed Agents Read Tool Config Params + +- `BetaManagedAgentsReadToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the read tool. + + - `name: "read"` + + Must be "read". + + - `"read"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "read"` + + - `"read"` + ### Beta Managed Agents Session Thread Agent - `BetaManagedAgentsSessionThreadAgent object { id, description, mcp_servers, 7 more }`
from line 8620
- `configs: array of BetaManagedAgentsAgentToolConfig` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + + - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` + + Resolved default configuration for agent tools. + - `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.
from line 8886
Tool calls are automatically approved without user confirmation. - - `type: "always_allow"` - - - `"always_allow"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` Tool calls require user confirmation before execution. - - `type: "always_ask"` - - - `"always_ask"` - - - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` - - Resolved default configuration for agent tools. + - `type: "agent_toolset_20260401"` + + - `"agent_toolset_20260401"` + + - `BetaManagedAgentsMCPToolset 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.
from line 8914
Tool calls require user confirmation before execution. - - `type: "agent_toolset_20260401"` - - - `"agent_toolset_20260401"` - - - `BetaManagedAgentsMCPToolset object { configs, default_config, mcp_server_name, type }` - - - `configs: array of BetaManagedAgentsMCPToolConfig` + - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` + + Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - - `name: string` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution.
from line 8932
Tool calls require user confirmation before execution. - - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` - - Resolved default configuration for all tools from an MCP server. - - - `enabled: boolean` - - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - Permission policy for tool execution. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - `mcp_server_name: string` - `type: "mcp_toolset"`
from line 9024
Endpoint URL for the MCP server. +### Beta Managed Agents User Location + +- `BetaManagedAgentsUserLocation object { type, city, country, 2 more }` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + +### Beta Managed Agents Web Fetch Tool Config + +- `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + +### Beta Managed Agents Web Fetch Tool Config Params + +- `BetaManagedAgentsWebFetchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_fetch tool. + + - `name: "web_fetch"` + + Must be "web_fetch". + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `max_content_tokens: optional number or null` + + Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "web_fetch"` + + - `"web_fetch"` + +### Beta Managed Agents Web Search Tool Config + +- `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + +### Beta Managed Agents Web Search Tool Config Params + +- `BetaManagedAgentsWebSearchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_search tool. + + - `name: "web_search"` + + Must be "web_search". + + - `"web_search"` + + - `allowed_domains: optional array of string` + + Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "web_search"` + + - `"web_search"` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + +### Beta Managed Agents Write Tool Config + +- `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "write"` + + - `"write"` + +### Beta Managed Agents Write Tool Config Params + +- `BetaManagedAgentsWriteToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the write tool. + + - `name: "write"` + + Must be "write". + + - `"write"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "write"` + + - `"write"` + # Versions ## List Agent Versions
from line 9690
- `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. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
from line 10117
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/beta/agents/archive Changed · +253 / -42 lines
from line 319
- `configs: array of BetaManagedAgentsAgentToolConfig` - - `enabled: boolean` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` - - `name: "bash" or "edit" or "read" or 5 more` + Configuration for the bash tool. - Built-in agent tool identifier. + - `enabled: boolean` - - `"bash"` + - `name: "bash"` - - `"edit"` + - `"bash"` - - `"read"` + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - `"write"` + Permission policy for tool execution. - - `"glob"` + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - `"grep"` + Tool calls are automatically approved without user confirmation. - - `"web_fetch"` + - `type: "always_allow"` - - `"web_search"` + - `"always_allow"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Permission policy for tool execution. + Tool calls require user confirmation before execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `type: "always_ask"` - Tool calls are automatically approved without user confirmation. + - `"always_ask"` - - `type: "always_allow"` + - `type: "bash"` - - `"always_allow"` + - `"bash"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Tool calls require user confirmation before execution. + Configuration for the edit tool. - - `type: "always_ask"` + - `enabled: boolean` - - `"always_ask"` + - `name: "edit"` + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools.
from line 741
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/beta/agents/create Changed · +575 / -114 lines
The two sides of this change are too far apart to line up, so this is the differ's own diff of it.
from line 373
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"` + - `BetaManagedAgentsBashToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the bash tool. + + - `name: "bash"` + + Must be "bash". + + - `"bash"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the edit tool. + + - `name: "edit"` + + Must be "edit". + + - `"edit"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the read tool. + + - `name: "read"` + + Must be "read". + + - `"read"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the write tool. + + - `name: "write"` + + Must be "write". + + - `"write"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the glob tool. + + - `name: "glob"` + + Must be "glob". + + - `"glob"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the grep tool. + + - `name: "grep"` + + Must be "grep". + + - `"grep"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_fetch tool. + + - `name: "web_fetch"` + + Must be "web_fetch". + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `max_content_tokens: optional number or null` + + Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_fetch"` + + - `"web_fetch"` + + - `BetaManagedAgentsWebSearchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_search tool. + + - `name: "web_search"` + + Must be "web_search". + + - `"web_search"` + + - `allowed_domains: optional array of string` + + Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_search"` + + - `"web_search"` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + + - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` + + Default configuration for all tools in a toolset. - `enabled: optional boolean or null` - Whether this tool is enabled and available to Claude. Overrides the default_config setting. + Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 683
Tool calls are automatically approved without user confirmation. - - `type: "always_allow"` - - - `"always_allow"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` Tool calls require user confirmation before execution. - - `type: "always_ask"` - - - `"always_ask"` - - - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` - - Default configuration for all tools in a toolset. + - `BetaManagedAgentsMCPToolsetParams 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 or null` - Whether tools are enabled and available to Claude by default. Defaults to true if not specified. + Whether this tool is enabled. Overrides the `default_config` setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 723
Tool calls require user confirmation before execution. - - `BetaManagedAgentsMCPToolsetParams 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. + - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` + + Default configuration for all tools from an MCP server. - `enabled: optional boolean or null` - Whether this tool is enabled. Overrides the `default_config` setting. + Whether tools are enabled by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 743
Tool calls require user confirmation before execution. - - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` - - Default configuration for all tools from an MCP server. - - - `enabled: optional boolean or null` - - Whether tools are enabled by default. Defaults to true if not specified. - - - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` - - Permission policy for tool execution. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - `BetaManagedAgentsCustomToolParams 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.
from line 999
- `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. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
from line 1435
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/beta/agents/list Changed · +253 / -42 lines
from line 337
- `configs: array of BetaManagedAgentsAgentToolConfig` - - `enabled: boolean` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` - - `name: "bash" or "edit" or "read" or 5 more` + Configuration for the bash tool. - Built-in agent tool identifier. + - `enabled: boolean` - - `"bash"` + - `name: "bash"` - - `"edit"` + - `"bash"` - - `"read"` + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - `"write"` + Permission policy for tool execution. - - `"glob"` + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - `"grep"` + Tool calls are automatically approved without user confirmation. - - `"web_fetch"` + - `type: "always_allow"` - - `"web_search"` + - `"always_allow"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Permission policy for tool execution. + Tool calls require user confirmation before execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `type: "always_ask"` - Tool calls are automatically approved without user confirmation. + - `"always_ask"` - - `type: "always_allow"` + - `type: "bash"` - - `"always_allow"` + - `"bash"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Tool calls require user confirmation before execution. + Configuration for the edit tool. - - `type: "always_ask"` + - `enabled: boolean` - - `"always_ask"` + - `name: "edit"` + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools.
from line 764
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/beta/agents/retrieve Changed · +253 / -42 lines
from line 325
- `configs: array of BetaManagedAgentsAgentToolConfig` - - `enabled: boolean` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` - - `name: "bash" or "edit" or "read" or 5 more` + Configuration for the bash tool. - Built-in agent tool identifier. + - `enabled: boolean` - - `"bash"` + - `name: "bash"` - - `"edit"` + - `"bash"` - - `"read"` + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - `"write"` + Permission policy for tool execution. - - `"glob"` + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - `"grep"` + Tool calls are automatically approved without user confirmation. - - `"web_fetch"` + - `type: "always_allow"` - - `"web_search"` + - `"always_allow"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Permission policy for tool execution. + Tool calls require user confirmation before execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `type: "always_ask"` - Tool calls are automatically approved without user confirmation. + - `"always_ask"` - - `type: "always_allow"` + - `type: "bash"` - - `"always_allow"` + - `"bash"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Tool calls require user confirmation before execution. + Configuration for the edit tool. - - `type: "always_ask"` + - `enabled: boolean` - - `"always_ask"` + - `name: "edit"` + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools.
from line 746
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/beta/agents/update Changed · +575 / -114 lines
The two sides of this change are too far apart to line up, so this is the differ's own diff of it.
from line 377
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"` + - `BetaManagedAgentsBashToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the bash tool. + + - `name: "bash"` + + Must be "bash". + + - `"bash"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the edit tool. + + - `name: "edit"` + + Must be "edit". + + - `"edit"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the read tool. + + - `name: "read"` + + Must be "read". + + - `"read"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the write tool. + + - `name: "write"` + + Must be "write". + + - `"write"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the glob tool. + + - `name: "glob"` + + Must be "glob". + + - `"glob"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the grep tool. + + - `name: "grep"` + + Must be "grep". + + - `"grep"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_fetch tool. + + - `name: "web_fetch"` + + Must be "web_fetch". + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `max_content_tokens: optional number or null` + + Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_fetch"` + + - `"web_fetch"` + + - `BetaManagedAgentsWebSearchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_search tool. + + - `name: "web_search"` + + Must be "web_search". + + - `"web_search"` + + - `allowed_domains: optional array of string` + + Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_search"` + + - `"web_search"` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + + - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` + + Default configuration for all tools in a toolset. - `enabled: optional boolean or null` - Whether this tool is enabled and available to Claude. Overrides the default_config setting. + Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 687
Tool calls are automatically approved without user confirmation. - - `type: "always_allow"` - - - `"always_allow"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` Tool calls require user confirmation before execution. - - `type: "always_ask"` - - - `"always_ask"` - - - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` - - Default configuration for all tools in a toolset. + - `BetaManagedAgentsMCPToolsetParams 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 or null` - Whether tools are enabled and available to Claude by default. Defaults to true if not specified. + Whether this tool is enabled. Overrides the `default_config` setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 727
Tool calls require user confirmation before execution. - - `BetaManagedAgentsMCPToolsetParams 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. + - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` + + Default configuration for all tools from an MCP server. - `enabled: optional boolean or null` - Whether this tool is enabled. Overrides the `default_config` setting. + Whether tools are enabled by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 747
Tool calls require user confirmation before execution. - - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` - - Default configuration for all tools from an MCP server. - - - `enabled: optional boolean or null` - - Whether tools are enabled by default. Defaults to true if not specified. - - - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` - - Permission policy for tool execution. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - `BetaManagedAgentsCustomToolParams 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.
from line 1007
- `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. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
from line 1434
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/beta/agents/versions Changed · +253 / -42 lines
from line 331
- `configs: array of BetaManagedAgentsAgentToolConfig` - - `enabled: boolean` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` - - `name: "bash" or "edit" or "read" or 5 more` + Configuration for the bash tool. - Built-in agent tool identifier. + - `enabled: boolean` - - `"bash"` + - `name: "bash"` - - `"edit"` + - `"bash"` - - `"read"` + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - `"write"` + Permission policy for tool execution. - - `"glob"` + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - `"grep"` + Tool calls are automatically approved without user confirmation. - - `"web_fetch"` + - `type: "always_allow"` - - `"web_search"` + - `"always_allow"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Permission policy for tool execution. + Tool calls require user confirmation before execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `type: "always_ask"` - Tool calls are automatically approved without user confirmation. + - `"always_ask"` - - `type: "always_allow"` + - `type: "bash"` - - `"always_allow"` + - `"bash"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Tool calls require user confirmation before execution. + Configuration for the edit tool. - - `type: "always_ask"` + - `enabled: boolean` - - `"always_ask"` + - `name: "edit"` + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools.
from line 758
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/beta/agents/versions/list Changed · +253 / -42 lines
from line 329
- `configs: array of BetaManagedAgentsAgentToolConfig` - - `enabled: boolean` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` - - `name: "bash" or "edit" or "read" or 5 more` + Configuration for the bash tool. - Built-in agent tool identifier. + - `enabled: boolean` - - `"bash"` + - `name: "bash"` - - `"edit"` + - `"bash"` - - `"read"` + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - `"write"` + Permission policy for tool execution. - - `"glob"` + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - `"grep"` + Tool calls are automatically approved without user confirmation. - - `"web_fetch"` + - `type: "always_allow"` - - `"web_search"` + - `"always_allow"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Permission policy for tool execution. + Tool calls require user confirmation before execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `type: "always_ask"` - Tool calls are automatically approved without user confirmation. + - `"always_ask"` - - `type: "always_allow"` + - `type: "bash"` - - `"always_allow"` + - `"bash"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Tool calls require user confirmation before execution. + Configuration for the edit tool. - - `type: "always_ask"` + - `enabled: boolean` - - `"always_ask"` + - `name: "edit"` + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools.
from line 756
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/beta/messages Changed · +11 / -11 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 4000
- `version: string` - Skill version or 'latest' for most recent version + The resolved version: a skill version ID for custom skills. - `content: array of BetaContentBlock`
from line 8171
- `enabled: optional boolean or null` - Whether this member is offered to the model. Default is per member, per the toolset's documentation. + Whether this member is offered to the model. Default is per member, per the toolset's docu
api/beta/messages/batches Changed · +4 / -4 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 5071
- `version: string` - Skill version or 'latest' for most recent version + The resolved version: a skill version ID for custom skills. - `content: array of BetaContentBlock`
from line 6962
- `version: string` - Skill version or 'latest' for most recent version + The resolved version: a skill version ID for custom skills. - `content: array of BetaContentBlock`
from line 8014
This will always be `"assistant"`. - - `"assistant" +
api/beta/sessions Changed · +15287 / -10074 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
api/beta/sessions/archive Changed · +255 / -43 lines
from line 307
- `configs: array of BetaManagedAgentsAgentToolConfig` - - `enabled: boolean` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` - - `name: "bash" or "edit" or "read" or 5 more` + Configuration for the bash tool. - Built-in agent tool identifier. + - `enabled: boolean` - - `"bash"` + - `name: "bash"` - - `"edit"` + - `"bash"` - - `"read"` + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - `"write"` + Permission policy for tool execution. - - `"glob"` + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - `"grep"` + Tool calls are automatically approved without user confirmation. - - `"web_fetch"` + - `type: "always_allow"` - - `"web_search"` + - `"always_allow"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Permission policy for tool execution. + Tool calls require user confirmation before execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `type: "always_ask"` - Tool calls are automatically approved without user confirmation. + - `"always_ask"` - - `type: "always_allow"` + - `type: "bash"` - - `"always_allow"` + - `"bash"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Tool calls require user confirmation before execution. + Configuration for the edit tool. - - `type: "always_ask"` + - `enabled: boolean` - - `"always_ask"` + - `name: "edit"` + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools.
from line 1027
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
from line 1068
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/beta/sessions/create Changed · +1140 / -678 lines
The two sides of this change are too far apart to line up, so this is the differ's own diff of it.
from line 345
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"` + - `BetaManagedAgentsBashToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the bash tool. + + - `name: "bash"` + + Must be "bash". + + - `"bash"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the edit tool. + + - `name: "edit"` + + Must be "edit". + + - `"edit"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the read tool. + + - `name: "read"` + + Must be "read". + + - `"read"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the write tool. + + - `name: "write"` + + Must be "write". + + - `"write"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the glob tool. + + - `name: "glob"` + + Must be "glob". + + - `"glob"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the grep tool. + + - `name: "grep"` + + Must be "grep". + + - `"grep"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_fetch tool. + + - `name: "web_fetch"` + + Must be "web_fetch". + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `max_content_tokens: optional number or null` + + Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_fetch"` + + - `"web_fetch"` + + - `BetaManagedAgentsWebSearchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_search tool. + + - `name: "web_search"` + + Must be "web_search". + + - `"web_search"` + + - `allowed_domains: optional array of string` + + Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_search"` + + - `"web_search"` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + + - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` + + Default configuration for all tools in a toolset. - `enabled: optional boolean or null` - Whether this tool is enabled and available to Claude. Overrides the default_config setting. + Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 655
Tool calls are automatically approved without user confirmation. - - `type: "always_allow"` - - - `"always_allow"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` Tool calls require user confirmation before execution. - - `type: "always_ask"` - - - `"always_ask"` - - - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` - - Default configuration for all tools in a toolset. + - `BetaManagedAgentsMCPToolsetParams 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 or null` - Whether tools are enabled and available to Claude by default. Defaults to true if not specified. + Whether this tool is enabled. Overrides the `default_config` setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 695
Tool calls require user confirmation before execution. - - `BetaManagedAgentsMCPToolsetParams 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. + - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` + + Default configuration for all tools from an MCP server. + + - `enabled: optional boolean or null` + + Whether tools are enabled by default. Defaults to true if not specified. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `BetaManagedAgentsCustomToolParams 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. + + - `input_schema: BetaManagedAgentsCustomToolInputSchema` + + JSON Schema for custom tool input parameters. + + - `type: "object"` + + - `"object"` + + - `properties: optional map[unknown] or null` + + - `required: optional array of string or null` + + - `name: string` + + Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens. + + - `type: "custom"` + + - `"custom"` + + - `version: optional number` + + The specific `agent` version to use. Omit to use the latest version. + +- `environment_id: string` + + ID of the `environment` defining the container configuration for this session. + +- `budget: optional BetaManagedAgentsBudgetLimit` + + A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`. + + - `max_list_cost: BetaMonetaryAmount` + + A monetary amount in a specific currency. + + - `amount: string` + + Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. + + - `currency: BetaCurrency` + + Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. + + - `"USD"` + + - `type: "limit"` + + - `"limit"` + +- `initial_events: optional array of BetaManagedAgentsUserMessageEventParams or BetaManagedAgentsUserDefineOutcomeEventParams` + + Initial events to send to the `session` at creation, processed in order. Supports `user.message` and `user.define_outcome` events. Maximum 50 events. + + - `BetaManagedAgentsUserMessageEventParams object { content, type }` + + Parameters for sending a user message to the session. + + - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` + + Array of content blocks for the user message. + + - `BetaManagedAgentsTextBlock object { text, type }` + + Regular text content. + + - `text: string` + + The text content. + + - `type: "text"` + + - `"text"` + + - `BetaManagedAgentsImageBlock 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. + + - `BetaManagedAgentsBase64ImageSource 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"` + + - `BetaManagedAgentsURLImageSource object { type, url }` + + Image referenced by URL. + + - `type: "url"` + + - `"url"` + + - `url: string` + + URL of the image to fetch. + + - `BetaManagedAgentsFileImageSource object { file_id, type }` + + Image referenced by file ID. + + - `file_id: string` + + ID of a previously uploaded file. + + - `type: "file"` + + - `"file"` + + - `type: "image"` + + - `"image"` + + - `BetaManagedAgentsDocumentBlock 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. + + - `BetaManagedAgentsBase64DocumentSource 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"` + + - `BetaManagedAgentsPlainTextDocumentSource 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"` + + - `BetaManagedAgentsURLDocumentSource object { type, url }` + + Document referenced by URL. + + - `type: "url"` + + - `"url"` + + - `url: string` + + URL of the document to fetch. + + - `BetaManagedAgentsFileDocumentSource 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 or null` + + Additional context about the document for the model. + + - `title: optional string or null` + + The title of the document. + + - `BetaManagedAgentsRedactedBlock object { type }` + + Placeholder for content withheld by Anthropic model policy. + + - `type: "redacted"` + + - `"redacted"` + + - `type: "user.message"` + + - `"user.message"` + + - `BetaManagedAgentsUserDefineOutcomeEventParams 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. + + - `BetaManagedAgentsFileRubricParams 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"` + + - `BetaManagedAgentsTextRubricParams 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 or null` + + Eval→revision cycles before giving up. Default 3, max 20. + +- `metadata: optional map[string]` + + Arbitrary key-value metadata attached to the session. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. + +- `resources: optional array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam` + + Resources (e.g. repositories, files) to mount into the session's container. + + - `BetaManagedAgentsGitHubRepositoryResourceParams object { 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 or null` + + Branch or commit to check out. Defaults to the repository's default branch. + + - `BetaManagedAgentsBranchCheckout object { name, type }` + + - `name: string` + + Branch name to check out. + + - `type: "branch"` + + - `"branch"` + + - `BetaManagedAgentsCommitCheckout object { sha, type }` + + - `sha: string` + + Full commit SHA to check out. + + - `type: "commit"` + + - `"commit"` + + - `mount_path: optional string or null` + + Mount path in the container. Defaults to `/workspace/<repo-name>`. + + - `BetaManagedAgentsFileResourceParams 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 or null` + + Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. + + - `BetaManagedAgentsMemoryStoreResourceParam 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" or null` + + Access mode for an attached memory store. + + - `"read_write"` + + - `"read_only"` + + - `instructions: optional string or null` + + Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. + +- `title: optional string or null` + + Human-readable session title. + +- `vault_ids: optional array of string` + + Vault IDs for stored credentials the agent can use during the session. + +### Returns + +- `BetaManagedAgentsSession object { id, agent, archived_at, 14 more }` + + A Managed Agents `session`. + + - `id: string` + + - `agent: BetaManagedAgentsSessionAgent` + + Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. + + - `id: string` + + - `description: string or null` + + - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` + + - `name: string` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `model: BetaManagedAgentsModelConfig` + + Model identifier and configuration. + + - `id: BetaManagedAgentsModel` + + The model that will power your agent. + + See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. + + - `"claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more` + + The model that will power your agent. + + See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. + + - `"claude-sonnet-5"` + + High-performance model for coding and agents + + - `"claude-fable-5"` + + Next generation of intelligence for the hardest knowledge work and coding problems + + - `"claude-opus-5"` + + Powerful intelligence for long-running agents and coding + + - `"claude-opus-4-8"` + + Powerful intelligence for long-running agents and coding + + - `"claude-opus-4-7"` + + Powerful intelligence for long-running agents and coding + + - `"claude-opus-4-6"` + + Powerful intelligence for long-running agents and coding + + - `"claude-sonnet-4-6"` + + Best combination of speed and intelligence + + - `"claude-haiku-4-5"` + + Fastest model with near-frontier intelligence + + - `"claude-haiku-4-5-20251001"` + + Fastest model with near-frontier intelligence + + - `"claude-opus-4-5"` + + Powerful intelligence for long-running agents and coding + + - `"claude-opus-4-5-20251101"` + + Powerful intelligence for long-running agents and coding + + - `"claude-sonnet-4-5"` + + High-performance model for agents and coding + + - `"claude-sonnet-4-5-20250929"` + + High-performance model for agents and coding + + - `string` + + - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` + + How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes. + + - `BetaManagedAgentsEffortLow object { type }` + + Low effort. Favors latency over reasoning depth. + + - `type: "low"` + + - `"low"` + + - `BetaManagedAgentsEffortMedium object { type }` + + Medium effort. Balances latency and reasoning depth. + + - `type: "medium"` + + - `"medium"` + + - `BetaManagedAgentsEffortHigh object { type }` + + High effort. Favors reasoning depth. + + - `type: "high"` + + - `"high"` + + - `BetaManagedAgentsEffortXhigh object { type }` + + Extra-high effort. Not all models accept this level. + + - `type: "xhigh"` + + - `"xhigh"` + + - `BetaManagedAgentsEffortMax object { type }` + + Maximum effort. Favors reasoning depth over latency. + + - `type: "max"` + + - `"max"` + + - `inference_geo: optional string` + + Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. + + - `speed: optional "standard" or "fast"` + + Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. + + - `"standard"` + + - `"fast"` + + - `multiagent: BetaManagedAgentsSessionMultiagentCoordinator or null` + + Resolved coordinator topology with full agent definitions for each roster member. + + - `agents: array of BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` + + Full `agent` definitions the coordinator may spawn as session threads. + + - `BetaManagedAgentsSessionThreadAgent 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 or null` + + - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` + + - `name: string` + + - `type: "url"` + + - `url: string` + + - `model: BetaManagedAgentsModelConfig` + + Model identifier and configuration. - `name: string` - Name of the MCP tool to configure. 1-128 characters. - - - `enabled: optional boolean or null` - - Whether this tool is enabled. Overrides the `default_config` setting. - - - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` - - Permission policy for tool execution. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` - - Default configuration for all tools from an MCP server. - - - `enabled: optional boolean or null` - - Whether tools are enabled by default. Defaults to true if not specified. - - - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` - - Permission policy for tool execution. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `BetaManagedAgentsCustomToolParams 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. - - - `input_schema: BetaManagedAgentsCustomToolInputSchema` - - JSON Schema for custom tool input parameters. - - - `type: "object"` - - - `"object"` - - - `properties: optional map[unknown] or null` - - - `required: optional array of string or null` - - - `name: string` - - Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens. - - - `type: "custom"` - - - `"custom"` - - - `version: optional number` - - The specific `agent` version to use. Omit to use the latest version. - -- `environment_id: string` - - ID of the `environment` defining the container configuration for this session. - -- `budget: optional BetaManagedAgentsBudgetLimit` - - A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`. - - - `max_list_cost: BetaMonetaryAmount` - - A monetary amount in a specific currency. - - - `amount: string` - - Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied. - - - `currency: BetaCurrency` - - Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced. - - - `"USD"` - - - `type: "limit"` - - - `"limit"` - -- `initial_events: optional array of BetaManagedAgentsUserMessageEventParams or BetaManagedAgentsUserDefineOutcomeEventParams` - - Initial events to send to the `session` at creation, processed in order. Supports `user.message` and `user.define_outcome` events. Maximum 50 events. - - - `BetaManagedAgentsUserMessageEventParams object { content, type }` - - Parameters for sending a user message to the session. - - - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock` - - Array of content blocks for the user message. - - - `BetaManagedAgentsTextBlock object { text, type }` - - Regular text content. - - - `text: string` - - The text content. - - - `type: "text"` - - - `"text"` - - - `BetaManagedAgentsImageBlock 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. - - - `BetaManagedAgentsBase64ImageSource 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"` - - - `BetaManagedAgentsURLImageSource object { type, url }` - - Image referenced by URL. - - - `type: "url"` - - - `"url"` - - - `url: string` - - URL of the image to fetch. - - - `BetaManagedAgentsFileImageSource object { file_id, type }` - - Image referenced by file ID. - - - `file_id: string` - - ID of a previously uploaded file. - - - `type: "file"` - - - `"file"` - - - `type: "image"` - - - `"image"` - - - `BetaManagedAgentsDocumentBlock 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. - - - `BetaManagedAgentsBase64DocumentSource 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"` - - - `BetaManagedAgentsPlainTextDocumentSource 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"` - - - `BetaManagedAgentsURLDocumentSource object { type, url }` - - Document referenced by URL. - - - `type: "url"` - - - `"url"` - - - `url: string` - - URL of the document to fetch. - - - `BetaManagedAgentsFileDocumentSource 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 or null` - - Additional context about the document for the model. - - - `title: optional string or null` - - The title of the document. - - - `BetaManagedAgentsRedactedBlock object { type }` - - Placeholder for content withheld by Anthropic model policy. - - - `type: "redacted"` - - - `"redacted"` - - - `type: "user.message"` - - - `"user.message"` - - - `BetaManagedAgentsUserDefineOutcomeEventParams 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. - - - `BetaManagedAgentsFileRubricParams 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"` - - - `BetaManagedAgentsTextRubricParams 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 or null` - - Eval→revision cycles before giving up. Default 3, max 20. - -- `metadata: optional map[string]` - - Arbitrary key-value metadata attached to the session. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - -- `resources: optional array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam` - - Resources (e.g. repositories, files) to mount into the session's container. - - - `BetaManagedAgentsGitHubRepositoryResourceParams object { 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 or null` - - Branch or commit to check out. Defaults to the repository's default branch. - - - `BetaManagedAgentsBranchCheckout object { name, type }` - - - `name: string` - - Branch name to check out. - - - `type: "branch"` - - - `"branch"` - - - `BetaManagedAgentsCommitCheckout object { sha, type }` - - - `sha: string` - - Full commit SHA to check out. - - - `type: "commit"` - - - `"commit"` - - - `mount_path: optional string or null` - - Mount path in the container. Defaults to `/workspace/<repo-name>`. - - - `BetaManagedAgentsFileResourceParams 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 or null` - - Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. - - - `BetaManagedAgentsMemoryStoreResourceParam 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" or null` - - Access mode for an attached memory store. - - - `"read_write"` - - - `"read_only"` - - - `instructions: optional string or null` - - Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - -- `title: optional string or null` - - Human-readable session title. - -- `vault_ids: optional array of string` - - Vault IDs for stored credentials the agent can use during the session. - -### Returns - -- `BetaManagedAgentsSession object { id, agent, archived_at, 14 more }` - - A Managed Agents `session`. - - - `id: string` - - - `agent: BetaManagedAgentsSessionAgent` - - Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. - - - `id: string` - - - `description: string or null` - - - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - - - `name: string` - - - `type: "url"` - - - `"url"` - - - `url: string` - - - `model: BetaManagedAgentsModelConfig` - - Model identifier and configuration. - - - `id: BetaManagedAgentsModel` - - The model that will power your agent. - - See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - - - `"claude-sonnet-5" or "claude-fable-5" or "claude-opus-5" or 10 more` - - The model that will power your agent. - - See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - - - `"claude-sonnet-5"` - - High-performance model for coding and agents - - - `"claude-fable-5"` - - Next generation of intelligence for the hardest knowledge work and coding problems - - - `"claude-opus-5"` - - Powerful intelligence for long-running agents and coding - - - `"claude-opus-4-8"` - - Powerful intelligence for long-running agents and coding - - - `"claude-opus-4-7"` - - Powerful intelligence for long-running agents and coding - - - `"claude-opus-4-6"` - - Powerful intelligence for long-running agents and coding - - - `"claude-sonnet-4-6"` - - Best combination of speed and intelligence - - - `"claude-haiku-4-5"` - - Fastest model with near-frontier intelligence - - - `"claude-haiku-4-5-20251001"` - - Fastest model with near-frontier intelligence - - - `"claude-opus-4-5"` - - Powerful intelligence for long-running agents and coding - - - `"claude-opus-4-5-20251101"` - - Powerful intelligence for long-running agents and coding - - - `"claude-sonnet-4-5"` - - High-performance model for agents and coding - - - `"claude-sonnet-4-5-20250929"` - - High-performance model for agents and coding - - - `string` - - - `effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more` - - How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes. - - - `BetaManagedAgentsEffortLow object { type }` - - Low effort. Favors latency over reasoning depth. - - - `type: "low"` - - - `"low"` - - - `BetaManagedAgentsEffortMedium object { type }` - - Medium effort. Balances latency and reasoning depth. - - - `type: "medium"` - - - `"medium"` - - - `BetaManagedAgentsEffortHigh object { type }` - - High effort. Favors reasoning depth. - - - `type: "high"` - - - `"high"` - - - `BetaManagedAgentsEffortXhigh object { type }` - - Extra-high effort. Not all models accept this level. - - - `type: "xhigh"` - - - `"xhigh"` - - - `BetaManagedAgentsEffortMax object { type }` - - Maximum effort. Favors reasoning depth over latency. - - - `type: "max"` - - - `"max"` - - - `inference_geo: optional string` - - Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - - - `speed: optional "standard" or "fast"` - - Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - - - `"standard"` - - - `"fast"` - - - `multiagent: BetaManagedAgentsSessionMultiagentCoordinator or null` - - Resolved coordinator topology with full agent definitions for each roster member. - - - `agents: array of BetaManagedAgentsSessionThreadAgent or BetaManagedAgentsAdvisor` - - Full `agent` definitions the coordinator may spawn as session threads. - - - `BetaManagedAgentsSessionThreadAgent 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 or null` - - - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition` - - - `name: string` - - - `type: "url"` - - - `url: string` - - - `model: BetaManagedAgentsModelConfig` - - Model identifier and configuration. - - - `name: string` - - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - `BetaManagedAgentsAnthropicSkill object { skill_id, type, version }`
from line 1299
- `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. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
from line 2024
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
from line 2065
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/beta/sessions/events Changed · +4805 / -3965 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
api/beta/sessions/events/list Changed · +251 / -41 lines
from line 1801
- `configs: array of BetaManagedAgentsAgentToolConfig` - - `enabled: boolean` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` - - `name: "bash" or "edit" or "read" or 5 more` + Configuration for the bash tool. - Built-in agent tool identifier. + - `enabled: boolean` - - `"bash"` + - `name: "bash"` - - `"edit"` + - `"bash"` - - `"read"` + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - `"write"` + Permission policy for tool execution. - - `"glob"` + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - `"grep"` + Tool calls are automatically approved without user confirmation. - - `"web_fetch"` + - `type: "always_allow"` - - `"web_search"` + - `"always_allow"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Permission policy for tool execution. + Tool calls require user confirmation before execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `type: "always_ask"` - Tool calls are automatically approved without user confirmation. + - `"always_ask"` - - `type: "always_allow"` + - `type: "bash"` - - `"always_allow"` + - `"bash"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Tool calls require user confirmation before execution. + Configuration for the edit tool. - - `type: "always_ask"` + - `enabled: boolean` - - `"always_ask"` + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
api/beta/sessions/events/stream Changed · +251 / -41 lines
from line 1773
- `configs: array of BetaManagedAgentsAgentToolConfig` - - `enabled: boolean` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` - - `name: "bash" or "edit" or "read" or 5 more` + Configuration for the bash tool. - Built-in agent tool identifier. + - `enabled: boolean` - - `"bash"` + - `name: "bash"` - - `"edit"` + - `"bash"` - - `"read"` + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - `"write"` + Permission policy for tool execution. - - `"glob"` + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - `"grep"` + Tool calls are automatically approved without user confirmation. - - `"web_fetch"` + - `type: "always_allow"` - - `"web_search"` + - `"always_allow"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Permission policy for tool execution. + Tool calls require user confirmation before execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `type: "always_ask"` - Tool calls are automatically approved without user confirmation. + - `"always_ask"` - - `type: "always_allow"` + - `type: "bash"` - - `"always_allow"` + - `"bash"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Tool calls require user confirmation before execution. + Configuration for the edit tool. - - `type: "always_ask"` + - `enabled: boolean` - - `"always_ask"` + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
api/beta/sessions/retrieve Changed · +255 / -43 lines
from line 307
- `configs: array of BetaManagedAgentsAgentToolConfig` - - `enabled: boolean` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` - - `name: "bash" or "edit" or "read" or 5 more` + Configuration for the bash tool. - Built-in agent tool identifier. + - `enabled: boolean` - - `"bash"` + - `name: "bash"` - - `"edit"` + - `"bash"` - - `"read"` + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - `"write"` + Permission policy for tool execution. - - `"glob"` + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - `"grep"` + Tool calls are automatically approved without user confirmation. - - `"web_fetch"` + - `type: "always_allow"` - - `"web_search"` + - `"always_allow"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Permission policy for tool execution. + Tool calls require user confirmation before execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `type: "always_ask"` - Tool calls are automatically approved without user confirmation. + - `"always_ask"` - - `type: "always_allow"` + - `type: "bash"` - - `"always_allow"` + - `"bash"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Tool calls require user confirmation before execution. + Configuration for the edit tool. - - `type: "always_ask"` + - `enabled: boolean` - - `"always_ask"` + - `name: "edit"` + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools.
from line 1026
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
from line 1067
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/beta/sessions/threads Changed · +5780 / -4307 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
api/beta/sessions/threads/archive Changed · +253 / -42 lines
from line 287
- `configs: array of BetaManagedAgentsAgentToolConfig` - - `enabled: boolean` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` - - `name: "bash" or "edit" or "read" or 5 more` + Configuration for the bash tool. - Built-in agent tool identifier. + - `enabled: boolean` - - `"bash"` + - `name: "bash"` - - `"edit"` + - `"bash"` - - `"read"` + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - `"write"` + Permission policy for tool execution. - - `"glob"` + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - `"grep"` + Tool calls are automatically approved without user confirmation. - - `"web_fetch"` + - `type: "always_allow"` - - `"web_search"` + - `"always_allow"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Permission policy for tool execution. + Tool calls require user confirmation before execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `type: "always_ask"` - Tool calls are automatically approved without user confirmation. + - `"always_ask"` - - `type: "always_allow"` + - `type: "bash"` - - `"always_allow"` + - `"bash"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Tool calls require user confirmation before execution. + Configuration for the edit tool. - - `type: "always_ask"` + - `enabled: boolean` - - `"always_ask"` + - `name: "edit"` + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools.
from line 807
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/beta/sessions/threads/events Changed · +502 / -82 lines
The two sides of this change are too far apart to line up, so this is the differ's own diff of it.
from line 1777
- `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. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
from line 4103
- `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. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
api/beta/sessions/threads/events/list Changed · +251 / -41 lines
from line 1775
- `configs: array of BetaManagedAgentsAgentToolConfig` - - `enabled: boolean` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` - - `name: "bash" or "edit" or "read" or 5 more` + Configuration for the bash tool. - Built-in agent tool identifier. + - `enabled: boolean` - - `"bash"` + - `name: "bash"` - - `"edit"` + - `"bash"` - - `"read"` + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - `"write"` + Permission policy for tool execution. - - `"glob"` + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - `"grep"` + Tool calls are automatically approved without user confirmation. - - `"web_fetch"` + - `type: "always_allow"` - - `"web_search"` + - `"always_allow"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Permission policy for tool execution. + Tool calls require user confirmation before execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `type: "always_ask"` - Tool calls are automatically approved without user confirmation. + - `"always_ask"` - - `type: "always_allow"` + - `type: "bash"` - - `"always_allow"` + - `"bash"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Tool calls require user confirmation before execution. + Configuration for the edit tool. - - `type: "always_ask"` + - `enabled: boolean` - - `"always_ask"` + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
api/beta/sessions/threads/events/stream Changed · +251 / -41 lines
from line 1775
- `configs: array of BetaManagedAgentsAgentToolConfig` - - `enabled: boolean` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` - - `name: "bash" or "edit" or "read" or 5 more` + Configuration for the bash tool. - Built-in agent tool identifier. + - `enabled: boolean` - - `"bash"` + - `name: "bash"` - - `"edit"` + - `"bash"` - - `"read"` + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - `"write"` + Permission policy for tool execution. - - `"glob"` + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - `"grep"` + Tool calls are automatically approved without user confirmation. - - `"web_fetch"` + - `type: "always_allow"` - - `"web_search"` + - `"always_allow"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Permission policy for tool execution. + Tool calls require user confirmation before execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `type: "always_ask"` - Tool calls are automatically approved without user confirmation. + - `"always_ask"` - - `type: "always_allow"` + - `type: "bash"` - - `"always_allow"` + - `"bash"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Tool calls require user confirmation before execution. + Configuration for the edit tool. - - `type: "always_ask"` + - `enabled: boolean` - - `"always_ask"` + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
api/beta/sessions/threads/list Changed · +253 / -42 lines
from line 295
- `configs: array of BetaManagedAgentsAgentToolConfig` - - `enabled: boolean` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` - - `name: "bash" or "edit" or "read" or 5 more` + Configuration for the bash tool. - Built-in agent tool identifier. + - `enabled: boolean` - - `"bash"` + - `name: "bash"` - - `"edit"` + - `"bash"` - - `"read"` + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - `"write"` + Permission policy for tool execution. - - `"glob"` + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - `"grep"` + Tool calls are automatically approved without user confirmation. - - `"web_fetch"` + - `type: "always_allow"` - - `"web_search"` + - `"always_allow"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Permission policy for tool execution. + Tool calls require user confirmation before execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `type: "always_ask"` - Tool calls are automatically approved without user confirmation. + - `"always_ask"` - - `type: "always_allow"` + - `type: "bash"` - - `"always_allow"` + - `"bash"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Tool calls require user confirmation before execution. + Configuration for the edit tool. - - `type: "always_ask"` + - `enabled: boolean` - - `"always_ask"` + - `name: "edit"` + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools.
from line 820
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/beta/sessions/threads/retrieve Changed · +253 / -42 lines
from line 287
- `configs: array of BetaManagedAgentsAgentToolConfig` - - `enabled: boolean` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` - - `name: "bash" or "edit" or "read" or 5 more` + Configuration for the bash tool. - Built-in agent tool identifier. + - `enabled: boolean` - - `"bash"` + - `name: "bash"` - - `"edit"` + - `"bash"` - - `"read"` + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` - - `"write"` + Permission policy for tool execution. - - `"glob"` + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - `"grep"` + Tool calls are automatically approved without user confirmation. - - `"web_fetch"` + - `type: "always_allow"` - - `"web_search"` + - `"always_allow"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Permission policy for tool execution. + Tool calls require user confirmation before execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `type: "always_ask"` - Tool calls are automatically approved without user confirmation. + - `"always_ask"` - - `type: "always_allow"` + - `type: "bash"` - - `"always_allow"` + - `"bash"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Tool calls require user confirmation before execution. + Configuration for the edit tool. - - `type: "always_ask"` + - `enabled: boolean` - - `"always_ask"` + - `name: "edit"` + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools.
from line 806
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/beta/sessions/update Changed · +577 / -115 lines
The two sides of this change are too far apart to line up, so this is the differ's own diff of it.
from line 129
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"` + - `BetaManagedAgentsBashToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the bash tool. + + - `name: "bash"` + + Must be "bash". + + - `"bash"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: optional "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the edit tool. + + - `name: "edit"` + + Must be "edit". + + - `"edit"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the read tool. + + - `name: "read"` + + Must be "read". + + - `"read"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the write tool. + + - `name: "write"` + + Must be "write". + + - `"write"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the glob tool. + + - `name: "glob"` + + Must be "glob". + + - `"glob"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfigParams object { name, enabled, permission_policy, type }` + + Configuration override for the grep tool. + + - `name: "grep"` + + Must be "grep". + + - `"grep"` + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_fetch tool. + + - `name: "web_fetch"` + + Must be "web_fetch". + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + Only fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never fetch URLs whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme, port, or path). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `max_content_tokens: optional number or null` + + Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_fetch"` + + - `"web_fetch"` + + - `BetaManagedAgentsWebSearchToolConfigParams object { name, allowed_domains, blocked_domains, 4 more }` + + Configuration override for the web_search tool. + + - `name: "web_search"` + + Must be "web_search". + + - `"web_search"` + + - `allowed_domains: optional array of string` + + Only return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "docs.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with blocked_domains. + + - `blocked_domains: optional array of string` + + Never return search results whose host is one of these domains or a subdomain of one. Each entry is a plain hostname like "ads.example.com" (no scheme or port; an optional path suffix is accepted). At most 64 entries; an empty list is rejected (omit the field instead). Cannot be combined with allowed_domains. + + - `enabled: optional boolean or null` + + Whether this tool is enabled and available to Claude. Overrides the default_config setting. + + - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: optional "web_search"` + + - `"web_search"` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". + + - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` + + Default configuration for all tools in a toolset. - `enabled: optional boolean or null` - Whether this tool is enabled and available to Claude. Overrides the default_config setting. + Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 439
Tool calls are automatically approved without user confirmation. - - `type: "always_allow"` - - - `"always_allow"` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` Tool calls require user confirmation before execution. - - `type: "always_ask"` - - - `"always_ask"` - - - `default_config: optional BetaManagedAgentsAgentToolsetDefaultConfigParams or null` - - Default configuration for all tools in a toolset. + - `BetaManagedAgentsMCPToolsetParams 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 or null` - Whether tools are enabled and available to Claude by default. Defaults to true if not specified. + Whether this tool is enabled. Overrides the `default_config` setting. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 479
Tool calls require user confirmation before execution. - - `BetaManagedAgentsMCPToolsetParams 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. + - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` + + Default configuration for all tools from an MCP server. - `enabled: optional boolean or null` - Whether this tool is enabled. Overrides the `default_config` setting. + Whether tools are enabled by default. Defaults to true if not specified. - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null`
from line 499
Tool calls require user confirmation before execution. - - `default_config: optional BetaManagedAgentsMCPToolsetDefaultConfigParams or null` - - Default configuration for all tools from an MCP server. - - - `enabled: optional boolean or null` - - Whether tools are enabled by default. Defaults to true if not specified. - - - `permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or null` - - Permission policy for tool execution. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - `BetaManagedAgentsCustomToolParams 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.
from line 777
- `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. - - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` - - Tool calls are automatically approved without user confirmation. - - - `type: "always_allow"` - - - `"always_allow"` - - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - - Tool calls require user confirmation before execution. - - - `type: "always_ask"` - - - `"always_ask"` + - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the bash tool. + + - `enabled: boolean` + + - `name: "bash"` + + - `"bash"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `type: "always_allow"` + + - `"always_allow"` + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "always_ask"` + + - `"always_ask"` + + - `type: "bash"` + + - `"bash"` + + - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the edit tool. + + - `enabled: boolean` + + - `name: "edit"` + + - `"edit"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "edit"` + + - `"edit"` + + - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the read tool. + + - `enabled: boolean` + + - `name: "read"` + + - `"read"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "read"` + + - `"read"` + + - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the write tool. + + - `enabled: boolean` + + - `name: "write"` + + - `"write"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "write"` + + - `"write"` + + - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the glob tool. + + - `enabled: boolean` + + - `name: "glob"` + + - `"glob"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "glob"` + + - `"glob"` + + - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` + + Configuration for the grep tool. + + - `enabled: boolean` + + - `name: "grep"` + + - `"grep"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "grep"` + + - `"grep"` + + - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_fetch tool. + + - `enabled: boolean` + + - `name: "web_fetch"` + + - `"web_fetch"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_fetch"` + + - `"web_fetch"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `max_content_tokens: optional number or null` + + - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + + Configuration for the web_search tool. + + - `enabled: boolean` + + - `name: "web_search"` + + - `"web_search"` + + - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` + + Permission policy for tool execution. + + - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + + Tool calls are automatically approved without user confirmation. + + - `BetaManagedAgentsAlwaysAskPolicy object { type }` + + Tool calls require user confirmation before execution. + + - `type: "web_search"` + + - `"web_search"` + + - `allowed_domains: optional array of string` + + - `blocked_domains: optional array of string` + + - `user_location: optional BetaManagedAgentsUserLocation or null` + + Approximate user location for search result localization. + + - `type: "approximate"` + + Location precision. Only "approximate" is supported. + + - `"approximate"` + + - `city: optional string or null` + + City name. + + - `country: optional string or null` + + Two-letter ISO 3166-1 country code, uppercase. + + - `region: optional string or null` + + Region or state name. + + - `timezone: optional string or null` + + IANA timezone identifier, e.g. "America/Los_Angeles". - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig`
from line 1500
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
from line 1541
"name": "bash", "permission_policy": { "type": "always_allow" - } + }, + "type": "bash" } ], "default_config": {
api/messages Changed · +40 / -40 lines
This page is larger than the 256 KiB this site keeps, so one side of the diff below stops where the stored text does.
from line 3073
- `version: string` - Skill version or 'latest' for most recent version + The resolved version: a skill version ID for custom skills. - `content: array of ContentBlock`
from line 8244
- `enabled: optional boolean or null` - Whether this member is offered to the model. De + Whether this member is offered to the
api/messages/batches Changed · +4 / -4 lines
from line 3749
- `version: string` - Skill version or 'latest' for most recent version + The resolved version: a skill version ID for custom skills. - `content: array of ContentBlock`
from line 5064
- `version: string` - Skill version or 'latest' for most recent version + The resolved version: a skill version ID for custom skills. - `content: array of ContentBlock`
from line 6179
- `version: string` - Skill version or 'latest' for most recent version + The resolved version: a skill version ID for custom skills. - `content: array of ContentBlock`
from line 7256
- `version: string` - Skill version or 'latest' for most recent version + The resolved version: a skill version ID for custom skills. - `content: array of ContentBlock`
build-with-claude/cache-diagnostics Changed · +16 / -16 lines
from line 30
```bash cURL # Turn 1: establish the cache and opt in to diagnostics response=$(curl -sS --fail-with-body https://api.anthropic.com/v1/messages \ - --header "x-api-key: $ANTHROPIC_API_KEY" \ - --header "anthropic-version: 2023-06-01" \ - --header "anthropic-beta: cache-diagnosis-2026-04-07" \ - --header "content-type: application/json" \ - --data '{ + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "anthropic-beta: cache-diagnosis-2026-04-07" \ + -H "content-type: application/json" \ + -d '{ "model": "claude-opus-5", "max_tokens": 1024, "cache_control": {"type": "ephemeral"},
from line 47
# Turn 2: reference the previous turn so the API can compare prefixes curl -sS --fail-with-body https://api.anthropic.com/v1/messages \ - --header "x-api-key: $ANTHROPIC_API_KEY" \ - --header "anthropic-version: 2023-06-01" \ - --header "anthropic-beta: cache-diagnosis-2026-04-07" \ - --header "content-type: application/json" \ - --data @- <<EOF | jq '{id, diagnostics}' # diagnostics: null means no divergence was found + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "anthropic-beta: cache-diagnosis-2026-04-07" \ + -H "content-type: application/json" \ + -d @- <<EOF | jq '{id, diagnostics}' # diagnostics: null means no divergence was found { "model": "claude-opus-5", "max_tokens": 1024,
from line 427
# Turn 2: stream the response. diagnostics arrives on the message_start event; # a null value means no divergence was found. curl -sS --fail-with-body https://api.anthropic.com/v1/messages \ - --header "x-api-key: $ANTHROPIC_API_KEY" \ - --header "anthropic-version: 2023-06-01" \ - --header "anthropic-beta: cache-diagnosis-2026-04-07" \ - --header "content-type: application/json" \ - --data @- <<EOF | jq -R 'select(startswith("data: ")) | ltrimstr("data: ") | fromjson | select(.type == "message_start") | .message.diagnostics' + -H "x-api-key: $ANTHROPIC_API_KEY" \ + -H "anthropic-version: 2023-06-01" \ + -H "anthropic-beta: cache-diagnosis-2026-04-07" \ + -H "content-type: application/json" \ + -d @- <<EOF | jq -R 'select(startswith("data: ")) | ltrimstr("data: ") | fromjson | select(.type == "message_start") | .message.diagnostics' { "model": "claude-opus-5", "max_tokens": 1024,
from line 1078
## Limitations -* **Beta:** Field names and semantics may change before general availability. +* **Beta:** Field names and semantics may change while this feature is in beta. * **Claude API only:** Not available on Amazon Bedrock or Google Cloud. * **Limited retention:** Fingerprints for `previous_message_id` lookup expire after a short period. Run diagnostic comparisons between closely spaced requests. * **Same workspace:** The previous request must have been made with an API key from the same organization and workspace. To check, compare the `anthropic-workspace-id` [response header](https://platform.claude.com/docs/en/api/overview#response-headers) on the two responses.
build-with-claude/citations Changed · +7 / -13 lines
from line 423
``` ```bash CLI - ant messages create \ - --model claude-opus-5 \ - --max-tokens 1024 <<'YAML' + ant messages create --model claude-opus-5 --max-tokens 1024 <<'YAML' messages: - role: user content:
from line 918
``` ```php PHP - // The PHP SDK supports file_id document and image sources only through $client->beta->messages with the files beta. - $citedResponse = $client->beta->messages->create( + $citedResponse = $client->messages->create( maxTokens: 1024, messages: [ [
from line 926
'content' => [ [ 'type' => 'document', - 'source' => ['type' => 'file', 'file_id' => $fileId], + 'source' => ['type' => 'file', 'fileID' => $fileId], 'title' => 'Document Title', 'context' => 'Context about the document that will not be cited from', 'citations' => ['enabled' => true],
from line 936
], ], model: 'claude-opus-5', - betas: ['files-api-2025-04-14'], ); - print_r($citedResponse); + echo $citedResponse; ``` ```ruby Ruby
from line 1739
``` ```php PHP - // The PHP SDK supports file_id document and image sources only through $client->beta->messages with the files beta. - $citedResponse = $client->beta->messages->create( + $citedResponse = $client->messages->create( maxTokens: 1024, messages: [ [
from line 1747
'content' => [ [ 'type' => 'document', - 'source' => ['type' => 'file', 'file_id' => $fileId], + 'source' => ['type' => 'file', 'fileID' => $fileId], 'title' => 'Document Title', 'context' => 'Context about the document that will not be cited from', 'citations' => ['enabled' => true],
from line 1757
], ], model: 'claude-opus-5', - betas: ['files-api-2025-04-14'], ); - print_r($citedResponse); + echo $citedResponse; ``` ```ruby Ruby
build-with-claude/claude-on-amazon-bedrock-legacy Changed · +3 / -2 lines
from line 326
# Temporary credentials can be used with aws_session_token. # Read more at https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html. aws_session_token="<session_token>", - # aws_region changes the aws region to which the request is made. By default, the SDK reads AWS_REGION, - # and if that's not present, defaults to us-east-1. Note that the SDK does not read ~/.aws/config for the region. + # aws_region changes the aws region to which the request is made. If it is not provided, the SDK reads + # AWS_REGION / AWS_DEFAULT_REGION, then the region configured for your boto3 session or AWS profile + # (including ~/.aws/config), and raises ValueError if no region can be resolved. aws_region="us-west-2", )
build-with-claude/claude-platform-on-aws Changed · +8 / -7 lines
from line 268
### Region resolution -The client reads `AWS_REGION` from the environment if `aws_region`/`awsRegion` is not passed to the constructor, falling back to `AWS_DEFAULT_REGION` for compatibility with the standard AWS SDKs. Region is required. There is no fallback default. Unlike `AnthropicBedrock`, which falls back to `us-east-1`, the `AnthropicAWS`/`AnthropicAws` client raises an error if neither the constructor argument nor the environment variable is set. +The client reads `AWS_REGION` from the environment if `aws_region`/`awsRegion` is not passed to the constructor, falling back to `AWS_DEFAULT_REGION` for compatibility with the standard AWS SDKs. Region is required and there is no default: the `AnthropicAWS`/`AnthropicAws` client raises an error if neither the constructor argument nor an environment variable is set. ## Install an SDK
from line 341
| Model | Model ID | | ----------------- | ----------------- | | Claude Fable 5 | claude-fable-5 | +| Claude Opus 5 | claude-opus-5 | | Claude Opus 4.8 | claude-opus-4-8 | | Claude Opus 4.7 | claude-opus-4-7 | | Claude Opus 4.6 | claude-opus-4-6 |
from line 840
### Spend limits -The Start, Build, and Scale usage tiers each carry a monthly spend cap; see the [per-tier spend caps](https://platform.claude.com/docs/en/api/rate-limits#spend-limits) for current values. When your organization's usage for the calendar month reaches its tier's cap, API requests fail with the [spend-cap error](https://platform.claude.com/docs/en/api/rate-limits#reaching-your-spend-cap) until 00UTC on the first day of the next month, and retrying sooner doesn't succeed. The spend cap and rate limits belong to the same tier. To raise the cap, or to restore access after reaching it, request a tier increase through your Anthropic account representative or [Anthropic support](https://support.claude.com) (see [Rate limits and quotas](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws#rate-limits-and-quotas)). +The Start, Build, and Scale usage tiers each carry a monthly spend cap; see the [per-tier spend caps](https://platform.claude.com/docs/en/api/rate-limits#spend-limits) for current values. When your organization's usage for the calendar month reaches its tier's cap, API requests fail with the [spend-cap error](https://platform.claude.com/docs/en/api/rate-limits#reaching-your-spend-cap) until 00:00 UTC on the first day of the next month, and retrying sooner doesn't succeed. The spend cap and rate limits belong to the same tier. To raise the cap, or to restore access after reaching it, request a tier increase through your Anthropic account representative or [Anthropic support](https://support.claude.com) (see [Rate limits and quotas](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws#rate-limits-and-quotas)). -You can also set your own monthly spend limits below the cap, after adding at least one recipient under **Email notifications** on the Billing page: +You can also set your own monthly spend limits below the cap, after adding at least one recipient under **Email recipients** on the Billing page: * **Organization spend limit:** Go to [Settings > Billing](https://platform.claude.com/settings/billing) in the [Claude Console](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws#using-the-claude-console) to set a monthly spend limit. * **Workspace spend limits:** Select a workspace under [Settings > Workspaces](https://platform.claude.com/settings/workspaces) and open its **Spend limits** page. Workspace details are otherwise read-only in the Claude Console on Claude Platform on AWS. -When usage reaches a limit you set, requests fail with HTTP 400 (see the [spend limit error](https://platform.claude.com/docs/en/api/rate-limits#setting-your-own-spend-limit)) until 00UTC on the first day of the next month, or until you raise or remove the limit. +When usage reaches a limit you set, requests fail with HTTP 400 (see the [spend limit error](https://platform.claude.com/docs/en/api/rate-limits#setting-your-own-spend-limit)) until 00:00 UTC on the first day of the next month, or until you raise or remove the limit. -Spend is calculated at list prices and can take about 2 hours to reflect recent usage, so usage can exceed the cap or a limit before requests start failing. The overshoot is billed. When the tier cap or an organization spend limit stops your requests, an email notice goes to the recipients listed under **Email notifications** on the Billing page. Role-based recipients, such as all admins, aren't available on Claude Platform on AWS. The tier-cap notice also goes to the email address used at AWS Marketplace sign-up. +Spend is calculated at list prices and can take about 2 hours to reflect recent usage, so usage can exceed the cap or a limit before requests start failing. The overshoot is billed. When the tier cap or an organization spend limit stops your requests, an email notice goes to the recipients listed under **Email recipients** on the Billing page. Role-based recipients, such as all admins, aren't available on Claude Platform on AWS. The tier-cap notice also goes to the email address used at AWS Marketplace sign-up. ## Monitoring and logging
build-with-claude/context-editing Changed · +21 / -88 lines
from line 20
* **Thinking block clearing** - For managing thinking blocks when using extended thinking, with options to preserve recent thinking for context continuity * **Client-side SDK compaction** - An SDK-based alternative for summary-based context management (server-side compaction is generally preferred) -| Approach | Where it runs | Strategies | How it works | -| --------------- | ------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Server-side** | API | Tool result clearing (`clear_tool_uses_20250919`) Thinking block clearing (`clear_thinking_20251015`) | Applied before the prompt reaches Claude. Clears specific content from conversation history. Each strategy can be configured independently. | -| **Client-side** | SDK | Compaction | Available in [Python, TypeScript, and Ruby SDKs](https://platform.claude.com/docs/en/cli-sdks-libraries/overview) when using [`tool_runner`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-runner). Generates a summary and replaces full conversation history. See [Client-side compaction](https://platform.claude.com/docs/en/build-with-claude/context-editing#client-side-compaction-sdk). | +| Approach | Where it runs | Strategies | How it works | +| --------------- | ------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Server-side** | API | Tool result clearing (`clear_tool_uses_20250919`) Thinking block clearing (`clear_thinking_20251015`) | Applied before the prompt reaches Claude. Clears specific content from conversation history. Each strategy can be configured independently. | +| **Client-side** | SDK | Compaction | Available in [TypeScript and Ruby SDKs](https://platform.claude.com/docs/en/cli-sdks-libraries/overview) when using [`tool_runner`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-runner). Generates a summary and replaces full conversation history. See [Client-side compaction](https://platform.claude.com/docs/en/build-with-claude/context-editing#client-side-compaction-sdk). | ## Server-side strategies
from line 2325
<Warning> **Anthropic recommends server-side compaction over SDK compaction.** [Server-side compaction](https://platform.claude.com/docs/en/build-with-claude/compaction) handles context management automatically with less integration complexity, better token usage calculation, and no client-side limitations. Use SDK compaction only if you specifically need client-side control over the summarization process. - The `compaction_control` parameter is deprecated in the Python, TypeScript, and Ruby SDKs and will be removed in a future version. The SDKs emit a deprecation warning when it is enabled. To use server-side compaction with a tool runner, pass the `compact_20260112` edit in the request's `context_management` parameter. + The `compaction_control` parameter is deprecated in the TypeScript and Ruby SDKs and will be removed in a future version. The SDKs emit a deprecation warning when it is enabled. The Python SDK removed it in v1.0. To use server-side compaction with a tool runner, pass the `compact_20260112` edit in the request's `context_management` parameter. </Warning> <Note> - Compaction is available in the [Python, TypeScript, and Ruby SDKs](https://platform.claude.com/docs/en/cli-sdks-libraries/overview) when using the [`tool_runner` method](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-runner). + Compaction is available in the [TypeScript and Ruby SDKs](https://platform.claude.com/docs/en/cli-sdks-libraries/overview) when using the [`tool_runner` method](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-runner). </Note> Compaction is an SDK feature that automatically manages conversation context by generating summaries when token usage grows too large. Unlike server-side context editing strategies that clear content, compaction instructs Claude to summarize the conversation history, then replaces the full history with that summary. This allows Claude to continue working on long-running tasks that would otherwise exceed the [context window](https://platform.claude.com/docs/en/build-with-claude/context-windows).
from line 2361
</Tab> <Tab title="Python"> - ```python Python - client = anthropic.Anthropic() - - runner = client.beta.messages.tool_runner( - model="claude-opus-5", - max_tokens=1024, - tools=[read_file], - messages=[{"role": "user", "content": "What's in config.json?"}], - compaction_control={"enabled": True, "context_token_threshold": 100000}, - ) - - for message in runner: - print(f"Tokens used: {message.usage.input_tokens}") - ``` + <Note> + In v1.0 and later, the Python SDK's tool runner does not support client-side `compaction_control`. Use [server-side compaction](https://platform.claude.com/docs/en/build-with-claude/compaction) instead: it works with the tool runner by passing the `compact_20260112` edit in the request's `context_management` parameter. + </Note> </Tab> <Tab title="TypeScript">
from line 2493
</Tab> <Tab title="Python"> - ```python Python - client = anthropic.Anthropic() - - runner = client.beta.messages.tool_runner( - model="claude-opus-5", - max_tokens=1024, - tools=[read_file], - messages=[{"role": "user", "content": "What's in config.json?"}], - # Lower values compact more often; raise to 150000 when the task needs more context - compaction_control={"enabled": True, "context_token_threshold": 50000}, - ) - - for message in runner: - print(f"Tokens used: {message.usage.input_tokens}") - ``` + <Note> + In v1.0 and later, the Python SDK's tool runner does not support client-side `compaction_control`. Use [server-side compaction](https://platform.claude.com/docs/en/build-with-claude/compaction) instead: it works with the tool runner by passing the `compact_20260112` edit in the request's `context_management` parameter. + </Note> </Tab> <Tab title="TypeScript">
from line 2579
</Tab> <Tab title="Python"> - ```python Python - client = anthropic.Anthropic() - - runner = client.beta.messages.tool_runner( - model="claude-opus-5", - max_tokens=1024, - tools=[read_file], - messages=[{"role": "user", "content": "What's in config.json?"}], - compaction_control={ - "enabled": True, - "context_token_threshold": 100000, - "model": "claude-haiku-4-5", - }, - ) - - for message in runner: - print(f"Tokens used: {message.usage.input_tokens}") - ``` + <Note> + In v1.0 and later, the Python SDK's tool runner does not support client-side `compaction_control`. Use [server-side compaction](https://platform.claude.com/docs/en/build-with-claude/compaction) instead: it works with the tool runner by passing the `compact_20260112` edit in the request's `context_management` parameter. + </Note> </Tab> <Tab title="TypeScript">
from line 2671
</Tab> <Tab title="Python"> - ```python Python - client = anthropic.Anthropic() - - runner = client.beta.messages.tool_runner( - model="claude-opus-5", - max_tokens=1024, - tools=[read_file], - messages=[{"role": "user", "content": "What's in config.json?"}], - compaction_control={ - "enabled": True, - "context_token_threshold": 100000, - "summary_prompt": """Summarize the research conducted so far, including: - - Sources consulted and key findings - - Questions answered and remaining unknowns - - Recommended next steps - - Wrap your summary in <summary></summary> tags.""", - }, - ) - - for message in runner: - print(f"Tokens used: {message.usage.input_tokens}") - ``` + <Note> + In v1.0 and later, the Python SDK's tool runner does not support client-side `compaction_control`. Use [server-side compaction](https://platform.claude.com/docs/en/build-with-claude/compaction) instead: it works with the tool runner by passing the `compact_20260112` edit in the request's `context_management` parameter. + </Note> </Tab> <Tab title="TypeScript">
from line 2856
</Tab> <Tab title="Python"> - The Python SDK logs compaction events at the INFO level. Enable the `anthropic.lib.tools` logger: - - ```python Python - import logging - - logging.basicConfig(level=logging.INFO) - logging.getLogger("anthropic.lib.tools").setLevel(logging.INFO) - - # Logs will show: - # INFO: Token usage 105000 has exceeded the threshold of 100000. Performing compaction. - # INFO: Compaction complete. New token usage: 2500 - ``` + <Note> + In v1.0 and later, the Python SDK's tool runner does not support `compaction_control`. Use [server-side compaction](https://platform.claude.com/docs/en/build-with-claude/compaction) instead. + </Note> </Tab> <Tab title="TypeScript">
build-with-claude/files Changed · +16 / -25 lines
from line 123
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. - $file = $client->beta->files->upload( - FileParam::fromResource(fopen('/path/to/document.pdf', 'rb'), contentType: 'application/pdf'), + $file = $client->files->upload( + file: FileParam::fromResource(fopen('/path/to/document.pdf', 'rb'), contentType: 'application/pdf'), ); $fileId = $file->id;
from line 329
``` ```php PHP - // The PHP SDK supports file_id document and image sources only through $client->beta->messages with the files beta. - $response = $client->beta->messages->create( + $response = $client->messages->create( maxTokens: 1024, messages: [ [
from line 340
'type' => 'document', 'source' => [ 'type' => 'file', - 'file_id' => $fileId - ] - ] - ] - ] + 'fileID' => $fileId, + ], + ], + ], + ], ], model: 'claude-opus-5', - betas: ['files-api-2025-04-14'], ); - print_r($response); + echo $response; ``` ```ruby Ruby
from line 691
``` ```bash CLI - ant files list \ - --max-items 10 + ant files list --max-items 10 ``` ```python Python
from line 735
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. - // list() paginates with afterID, beforeID, and limit; page and ids[] are not parameters here. $client = new Client(); - $files = $client->beta->files->list(); + $files = $client->files->list(); echo $files; ```
from line 798
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. - $file = $client->beta->files->retrieveMetadata($fileId); + $file = $client->files->retrieveMetadata($fileId); echo $file; ```
from line 848
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. - $client->beta->files->delete($fileId); + $client->files->delete($fileId); ``` ```ruby Ruby
from line 924
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. - $fileContent = $client->beta->files->download($fileId); + $fileContent = $client->files->download($fileId); - file_put_contents("downloaded_file.txt", $fileContent); + file_put_contents('downloaded_file.txt', $fileContent); ``` ```ruby Ruby
build-with-claude/overview Changed · +6 / -7 lines
from line 18
## Feature availability -Features on the Claude Platform are assigned one of the following availability classifications per platform (shown in the Availability column of each following table). Not all features pass through every stage. A feature may enter at any classification and may skip stages. +The Availability column in each of the following tables lists the platforms that offer a feature. A platform listed without a label offers the feature as stable, fully supported, and recommended for production use, with no beta header and with standard API [versioning](https://platform.claude.com/docs/en/api/versioning) guarantees. A label after a platform name marks one of the following classifications on that platform. Not all features pass through every stage, and a feature may enter at any stage or skip stages. -| Classification | Description | -| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Beta** | Preview features used for gathering feedback and iterating on a less mature use case. Availability may be limited, including through sign-up requirements or waitlists, and may not be publicly announced. Features may change significantly or be discontinued based on feedback. Not guaranteed for ongoing production use. Breaking changes are possible with notice, and some platform-specific limitations may apply. Beta features on the Claude API and [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws) have a [beta header](https://platform.claude.com/docs/en/api/beta-headers). | -| **Generally available (GA)** | Feature is stable, fully supported, and recommended for production use. Should not have a beta header or other indicator that the feature is in a preview state. Covered by standard API [versioning](https://platform.claude.com/docs/en/api/versioning) guarantees. | -| **Deprecated** | Feature is still functional but no longer recommended. A migration path and removal timeline are provided. | -| **Retired** | Feature is no longer available. | +| Classification | Description | +| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Beta** | Preview features used for gathering feedback and iterating on a less mature use case. Availability may be limited, including through sign-up requirements or waitlists, and may not be publicly announced. Features may change significantly or be discontinued based on feedback. Not guaranteed for ongoing production use. Breaking changes are possible with notice, and some platform-specific limitations may apply. Beta features on the Claude API and [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws) have a [beta header](https://platform.claude.com/docs/en/api/beta-headers). | +| **Deprecated** | Feature is still functional but no longer recommended. A migration path and removal timeline are provided. | +| **Retired** | Feature is no longer available. | **Platform labels:** Claude API (Anthropic first-party) · [Bedrock](https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon-bedrock) (AWS-operated) · [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws) (Anthropic-operated on AWS) · [Google Cloud](https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai) (Google-operated) · [Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry) (Anthropic-operated on Azure)
build-with-claude/pdf-support Changed · +9 / -12 lines
from line 425
```python Python import base64 - import httpx + import httpx2 # First, load and encode the PDF pdf_url = "https://assets.anthropic.com/m/1cd9d098ac3e6467/original/Claude-3-Model-Card-October-Addendum.pdf" pdf_data = base64.standard_b64encode( - httpx.get(pdf_url, follow_redirects=True).content + httpx2.get(pdf_url, follow_redirects=True).content ).decode("utf-8") # Alternative: Load from a local file
from line 941
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. - // The PHP SDK supports file_id document and image sources only through $client->beta->messages with the files beta. use Anthropic\Core\FileParam; $client = new Client(); // Upload the PDF file - $file_upload = $client->beta->files->upload( + $file_upload = $client->files->upload( file: FileParam::fromResource(fopen('/path/to/document.pdf', 'r'), contentType: 'application/pdf'), ); // Use the uploaded file in a message - $message = $client->beta->messages->create( + $message = $client->messages->create( maxTokens: 1024, - betas: ['files-api-2025-04-14'], messages: [ [ 'role' => 'user',
from line 961
'type' => 'document', 'source' => [ 'type' => 'file', - 'file_id' => $file_upload->id, + 'fileID' => $file_upload->id, ], ], [
from line 1120
```python Python import base64 - import httpx + import httpx2 # First, load and encode the PDF pdf_url = "https://assets.anthropic.com/m/1cd9d098ac3e6467/original/Claude-3-Model-Card-October-Addendum.pdf" pdf_data = base64.standard_b64encode( - httpx.get(pdf_url, follow_redirects=True).content + httpx2.get(pdf_url, follow_redirects=True).content ).decode("utf-8") # Create a message with the cached document
from line 1488
```python Python import base64 - import httpx + import httpx2 # First, load and encode the PDF pdf_url = "https://assets.anthropic.com/m/1cd9d098ac3e6467/original/Claude-3-Model-Card-October-Addendum.pdf" pdf_data = base64.standard_b64encode( - httpx.get(pdf_url, follow_redirects=True).content + httpx2.get(pdf_url, follow_redirects=True).content ).decode("utf-8") # Create a batch of requests that use the document
build-with-claude/skills-guide Changed · +79 / -114 lines
from line 250
``` ```php PHP - // The PHP SDK supports container skills only through $client->beta->messages with the skills beta. $client = new Client(); - $message = $client->beta->messages->create( + $message = $client->messages->create( maxTokens: 4096, messages: [ ['role' => 'user', 'content' => 'Create a presentation about renewable energy'] ], model: 'claude-opus-5', - betas: ['code-execution-2025-08-25', 'skills-2025-10-02'], container: [ 'skills' => [ [ 'type' => 'anthropic', - 'skill_id' => 'pptx', + 'skillID' => 'pptx', 'version' => 'latest' ] ]
from line 387
--raw-output) # Step 4: Download the file using Files API - ant files download \ - --file-id "$FILE_ID" \ - --output "$FILENAME" > /dev/null + ant files download --file-id "$FILE_ID" --output "$FILENAME" > /dev/null printf 'Downloaded: %s\n' "$FILENAME" ```
from line 663
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. - // The PHP SDK supports container skills only through $client->beta->messages with the skills beta. $client = new Client(); // Step 1: Use a Skill to create a file - $response = $client->beta->messages->create( + $response = $client->messages->create( maxTokens: 4096, messages: [ ['role' => 'user', 'content' => 'Create an Excel file with a simple budget spreadsheet'] ], model: 'claude-opus-5', - betas: ['code-execution-2025-08-25', 'skills-2025-10-02'], container: [ 'skills' => [ - ['type' => 'anthropic', 'skill_id' => 'xlsx', 'version' => 'latest'] + ['type' => 'anthropic', 'skillID' => 'xlsx', 'version' => 'latest'] ] ], tools: [
from line 700
// Step 3: Download the file using Files API foreach (extractFileIds($response) as $fileId) { - $fileMetadata = $client->beta->files->retrieveMetadata($fileId); - $fileContent = $client->beta->files->download($fileId); + $fileMetadata = $client->files->retrieveMetadata($fileId); + $fileContent = $client->files->download($fileId); // Step 4: Save to disk file_put_contents($fileMetadata->filename, $fileContent);
from line 785
--format yaml # List all files - ant files list \ - --transform '{filename,created_at}' \ - --format yaml + ant files list --transform '{filename,created_at}' --format yaml # Delete a file ant files delete --file-id "$FILE_ID" >/dev/null
from line 894
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. $client = new Client(); $fileId = 'file_011CNha8iCJcU1wXNR6q4V8w'; // Get file metadata - $fileInfo = $client->beta->files->retrieveMetadata($fileId); + $fileInfo = $client->files->retrieveMetadata($fileId); echo "Filename: {$fileInfo->filename}, Size: {$fileInfo->sizeBytes} bytes\n"; // List files (first page) - $files = $client->beta->files->list(); - foreach ($files->data as $file) { + foreach ($client->files->list()->getItems() as $file) { echo "{$file->filename} - {$file->createdAt->format(DATE_ATOM)}\n"; } // Delete a file - $client->beta->files->delete($fileId); + $client->files->delete($fileId); ``` ```ruby Ruby
from line 1249
``` ```php PHP - // The PHP SDK supports container skills only through $client->beta->messages with the skills beta. $client = new Client(); - $response1 = $client->beta->messages->create( + $response1 = $client->messages->create( maxTokens: 4096, messages: [ ['role' => 'user', 'content' => 'Create a sample sales dataset and analyze it'] ], model: 'claude-opus-5', - betas: ['code-execution-2025-08-25', 'skills-2025-10-02'], container: [ 'skills' => [ - ['type' => 'anthropic', 'skill_id' => 'xlsx', 'version' => 'latest'] + ['type' => 'anthropic', 'skillID' => 'xlsx', 'version' => 'latest'] ] ], tools: [
from line 1277
['role' => 'user', 'content' => 'What was the total revenue?'] ]; - $response2 = $client->beta->messages->create( + $response2 = $client->messages->create( maxTokens: 4096, messages: $messages, model: 'claude-opus-5', - betas: ['code-execution-2025-08-25', 'skills-2025-10-02'], container: [ 'id' => $response1->container->id, 'skills' => [ - ['type' => 'anthropic', 'skill_id' => 'xlsx', 'version' => 'latest'] + ['type' => 'anthropic', 'skillID' => 'xlsx', 'version' => 'latest'] ] ], tools: [
from line 1725
``` ```php PHP - // The PHP SDK supports container skills only through $client->beta->messages with the skills beta. $client = new Client(); $messages = [
from line 1732
]; $maxRetries = 10; - $response = $client->beta->messages->create( + $response = $client->messages->create( maxTokens: 4096, messages: $messages, model: 'claude-opus-5', - betas: ['code-execution-2025-08-25', 'skills-2025-10-02'], container: [ 'skills' => [ [ 'type' => 'custom', - 'skill_id' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', + 'skillID' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', 'version' => 'latest' ] ]
from line 1755
$messages[] = ['role' => 'assistant', 'content' => $response->content]; - $response = $client->beta->messages->create( + $response = $client->messages->create( maxTokens: 4096, messages: $messages, model: 'claude-opus-5', - betas: ['code-execution-2025-08-25', 'skills-2025-10-02'], container: [ 'id' => $response->container->id, 'skills' => [ [ 'type' => 'custom', - 'skill_id' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', + 'skillID' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', 'version' => 'latest' ] ]
from line 2077
``` ```php PHP - // The PHP SDK supports container skills only through $client->beta->messages with the skills beta. $client = new Client(); - $message = $client->beta->messages->create( + $message = $client->messages->create( maxTokens: 4096, messages: [ ['role' => 'user', 'content' => 'Analyze sales data and create a presentation'] ], model: 'claude-opus-5', - betas: ['code-execution-2025-08-25', 'skills-2025-10-02'], container: [ 'skills' => [ [ 'type' => 'anthropic', - 'skill_id' => 'xlsx', + 'skillID' => 'xlsx', 'version' => 'latest' ], [ 'type' => 'anthropic', - 'skill_id' => 'pptx', + 'skillID' => 'pptx', 'version' => 'latest' ], [ 'type' => 'custom', - 'skill_id' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', + 'skillID' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', 'version' => 'latest' ] ]
from line 2389
``` ```php PHP - // The PHP SDK exposes the Skills API under the beta namespace; field names can differ from other SDKs. use Anthropic\Core\FileParam; // ...
from line 2395
$client = new Client(); // Option 1: Using a zip file - $skill = $client->beta->skills->create( + $skill = $client->skills->create( files: [ - FileParam::fromResource(fopen('example_skill.zip', 'r')) + FileParam::fromResource(fopen('example_skill.zip', 'r')), ], ); // Option 2: Using individual files - $skill = $client->beta->skills->create( + $skill = $client->skills->create( files: [ - FileParam::fromResource(fopen('financial_skill/SKILL.md', 'r'), 'financial_skill/SKILL.md', 'text/markdown'), - FileParam::fromResource(fopen('financial_skill/analyze.py', 'r'), 'financial_skill/analyze.py', 'text/x-python') + FileParam::fromResource( + fopen('financial_skill/SKILL.md', 'r'), + filename: 'financial_skill/SKILL.md', + contentType: 'text/markdown', + ), + FileParam::fromResource( + fopen('financial_skill/analyze.py', 'r'), + filename: 'financial_skill/analyze.py', + contentType: 'text/x-python', + ), ], ); echo "Created skill: {$skill->id}\n"; - echo "Latest version: {$skill->latestVersion}\n"; + echo "Latest version: {$skill->latestVersionID}\n"; ``` ```ruby Ruby
from line 2583
``` ```php PHP - // The PHP SDK exposes the Skills API under the beta namespace; field names can differ from other SDKs. $client = new Client(); // List Skills (first page) - $skills = $client->beta->skills->list(); - - foreach ($skills->data as $skill) { - echo "{$skill->id}: {$skill->displayTitle} (source: {$skill->source})\n"; + foreach ($client->skills->list()->getItems() as $skill) { + echo "{$skill->id}: {$skill->displayName} (source: {$skill->source->type})\n"; } // List only custom Skills - $customSkills = $client->beta->skills->list( + $customSkills = $client->skills->list( source: 'custom', ); ```
from line 2625
``` ```bash CLI - ant skills retrieve \ - --skill-id skill_01AbCdEfGhIjKlMnOpQrStUv + ant skills retrieve --skill-id skill_01AbCdEfGhIjKlMnOpQrStUv ``` ```python Python
from line 2689
``` ```php PHP - // The PHP SDK exposes the Skills API under the beta namespace; field names can differ from other SDKs. $client = new Client(); - $skill = $client->beta->skills->retrieve( - skillID: 'skill_01AbCdEfGhIjKlMnOpQrStUv', - ); + $skill = $client->skills->retrieve('skill_01AbCdEfGhIjKlMnOpQrStUv'); - echo "Skill: " . $skill->displayTitle . "\n"; - echo "Latest version: " . $skill->latestVersion . "\n"; - echo "Created: " . $skill->createdAt . "\n"; + echo "Skill: {$skill->displayName}\n"; + echo "Latest version: {$skill->latestVersionID}\n"; + echo "Created: {$skill->createdAt->format(DATE_ATOM)}\n"; ``` ```ruby Ruby
from line 2721
``` ```bash CLI - ant skills delete \ - --skill-id skill_01AbCdEfGhIjKlMnOpQrStUv >/dev/null + ant skills delete --skill-id skill_01AbCdEfGhIjKlMnOpQrStUv >/dev/null ``` ```python Python
from line 2763
``` ```php PHP - // The PHP SDK exposes the Skills API under the beta namespace; field names can differ from other SDKs. $client = new Client(); - // In the beta namespace, a Skill's versions must be deleted before the Skill itself. - $skillId = 'skill_01AbCdEfGhIjKlMnOpQrStUv'; - foreach ($client->beta->skills->versions->list($skillId)->pagingEachItem() as $version) { - $client->beta->skills->versions->delete($version->version, skillID: $skillId); - } - $client->beta->skills->delete($skillId); + $client->skills->delete('skill_01AbCdEfGhIjKlMnOpQrStUv'); ``` ```ruby Ruby
from line 3203
``` ```php PHP - // The PHP SDK exposes the Skills API under the beta namespace; field names can differ from other SDKs. - // The PHP SDK supports container skills only through $client->beta->messages with the skills beta. use Anthropic\Core\FileParam; - // ... + $client = new Client(); // Create a new version - $newVersion = $client->beta->skills->versions->create( + $newVersion = $client->skills->versions->create( skillID: 'skill_01AbCdEfGhIjKlMnOpQrStUv', files: [ - FileParam::fromResource(fopen('financial_skill/SKILL.md', 'r'), 'financial_skill/SKILL.md', 'text/markdown'), - FileParam::fromResource(fopen('financial_skill/analyze.py', 'r'), 'financial_skill/analyze.py', 'text/x-python'), + FileParam::fromResource( + fopen('financial_skill/SKILL.md', 'r'), + filename: 'financial_skill/SKILL.md', + contentType: 'text/markdown', + ), + FileParam::fromResource( + fopen('financial_skill/analyze.py', 'r'), + filename: 'financial_skill/analyze.py', + contentType: 'text/x-python', + ), ], ); // Use specific version - $response = $client->beta->messages->create( + $response = $client->messages->create( maxTokens: 4096, messages: [['role' => 'user', 'content' => 'Use updated Skill']], model: 'claude-opus-5', - betas: ['code-execution-2025-08-25', 'skills-2025-10-02'], container: [ 'skills' => [[ 'type' => 'custom', - 'skill_id' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', - 'version' => $newVersion->version + 'skillID' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', + 'version' => $newVersion->id ]] ], tools: [['type' => 'code_execution_20250825', 'name' => 'code_execution']]
from line 3242
echo $response; // Use latest version - $latestResponse = $client->beta->messages->create( + $latestResponse = $client->messages->create( maxTokens: 4096, messages: [['role' => 'user', 'content' => 'Use latest Skill version']], model: 'claude-opus-5', - betas: ['code-execution-2025-08-25', 'skills-2025-10-02'], container: [ 'skills' => [[ 'type' => 'custom', - 'skill_id' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', + 'skillID' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', 'version' => 'latest' ]] ],
from line 3599
``` ```php PHP - // The PHP SDK supports container skills only through $client->beta->messages with the skills beta. $client = new Client(); // Custom DCF analysis Skill (ID obtained from Skills API create response) - $dcfSkillId = "skill_01AbCdEfGhIjKlMnOpQrStUv"; + $dcfSkillId = 'skill_01AbCdEfGhIjKlMnOpQrStUv'; // Use with Excel to create financial model - $message = $client->beta->messages->create( + $message = $client->messages->create( maxTokens: 4096, messages: [ ['role' => 'user', 'content' => 'Build a DCF valuation model for a SaaS company'] ], model: 'claude-opus-5', - betas: ['code-execution-2025-08-25', 'skills-2025-10-02'], container: [ 'skills' => [ - ['type' => 'anthropic', 'skill_id' => 'xlsx', 'version' => 'latest'], - ['type' => 'custom', 'skill_id' => $dcfSkillId, 'version' => 'latest'] + ['type' => 'anthropic', 'skillID' => 'xlsx', 'version' => 'latest'], + ['type' => 'custom', 'skillID' => $dcfSkillId, 'version' => 'latest'] ] ], tools: [
from line 3827
$container = [ 'skills' => [[ 'type' => 'custom', - 'skill_id' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', - 'version' => '1759178010641129' + 'skillID' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', + 'version' => 'skver_01AbCdEfGhIjKlMnOpQrStUv' ]] ]; ```
from line 3968
$container = [ 'skills' => [[ 'type' => 'custom', - 'skill_id' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', + 'skillID' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', 'version' => 'latest' ]] ];
from line 4306
``` ```php PHP - // The PHP SDK supports container skills only through $client->beta->messages with the skills beta. $client = new Client(); // Skills render into the system prompt in a fixed, cache-friendly order - $response1 = $client->beta->messages->create( + $response1 = $client->messages->create( maxTokens: 4096, messages: [ ['role' => 'user', 'content' => 'Analyze sales data'] ], model: 'claude-opus-5', - betas: [ - 'code-execution-2025-08-25', - 'skills-2025-10-02', - ], container: [ 'skills' => [ - ['type' => 'anthropic', 'skill_id' => 'xlsx', 'version' => 'latest'] + ['type' => 'anthropic', 'skillID' => 'xlsx', 'version' => 'latest'] ] ], tools: [
from line 4327
echo $response1; // Changing the Skills list ([xlsx] vs [xlsx, pptx]) changes the prefix: a cache miss, while an identical list is a cache hit - $response2 = $client->beta->messages->create( + $response2 = $client->messages->create( maxTokens: 4096, messages: [ ['role' => 'user', 'content' => 'Create a presentation'] ], model: 'claude-opus-5', - betas: [ - 'code-execution-2025-08-25', - 'skills-2025-10-02', - ], container: [ 'skills' => [ - ['type' => 'anthropic', 'skill_id' => 'xlsx', 'version' => 'latest'], - ['type' => 'anthropic', 'skill_id' => 'pptx', 'version' => 'latest'] + ['type' => 'anthropic', 'skillID' => 'xlsx', 'version' => 'latest'], + ['type' => 'anthropic', 'skillID' => 'pptx', 'version' => 'latest'] ] ], tools: [
from line 4588
``` ```php PHP - // The PHP SDK supports container skills only through $client->beta->messages with the skills beta. use Anthropic\Core\Exceptions\BadRequestException; $client = new Client(); try { - $message = $client->beta->messages->create( + $message = $client->messages->create( maxTokens: 4096, messages: [ ['role' => 'user', 'content' => 'Process data'] ], model: 'claude-opus-5', - betas: ['code-execution-2025-08-25', 'skills-2025-10-02'], container: [ 'skills' => [ [ 'type' => 'custom', - 'skill_id' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', + 'skillID' => 'skill_01AbCdEfGhIjKlMnOpQrStUv', 'version' => 'latest' ] ]
build-with-claude/token-counting Changed · +4 / -2 lines
from line 516
```python Python import base64 - import httpx + import httpx2 image_url = "https://platform.claude.com/docs/images/vision-example.jpg" image_media_type = "image/jpeg" - image_data = base64.standard_b64encode(httpx.get(image_url).content).decode("utf-8") + image_data = base64.standard_b64encode(httpx2.get(image_url).content).decode("utf-8") client = anthropic.Anthropic()
from line 771
```json Output { "input_tokens": 1028 } ``` + +An embedded image block that sets [`"oversized_image": "error"`](https://platform.claude.com/docs/en/build-with-claude/vision-coordinates#oversized-image-error) is rejected at count time exactly as the Messages API would reject it. ### Count tokens in messages with thinking
build-with-claude/vision Changed · +8 / -9 lines
from line 792
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. - // The PHP SDK supports file_id document and image sources only through $client->beta->messages with the files beta. + use Anthropic\Core\FileParam; + $client = new Client(); // Upload the image file - $fileUpload = $client->beta->files->upload( - FileParam::fromResource(fopen('vision-example.jpg', 'rb'), contentType: 'image/jpeg'), + $fileUpload = $client->files->upload( + file: FileParam::fromResource(fopen('vision-example.jpg', 'rb'), contentType: 'image/jpeg'), ); // Use the uploaded file in a message - $message = $client->beta->messages->create( + $message = $client->messages->create( maxTokens: 1024, messages: [ [
from line 810
'content' => [ [ 'type' => 'image', - 'source' => ['type' => 'file', 'file_id' => $fileUpload->id], + 'source' => ['type' => 'file', 'fileID' => $fileUpload->id], ], ['type' => 'text', 'text' => 'Describe this image.'], ],
from line 817
], ], model: 'claude-opus-5', - betas: ['files-api-2025-04-14'], ); echo json_encode($message, JSON_PRETTY_PRINT), PHP_EOL;
from line 1257
Claude views images in patches instead of pixels. Each patch is a 28×28-pixel block of the image, referred to as a visual token. An image, therefore, costs `⌈width / 28⌉ × ⌈height / 28⌉` visual tokens. -Each model has a maximum native image resolution, expressed as a long-edge limit and a visual-token limit. Images larger than either limit are downscaled before processing; see [How Claude resizes and pads images](https://platform.claude.com/docs/en/build-with-claude/vision-coordinates#how-claude-resizes-and-pads-images) for the exact rule. The exception is screenshots and zoom images that you return to the [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#handle-coordinate-scaling-for-higher-resolutions) and [browser use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool#targets-and-coordinates) toolsets: the API rejects a `tool_result` image that exceeds the model's limits with a validation error instead of downscaling it, so resize those images in your application before returning them. +Each model has a maximum native image resolution, expressed as a long-edge limit and a visual-token limit. Images larger than either limit are downscaled before processing; see [How Claude resizes and pads images](https://platform.claude.com/docs/en/build-with-claude/vision-coordinates#how-claude-resizes-and-pads-images) for the exact rule. The exception is screenshots and zoom images that you return to the [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#handle-coordinate-scaling-for-higher-resolutions) and [browser use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool#targets-and-coordinates) toolsets: the API rejects a `tool_result` image that exceeds the model's limits with a validation error instead of downscaling it, so resize those images in your application before returning them. To have any other oversized image rejected with an error instead of downscaled, set the image block's [`transformations` field](https://platform.claude.com/docs/en/build-with-claude/vision-coordinates#oversized-image-error). | Resolution tier | Models | Max long edge | Max visual tokens | | --------------- | --------------------------- | ------------- | ----------------- |
from line 1289
* **Image clarity:** Ensure images are clear and not too blurry or pixelated. * **Text:** If the image contains important text, make sure it's legible and not too small. Avoid cropping out key visual context solely to enlarge the text. -* **Resizing:** Take into account that your image might be resized if it is too large (see [Resolution and token cost](https://platform.claude.com/docs/en/build-with-claude/vision#evaluate-image-size)); this might, for example, make text less legible. Consider pre-resizing your images, cropping them, or both. +* **Resizing:** Take into account that your image might be resized if it is too large (see [Resolution and token cost](https://platform.claude.com/docs/en/build-with-claude/vision#evaluate-image-size)); this might, for example, make text less legible. Consider pre-resizing your images, cropping them, or both. To have an oversized image rejected with an error instead of resized (important for [coordinate workflows](https://platform.claude.com/docs/en/build-with-claude/vision-coordinates)), mark the image block with [`"oversized_image": "error"`](https://platform.claude.com/docs/en/build-with-claude/vision-coordinates#oversized-image-error). * **Image compression:** Compressing images before sending them, using a lossy format such as JPEG or WebP (lossy mode), can reduce latency by reducing the size of requests. However, this can introduce artifacts that are detrimental to model performance, especially when multiple compression passes are applied. For example, heavy JPEG compression can make text difficult to read. Confirm your compression settings are appropriate for the task by inspecting the actual images sent to the API. ***
build-with-claude/vision-coordinates Changed · +31 / -1 lines
## Turn resizing into an error with `transformations`
from line 444
The [Token counting](https://platform.claude.com/docs/en/build-with-claude/token-counting) endpoint estimates an image's token cost from its dimensions without fully processing it, so a successful count doesn't mean the image is within the Messages API's [request limits](https://platform.claude.com/docs/en/build-with-claude/vision#request-limits). An image can count successfully and still be rejected when you send it. </Note> +## Turn resizing into an error with `transformations` + +Pre-resizing only protects your coordinates while your pipeline keeps producing the right sizes. A new image source or a switch to a model on a different resolution tier can quietly reintroduce server-side resizing. To turn that silent drift into a visible error, set the optional `transformations` field on an image content block in a [Messages](https://platform.claude.com/docs/en/api/messages) request: + +```json +{ + "type": "image", + "source": { "type": "base64", "media_type": "image/png", "data": "..." }, + "transformations": { "oversized_image": "error" } +} +``` + +A request whose marked image (any block that sets `"oversized_image": "error"`) would be resized is rejected with a 400 `invalid_request_error` naming the image's dimensions and the largest dimensions that fit. Whether an image triggers the rejection depends on the [limits of every model the request names](https://platform.claude.com/docs/en/build-with-claude/vision-coordinates#how-claude-resizes-and-pads-images): the 1920×1080 example below is rejected by a standard-tier model but fits within the high-resolution tier: + +```text wrap +messages.0.content.0: image dimensions 1920x1080 exceed the maximum image size of a model named on this request and would be downsized to 1456x819; scale the image to at most 1456x819 or set the image's oversized_image setting to "downsize" +``` + +Rescale to the reported target and resend: the target is the largest size, at your image's aspect ratio, that every model named on the request accepts. How marked images interact with the [server-side fallback beta](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback#server-side-fallback) is described with that feature; in every mode, a marked image is never served resized. + +The setting is per image. `"oversized_image": "downsize"` (the default when the field is omitted) keeps automatic resizing as described on this page. Each image block is checked only against its own setting, so one request can mix images whose dimensions are load-bearing (a screenshot you'll click on) with images where resizing is harmless (a logo). What the setting does and does not change: + +* Padding ([which never discards content](https://platform.claude.com/docs/en/build-with-claude/vision-coordinates#how-claude-resizes-and-pads-images)), format conversion, and orientation correction proceed as usual. +* The hard limits (8000 px on the longest side, and the stricter per-image limit on [many-image requests](https://platform.claude.com/docs/en/build-with-claude/vision#request-limits)) are separate rejections; this setting never lets an image past them. +* Images supplied by URL or file ID are checked once their bytes have been fetched; those rejections carry the same message without the leading position, so they don't identify which image failed; only embedded base64 images are named by position in the error. +* [PDF pages](https://platform.claude.com/docs/en/build-with-claude/pdf-support) are rasterized server-side at dimensions you don't control; the `document` block does not accept the field (an image block nested inside a document's content accepts it like any other). +* A marked image whose dimensions cannot be determined is rejected rather than passed through: that rejection reports that the image's source dimensions could not be determined, not the resize message quoted above. No image that sets `"error"` reaches the model resized. + +The [Token counting](https://platform.claude.com/docs/en/build-with-claude/token-counting) endpoint honors `transformations` too, rejecting an embedded image exactly as the Messages API would, so you can check whether an embedded image fits without being resized, before running inference. Counting never fetches images supplied by URL or file ID, so a marked image from those sources is checked only at Messages time, as described above. + ## Rescale coordinates when you cannot pre-resize -If you cannot pre-resize (for example, when the image comes from an upstream system you can't modify), use the resize helper from [Resize your image before uploading](https://platform.claude.com/docs/en/build-with-claude/vision-coordinates#resize-your-image-before-uploading) to recover the dimensions Claude saw, then map the coordinates Claude returns into normalized coordinates or back onto your original image. Claude resizes oversized images rather than rejecting them, up to the API's [request limits](https://platform.claude.com/docs/en/build-with-claude/vision#request-limits). Beyond those limits the request fails with a validation error instead. Pass the tier limits that match the model you called: the wrong tier's limits recover the wrong resized dimensions and silently shift every coordinate. This approach requires knowing the pixel dimensions of the image you uploaded, so it does not apply to PDF uploads. +If you cannot pre-resize (for example, when the image comes from an upstream system you can't modify), use the resize helper from [Resize your image before uploading](https://platform.claude.com/docs/en/build-with-claude/vision-coordinates#resize-your-image-before-uploading) to recover the dimensions Claude saw, then map the coordinates Claude returns into normalized coordinates or back onto your original image. Unless an image [opts into an error instead](https://platform.claude.com/docs/en/build-with-claude/vision-coordinates#oversized-image-error), Claude resizes oversized images rather than rejecting them, up to the API's [request limits](https://platform.claude.com/docs/en/build-with-claude/vision#request-limits). Beyond those limits the request fails with a validation error instead. Pass the tier limits that match the model you called: the wrong tier's limits recover the wrong resized dimensions and silently shift every coordinate. This approach requires knowing the pixel dimensions of the image you uploaded, so it does not apply to PDF uploads. Screenshots and zoom images that you return to the [computer use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#handle-coordinate-scaling-for-higher-resolutions) and [browser use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool#targets-and-coordinates) toolsets are an exception to automatic resizing. The API rejects a `tool_result` image that exceeds the model's limits with a validation error instead of resizing it. Resize those images in your application before returning them, then scale the coordinates Claude returns back to your screen's dimensions.
claude_api_primer Changed · +3 / -4 lines
from line 181
```python Python import anthropic import base64 - import httpx + import httpx2 # Option 1: Base64-encoded image image_url = "https://platform.claude.com/docs/images/vision-example.jpg" image_media_type = "image/jpeg" - image_data = base64.standard_b64encode(httpx.get(image_url).content).decode("utf-8") + image_data = base64.standard_b64encode(httpx2.get(image_url).content).decode("utf-8") message = anthropic.Anthropic().messages.create( model="claude-opus-5",
from line 262
<CodeGroup exclude="shell:cURL, typescript, csharp, go, java, php, ruby"> ```bash CLI - ant messages create \ - --transform content --format yaml <<'YAML' + ant messages create --transform content --format yaml <<'YAML' model: claude-opus-5 max_tokens: 16000 thinking:
cli-sdks-libraries/sdks/python Changed · +20 / -18 lines
from line 36
## Requirements -Python 3.9 or later is required. +Python 3.10 or later is required. If you are upgrading from a 0.x release of the SDK, see the [v1 migration guide](https://github.com/anthropics/anthropic-sdk-python/blob/main/MIGRATION.md) for the list of breaking changes. ## Usage
from line 102
### Using aiohttp for better concurrency -For improved async performance, you can use the `aiohttp` HTTP backend instead of the default `httpx`: +For improved async performance, you can use the `aiohttp` HTTP backend instead of the default `httpx2`: ```python import os
from line 362
) except anthropic.APIConnectionError as e: print("The server could not be reached") - print(e.__cause__) # an underlying Exception, likely raised within httpx + print(e.__cause__) # an underlying Exception, likely raised within httpx2 except anthropic.RateLimitError as e: print("A 429 status code was received; we should back off a bit.") except anthropic.APIStatusError as e:
from line 426
## Timeouts -By default requests time out after 10 minutes. You can configure this with a `timeout` option, which accepts a float or an `httpx.Timeout` object: +By default requests time out after 10 minutes. You can configure this with a `timeout` option, which accepts a float or an `httpx2.Timeout` object: ```python -import httpx +import httpx2 from anthropic import Anthropic # Configure the default for all requests:
from line 439
# More granular control: client = Anthropic( - timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0), + timeout=httpx2.Timeout(60.0, read=5.0, write=10.0, connect=2.0), ) # Override per-request:
from line 588
### Accessing raw response data (for example, headers) -The "raw" `Response` returned by `httpx` can be accessed through the `.with_raw_response` property on the client. This is useful for accessing response headers or other metadata: +The "raw" `Response` returned by `httpx2` can be accessed through the `.with_raw_response` property on the client. This is useful for accessing response headers or other metadata: ```python client = Anthropic()
from line 606
print(message.content) ``` -These methods return an `APIResponse` object. +These methods return an `APIResponse` object. On the async client they return an `AsyncAPIResponse`, and `.parse()`, `.read()`, `.text()`, and `.json()` must be awaited. ### Streaming response body
from line 645
To make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs. Options on the client, such as retries, are respected when making these requests. ```python -import httpx +import httpx2 response = client.post( "/foo", - cast_to=httpx.Response, + cast_to=httpx2.Response, body={"my_param": True}, )
from line 670
### Configuring the HTTP client -You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including support for proxies and transports: +The SDK sends requests with [httpx2](https://httpx2.pydantic.dev), an API-compatible fork of `httpx`. To customize the HTTP client, including proxies and transports, pass your own [httpx2 client](https://httpx2.pydantic.dev/api/#client) as `http_client`: ```python -import httpx +import httpx2 from anthropic import Anthropic, DefaultHttpxClient client = Anthropic(
from line 681
base_url="http://my.test.server.example.com:8083", http_client=DefaultHttpxClient( proxy="http://my.test.proxy.example.com", - transport=httpx.HTTPTransport(local_address="0.0.0.0"), + transport=httpx2.HTTPTransport(local_address="0.0.0.0"), ), ) ```
from line 693
``` <Note> - Use `DefaultHttpxClient` and `DefaultAsyncHttpxClient` instead of raw `httpx.Client` and `httpx.AsyncClient` to ensure the SDK's default configuration (such as timeouts and connection limits) is preserved. + Use `DefaultHttpxClient` and `DefaultAsyncHttpxClient` instead of raw `httpx2.Client` and `httpx2.AsyncClient` to ensure the SDK's default configuration (such as timeouts and connection limits) is preserved. The `http_client` argument must be an `httpx2` client. Passing a client from the separate `httpx` package raises a `TypeError`. </Note> + +Tracing and mocking tools that patch `httpx` itself, such as OpenTelemetry's `HTTPXClientInstrumentor`, Sentry's `httpx` integration, `respx`, or `pytest-httpx`, do not see the SDK's requests by default. To use them, call `httpx2.alias_httpx()` once at startup, before anything imports `httpx`. This makes `import httpx` resolve to `httpx2` for the whole process. ### Managing HTTP resources
manage-claude/compliance-activity-feed Changed · +4 / -2 lines
from line 14
Both Compliance Access Keys (`sk-ant-api01-...`) carrying this scope and Admin API keys (`sk-ant-admin01-...`) can call the Activity Feed. See [Set up the Compliance API](https://platform.claude.com/docs/en/manage-claude/compliance-api-access) for the conditions under which each key type carries the scope. </Check> -The Activity Feed records every authentication, chat, file, project, administrative, and platform action that occurs in your organization, in reverse chronological order. Activities are queryable within 1 minute of occurring and are retained for 6 years. +The Activity Feed records authentication, chat, file, project, administrative, and platform activity across your organization and returns it in reverse chronological order. Activities are queryable within 1 minute of occurring and are retained for 6 years. ```bash cURL curl --fail-with-body -sS \
from line 150
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | `user_actor` | A signed-in claude.ai or Claude Console user took the action. | `email_address`, `user_id`, `ip_address`, `user_agent` | | `api_actor` | A request called the Claude API or the Compliance API with a customer-issued API key. Compliance API calls produce this actor type for both Compliance Access Keys and Admin API keys. | `api_key_id`, `ip_address`, `user_agent` | -| `admin_api_key_actor` | An organization admin used an Admin API key to manage users, invites, workspaces, or API keys. | `admin_api_key_id` | +| `admin_api_key_actor` | An organization admin used an Admin API key to manage users, invites, workspaces, or API keys. | `admin_api_key_id`, `ip_address`, `user_agent` | | `unauthenticated_user_actor` | An action occurred before sign-in completed, for example `sso_login_initiated`. | `unauthenticated_email_address`, `ip_address`, `user_agent` | | `anthropic_actor` | Anthropic acted on the organization, for example through internal tooling. | `email_address` (always `null`; present for shape consistency with `user_actor`, because Anthropic operators are not represented by individual email) | | `scim_directory_sync_actor` | An identity provider (such as Okta, Microsoft Entra ID, or JumpCloud) pushed a change through SCIM directory sync. | `workos_event_id`, `directory_id`, `idp_connection_type` (nullable; for example `OktaSCIMV2`, `AzureSCIMV2`) | + +A `claude_*_viewed` activity means a Claude app loaded content, not that a person viewed it. Types such as `claude_chat_viewed`, `claude_file_viewed`, and `claude_project_viewed` are recorded each time a Claude app loads the chat, file, or project from Anthropic's servers. Repeated loads are not deduplicated. The web, desktop, and mobile apps load content at different moments, sometimes in the background, and can display a cached copy without loading it. Counts of these activities vary by platform as a result, and they do not correspond to messages sent or screens viewed. <Note> **Build forward-compatible handlers.** Pass through unrecognized `type` and `actor.type` values, and ignore fields your handler does not expect, so your integration keeps working when new activity types ship.
manage-claude/compliance-integration-patterns Changed · +10 / -7 lines
from line 94
Each `Activity` carries fields you can join against events already in your SIEM (Splunk, Datadog, Microsoft Sentinel, Cribl, or similar): -| Compliance API field | Join target | -| --------------------- | ----------------------------------------------- | -| `actor.user_id` | Your identity provider's stable user identifier | -| `actor.email_address` | Directory email when a stable ID is unavailable | -| `actor.ip_address` | Network, VPN, and endpoint logs | -| `created_at` | Time-window correlation across any source | +| Compliance API field | Join target | +| --------------------- | ----------------------------------------------------------------------- | +| `actor.user_id` | Your identity provider's stable user identifier | +| `actor.email_address` | Directory email when a stable ID is unavailable | +| `actor.ip_address` | Network, VPN, and endpoint logs | +| `actor.user_agent` | Endpoint and device inventory, and the client app that made the request | +| `created_at` | Time-window correlation across any source | -`actor.user_id` and `actor.email_address` are present when `actor.type` is `user_actor`; check the discriminator before reading them. `user_id` is a stable, opaque identifier for the user account: it is consistent across every Compliance API endpoint and activity payload, and it does not change when the user's email or display name changes. Use `user_id`, not `email_address`, as the primary join key. +`actor.user_id` and `actor.email_address` are present when `actor.type` is `user_actor`. `actor.ip_address` and `actor.user_agent` are absent on some actor types, such as `anthropic_actor` and `scim_directory_sync_actor`. Check the discriminator before reading any of these fields. `user_id` is a stable, opaque identifier for the user account: it is consistent across every Compliance API endpoint and activity payload, and it does not change when the user's email or display name changes. Use `user_id`, not `email_address`, as the primary join key. Calls to the Compliance API itself emit `compliance_api_accessed` activities. Ingest these alongside other activity types so your SIEM records who queried compliance data, and when. Pass `activity_types[]=compliance_api_accessed` to scope the query, then in your client, read `actor.api_key_id` from each activity whose `actor.type` is `api_actor` to attribute the access to a specific Compliance Access Key or Admin API key.
from line 137
* The starting cursor and the terminal `last_id`. * The number of records exported. * The run timestamp and the `request-id` of the final page. + +Activity volume is not a completeness check. The `claude_*_viewed` activity types, such as `claude_chat_viewed`, follow each app's loading pattern (see [Understand the Activity object](https://platform.claude.com/docs/en/manage-claude/compliance-activity-feed#understand-the-activity-object)). A period with chat messages but no `claude_chat_viewed` activities does not on its own indicate missing data. Rely on the traversal and the overlap or reconciliation pass described in [Window polling](https://platform.claude.com/docs/en/manage-claude/compliance-integration-patterns#window-polling) instead. The content endpoints (chats, files, projects, project attachments, and local and remote session transcripts) serve Claude Enterprise data only. The Activity Feed surfaces administrative and resource events organization-wide. The Compliance API does not include:
managed-agents/cloud-sandboxes-reference Changed · +37 / -25 lines
### Document and media processing ### Browser automation
from line 14
## Programming languages -| Language | Version | Package manager | -| -------- | ------- | --------------- | -| Python | 3.12+ | pip, uv | -| Node.js | 20+ | npm, yarn, pnpm | -| Go | 1.22+ | go modules | -| Rust | 1.77+ | cargo | -| Java | 21+ | maven, gradle | -| Ruby | 3.3+ | bundler, gem | -| PHP | 8.3+ | composer | -| C/C++ | GCC 13+ | make, cmake | +| Language | Version | Package manager | +| -------- | --------------------------- | -------------------- | +| Python | 3.10, 3.11, 3.12, and 3.13 | pip, uv, poetry | +| Node.js | 20, 21, and 22 (default) | npm, yarn, pnpm, bun | +| Go | 1.24 (default) and 1.25 | go modules | +| Rust | Stable toolchain (rustup) | cargo | +| Java | OpenJDK 21 | maven, gradle | +| Ruby | 3.1, 3.2, and 3.3 (default) | bundler, gem | +| PHP | 8.3 | composer | +| C/C++ | GCC 13 and Clang | make, cmake, ninja | +Common Python data and document libraries, including NumPy, pandas, Matplotlib, openpyxl, python-docx, python-pptx, and pypdf, are installed for the `python3` interpreter. + ## Databases -| Database | Description | -| ----------------- | -------------------------------------------------- | -| SQLite | Pre-installed, available immediately | -| PostgreSQL client | `psql` client for connecting to external databases | -| Redis client | `redis-cli` for connecting to external instances | +| Database | Description | +| ------------- | ----------------------------------------------------------------------------- | +| PostgreSQL 16 | Server and `psql` client are installed. The server is not running by default. | +| Redis 7 | Server and `redis-cli` are installed. The server is not running by default. | +| SQLite | Available through language bindings, such as Python's `sqlite3` module. | -<Note> - Database servers (such as PostgreSQL and Redis) are not running in the sandbox by default. The sandbox includes client tools for connecting to external database instances. SQLite is fully available for local use. -</Note> - ## Utilities ### System tools
from line 41
* `git` - Version control * `curl`, `wget` - HTTP clients -* `jq` - JSON processing +* `jq`, `yq` - JSON and YAML processing * `tar`, `zip`, `unzip` - Archive tools -* `ssh`, `scp` - Remote access (requires a networking mode that allows the destination host) -* `tmux`, `screen` - Terminal multiplexers +* `tmux` - Terminal multiplexer ### Development tools
from line 50
* `make`, `cmake` - Build systems * `docker` - Container management (limited availability) * `ripgrep` (`rg`) - Fast file search -* `tree` - Directory visualization -* `htop` - Process monitoring ### Text processing
from line 57
* `vim`, `nano` - Text editors * `diff`, `patch` - File comparison +### Document and media processing + +* `ffmpeg` - Audio and video processing +* ImageMagick (`convert`, `identify`) - Image manipulation +* `pandoc` - Document conversion +* LibreOffice (headless) - Office document conversion +* Poppler utilities (`pdftotext`, `pdftoppm`) and `qpdf` - PDF processing +* `tesseract` - Optical character recognition (English language data) +* TeX Live (`pdflatex`, `xelatex`, `latexmk`) - Typesetting + +### Browser automation + +* Playwright (Python and Node.js) - Browser automation library +* Chromium (`/opt/pw-browsers/chromium`) - Browser used by Playwright, not on `PATH` + +The sandbox sets `PLAYWRIGHT_BROWSERS_PATH` to `/opt/pw-browsers`, so the pre-installed Playwright packages find Chromium there without configuration. The Python package is installed for the `python3` interpreter. Use the pre-installed packages rather than installing another Playwright version, which would look for a browser build that is not present. Firefox and WebKit are not installed. + ## Sandbox specifications | Property | Value | | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Operating system | Ubuntu 22.04 LTS | +| Operating system | Ubuntu 24.04 LTS | | Architecture | x86\_64 (amd64) | | Memory | Up to 8 GB | | Disk space | Up to 10 GB |
about-claude/models/introducing-claude-fable-5-and-claude-mythos-5 Changed · +2 / -2 lines
from line 50
Claude Fable 5 and Claude Mythos 5 both become available on June 9, 2026: -* **Claude Fable 5** is generally available on the Claude API, [Amazon Bedrock](https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon-bedrock), [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws), [Google Cloud](https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai), and [Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry). -* **Claude Mythos 5** is not generally available: it is offered in limited availability to approved customers in [Project Glasswing](https://anthropic.com/glasswing). For access, contact your Anthropic, AWS, or Google Cloud account team. Customers without access to Claude Mythos 5 can use Claude Fable 5, which is generally available and offers the same capabilities. +* **Claude Fable 5** is available on the Claude API, [Amazon Bedrock](https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon-bedrock), [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws), [Google Cloud](https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai), and [Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry). +* **Claude Mythos 5** is offered only to approved customers in [Project Glasswing](https://anthropic.com/glasswing). For access, contact your Anthropic, AWS, or Google Cloud account team. Customers without access to Claude Mythos 5 can use Claude Fable 5, which does not require access approval and offers the same capabilities. Claude Fable 5 and Claude Mythos 5 carry 30-day data retention and are not available under zero data retention: both are designated [Covered Models](https://support.claude.com/en/articles/15425695). See [Model-specific data retention requirements](https://platform.claude.com/docs/en/manage-claude/api-and-data-retention#model-specific-data-retention-requirements).
managed-agents/define-outcomes Changed · +7 / -11 lines
from line 238
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. use Anthropic\Client; use Anthropic\Core\FileParam;
from line 255
MD; file_put_contents('/tmp/rubric.md', $rubricText); - $rubric = $client->beta->files->upload( + $rubric = $client->files->upload( file: FileParam::fromResource(fopen('/tmp/rubric.md', 'r'), contentType: 'text/markdown'), ); echo "Uploaded rubric: {$rubric->id}\n";
from line 335
--transform id --raw-output) # Define the outcome — agent starts working on receipt - ant beta:sessions:events send \ - --session-id "$SESSION_ID" <<YAML + ant beta:sessions:events send --session-id "$SESSION_ID" <<YAML events: - type: user.define_outcome description: Build a DCF model for Costco in .xlsx
from line 710
## Retrieve deliverables -The agent writes output files to `/mnt/session/outputs/` inside the sandbox. Once the session is idle, fetch them through the [Files API](https://platform.claude.com/docs/en/build-with-claude/files) scoped to the session. Filtering by `scope_id` requires the `managed-agents-2026-04-01` beta header on the list request, so the SDK and CLI examples make that call through the `beta` namespace and pass the header explicitly. +The agent writes output files to `/mnt/session/outputs/` inside the sandbox. To retrieve them, list files through the [Files API](https://platform.claude.com/docs/en/build-with-claude/files) with the session ID as the `scope_id`, then download them by ID. Filtering by `scope_id` requires the `managed-agents-2026-04-01` beta header on the list request, so the SDK and CLI examples make that call through the `beta` namespace and pass the header explicitly. Files appear in the list shortly after the agent finishes writing them, sometimes a few seconds after the session goes idle. If a file you expect is not listed yet, list again after a short delay; once it appears in the list, its upload has finished. <CodeGroup> ```bash cURL
from line 736
```bash CLI # List files produced by this session # scope_id filtering requires the managed-agents beta on the files request - ant beta:files list --scope-id "$SESSION_ID" \ - --beta managed-agents-2026-04-01 + ant beta:files list --scope-id "$SESSION_ID" --beta managed-agents-2026-04-01 # Download a file FILE_ID=$(ant beta:files list --scope-id "$SESSION_ID" \
from line 855
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. // List files produced by this session // scope_id filtering requires the managed-agents beta on the files request $files = $client->beta->files->list(scopeID: $session->id, betas: ['managed-agents-2026-04-01']); - foreach ($files->data as $file) { + foreach ($files->getItems() as $file) { echo "{$file->id} {$file->filename}\n"; } // Download a file - if (count($files->data) > 0) { - $content = $client->beta->files->download($files->data[0]->id); + if (count($files->getItems()) > 0) { + $content = $client->files->download($files->getItems()[0]->id); file_put_contents('/tmp/output.txt', $content); } ```
managed-agents/environments Changed · +5 / -7 lines
from line 161
``` ```bash CLI - ant beta:sessions create \ - --agent "$AGENT_ID" \ - --environment-id "$ENVIRONMENT_ID" + ant beta:sessions create --agent "$AGENT_ID" --environment-id "$ENVIRONMENT_ID" ``` ```python Python
from line 388
| Field | Package manager | Example | | ------- | ------------------------- | ------------------------------------------- | -| `apt` | System packages (apt-get) | `"ffmpeg"` | -| `cargo` | Rust (cargo) | `"[email protected]"` | +| `apt` | System packages (apt-get) | `"graphviz"` | +| `cargo` | Rust (cargo) | `"[email protected]"` | | `gem` | Ruby (gem) | `"rails:7.1.0"` | | `go` | Go modules | `"golang.org/x/tools/cmd/goimports@latest"` | | `npm` | Node.js (npm) | `"[email protected]"` | -| `pip` | Python (pip) | `"pandas==2.2.0"` | +| `pip` | Python (pip) | `"sqlalchemy==2.0.30"` | ### Networking
from line 720
## Pre-installed runtimes -Cloud sandboxes include common runtimes out of the box. See [Cloud sandbox reference](https://platform.claude.com/docs/en/managed-agents/cloud-sandboxes-reference) for the full list of pre-installed languages, databases, and utilities. +Cloud sandboxes include common language runtimes, databases, and command-line tools out of the box. See [Cloud sandbox reference](https://platform.claude.com/docs/en/managed-agents/cloud-sandboxes-reference) for the full list. ## Next steps
managed-agents/files Changed · +15 / -14 lines
from line 24
``` ```bash CLI - FILE_ID=$(ant files upload \ - --file data.csv \ - --transform id --raw-output) + FILE_ID=$(ant files upload --file data.csv --transform id --raw-output) ``` ```python Python
from line 69
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. - $file = $client->beta->files->upload( - FileParam::fromResource(fopen($csvPath, 'r'), filename: 'data.csv', contentType: 'text/csv'), + $file = $client->files->upload( + file: FileParam::fromResource(fopen($csvPath, 'r'), filename: 'data.csv', contentType: 'text/csv'), ); echo "File ID: {$file->id}\n"; ```
from line 314
```php PHP $resources = [ - ['type' => 'file', 'file_id' => 'file_abc123', 'mount_path' => '/data.csv'], - ['type' => 'file', 'file_id' => 'file_def456', 'mount_path' => '/config.json'], - ['type' => 'file', 'file_id' => 'file_ghi789', 'mount_path' => '/src/main.py'], + ['type' => 'file', 'fileID' => 'file_abc123', 'mountPath' => '/data.csv'], + ['type' => 'file', 'fileID' => 'file_def456', 'mountPath' => '/config.json'], + ['type' => 'file', 'fileID' => 'file_ghi789', 'mountPath' => '/src/main.py'], ]; ```
from line 535
## Listing and downloading session files -Use the [Files API](https://platform.claude.com/docs/en/build-with-claude/files) to list files scoped to a session and download them. Filtering by `scope_id` requires the `managed-agents-2026-04-01` beta header, so the list examples use the `beta` files namespace and pass that header explicitly. +Use the [Files API](https://platform.claude.com/docs/en/build-with-claude/files) to list files scoped to a session and download them. Files the agent writes to `/mnt/session/outputs/` appear in the list shortly after the agent finishes writing them, sometimes a few seconds after the session goes idle. If an output file you expect is missing, list again after a short delay; once it appears in the list, its upload has finished. +Filtering by `scope_id` requires the `managed-agents-2026-04-01` beta header, so the list examples use the `beta` files namespace and pass that header explicitly. + <CodeGroup> ```bash cURL # List files associated with a session
from line 556
```bash CLI # List files associated with a session - ant beta:files list --scope-id sesn_abc123 \ - --beta managed-agents-2026-04-01 + ant beta:files list --scope-id sesn_abc123 --beta managed-agents-2026-04-01 # Download a file ant files download --file-id "$FILE_ID" --output output.txt
from line 649
``` ```php PHP - // The PHP SDK exposes the Files API under the beta namespace; field names can differ from other SDKs. // List files associated with a session $files = $client->beta->files->list( scopeID: 'sesn_abc123', betas: ['managed-agents-2026-04-01'], ); + foreach ($files->getItems() as $file) { + echo "{$file->id} {$file->filename}\n"; + } // Download a file - $content = $client->beta->files->download($files->data[0]->id); + $content = $client->files->download($files->getItems()[0]->id); file_put_contents('output.txt', $content); ```
from line 696
* If you omit `mount_path`, the file is placed at `/mnt/session/uploads/<file_id>` * Parent directories are created automatically * Paths should be absolute (starting with `/`) +* Files the agent writes to `/mnt/session/outputs/` become available through the Files API, scoped to the session; see [Listing and downloading session files](https://platform.claude.com/docs/en/managed-agents/files#listing-and-downloading-session-files)
managed-agents/github Changed · +10 / -4 lines
from line 389
``` </CodeGroup> -The `resources[].authorization_token` authenticates the repository clone operation and is not echoed in API responses. +A `github_repository` resource accepts the following fields: +| Field | Description | +| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | Required. Must be `"github_repository"`. | +| `url` | Required. The repository's HTTPS URL in the form `https://github.com/<owner>/<repo>`, without a `.git` suffix. Other forms, including SSH URLs, are rejected with an `invalid_request_error`. | +| `authorization_token` | Required. The GitHub token used to clone the repository. It is not echoed in API responses. See [Token permissions](https://platform.claude.com/docs/en/managed-agents/github#token-permissions). | +| `mount_path` | Optional. The directory under `/workspace` to clone the repository into. Defaults to `/workspace/<repo-name>`. | +| `checkout` | Optional. A branch (`{"type": "branch", "name": "main"}`) or commit (`{"type": "commit", "sha": "..."}`) to check out. Defaults to the repository's default branch. | + Mounting a repository also loads any skills stored in its root `.claude/skills` directory. Skills are discovered once per session, from the repository state checked out at session start. See [Load skills from a GitHub repository](https://platform.claude.com/docs/en/managed-agents/skills#load-skills-from-a-github-repository). ## Token permissions
from line 753
``` ```bash CLI - ant beta:sessions:events send \ - --session-id "$SESSION_ID" \ - > /dev/null <<'EOF' + ant beta:sessions:events send --session-id "$SESSION_ID" > /dev/null <<'EOF' events: - type: user.message content:
managed-agents/session-operations Changed · +5 / -5 lines
from line 29
The semantics of a `tools` or `mcp_servers` update are full replacement: the provided array is the new value. To preserve existing entries, `GET` the session, modify the array, and `POST` it back. -The session must be `idle` to update the agent. [Interrupt](https://platform.claude.com/docs/en/managed-agents/events-and-streaming#integrating-events) the session if you need to update the agent while it's running. +The session must be `idle` to update the agent. To update the agent while the session is running, send a [`user.interrupt` event](https://platform.claude.com/docs/en/managed-agents/events-and-streaming#integrating-events) by itself and wait for the session to become `idle`. <CodeGroup defaultLanguage="CLI"> ```bash cURL
from line 532
## Archiving a session -Archive a session to prevent new events from being sent while preserving its history. A `running` session cannot be archived; send an [interrupt event](https://platform.claude.com/docs/en/managed-agents/events-and-streaming#integrating-events) if you need to archive it immediately. +Archive a session to prevent new events from being sent while preserving its history. A `running` session cannot be archived; to archive one, send a [`user.interrupt` event](https://platform.claude.com/docs/en/managed-agents/events-and-streaming#integrating-events) by itself and wait for the session to become `idle`. <CodeGroup defaultLanguage="CLI"> ```bash cURL
from line 581
## Deleting a session -Delete a session to permanently remove its record, events, and associated sandbox. A `running` session cannot be deleted; send an [interrupt event](https://platform.claude.com/docs/en/managed-agents/events-and-streaming#integrating-events) if you need to delete it immediately. +Delete a session to permanently remove its record, events, and associated sandbox. A `running` session cannot be deleted; to delete one, send a [`user.interrupt` event](https://platform.claude.com/docs/en/managed-agents/events-and-streaming#integrating-events) by itself and wait for the session to become `idle`. -Memory stores, vaults, skills, environments, and agents are independent resources and are not affected by session deletion. Files you uploaded through the Files API are also unaffected, but files the session itself produced are scoped to it and are permanently deleted along with its filesystem. Download anything you need to keep before deleting the session. +Memory stores, vaults, skills, environments, and agents are independent resources and are not affected by session deletion. Files you uploaded through the Files API are also unaffected, but files the session itself produced are scoped to it and are permanently deleted along with its filesystem. Download anything you need to keep before deleting the session. An output file written at the end of the last turn can take a few seconds after the session goes idle to appear in the [session's file list](https://platform.claude.com/docs/en/managed-agents/files#listing-and-downloading-session-files), so check that the files you expect are listed first. <CodeGroup defaultLanguage="CLI"> ```bash cURL
release-notes/overview Changed · +29 / -25 lines
### August 20, 2026
from line 12
For updates to Claude Code, see the [complete CHANGELOG.md](https://github.com/anthropics/claude-code/blob/main/CHANGELOG.md) in the `claude-code` repository. </Tip> +### August 20, 2026 + +* We've released **v1.0 of the [Python SDK](https://platform.claude.com/docs/en/cli-sdks-libraries/sdks/python)**. The SDK's HTTP layer moves from `httpx` to [httpx2](https://httpx2.pydantic.dev), a maintained, API-compatible fork: build custom `http_client`, `Timeout`, and transport objects from `httpx2` (the `DefaultHttpxClient` helpers are unchanged), and call `httpx2.alias_httpx()` at startup if you rely on tracing or mocking libraries that patch `httpx`. v1.0 requires Python 3.10 or later and removes long-deprecated surface, including the legacy Text Completions API, the `temperature`, `top_p`, and `top_k` parameters on Messages methods, and the tool runner's client-side `compaction_control`. On the async client, `.with_raw_response` results now need `await response.parse()`, and `AnthropicBedrock` now raises an error when no AWS region is configured instead of defaulting to `us-east-1`. See the [v1 migration guide](https://github.com/anthropics/anthropic-sdk-python/blob/main/MIGRATION.md) for every change with before-and-after snippets. + ### August 19, 2026 -* The [computer use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) is now generally available on the Claude API as the `computer_toolset_20260801` toolset: no beta header, batch actions (several actions in one turn), `zoom` enabled by default, and per-member configuration through `configs`. Earlier beta versions remain available. Upgrading an existing integration changes the request shape and tool handling; see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). +* The [computer use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool) is out of beta on the Claude API as the `computer_toolset_20260801` toolset: no beta header, batch actions (several actions in one turn), `zoom` enabled by default, and per-member configuration through `configs`. Earlier beta versions remain available. Upgrading an existing integration changes the request shape and tool handling; see [Migrate from `computer_20251124`](https://platform.claude.com/docs/en/agents-and-tools/tool-use/computer-use-tool#migrate-from-computer-20251124). * We've launched the [browser use tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/browser-use-tool) (`browser_toolset_20260801`), a client toolset for driving a browser that your application hosts. It works inside a browser viewport rather than a whole desktop, reading the page itself (its accessibility tree, elements, forms, and tabs) and adding element references, form input, tab management, download reporting, and opt-in file upload on top of screenshot-and-click control. * Both toolsets are available for Claude Fable 5, Claude Mythos 5, Claude Opus 5, Claude Sonnet 5, and Claude Opus 4.8 on the Claude API. -* The [Files API](https://platform.claude.com/docs/en/build-with-claude/files) is now generally available on the Claude API. Requests to the `/v1/files` endpoints, and Messages API requests that reference an uploaded file, no longer require the `files-api-2025-04-14` beta header. Requests sent without the header use the GA response format: [file expiration](https://platform.claude.com/docs/en/build-with-claude/files#file-expiration) (set `expires_in_seconds` when you upload a file; file objects report `expires_at`), and `page` and `next_page` [pagination](https://platform.claude.com/docs/en/api/overview#pagination) plus an `ids[]` filter when you [list files](https://platform.claude.com/docs/en/build-with-claude/files#list-files). `/v1/files` requests that still send the beta header keep working and return the previous response format. -* [Agent Skills](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/overview) and the Skills API (`/v1/skills`) are now generally available on the Claude API. Requests no longer require the `skills-2025-10-02` beta header, including Messages API requests that load Skills through the `container` parameter. Requests that still send the header continue to work unchanged. See [Using Agent Skills with the API](https://platform.claude.com/docs/en/build-with-claude/skills-guide). -* The [Admin API](https://platform.claude.com/docs/en/api/admin) user-management endpoints for **Claude Enterprise** (claude.ai) organizations (members, invites, groups, and custom roles) are now generally available. The `anthropic-beta: ce-user-management-2026-07-13` header is no longer required on group and custom-role requests; requests that still send it are accepted unchanged. See [User management](https://platform.claude.com/docs/en/manage-claude/user-management). +* The [Files API](https://platform.claude.com/docs/en/build-with-claude/files) is out of beta on the Claude API. Requests to the `/v1/files` endpoints, and Messages API requests that reference an uploaded file, no longer require the `files-api-2025-04-14` beta header. Requests sent without the header use the current response format: [file expiration](https://platform.claude.com/docs/en/build-with-claude/files#file-expiration) (set `expires_in_seconds` when you upload a file; file objects report `expires_at`), and `page` and `next_page` [pagination](https://platform.claude.com/docs/en/api/overview#pagination) plus an `ids[]` filter when you [list files](https://platform.claude.com/docs/en/build-with-claude/files#list-files). `/v1/files` requests that still send the beta header keep working and return the previous response format. +* [Agent Skills](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/overview) and the Skills API (`/v1/skills`) are out of beta on the Claude API. Requests no longer require the `skills-2025-10-02` beta header, including Messages API requests that load Skills through the `container` parameter. Requests that still send the header continue to work unchanged. See [Using Agent Skills with the API](https://platform.claude.com/docs/en/build-with-claude/skills-guide). +* The [Admin API](https://platform.claude.com/docs/en/api/admin) user-management endpoints for **Claude Enterprise** (claude.ai) organizations (members, invites, groups, and custom roles) are out of beta. The `anthropic-beta: ce-user-management-2026-07-13` header is no longer required on group and custom-role requests; requests that still send it are accepted unchanged. See [User management](https://platform.claude.com/docs/en/manage-claude/user-management). * You can now restrict which sites a Claude Managed Agents agent's `web_search` and `web_fetch` tools can reach. Set `allowed_domains` or `blocked_domains` on the tool's entry in the `agent_toolset_20260401` `configs` array; `web_fetch` also accepts `max_content_tokens` and `web_search` accepts `user_location`. Each `configs` entry is identified by its `name` and typed by an optional `type`, and requests that pass only `name`, `enabled`, and `permission_policy` continue to work; in the typed SDKs, `configs` entries become per-tool types. See [Restrict web search and web fetch domains](https://platform.claude.com/docs/en/managed-agents/tools#restrict-web-search-and-web-fetch-domains). * Claude Managed Agents sessions that run in a [self-hosted sandbox](https://platform.claude.com/docs/en/managed-agents/self-hosted-sandboxes) can now attach [memory stores](https://platform.claude.com/docs/en/managed-agents/memory). The Python, TypeScript, and Go SDK workers download each attached store into the sandbox at its `mount_path` and sync the agent's changes back to the store. See [Use memory stores](https://platform.claude.com/docs/en/managed-agents/self-hosted-sandboxes#use-memory-stores). * The session viewer in the Claude Console has been redesigned with a timeline minimap, a transcript grouped by model request, and an Inspector panel for session details and cost, raw events, per-tool statistics, mounted resources, and per-thread activity. See [Console observability](https://platform.claude.com/docs/en/managed-agents/events-and-streaming#console-observability).
from line 63
### July 24, 2026 -* We've launched **Claude Opus 5** (`claude-opus-5`), a step-change improvement over Claude Opus 4.8. Claude Opus 5 supports a [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) (both the default and the maximum), 128k max output tokens, and [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking) on by default, at $5 / $25 USD per MTok, the same pricing as Claude Opus 4.8. It's available on the Claude API, [Claude in Amazon Bedrock](https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon-bedrock), [Claude on Google Cloud](https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai), and [Claude in Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry). See [What's new in Claude Opus 5](https://platform.claude.com/docs/en/about-claude/models/whats-new-opus-5) for new features, behavior changes, and migration guidance, and the [models overview](https://platform.claude.com/docs/en/about-claude/models/overview) for complete specs. +* We've launched **Claude Opus 5** (`claude-opus-5`), a step-change improvement over Claude Opus 4.8. Claude Opus 5 supports a [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) (both the default and the maximum), 128k max output tokens, and [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking) on by default, at $5 / $25 USD per MTok, the same pricing as Claude Opus 4.8. It's available on the Claude API, [Claude in Amazon Bedrock](https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon-bedrock), [Claude Platform on AWS](https://platform.claude.com/docs/en/build-with-claude/claude-platform-on-aws), [Claude on Google Cloud](https://platform.claude.com/docs/en/build-with-claude/claude-on-vertex-ai), and [Claude in Microsoft Foundry](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry). See [What's new in Claude Opus 5](https://platform.claude.com/docs/en/about-claude/models/whats-new-opus-5) for new features, behavior changes, and migration guidance, and the [models overview](https://platform.claude.com/docs/en/about-claude/models/overview) for complete specs. * On Claude Opus 5, disabling thinking is allowed only at effort `high` or below: `thinking: {"type": "disabled"}` with effort `xhigh` or `max` returns a 400 error, a breaking change from Claude Opus 4.8. See [What's new in Claude Opus 5](https://platform.claude.com/docs/en/about-claude/models/whats-new-opus-5#behavior-changes). * [Effort](https://platform.claude.com/docs/en/build-with-claude/effort) is the primary control for steering Claude Opus 5: the model supports the full ladder (`low`, `medium`, `high`, `xhigh`, `max`), with `max` for capability-critical work. * Mid-conversation tool changes are now in beta on Claude Fable 5, Claude Mythos 5, Claude Opus 4.8, and Claude Opus 5: add or remove tools between turns of a conversation while preserving the prompt cache. Include the `mid-conversation-tool-changes-2026-07-01` beta header in your requests.
from line 181
### May 28, 2026 -* We've launched **Claude Opus 4.8** (claude-opus-4-8), our most capable generally available model. Claude Opus 4.8 supports a [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) by default on the Claude API, Amazon Bedrock, Google Cloud, and Microsoft Foundry, 128k max output tokens, and the same set of tools and platform features as Claude Opus 4.7. See the [migration guide](https://platform.claude.com/docs/en/about-claude/models/migration-guide) for baseline settings, features, and migration guidance. +* We've launched **Claude Opus 4.8** (claude-opus-4-8), our most capable widely released model. Claude Opus 4.8 supports a [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) by default on the Claude API, Amazon Bedrock, Google Cloud, and Microsoft Foundry, 128k max output tokens, and the same set of tools and platform features as Claude Opus 4.7. See the [migration guide](https://platform.claude.com/docs/en/about-claude/models/migration-guide) for baseline settings, features, and migration guidance. * We've launched [mid-conversation system messages](https://platform.claude.com/docs/en/build-with-claude/mid-conversation-system-messages). On Claude Opus 4.8, you can send `role: "system"` messages after a user turn (subject to [placement rules](https://platform.claude.com/docs/en/build-with-claude/mid-conversation-system-messages#limitations)) in the `messages` array, preserving prompt cache hits when instructions change during a long-running session. No beta header is required. * The [`stop_details`](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback#refusal-response) field on refusal responses is now publicly documented; it returns a `category` (`cyber`, `bio`, or `null`) and a human-readable `explanation`, so your application can route different classes of refusal to the right next step. No beta header is required. * On Claude Opus 4.8, the [effort parameter](https://platform.claude.com/docs/en/build-with-claude/effort) defaults to `high` across all surfaces, including Claude Code and the Messages API.
from line 236
### May 4, 2026 -* [Workload Identity Federation](https://platform.claude.com/docs/en/manage-claude/workload-identity-federation) is now generally available. Authenticate workloads to the Claude API with short-lived OIDC tokens from your own identity provider (AWS IAM, Google Cloud, GitHub Actions, Kubernetes, Microsoft Entra ID, Okta, SPIFFE, and more) instead of long-lived static API keys. Configure issuers and federation rules in the Claude Console, and the SDK handles token exchange and refresh automatically. See [Authentication](https://platform.claude.com/docs/en/manage-claude/authentication). +* We've launched [Workload Identity Federation](https://platform.claude.com/docs/en/manage-claude/workload-identity-federation). Authenticate workloads to the Claude API with short-lived OIDC tokens from your own identity provider (AWS IAM, Google Cloud, GitHub Actions, Kubernetes, Microsoft Entra ID, Okta, SPIFFE, and more) instead of long-lived static API keys. Configure issuers and federation rules in the Claude Console, and the SDK handles token exchange and refresh automatically. See [Authentication](https://platform.claude.com/docs/en/manage-claude/authentication). ### April 30, 2026 -* We've retired the 1M token context window beta (`context-1m-2025-08-07`) for Claude Sonnet 4.5 and Claude Sonnet 4. The beta header now has no effect on these models, and requests exceeding the standard 200k-token context window return an error. To use the 1M context window, migrate to [Claude Sonnet 4.6](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison) or [Claude Opus 4.6](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), where it's generally available at standard pricing with no beta header required. +* We've retired the 1M token context window beta (`context-1m-2025-08-07`) for Claude Sonnet 4.5 and Claude Sonnet 4. The beta header now has no effect on these models, and requests exceeding the standard 200k-token context window return an error. To use the 1M context window, migrate to [Claude Sonnet 4.6](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison) or [Claude Opus 4.6](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), where it's included at standard pricing with no beta header required. ### April 29, 2026
from line 260
### April 16, 2026 -* We've launched [Claude Opus 4.7](https://www.anthropic.com/news/claude-opus-4-7), our most capable generally available model for complex reasoning and agentic coding, at the same $5 / $25 per MTok pricing as Opus 4.6. See [What's new in Claude Opus 4.7](https://platform.claude.com/docs/en/about-claude/models/whats-new-claude-4-7) for capability improvements, new features, and the updated tokenizer. Opus 4.7 includes API breaking changes versus Opus 4.6; see the [migration guide](https://platform.claude.com/docs/en/about-claude/models/migration-guide) before upgrading. +* We've launched [Claude Opus 4.7](https://www.anthropic.com/news/claude-opus-4-7), our most capable widely released model for complex reasoning and agentic coding, at the same $5 / $25 per MTok pricing as Opus 4.6. See [What's new in Claude Opus 4.7](https://platform.claude.com/docs/en/about-claude/models/whats-new-claude-4-7) for capability improvements, new features, and the updated tokenizer. Opus 4.7 includes API breaking changes versus Opus 4.6; see the [migration guide](https://platform.claude.com/docs/en/about-claude/models/migration-guide) before upgrading. * [Claude in Amazon Bedrock](https://platform.claude.com/docs/en/build-with-claude/claude-in-amazon-bedrock) is now open to all Amazon Bedrock customers. Claude Opus 4.7 and Claude Haiku 4.5 are available self-serve from the Bedrock console through the Messages API endpoint at `/anthropic/v1/messages`, in 27 AWS regions with global and regional endpoints. * We've launched [task budgets](https://platform.claude.com/docs/en/build-with-claude/task-budgets) in beta on Claude Opus 4.7. Give Claude an advisory token budget for a full agentic loop (thinking, tool calls, tool results, and output) and the model sees a running countdown, using it to prioritize work and finish gracefully as the budget is consumed. Include the `task-budgets-2026-03-13` beta header in your requests. * Claude Opus 4.7 supports [high-resolution image input](https://platform.claude.com/docs/en/build-with-claude/vision#high-resolution-image-support-on-claude-opus-4-7), raising the maximum image resolution from 1568 to 2576 pixels on the long edge for improved performance on computer use, screenshot understanding, and document analysis. High-resolution support is automatic and requires no beta header; images may use up to approximately 3x more image tokens than on prior models.
from line 299
### March 13, 2026 -* The [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) is now generally available for Claude Opus 4.6 and Sonnet 4.6 at standard pricing. Requests over 200k tokens work automatically for these models with no beta header required. The 1M token context window remains in beta for Claude Sonnet 4.5 and Sonnet 4. +* The [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) is out of beta for Claude Opus 4.6 and Sonnet 4.6, at standard pricing. Requests over 200k tokens work automatically for these models with no beta header required. The 1M token context window remains in beta for Claude Sonnet 4.5 and Sonnet 4. * We've removed the dedicated 1M rate limits for all supported models. Your standard account limits now apply across every context length. * We've raised the media limit from 100 to 600 images or PDF pages per request when using the 1M token context window.
from line 313
* We've launched [Claude Sonnet 4.6](https://www.anthropic.com/news/claude-sonnet-4-6), our latest balanced model combining speed and intelligence for everyday tasks. Sonnet 4.6 delivers improved agentic search performance while consuming fewer tokens. Sonnet 4.6 supports [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) and a [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) (beta). See [Models & Pricing](https://platform.claude.com/docs/en/about-claude/models) for details. * API [code execution](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool) is now **free when used with web search or web fetch**. Sandboxed code execution improves model capability and token efficiency. See the [pricing details](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool#usage-and-pricing) for standalone usage. -* The [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool) and [programmatic tool calling](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling) are now generally available (no beta header required). Web search and web fetch now support [dynamic filtering](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool#dynamic-filtering), which uses code execution to filter results before they reach the context window for better performance and reduced token cost. -* The [code execution tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool), [web fetch tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool), [tool search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-search-tool), [tool use examples](https://platform.claude.com/docs/en/agents-and-tools/tool-use/define-tools#providing-tool-use-examples), and [memory tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/memory-tool) are now generally available (no beta header required). +* The [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool) and [programmatic tool calling](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling) are available with no beta header required. Web search and web fetch now support [dynamic filtering](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool#dynamic-filtering), which uses code execution to filter results before they reach the context window for better performance and reduced token cost. +* The [code execution tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool), [web fetch tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-fetch-tool), [tool search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/tool-search-tool), [tool use examples](https://platform.claude.com/docs/en/agents-and-tools/tool-use/define-tools#providing-tool-use-examples), and [memory tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/memory-tool) no longer require a beta header. ### February 7, 2026
from line 323
### February 5, 2026 * We've launched [Claude Opus 4.6](https://www.anthropic.com/news/claude-opus-4-6), our most intelligent model for complex agentic tasks and long-horizon work. Opus 4.6 recommends [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/thinking) (`thinking: {type: "adaptive"}`); manual thinking (`type: "enabled"` with `budget_tokens`) is deprecated. Opus 4.6 does not support prefilling assistant messages. Learn more in [What's new in Claude 4.6](https://platform.claude.com/docs/en/about-claude/models/whats-new-claude-4-6). -* The [effort parameter](https://platform.claude.com/docs/en/build-with-claude/effort) is now generally available (no beta header required) and supports Claude Opus 4.6. Effort replaces `budget_tokens` for controlling thinking depth on new models. +* The [effort parameter](https://platform.claude.com/docs/en/build-with-claude/effort) no longer requires a beta header and now supports Claude Opus 4.6. Effort replaces `budget_tokens` for controlling thinking depth on new models. * We've launched the [compaction API](https://platform.claude.com/docs/en/build-with-claude/compaction) in beta, providing server-side context summarization for effectively infinite conversations. Available on Opus 4.6. * We've introduced [data residency controls](https://platform.claude.com/docs/en/manage-claude/data-residency), allowing you to specify where model inference runs with the `inference_geo` parameter. US-only inference is available at 1.1x pricing for models released after February 1, 2026. * The [1M token context window](https://platform.claude.com/docs/en/build-with-claude/context-windows) is now available in beta for Claude Opus 4.6, in addition to Sonnet 4.5 and Sonnet 4. [Long context pricing](https://platform.claude.com/docs/en/about-claude/pricing#long-context-pricing) applies to requests exceeding 200k input tokens. -* [Fine-grained tool streaming](https://platform.claude.com/docs/en/agents-and-tools/tool-use/fine-grained-tool-streaming) is now generally available on all models and platforms (no beta header required). +* [Fine-grained tool streaming](https://platform.claude.com/docs/en/agents-and-tools/tool-use/fine-grained-tool-streaming) no longer requires a beta header on any model or platform. ### January 29, 2026 -* [Structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) are now generally available on the Claude API for Claude Sonnet 4.5, Claude Opus 4.5, and Claude Haiku 4.5. GA includes expanded schema support, improved grammar compilation latency, and a simplified integration path with no beta header required. The `output_format` parameter has moved to `output_config.format`. Existing beta users can continue using the beta header during the transition period. Structured outputs remain in public beta on Amazon Bedrock and Microsoft Foundry. +* [Structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) are out of beta on the Claude API for Claude Sonnet 4.5, Claude Opus 4.5, and Claude Haiku 4.5. This release includes expanded schema support, improved grammar compilation latency, and a simplified integration path with no beta header required. The `output_format` parameter has moved to `output_config.format`. Existing beta users can continue using the beta header during the transition period. Structured outputs remain in public beta on Amazon Bedrock and Microsoft Foundry. ### January 12, 2026
from line 359
### November 21, 2025 -* Search result content blocks are now generally available on Amazon Bedrock. Learn more in [Search results](https://platform.claude.com/docs/en/build-with-claude/search-results). +* Search result content blocks are now available on Amazon Bedrock with no beta header required. Learn more in [Search results](https://platform.claude.com/docs/en/build-with-claude/search-results). ### November 19, 2025
from line 455
### August 13, 2025 * We announced the deprecation of the Claude Sonnet 3.5 models (`claude-3-5-sonnet-20240620` and `claude-3-5-sonnet-20241022`). These models will be retired on October 28, 2025. We recommend migrating to Claude Sonnet 4.5 (`claude-sonnet-4-5-20250929`) for improved performance and capabilities. Read more in [Model deprecations](https://platform.claude.com/docs/en/about-claude/model-deprecations). -* The 1-hour cache duration for prompt caching is now generally available. You can now use the extended cache TTL without a beta header. Learn more in [Prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#1-hour-cache-duration). +* The 1-hour cache duration for prompt caching no longer requires a beta header. Learn more in [Prompt caching](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#1-hour-cache-duration). ### August 12, 2025
from line 467
### August 8, 2025 -* Search result content blocks are now generally available on the Claude API and Vertex AI. This feature enables natural citations for RAG applications with proper source attribution. The beta header `search-results-2025-06-09` is no longer required. Learn more in [Search results](https://platform.claude.com/docs/en/build-with-claude/search-results). +* Search result content blocks are out of beta on the Claude API and Vertex AI. This feature enables natural citations for RAG applications with proper source attribution. The beta header `search-results-2025-06-09` is no longer required. Learn more in [Search results](https://platform.claude.com/docs/en/build-with-claude/search-results). ### August 5, 2025
from line 516
* We've launched the [Code execution tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool) in public beta, a tool that enables Claude to execute Python code in a secure, sandboxed environment. * We've launched the [MCP connector](https://platform.claude.com/docs/en/agents-and-tools/mcp-connector) in public beta, a feature that allows you to connect to remote MCP servers directly from the Messages API. * To increase answer quality and decrease tool errors, we've changed the default value for the `top_p` [nucleus sampling](https://en.wikipedia.org/wiki/Top-p_sampling) parameter in the Messages API from 0.999 to 0.99 for all models. To revert this change, set `top_p` to 0.999. Additionally, when extended thinking is enabled, you can now set `top_p` to values between 0.95 and 1. -* We've moved our [Go SDK](https://github.com/anthropics/anthropic-sdk-go) from beta to GA. +* Our [Go SDK](https://github.com/anthropics/anthropic-sdk-go) has moved from beta to its first stable release. * We've included minute and hour level granularity to the [Usage](https://console.anthropic.com/settings/usage) page of Console alongside 429 error rates on the Usage page. ### May 21, 2025 -* We've moved our [Ruby SDK](https://github.com/anthropics/anthropic-sdk-ruby) from beta to GA. +* Our [Ruby SDK](https://github.com/anthropics/anthropic-sdk-ruby) has moved from beta to its first stable release. ### May 7, 2025
from line 537
### March 31st, 2025 -* We've moved our [Java SDK](https://github.com/anthropics/anthropic-sdk-java) from beta to GA. +* Our [Java SDK](https://github.com/anthropics/anthropic-sdk-java) has moved from beta to its first stable release. * We've moved our [Go SDK](https://github.com/anthropics/anthropic-sdk-go) from alpha to beta. ### February 27th, 2025
from line 594
### December 17th, 2024 -The following features are now generally available in the Claude API: +The following features are now available in the Claude API without a beta header: * [Models API](https://platform.claude.com/docs/en/api/models/list): Query available models, validate model IDs, and resolve [model aliases](https://platform.claude.com/docs/en/about-claude/models/overview) to their canonical model IDs. * [Message Batches API](https://platform.claude.com/docs/en/build-with-claude/batch-processing): Process large batches of messages asynchronously at 50% of the standard API cost.
from line 667
### August 19th, 2024 -* We've moved 8,192 token outputs from beta to general availability for Claude Sonnet 3.5. +* 8,192-token outputs on Claude Sonnet 3.5 are out of beta and no longer require the `max-tokens-3-5-sonnet-2024-07-15` header. ### August 14th, 2024
from line 689
### June 20th, 2024 -* [Claude Sonnet 3.5](https://www.anthropic.com/news/claude-3-5-sonnet), our most intelligent model yet, is now generally available across the Claude API, Amazon Bedrock, and Vertex AI. +* [Claude Sonnet 3.5](https://www.anthropic.com/news/claude-3-5-sonnet), our most intelligent model yet, is now available across the Claude API, Amazon Bedrock, and Vertex AI. ### May 30th, 2024 -* [Tool use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) is now generally available across the Claude API, Amazon Bedrock, and Vertex AI. +* [Tool use](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) is out of beta across the Claude API, Amazon Bedrock, and Vertex AI, with no beta header required. ### May 10th, 2024
about-claude/model-deprecations Changed · +1 / -1 lines
from line 213
## API parameter deprecations -Anthropic occasionally deprecates request parameters that no longer apply to current models. Deprecated parameters remain in the SDK request types so existing code continues to type-check, but their behavior changes per model. +Anthropic occasionally deprecates request parameters that no longer apply to current models. How the API treats a deprecated parameter depends on the model, as the following table shows. Most SDKs keep deprecated parameters in their request types so existing code continues to type-check. The Python SDK (v1.0 and later) removes `temperature`, `top_p`, and `top_k`, so passing them raises a `TypeError`. | Parameter | Status | Behavior | Recommended replacement | | ------------------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |