From 46594c207a2debc84d04636bb07045f36b44439a Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Tue, 15 Sep 2026 20:27:02 +1000 Subject: [PATCH] anthropic updates --- .../src/anthropic/v00.00.00000/provider.yaml | 9 + .../v00.00.00000/services/agents.yaml | 1431 +++- .../v00.00.00000/services/deployments.yaml | 501 +- .../v00.00.00000/services/dreams.yaml | 1418 ++++ .../v00.00.00000/services/environments.yaml | 1527 +++- .../v00.00.00000/services/files.yaml | 920 ++- .../v00.00.00000/services/memory_stores.yaml | 319 +- .../v00.00.00000/services/messages.yaml | 6566 +++++++++++++---- .../v00.00.00000/services/models.yaml | 238 +- .../v00.00.00000/services/sessions.yaml | 4464 ++++++++--- .../v00.00.00000/services/skills.yaml | 2071 ++++-- .../v00.00.00000/services/user_profiles.yaml | 455 +- .../v00.00.00000/services/vaults.yaml | 379 +- 13 files changed, 16528 insertions(+), 3770 deletions(-) create mode 100644 providers/src/anthropic/v00.00.00000/services/dreams.yaml diff --git a/providers/src/anthropic/v00.00.00000/provider.yaml b/providers/src/anthropic/v00.00.00000/provider.yaml index 11c231b1..6f7d1c5d 100644 --- a/providers/src/anthropic/v00.00.00000/provider.yaml +++ b/providers/src/anthropic/v00.00.00000/provider.yaml @@ -20,6 +20,15 @@ providerServices: title: deployments API version: v00.00.00000 description: anthropic deployments API + dreams: + id: dreams:v00.00.00000 + name: dreams + preferred: true + service: + $ref: anthropic/v00.00.00000/services/dreams.yaml + title: dreams API + version: v00.00.00000 + description: anthropic dreams API environments: id: environments:v00.00.00000 name: environments diff --git a/providers/src/anthropic/v00.00.00000/services/agents.yaml b/providers/src/anthropic/v00.00.00000/services/agents.yaml index 4362296e..a2aa2c3d 100644 --- a/providers/src/anthropic/v00.00.00000/services/agents.yaml +++ b/providers/src/anthropic/v00.00.00000/services/agents.yaml @@ -111,6 +111,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 parameters: - name: anthropic-version in: header @@ -131,6 +133,17 @@ paths: items: $ref: "#/components/schemas/AnthropicBeta" default: managed-agents-2026-04-01 + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy get: operationId: BetaListAgents summary: List Agents @@ -192,6 +205,17 @@ paths: schema: type: boolean description: Include archived agents in results. Defaults to false. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -289,6 +313,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/agents/{agent_id}?beta=true: get: operationId: BetaGetAgent @@ -332,6 +358,17 @@ paths: type: integer format: int32 description: Agent version. Omit for the most recent version. Must be at least 1 if specified. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -429,6 +466,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 post: operationId: BetaUpdateAgent summary: Update Agent @@ -460,12 +499,25 @@ paths: x-stainless-cli-data-alias: id description: Path parameter agent_id example: agent_011CZkYpogX7uDKUyvBTophP + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/BetaManagedAgentsUpdateAgentParams" + example: + description: updated responses: "200": description: Successful response (OK) @@ -563,6 +615,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/agents/{agent_id}/archive?beta=true: post: operationId: BetaArchiveAgent @@ -594,6 +648,17 @@ paths: type: string description: Path parameter agent_id example: agent_011CZkYpogX7uDKUyvBTophP + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -691,6 +756,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/agents/{agent_id}/versions?beta=true: get: operationId: BetaListAgentVersions @@ -742,6 +809,17 @@ paths: x-stainless-pagination-property: purpose: next_cursor_param description: Opaque pagination cursor. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -839,6 +917,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 components: schemas: BetaManagedAgentsCreateAgentParams: @@ -856,9 +936,9 @@ components: examples: - My First Agent model: - description: Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-4-6`, or a `model_config` object for additional configuration control + description: Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control examples: - - claude-sonnet-4-6 + - claude-opus-5 title: BetaManagedAgentsModel x-stainless-skip: - go @@ -866,7 +946,7 @@ components: type: string x-stainless-nominal: false enum: - - claude-sonnet-5 + - claude-fable-5-1 required: - id properties: @@ -879,22 +959,55 @@ components: enum: - standard - fast + effort: + description: 'How hard Claude works on each inference call. Accepts a bare level string (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged.' + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: string + enum: + - low + - medium + - high + - xhigh + - max + discriminator: + propertyName: type + mapping: + low: "#/components/schemas/BetaManagedAgentsEffortLow" + medium: "#/components/schemas/BetaManagedAgentsEffortMedium" + high: "#/components/schemas/BetaManagedAgentsEffortHigh" + xhigh: "#/components/schemas/BetaManagedAgentsEffortXhigh" + max: "#/components/schemas/BetaManagedAgentsEffortMax" + required: + - type + properties: + type: + type: string + enum: + - low + inference_geo: + description: Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: string example: - id: claude-opus-4-6 + id: claude-opus-5 description: description: Description of what the agent does. - type: string - maxLength: 2048 - nullable: true examples: - A general-purpose starter agent. + nullable: true + type: string + maxLength: 2048 system: description: System prompt for the agent. - type: string - maxLength: 100000 - nullable: true examples: - You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end. + nullable: true + type: string + maxLength: 100000 tools: description: Tool configurations available to the agent. Maximum of 128 tools across all toolsets allowed. type: array @@ -919,6 +1032,8 @@ components: - foo: bar multiagent: description: Multiagent orchestration configuration. Currently supports the `coordinator` topology with a roster of 1-20 agents. + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true discriminator: propertyName: type @@ -950,7 +1065,7 @@ components: - type: self example: name: My First Agent - model: claude-sonnet-4-6 + model: claude-opus-5 description: A general-purpose starter agent. system: You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end. tools: @@ -998,20 +1113,20 @@ components: examples: - My First Agent description: - type: string - nullable: true examples: - A general-purpose starter agent. + nullable: true + type: string model: $ref: "#/components/schemas/BetaManagedAgentsModelConfig" examples: - - id: claude-sonnet-4-6 + - id: claude-opus-5 speed: standard system: - type: string - nullable: true examples: - You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end. + nullable: true + type: string tools: type: array items: @@ -1056,16 +1171,18 @@ components: - "2026-03-15T10:00:00Z" archived_at: description: When the agent was archived. Null if not archived. - nullable: true examples: - null + nullable: true type: string format: date-time multiagent: description: Multiagent orchestration configuration. Null when the agent is single-threaded. - nullable: true + x-anthropic-beta-required: + - managed-agents-2026-04-01 examples: - null + nullable: true discriminator: propertyName: type mapping: @@ -1083,7 +1200,7 @@ components: description: Agents the coordinator may spawn as session threads, each resolved to a specific version. type: array items: - $ref: "#/components/schemas/BetaManagedAgentsAgentReference" + $ref: "#/components/schemas/BetaManagedAgentsMultiagentRosterEntry" example: type: agent id: agent_011CZkYpogX7uDKUyvBTophP @@ -1091,7 +1208,7 @@ components: name: My First Agent description: A general-purpose starter agent. model: - id: claude-sonnet-4-6 + id: claude-opus-5 speed: standard system: You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end. tools: @@ -1191,13 +1308,29 @@ components: - fast-mode-2026-02-01 - output-300k-2026-03-24 - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 - advisor-tool-2026-03-01 - managed-agents-2026-04-01 - cache-diagnosis-2026-04-07 + - dreaming-2026-04-21 - thinking-token-count-2026-05-13 - server-side-fallback-2026-06-01 + - server-side-fallback-2026-07-01 - fallback-credit-2026-06-01 + - fallback-credit-2026-07-01 - agent-memory-2026-07-22 + - mid-conversation-tool-changes-2026-07-01 + - compact-2026-01-12 + - computer-use-2025-11-24 + - mcp-tunnels-2026-06-22 + - structured-outputs-2025-11-13 + - task-budgets-2026-03-13 + - thinking-display-updates-2026-08-18 + - ce-user-management-2026-07-13 + - mid-conversation-output-config-2026-07-01 + - thinking-binding-controls-2026-08-01 + - mid-conversation-system-clear-at-2026-08-21 x-stainless-nominal: false BetaTimestamp: description: A timestamp in RFC 3339 format @@ -1220,14 +1353,14 @@ components: description: Opaque cursor for the next page. Null when no more results. x-stainless-pagination-property: purpose: next_cursor_field - type: string nullable: true + type: string BetaManagedAgentsUpdateAgentParams: description: Request parameters for updating an `agent`. Omit a field to preserve its current value. type: object properties: version: - description: The agent's current version, used to prevent concurrent overwrites. Obtain this value from a create or retrieve response. The request fails if this does not match the server's current version. + description: The agent's current version, used to prevent concurrent overwrites. Obtain this value from a create or retrieve response. Must be at least 1 if specified. When supplied, the request fails if it does not match the server's current version; omit to apply the update unconditionally. type: integer format: int32 examples: @@ -1238,11 +1371,11 @@ components: maxLength: 256 description: description: Description. Omit to preserve; send empty string or null to clear. + nullable: true type: string maxLength: 2048 - nullable: true model: - description: Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-4-6`, or a `model_config` object for additional configuration control. Omit to preserve. Cannot be cleared. + description: Model identifier. Accepts the [model string](https://platform.claude.com/docs/en/about-claude/models/overview#latest-models-comparison), e.g. `claude-opus-5`, or a `model_config` object for additional configuration control. Omit to preserve. Cannot be cleared. title: BetaManagedAgentsModel x-stainless-skip: - go @@ -1250,7 +1383,7 @@ components: type: string x-stainless-nominal: false enum: - - claude-sonnet-5 + - claude-fable-5-1 required: - id properties: @@ -1263,39 +1396,74 @@ components: enum: - standard - fast + effort: + description: 'How hard Claude works on each inference call. Accepts a bare level string (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged.' + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: string + enum: + - low + - medium + - high + - xhigh + - max + discriminator: + propertyName: type + mapping: + low: "#/components/schemas/BetaManagedAgentsEffortLow" + medium: "#/components/schemas/BetaManagedAgentsEffortMedium" + high: "#/components/schemas/BetaManagedAgentsEffortHigh" + xhigh: "#/components/schemas/BetaManagedAgentsEffortXhigh" + max: "#/components/schemas/BetaManagedAgentsEffortMax" + required: + - type + properties: + type: + type: string + enum: + - low + inference_geo: + description: Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: string example: - id: claude-opus-4-6 + id: claude-opus-5 system: description: System prompt. Omit to preserve; send empty string or null to clear. - type: string - maxLength: 100000 - nullable: true examples: - You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end. + nullable: true + type: string + maxLength: 100000 tools: description: Tool configurations available to the agent. Full replacement. Omit to preserve; send empty array or null to clear. Maximum of 128 tools across all toolsets allowed. + nullable: true type: array items: $ref: "#/components/schemas/BetaManagedAgentsAgentToolParams" - nullable: true mcp_servers: description: MCP servers. Full replacement. Omit to preserve; send empty array or `null` to clear. Names must be unique. Maximum 20. Every server must be referenced by an `mcp_toolset` in the agent's resulting `tools`; unreferenced servers are rejected. See the [MCP connector guide](https://platform.claude.com/docs/en/managed-agents/mcp-connector). + nullable: true type: array items: $ref: "#/components/schemas/BetaManagedAgentsMCPServerParams" - nullable: true skills: description: Skills. Full replacement. Omit to preserve; send empty array or null to clear. + nullable: true type: array items: $ref: "#/components/schemas/BetaManagedAgentsSkillParams" - nullable: true metadata: description: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars. - type: object nullable: true + type: object multiagent: description: Multiagent orchestration configuration. Full replacement. Omit to preserve; send null to clear. + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true discriminator: propertyName: type @@ -1328,8 +1496,6 @@ components: example: version: 1 system: You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end. - required: - - version BetaManagedAgentsListAgentVersions: description: Paginated list of agent versions. type: object @@ -1347,8 +1513,8 @@ components: description: Opaque cursor for the next page. Null when no more results. x-stainless-pagination-property: purpose: next_cursor_field - type: string nullable: true + type: string BetaManagedAgentsModelParams: title: BetaManagedAgentsModel x-stainless-skip: @@ -1361,7 +1527,7 @@ components: type: string x-stainless-nominal: false enum: - - claude-sonnet-5 + - claude-fable-5-1 required: - id properties: @@ -1374,8 +1540,41 @@ components: enum: - standard - fast + effort: + description: 'How hard Claude works on each inference call. Accepts a bare level string (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged.' + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: string + enum: + - low + - medium + - high + - xhigh + - max + discriminator: + propertyName: type + mapping: + low: "#/components/schemas/BetaManagedAgentsEffortLow" + medium: "#/components/schemas/BetaManagedAgentsEffortMedium" + high: "#/components/schemas/BetaManagedAgentsEffortHigh" + xhigh: "#/components/schemas/BetaManagedAgentsEffortXhigh" + max: "#/components/schemas/BetaManagedAgentsEffortMax" + required: + - type + properties: + type: + type: string + enum: + - low + inference_geo: + description: Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: string example: - id: claude-opus-4-6 + id: claude-opus-5 BetaManagedAgentsAgentToolParams: description: Union type for tool configurations in the tools array. type: object @@ -1403,8 +1602,8 @@ components: properties: enabled: description: Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - type: boolean nullable: true + type: boolean permission_policy: description: Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation. nullable: true @@ -1414,6 +1613,7 @@ components: mapping: always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" required: - type properties: @@ -1425,7 +1625,7 @@ components: description: Per-tool configuration overrides. type: array items: - $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfigParams" + $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfigUnionParams" mcp_server_name: description: Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters. type: string @@ -1437,10 +1637,9 @@ components: minLength: 1 maxLength: 128 description: - description: Description of what the tool does, shown to the agent to help it decide when to use the tool. 1-1024 characters. + description: Description of what the tool does, shown to the agent to help it decide when to use the tool. type: string minLength: 1 - maxLength: 1024 input_schema: description: JSON Schema defining the expected input parameters for the tool. properties: @@ -1526,12 +1725,12 @@ components: - xlsx version: description: Version to pin. Defaults to latest if omitted. + examples: + - "1" + nullable: true type: string minLength: 1 maxLength: 64 - nullable: true - examples: - - "1" example: type: anthropic skill_id: xlsx @@ -1576,14 +1775,42 @@ components: $ref: "#/components/schemas/BetaManagedAgentsModel" speed: description: Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + - fast-mode-2026-02-01 examples: - standard type: string enum: - standard - fast + effort: + description: How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + type: object + discriminator: + propertyName: type + mapping: + low: "#/components/schemas/BetaManagedAgentsEffortLow" + medium: "#/components/schemas/BetaManagedAgentsEffortMedium" + high: "#/components/schemas/BetaManagedAgentsEffortHigh" + xhigh: "#/components/schemas/BetaManagedAgentsEffortXhigh" + max: "#/components/schemas/BetaManagedAgentsEffortMax" + required: + - type + properties: + type: + type: string + enum: + - low + inference_geo: + description: Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. + type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 example: - id: claude-opus-4-6 + id: claude-opus-5 speed: standard BetaManagedAgentsAgentTool: description: Union type for tool configurations returned in API responses. @@ -1612,7 +1839,7 @@ components: configs: type: array items: - $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfig" + $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfigUnion" mcp_server_name: type: string name: @@ -1701,7 +1928,7 @@ components: description: Agents the coordinator may spawn as session threads, each resolved to a specific version. type: array items: - $ref: "#/components/schemas/BetaManagedAgentsAgentReference" + $ref: "#/components/schemas/BetaManagedAgentsMultiagentRosterEntry" BetaInvalidRequestError: properties: message: @@ -1864,7 +2091,7 @@ components: type: string x-stainless-nominal: false enum: - - claude-sonnet-5 + - claude-fable-5-1 BetaManagedAgentsModelConfigParams: description: An object that defines additional configuration control over model use type: object @@ -1880,8 +2107,41 @@ components: enum: - standard - fast + effort: + description: 'How hard Claude works on each inference call. Accepts a bare level string (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged.' + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: string + enum: + - low + - medium + - high + - xhigh + - max + discriminator: + propertyName: type + mapping: + low: "#/components/schemas/BetaManagedAgentsEffortLow" + medium: "#/components/schemas/BetaManagedAgentsEffortMedium" + high: "#/components/schemas/BetaManagedAgentsEffortHigh" + xhigh: "#/components/schemas/BetaManagedAgentsEffortXhigh" + max: "#/components/schemas/BetaManagedAgentsEffortMax" + required: + - type + properties: + type: + type: string + enum: + - low + inference_geo: + description: Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: string example: - id: claude-opus-4-6 + id: claude-opus-5 BetaManagedAgentsAgentToolset20260401Params: description: Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent. type: object @@ -1899,8 +2159,8 @@ components: properties: enabled: description: Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - type: boolean nullable: true + type: boolean permission_policy: description: Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation. nullable: true @@ -1910,6 +2170,7 @@ components: mapping: always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" required: - type properties: @@ -1921,7 +2182,7 @@ components: description: Per-tool configuration overrides. type: array items: - $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfigParams" + $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfigUnionParams" BetaManagedAgentsMCPToolsetParams: description: Configuration for tools from an MCP server defined in `mcp_servers`. type: object @@ -1945,8 +2206,8 @@ components: properties: enabled: description: Whether tools are enabled by default. Defaults to true if not specified. - type: boolean nullable: true + type: boolean permission_policy: description: Default permission policy for tools from this server. nullable: true @@ -1956,6 +2217,7 @@ components: mapping: always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" required: - type properties: @@ -1987,10 +2249,9 @@ components: minLength: 1 maxLength: 128 description: - description: Description of what the tool does, shown to the agent to help it decide when to use the tool. 1-1024 characters. + description: Description of what the tool does, shown to the agent to help it decide when to use the tool. type: string minLength: 1 - maxLength: 1024 input_schema: description: JSON Schema defining the expected input parameters for the tool. properties: @@ -2067,12 +2328,12 @@ components: - xlsx version: description: Version to pin. Defaults to latest if omitted. + examples: + - "1" + nullable: true type: string minLength: 1 maxLength: 64 - nullable: true - examples: - - "1" example: type: anthropic skill_id: xlsx @@ -2099,12 +2360,12 @@ components: - skill_011CZkZFNu9hAbo3jZPRgTlx version: description: Version to pin. Defaults to latest if omitted. + examples: + - "2" + nullable: true type: string minLength: 1 maxLength: 64 - nullable: true - examples: - - "2" example: type: custom skill_id: skill_011CZkZFNu9hAbo3jZPRgTlx @@ -2141,6 +2402,24 @@ components: enum: - standard - fast + BetaManagedAgentsEffort: + description: How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes. + type: object + discriminator: + propertyName: type + mapping: + low: "#/components/schemas/BetaManagedAgentsEffortLow" + medium: "#/components/schemas/BetaManagedAgentsEffortMedium" + high: "#/components/schemas/BetaManagedAgentsEffortHigh" + xhigh: "#/components/schemas/BetaManagedAgentsEffortXhigh" + max: "#/components/schemas/BetaManagedAgentsEffortMax" + required: + - type + properties: + type: + type: string + enum: + - low BetaManagedAgentsAgentToolset20260401: type: object required: @@ -2157,7 +2436,7 @@ components: configs: type: array items: - $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfig" + $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfigUnion" BetaManagedAgentsMCPToolset: type: object required: @@ -2290,15 +2569,39 @@ components: description: Agents the coordinator may spawn as session threads, each resolved to a specific version. type: array items: - $ref: "#/components/schemas/BetaManagedAgentsAgentReference" + $ref: "#/components/schemas/BetaManagedAgentsMultiagentRosterEntry" + BetaManagedAgentsEffortParams: + type: string + description: How hard Claude works on each turn. Higher levels favor reasoning depth over latency. Not all models accept every level; invalid combinations are rejected at create time. + enum: + - low + - medium + - high + - xhigh + - max + discriminator: + propertyName: type + mapping: + low: "#/components/schemas/BetaManagedAgentsEffortLow" + medium: "#/components/schemas/BetaManagedAgentsEffortMedium" + high: "#/components/schemas/BetaManagedAgentsEffortHigh" + xhigh: "#/components/schemas/BetaManagedAgentsEffortXhigh" + max: "#/components/schemas/BetaManagedAgentsEffortMax" + required: + - type + properties: + type: + type: string + enum: + - low BetaManagedAgentsAgentToolsetDefaultConfigParams: description: Default configuration for all tools in a toolset. type: object properties: enabled: description: Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - type: boolean nullable: true + type: boolean permission_policy: description: Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation. nullable: true @@ -2308,6 +2611,7 @@ components: mapping: always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" required: - type properties: @@ -2315,18 +2619,36 @@ components: type: string enum: - always_allow - BetaManagedAgentsAgentToolConfigParams: + BetaManagedAgentsAgentToolConfigUnionParams: description: Configuration override for a specific tool within a toolset. type: object + discriminator: + propertyName: type + mapping: + bash: "#/components/schemas/BetaManagedAgentsBashToolConfigParams" + edit: "#/components/schemas/BetaManagedAgentsEditToolConfigParams" + read: "#/components/schemas/BetaManagedAgentsReadToolConfigParams" + write: "#/components/schemas/BetaManagedAgentsWriteToolConfigParams" + glob: "#/components/schemas/BetaManagedAgentsGlobToolConfigParams" + grep: "#/components/schemas/BetaManagedAgentsGrepToolConfigParams" + web_fetch: "#/components/schemas/BetaManagedAgentsWebFetchToolConfigParams" + web_search: "#/components/schemas/BetaManagedAgentsWebSearchToolConfigParams" required: - name properties: + type: + type: string + enum: + - bash name: - $ref: "#/components/schemas/BetaManagedAgentsAgentToolName" + description: Must be "bash". + type: string + enum: + - bash enabled: description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. - type: boolean nullable: true + type: boolean permission_policy: description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. nullable: true @@ -2336,6 +2658,7 @@ components: mapping: always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" required: - type properties: @@ -2343,14 +2666,63 @@ components: type: string enum: - always_allow + allowed_domains: + description: 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. + type: array + items: + type: string + blocked_domains: + description: 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. + type: array + items: + type: string + max_content_tokens: + description: Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. + nullable: true + type: integer + format: int32 + user_location: + description: Approximate user location for search result localization. + nullable: true + type: object + required: + - type + properties: + type: + description: Location precision. Only "approximate" is supported. + type: string + enum: + - approximate + city: + description: City name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + region: + description: Region or state name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + country: + description: Two-letter ISO 3166-1 country code, uppercase. + nullable: true + type: string + timezone: + description: IANA timezone identifier, e.g. "America/Los_Angeles". + nullable: true + type: string + minLength: 1 + maxLength: 255 BetaManagedAgentsMCPToolsetDefaultConfigParams: description: Default configuration for all tools from an MCP server. type: object properties: enabled: description: Whether tools are enabled by default. Defaults to true if not specified. - type: boolean nullable: true + type: boolean permission_policy: description: Default permission policy for tools from this server. nullable: true @@ -2360,6 +2732,7 @@ components: mapping: always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" required: - type properties: @@ -2380,8 +2753,8 @@ components: maxLength: 128 enabled: description: Whether this tool is enabled. Overrides the `default_config` setting. - type: boolean nullable: true + type: boolean permission_policy: description: Permission policy for this tool. Overrides the `default_config` setting. nullable: true @@ -2391,6 +2764,7 @@ components: mapping: always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" required: - type properties: @@ -2424,31 +2798,145 @@ components: BetaManagedAgentsMultiagentRosterEntryParams: type: string description: "An entry in a multiagent roster: an agent ID string, a versioned agent reference, or `self`." - BetaManagedAgentsAgentToolsetDefaultConfig: - description: Resolved default configuration for agent tools. + BetaManagedAgentsEffortLow: + description: Low effort. Favors latency over reasoning depth. type: object required: - - enabled - - permission_policy + - type properties: - enabled: - type: boolean - permission_policy: - $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" - BetaManagedAgentsAgentToolConfig: - description: Configuration for a specific agent tool. + type: + type: string + enum: + - low + BetaManagedAgentsEffortMedium: + description: Medium effort. Balances latency and reasoning depth. type: object required: - - name - - enabled - - permission_policy + - type properties: - name: - $ref: "#/components/schemas/BetaManagedAgentsAgentToolName" - enabled: - type: boolean - permission_policy: + type: + type: string + enum: + - medium + BetaManagedAgentsEffortHigh: + description: High effort. Favors reasoning depth. + type: object + required: + - type + properties: + type: + type: string + enum: + - high + BetaManagedAgentsEffortXhigh: + description: Extra-high effort. Not all models accept this level. + type: object + required: + - type + properties: + type: + type: string + enum: + - xhigh + BetaManagedAgentsEffortMax: + description: Maximum effort. Favors reasoning depth over latency. + type: object + required: + - type + properties: + type: + type: string + enum: + - max + BetaManagedAgentsAgentToolsetDefaultConfig: + description: Resolved default configuration for agent tools. + type: object + required: + - enabled + - permission_policy + properties: + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsAgentToolConfigUnion: + description: Configuration for a specific agent tool. + type: object + discriminator: + propertyName: type + mapping: + bash: "#/components/schemas/BetaManagedAgentsBashToolConfig" + edit: "#/components/schemas/BetaManagedAgentsEditToolConfig" + read: "#/components/schemas/BetaManagedAgentsReadToolConfig" + write: "#/components/schemas/BetaManagedAgentsWriteToolConfig" + glob: "#/components/schemas/BetaManagedAgentsGlobToolConfig" + grep: "#/components/schemas/BetaManagedAgentsGrepToolConfig" + web_fetch: "#/components/schemas/BetaManagedAgentsWebFetchToolConfig" + web_search: "#/components/schemas/BetaManagedAgentsWebSearchToolConfig" + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - bash + name: + type: string + enum: + - bash + enabled: + type: boolean + permission_policy: $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + allowed_domains: + type: array + items: + type: string + blocked_domains: + type: array + items: + type: string + max_content_tokens: + nullable: true + type: integer + format: int32 + user_location: + nullable: true + description: Approximate user location for search result localization. + type: object + required: + - type + properties: + type: + description: Location precision. Only "approximate" is supported. + type: string + enum: + - approximate + city: + description: City name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + region: + description: Region or state name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + country: + description: Two-letter ISO 3166-1 country code, uppercase. + nullable: true + type: string + timezone: + description: IANA timezone identifier, e.g. "America/Los_Angeles". + nullable: true + type: string + minLength: 1 + maxLength: 255 BetaManagedAgentsMCPToolsetDefaultConfig: description: Resolved default configuration for all tools from an MCP server. type: object @@ -2474,13 +2962,19 @@ components: type: boolean permission_policy: $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" - BetaManagedAgentsAgentReference: - description: A resolved agent reference with a concrete version. + BetaManagedAgentsMultiagentRosterEntry: + description: A resolved multiagent roster entry. + discriminator: + propertyName: type + mapping: + agent: "#/components/schemas/BetaManagedAgentsAgentReference" + advisor: "#/components/schemas/BetaManagedAgentsAdvisor" type: object required: - type - id - version + - model properties: type: type: string @@ -2497,10 +2991,22 @@ components: format: int32 examples: - 1 + model: + description: The advisor model id. + type: string example: type: agent id: agent_011CZkYqphY8vELVzwCUpqiQ version: 1 + BetaManagedAgentsEffortLevel: + type: string + description: How hard Claude works on each turn. Higher levels favor reasoning depth over latency. Not all models accept every level; invalid combinations are rejected at create time. + enum: + - low + - medium + - high + - xhigh + - max BetaManagedAgentsPermissionPolicy: description: Permission policy for tool execution. type: object @@ -2509,6 +3015,7 @@ components: mapping: always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" required: - type properties: @@ -2516,72 +3023,736 @@ components: type: string enum: - always_allow - BetaManagedAgentsAgentToolName: - type: string - description: Built-in agent tool identifier. - enum: - - bash - - edit - - read - - write - - glob - - grep - - web_fetch - - web_search - BetaManagedAgentsAgentParams: - description: Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version + BetaManagedAgentsBashToolConfigParams: + description: Configuration override for the bash tool. type: object required: - - type - - id + - name properties: type: type: string enum: - - agent - id: - description: The `agent` ID. + - bash + name: + description: Must be "bash". type: string - minLength: 1 - maxLength: 128 - version: - description: The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. - type: integer - format: int32 - BetaManagedAgentsMultiagentSelfParams: - description: Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. + enum: + - bash + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsEditToolConfigParams: + description: Configuration override for the edit tool. type: object required: - - type + - name properties: type: type: string enum: - - self - examples: - - self - example: - type: self - BetaManagedAgentsAlwaysAllowPolicy: - description: Tool calls are automatically approved without user confirmation. + - edit + name: + description: Must be "edit". + type: string + enum: + - edit + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsReadToolConfigParams: + description: Configuration override for the read tool. type: object required: - - type + - name properties: type: type: string enum: - - always_allow - BetaManagedAgentsAlwaysAskPolicy: - description: Tool calls require user confirmation before execution. + - read + name: + description: Must be "read". + type: string + enum: + - read + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsWriteToolConfigParams: + description: Configuration override for the write tool. type: object required: - - type + - name properties: type: type: string enum: - - always_ask + - write + name: + description: Must be "write". + type: string + enum: + - write + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsGlobToolConfigParams: + description: Configuration override for the glob tool. + type: object + required: + - name + properties: + type: + type: string + enum: + - glob + name: + description: Must be "glob". + type: string + enum: + - glob + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsGrepToolConfigParams: + description: Configuration override for the grep tool. + type: object + required: + - name + properties: + type: + type: string + enum: + - grep + name: + description: Must be "grep". + type: string + enum: + - grep + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsWebFetchToolConfigParams: + description: Configuration override for the web_fetch tool. + type: object + required: + - name + properties: + type: + type: string + enum: + - web_fetch + name: + description: Must be "web_fetch". + type: string + enum: + - web_fetch + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + allowed_domains: + description: 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. + type: array + items: + type: string + blocked_domains: + description: 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. + type: array + items: + type: string + max_content_tokens: + description: Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. + nullable: true + type: integer + format: int32 + BetaManagedAgentsWebSearchToolConfigParams: + description: Configuration override for the web_search tool. + type: object + required: + - name + properties: + type: + type: string + enum: + - web_search + name: + description: Must be "web_search". + type: string + enum: + - web_search + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + allowed_domains: + description: 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. + type: array + items: + type: string + blocked_domains: + description: 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. + type: array + items: + type: string + user_location: + description: Approximate user location for search result localization. + nullable: true + type: object + required: + - type + properties: + type: + description: Location precision. Only "approximate" is supported. + type: string + enum: + - approximate + city: + description: City name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + region: + description: Region or state name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + country: + description: Two-letter ISO 3166-1 country code, uppercase. + nullable: true + type: string + timezone: + description: IANA timezone identifier, e.g. "America/Los_Angeles". + nullable: true + type: string + minLength: 1 + maxLength: 255 + BetaManagedAgentsAgentParams: + description: Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version + type: object + required: + - type + - id + properties: + type: + type: string + enum: + - agent + id: + description: The `agent` ID. + type: string + minLength: 1 + maxLength: 128 + version: + description: The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. + type: integer + format: int32 + BetaManagedAgentsMultiagentSelfParams: + description: Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference. + type: object + required: + - type + properties: + type: + type: string + enum: + - self + examples: + - self + example: + type: self + BetaManagedAgentsAdvisorParams: + description: "Platform advisor roster entry: a model the session's primary thread may consult mid-turn. At most one per roster; the entry occupies the roster name `anthropic.advisor`." + type: object + required: + - type + - model + properties: + type: + type: string + enum: + - advisor + examples: + - advisor + model: + description: A Claude model id. The model must be permitted as an advisor for this agent's model — see the sessions/threads/advisor spec. + type: string + minLength: 1 + maxLength: 256 + examples: + - claude-fable-5 + example: + type: advisor + model: claude-fable-5 + BetaManagedAgentsBashToolConfig: + description: Configuration for the bash tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - bash + name: + type: string + enum: + - bash + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsEditToolConfig: + description: Configuration for the edit tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - edit + name: + type: string + enum: + - edit + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsReadToolConfig: + description: Configuration for the read tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - read + name: + type: string + enum: + - read + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsWriteToolConfig: + description: Configuration for the write tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - write + name: + type: string + enum: + - write + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsGlobToolConfig: + description: Configuration for the glob tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - glob + name: + type: string + enum: + - glob + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsGrepToolConfig: + description: Configuration for the grep tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - grep + name: + type: string + enum: + - grep + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsWebFetchToolConfig: + description: Configuration for the web_fetch tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - web_fetch + name: + type: string + enum: + - web_fetch + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + allowed_domains: + type: array + items: + type: string + blocked_domains: + type: array + items: + type: string + max_content_tokens: + nullable: true + type: integer + format: int32 + BetaManagedAgentsWebSearchToolConfig: + description: Configuration for the web_search tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - web_search + name: + type: string + enum: + - web_search + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + allowed_domains: + type: array + items: + type: string + blocked_domains: + type: array + items: + type: string + user_location: + nullable: true + description: Approximate user location for search result localization. + type: object + required: + - type + properties: + type: + description: Location precision. Only "approximate" is supported. + type: string + enum: + - approximate + city: + description: City name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + region: + description: Region or state name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + country: + description: Two-letter ISO 3166-1 country code, uppercase. + nullable: true + type: string + timezone: + description: IANA timezone identifier, e.g. "America/Los_Angeles". + nullable: true + type: string + minLength: 1 + maxLength: 255 + BetaManagedAgentsAgentReference: + description: A resolved agent reference with a concrete version. + type: object + required: + - type + - id + - version + properties: + type: + type: string + enum: + - agent + examples: + - agent + id: + type: string + examples: + - agent_011CZkYqphY8vELVzwCUpqiQ + version: + type: integer + format: int32 + examples: + - 1 + example: + type: agent + id: agent_011CZkYqphY8vELVzwCUpqiQ + version: 1 + BetaManagedAgentsAdvisor: + description: "Platform advisor roster entry: a model the session's primary thread may consult mid-turn." + type: object + required: + - type + - model + properties: + type: + type: string + enum: + - advisor + model: + description: The advisor model id. + type: string + BetaManagedAgentsAlwaysAllowPolicy: + description: Tool calls are automatically approved without user confirmation. + type: object + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsAlwaysAskPolicy: + description: Tool calls require user confirmation before execution. + type: object + required: + - type + properties: + type: + type: string + enum: + - always_ask + BetaManagedAgentsAutoPolicy: + description: "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask." + type: object + required: + - type + properties: + type: + type: string + enum: + - auto + BetaManagedAgentsUserLocation: + description: Approximate user location for search result localization. + type: object + required: + - type + properties: + type: + description: Location precision. Only "approximate" is supported. + type: string + enum: + - approximate + city: + description: City name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + region: + description: Region or state name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + country: + description: Two-letter ISO 3166-1 country code, uppercase. + nullable: true + type: string + timezone: + description: IANA timezone identifier, e.g. "America/Los_Angeles". + nullable: true + type: string + minLength: 1 + maxLength: 255 x-stackQL-resources: agents: id: anthropic.agents.agents diff --git a/providers/src/anthropic/v00.00.00000/services/deployments.yaml b/providers/src/anthropic/v00.00.00000/services/deployments.yaml index e520d9a9..bfdb5cee 100644 --- a/providers/src/anthropic/v00.00.00000/services/deployments.yaml +++ b/providers/src/anthropic/v00.00.00000/services/deployments.yaml @@ -111,6 +111,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 parameters: - name: anthropic-version in: header @@ -131,6 +133,17 @@ paths: items: $ref: "#/components/schemas/AnthropicBeta" default: managed-agents-2026-04-01 + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy get: operationId: BetaListDeployments summary: List Deployments @@ -185,7 +198,7 @@ paths: required: false schema: $ref: "#/components/schemas/BetaManagedAgentsDeploymentStatus" - description: "Filter by status: active or paused. Omit for both. To include archived deployments, use include_archived instead; the two cannot be combined." + description: "Filter by status: `active` or `paused`. Omit for both. To include archived deployments, use `include_archived` instead; the two cannot be combined." - name: created_at[gte] in: query required: false @@ -204,6 +217,17 @@ paths: schema: type: boolean description: "When true, includes archived deployments. Default: false (exclude archived)." + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -301,6 +325,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/deployments/{deployment_id}?beta=true: get: operationId: BetaGetDeployment @@ -337,6 +363,17 @@ paths: type: string description: Path parameter deployment_id example: depl_011CZkZcDH3vPqd7xnEfwTai + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -434,6 +471,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 post: operationId: BetaUpdateDeployment summary: Update Deployment @@ -465,6 +504,17 @@ paths: x-stainless-cli-data-alias: id description: Path parameter deployment_id example: depl_011CZkZcDH3vPqd7xnEfwTai + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -568,6 +618,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/deployments/{deployment_id}/archive?beta=true: post: operationId: BetaArchiveDeployment @@ -599,6 +651,17 @@ paths: type: string description: Path parameter deployment_id example: depl_011CZkZcDH3vPqd7xnEfwTai + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -696,6 +759,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/deployments/{deployment_id}/pause?beta=true: post: operationId: BetaPauseDeployment @@ -727,6 +792,17 @@ paths: type: string description: Path parameter deployment_id example: depl_011CZkZcDH3vPqd7xnEfwTai + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -824,6 +900,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/deployments/{deployment_id}/unpause?beta=true: post: operationId: BetaUnpauseDeployment @@ -855,6 +933,17 @@ paths: type: string description: Path parameter deployment_id example: depl_011CZkZcDH3vPqd7xnEfwTai + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -952,6 +1041,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/deployments/{deployment_id}/run?beta=true: post: operationId: BetaRunDeploymentNow @@ -983,6 +1074,17 @@ paths: type: string description: Path parameter deployment_id example: depl_011CZkZcDH3vPqd7xnEfwTai + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1080,6 +1182,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/deployment_runs?beta=true: get: operationId: BetaListDeploymentRuns @@ -1123,13 +1227,13 @@ paths: type: string x-stainless-pagination-property: purpose: next_cursor_param - description: Opaque pagination cursor. Pass next_page from the previous response. Invalid or expired cursors return 400. + description: Opaque pagination cursor. Pass `next_page` from the previous response. Invalid or expired cursors return 400. - name: deployment_id in: query required: false schema: type: string - description: Filter to a specific deployment. Omit to list across all deployments in the workspace. Filtering by a non-existent deployment_id returns 200 with empty data. + description: Filter to a specific deployment. Omit to list across all deployments in the workspace. Filtering by a non-existent `deployment_id` returns 200 with empty data. - name: trigger_type in: query required: false @@ -1141,7 +1245,7 @@ paths: required: false schema: type: boolean - description: "Filter: true for runs with non-null error, false for runs with non-null session_id. Omit for all." + description: "Filter: true for runs with non-null `error`, false for runs with non-null `session_id`. Omit for all." - name: created_at[gte] in: query required: false @@ -1166,6 +1270,17 @@ paths: schema: $ref: "#/components/schemas/BetaTimestamp" description: Return runs created strictly before this time (exclusive). + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1263,6 +1378,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/deployment_runs/{deployment_run_id}?beta=true: get: operationId: BetaGetDeploymentRun @@ -1298,6 +1415,17 @@ paths: schema: type: string description: Path parameter deployment_run_id + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1395,6 +1523,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 components: schemas: BetaManagedAgentsCreateDeploymentParams: @@ -1413,9 +1543,9 @@ components: maxLength: 256 description: description: Description of what the deployment does. + nullable: true type: string maxLength: 2048 - nullable: true agent: type: string description: Agent to deploy. Accepts the `agent` ID string, which pins the latest version, or an `agent` object with both id and version specified. The agent must exist and not be archived. @@ -1478,6 +1608,46 @@ components: type: cron expression: 0 9 * * 1-5 timezone: America/Los_Angeles + budget: + description: Enforced spend ceiling stamped onto each session created from this deployment, copied at session-creation time. Omit to leave sessions uncapped. The deployment agent's model must have a public list price, or the request is rejected; a multiagent roster is re-validated in full when each fire copies the cap, which fails closed the same way. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: object + discriminator: + propertyName: type + mapping: + limit: "#/components/schemas/BetaManagedAgentsBudgetLimit" + required: + - type + - max_list_cost + properties: + type: + type: string + enum: + - limit + max_list_cost: + description: Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" BetaManagedAgentsDeployment: description: "A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule." type: object @@ -1517,10 +1687,10 @@ components: - Daily order report description: description: Description of what the deployment does. - type: string - nullable: true examples: - Compiles yesterday's orders into a report every weekday morning. + nullable: true + type: string agent: description: Reference to the agent this deployment runs, resolved to a concrete version. examples: @@ -1588,7 +1758,6 @@ components: - {} schedule: description: Recurring cron schedule. Presence enables scheduled execution; null means manual-only. Includes computed timestamps (next fire times, last run) on the cron variant. - nullable: true examples: - type: cron expression: 0 9 * * 1-5 @@ -1597,6 +1766,7 @@ components: upcoming_runs_at: - "2026-03-17T16:00:00Z" - "2026-03-18T16:00:00Z" + nullable: true type: object discriminator: propertyName: type @@ -1628,9 +1798,9 @@ components: - America/Los_Angeles last_run_at: description: Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this. - nullable: true examples: - "2026-03-16T16:00:09Z" + nullable: true type: string format: date-time upcoming_runs_at: @@ -1658,10 +1828,10 @@ components: - active - paused paused_reason: - description: Why the deployment is paused. Non-null exactly when status is paused; null otherwise. - nullable: true + description: Why the deployment is `paused`. Non-null exactly when `status` is `paused`; null otherwise. examples: - null + nullable: true type: object discriminator: propertyName: type @@ -1703,6 +1873,46 @@ components: type: string enum: - environment_archived_error + budget: + description: Spend ceiling stamped onto each session created from this deployment. Absent when no budget is set. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: object + discriminator: + propertyName: type + mapping: + limit: "#/components/schemas/BetaManagedAgentsBudgetLimit" + required: + - type + - max_list_cost + properties: + type: + type: string + enum: + - limit + max_list_cost: + description: Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" created_at: description: Time the deployment was created. examples: @@ -1717,9 +1927,9 @@ components: format: date-time archived_at: description: Time the deployment was archived. Null if not archived. - nullable: true examples: - null + nullable: true type: string format: date-time example: @@ -1827,13 +2037,29 @@ components: - fast-mode-2026-02-01 - output-300k-2026-03-24 - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 - advisor-tool-2026-03-01 - managed-agents-2026-04-01 - cache-diagnosis-2026-04-07 + - dreaming-2026-04-21 - thinking-token-count-2026-05-13 - server-side-fallback-2026-06-01 + - server-side-fallback-2026-07-01 - fallback-credit-2026-06-01 + - fallback-credit-2026-07-01 - agent-memory-2026-07-22 + - mid-conversation-tool-changes-2026-07-01 + - compact-2026-01-12 + - computer-use-2025-11-24 + - mcp-tunnels-2026-06-22 + - structured-outputs-2025-11-13 + - task-budgets-2026-03-13 + - thinking-display-updates-2026-08-18 + - ce-user-management-2026-07-13 + - mid-conversation-output-config-2026-07-01 + - thinking-binding-controls-2026-08-01 + - mid-conversation-system-clear-at-2026-08-21 x-stainless-nominal: false BetaManagedAgentsDeploymentStatus: type: string @@ -1894,10 +2120,10 @@ components: description: Opaque cursor for the next page. Null when no more results. x-stainless-pagination-property: purpose: next_cursor_field - type: string - nullable: true examples: - page_MjAyNS0wNS0xNFQwMDowMDowMFo= + nullable: true + type: string example: data: - type: deployment @@ -1942,9 +2168,9 @@ components: maxLength: 256 description: description: Description. Omit to preserve; send empty string or null to clear. + nullable: true type: string maxLength: 2048 - nullable: true agent: type: string description: Agent to deploy. Accepts the `agent` ID string, which re-pins to the latest version, or an `agent` object with both id and version specified. Omit to preserve. Cannot be cleared. @@ -1954,10 +2180,10 @@ components: maxLength: 128 vault_ids: description: Vault IDs. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 50. + nullable: true type: array items: type: string - nullable: true initial_events: description: Initial events. Full replacement. Omit to preserve. Cannot be cleared. At least 1, maximum 50. type: array @@ -1965,14 +2191,14 @@ components: $ref: "#/components/schemas/BetaManagedAgentsDeploymentInitialEventParams" resources: description: Session resources. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 500. + nullable: true type: array items: $ref: "#/components/schemas/BetaManagedAgentsSessionResourceParams" - nullable: true metadata: description: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars. - type: object nullable: true + type: object schedule: description: Cron schedule. Full replacement. Omit to preserve; send null to clear (revert to manual-only). nullable: true @@ -2009,6 +2235,46 @@ components: type: cron expression: 0 9 * * 1-5 timezone: America/Los_Angeles + budget: + description: Spend ceiling for future sessions. Full replacement. Omit to preserve; send null to clear (sessions created afterwards are uncapped). The deployment agent's model must have a public list price, or the request is rejected; a multiagent roster is re-validated in full when each fire copies the cap, which fails closed the same way. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: object + discriminator: + propertyName: type + mapping: + limit: "#/components/schemas/BetaManagedAgentsBudgetLimit" + required: + - type + - max_list_cost + properties: + type: + type: string + enum: + - limit + max_list_cost: + description: Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" BetaManagedAgentsDeploymentRun: description: A persistent, append-only record of a single deployment execution. Records session creation success or failure — no session lifecycle tracking. type: object @@ -2049,15 +2315,15 @@ components: enum: - schedule scheduled_at: - description: The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (deployment_id, scheduled_at) pair. + description: The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair. type: string format: date-time session_id: - description: Populated on success. Null on creation failure. Exactly one of session_id or error is non-null. - type: string + description: Populated on success. Null on creation failure. Exactly one of `session_id` or `error` is non-null. nullable: true + type: string error: - description: Populated on creation failure. Null on success. Exactly one of session_id or error is non-null. + description: Populated on creation failure. Null on success. Exactly one of `session_id` or `error` is non-null. nullable: true type: object discriminator: @@ -2128,7 +2394,7 @@ components: - schedule - manual BetaManagedAgentsListDeploymentRunsData: - description: Paginated list of deployment runs. Sorted by created_at descending (most recent first). + description: Paginated list of deployment runs. Sorted by `created_at` descending (most recent first). type: object required: - data @@ -2144,8 +2410,8 @@ components: description: Opaque cursor for the next page. Null when no more results. x-stainless-pagination-property: purpose: next_cursor_field - type: string nullable: true + type: string BetaManagedAgentsAgentUnionParams: type: string BetaManagedAgentsDeploymentInitialEventParams: @@ -2221,11 +2487,11 @@ components: content: Must cover all five sections; cite sources inline. max_iterations: description: Eval→revision cycles before giving up. Default 3, max 20. - type: integer - format: int32 - nullable: true examples: - 3 + nullable: true + type: integer + format: int32 example: type: user.message content: @@ -2254,7 +2520,6 @@ components: required: - type - url - - authorization_token - file_id - memory_store_id properties: @@ -2272,18 +2537,19 @@ components: examples: - https://github.com/example-org/example-repo authorization_token: - description: GitHub authorization token used to clone the repository. + description: GitHub authorization token used to clone the repository. Required for private repositories; optional for public ones. type: string minLength: 1 maxLength: 4096 examples: - ghp_exampletoken + x-stainless-go-json: omitzero mount_path: description: Mount path in the container. Defaults to `/workspace/`. + nullable: true type: string minLength: 1 maxLength: 4096 - nullable: true checkout: description: Branch or commit to check out. Defaults to the repository's default branch. nullable: true @@ -2338,9 +2604,12 @@ components: - read_only instructions: description: Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 + nullable: true type: string maxLength: 4096 - nullable: true BetaManagedAgentsScheduleParams: description: A recurring schedule. Discriminated union — only cron is supported currently. type: object @@ -2376,6 +2645,43 @@ components: type: cron expression: 0 9 * * 1-5 timezone: America/Los_Angeles + BetaManagedAgentsBudget: + description: An enforced spend ceiling on a session. Discriminated on `type`; `limit` is the only kind currently supported. + type: object + discriminator: + propertyName: type + mapping: + limit: "#/components/schemas/BetaManagedAgentsBudgetLimit" + required: + - type + - max_list_cost + properties: + type: + type: string + enum: + - limit + max_list_cost: + description: Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" BetaManagedAgentsAgentReference: description: A resolved agent reference with a concrete version. type: object @@ -2455,9 +2761,9 @@ components: type: string max_iterations: description: Eval→revision cycles before giving up. Default 3, max 20. + nullable: true type: integer format: int32 - nullable: true BetaManagedAgentsSessionResourceConfig: description: A configured session resource. Echoes the input minus write-only credentials. type: object @@ -2482,8 +2788,8 @@ components: type: string mount_path: description: Mount path in the container. Defaults to `/workspace/`. - type: string nullable: true + type: string checkout: description: Branch or commit to check out. Defaults to the repository's default branch. nullable: true @@ -2526,7 +2832,7 @@ components: description: The memory store ID (memstore_...). Must belong to the caller's organization and workspace. type: string access: - description: Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem. + description: Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. nullable: true type: string enum: @@ -2534,8 +2840,11 @@ components: - read_only instructions: description: Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - type: string + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 nullable: true + type: string BetaManagedAgentsSchedule: description: A recurring schedule with computed runtime timestamps. Discriminated union — only cron is supported currently. type: object @@ -2569,9 +2878,9 @@ components: - America/Los_Angeles last_run_at: description: Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this. - nullable: true examples: - "2026-03-16T16:00:09Z" + nullable: true type: string format: date-time upcoming_runs_at: @@ -2803,7 +3112,7 @@ components: enum: - schedule scheduled_at: - description: The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (deployment_id, scheduled_at) pair. + description: The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair. type: string format: date-time BetaManagedAgentsRunError: @@ -2943,11 +3252,11 @@ components: content: Must cover all five sections; cite sources inline. max_iterations: description: Eval→revision cycles before giving up. Default 3, max 20. - type: integer - format: int32 - nullable: true examples: - 3 + nullable: true + type: integer + format: int32 example: type: user.define_outcome description: Produce a 2-page summary as summary.md @@ -2977,7 +3286,6 @@ components: required: - type - url - - authorization_token properties: type: type: string @@ -2993,18 +3301,19 @@ components: examples: - https://github.com/example-org/example-repo authorization_token: - description: GitHub authorization token used to clone the repository. + description: GitHub authorization token used to clone the repository. Required for private repositories; optional for public ones. type: string minLength: 1 maxLength: 4096 examples: - ghp_exampletoken + x-stainless-go-json: omitzero mount_path: description: Mount path in the container. Defaults to `/workspace/`. + nullable: true type: string minLength: 1 maxLength: 4096 - nullable: true checkout: description: Branch or commit to check out. Defaults to the repository's default branch. nullable: true @@ -3066,12 +3375,12 @@ components: - file_011CNha8iCJcU1wXNR6q4V8w mount_path: description: Mount path in the container. Defaults to `/mnt/session/uploads/`. + examples: + - /uploads/receipt.pdf + nullable: true type: string minLength: 1 maxLength: 4096 - nullable: true - examples: - - /uploads/receipt.pdf example: type: file file_id: file_011CNha8iCJcU1wXNR6q4V8w @@ -3099,9 +3408,12 @@ components: - read_only instructions: description: Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 + nullable: true type: string maxLength: 4096 - nullable: true BetaManagedAgentsCronScheduleParams: description: 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone. type: object @@ -3133,6 +3445,39 @@ components: type: cron expression: 0 9 * * 1-5 timezone: America/Los_Angeles + BetaManagedAgentsBudgetLimit: + description: A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`. + type: object + required: + - type + - max_list_cost + properties: + type: + type: string + enum: + - limit + max_list_cost: + description: Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" BetaManagedAgentsDeploymentUserMessageEvent: description: A user message sent to the session. type: object @@ -3189,9 +3534,9 @@ components: type: string max_iterations: description: Eval→revision cycles before giving up. Default 3, max 20. + nullable: true type: integer format: int32 - nullable: true BetaManagedAgentsDeploymentSystemMessageEvent: description: "Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: \"system\"` turn rather than replacing the top-level system prompt." type: object @@ -3224,8 +3569,8 @@ components: type: string mount_path: description: Mount path in the container. Defaults to `/workspace/`. - type: string nullable: true + type: string checkout: description: Branch or commit to check out. Defaults to the repository's default branch. nullable: true @@ -3277,8 +3622,8 @@ components: type: string mount_path: description: Mount path in the container. Defaults to `/mnt/session/uploads/`. - type: string nullable: true + type: string BetaManagedAgentsMemoryStoreResourceConfig: description: A memory store attached to each session created from this deployment. type: object @@ -3294,7 +3639,7 @@ components: description: The memory store ID (memstore_...). Must belong to the caller's organization and workspace. type: string access: - description: Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem. + description: Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. nullable: true type: string enum: @@ -3302,8 +3647,11 @@ components: - read_only instructions: description: Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - type: string + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 nullable: true + type: string BetaManagedAgentsCronSchedule: description: 5-field POSIX cron schedule with computed runtime timestamps. type: object @@ -3333,9 +3681,9 @@ components: - America/Los_Angeles last_run_at: description: Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this. - nullable: true examples: - "2026-03-16T16:00:09Z" + nullable: true type: string format: date-time upcoming_runs_at: @@ -3414,7 +3762,7 @@ components: enum: - schedule scheduled_at: - description: The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (deployment_id, scheduled_at) pair. + description: The UTC instant at which the cron expression matched in the configured timezone, before jitter is applied. At most one run is recorded per (`deployment_id`, `scheduled_at`) pair. type: string format: date-time BetaManagedAgentsManualTriggerContext: @@ -3660,6 +4008,7 @@ components: text: "#/components/schemas/BetaManagedAgentsTextBlock" image: "#/components/schemas/BetaManagedAgentsImageBlock" document: "#/components/schemas/BetaManagedAgentsDocumentBlock" + redacted: "#/components/schemas/BetaManagedAgentsRedactedBlock" required: - type - text @@ -3715,12 +4064,12 @@ components: minLength: 1 title: description: The title of the document. - type: string nullable: true + type: string context: description: Additional context about the document for the model. - type: string nullable: true + type: string example: type: text text: "Where is my order #1234?" @@ -3823,6 +4172,28 @@ components: enum: - read_write - read_only + BetaMonetaryAmount: + description: A monetary amount in a specific currency. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" BetaManagedAgentsRubric: description: Rubric for grading the quality of an outcome. discriminator: @@ -3992,12 +4363,22 @@ components: minLength: 1 title: description: The title of the document. - type: string nullable: true + type: string context: description: Additional context about the document for the model. - type: string nullable: true + type: string + BetaManagedAgentsRedactedBlock: + description: Placeholder for content withheld by Anthropic model policy. + type: object + required: + - type + properties: + type: + type: string + enum: + - redacted BetaManagedAgentsFileRubricParams: description: Rubric referenced by a file uploaded via the Files API. type: object @@ -4078,6 +4459,10 @@ components: type: string minLength: 7 maxLength: 64 + BetaCurrency: + type: string + enum: + - USD BetaManagedAgentsFileRubric: description: Rubric referenced by a file uploaded via the Files API. type: object diff --git a/providers/src/anthropic/v00.00.00000/services/dreams.yaml b/providers/src/anthropic/v00.00.00000/services/dreams.yaml new file mode 100644 index 00000000..7b30fc2a --- /dev/null +++ b/providers/src/anthropic/v00.00.00000/services/dreams.yaml @@ -0,0 +1,1418 @@ +openapi: 3.0.3 +info: + title: dreams API + description: anthropic dreams API + version: 1.0.0 +paths: + /v1/dreams?beta=true: + post: + operationId: BetaCreateDream + summary: Create a Dream + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/BetaCreateDreamRequest" + responses: + "200": + description: Successful response (OK) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDream" + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "409": + description: Custom error status + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + x-anthropic-beta-required: + - dreaming-2026-04-21 + parameters: + - name: anthropic-version + in: header + required: false + schema: + type: string + default: "2023-06-01" + - name: anthropic-beta + in: header + required: false + schema: + type: string + x-stainless-override-schema: + x-stainless-param: betas + x-stainless-extend-default: true + type: array + description: Optional header to specify the beta version(s) you want to use. + items: + $ref: "#/components/schemas/AnthropicBeta" + default: dreaming-2026-04-21 + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy + get: + operationId: BetaListDreams + summary: List Dreams + parameters: + - name: x-api-key + in: header + required: false + schema: + type: string + - name: anthropic-version + in: header + required: false + schema: + type: string + default: "2023-06-01" + - name: anthropic-beta + in: header + required: false + schema: + type: string + x-stainless-override-schema: + x-stainless-param: betas + x-stainless-extend-default: true + type: array + description: Optional header to specify the beta version(s) you want to use. + items: + $ref: "#/components/schemas/AnthropicBeta" + default: dreaming-2026-04-21 + - name: limit + in: query + required: false + schema: + type: integer + format: int32 + description: Query parameter for limit + - name: page + in: query + required: false + schema: + type: string + description: Query parameter for page + - name: include_archived + in: query + required: false + schema: + type: boolean + description: Query parameter for include_archived + - name: statuses[] + in: query + required: false + style: form + explode: true + schema: + type: array + items: + $ref: "#/components/schemas/BetaDreamStatus" + description: Filter by lifecycle status. Repeat the parameter to match any of multiple statuses. Empty applies no status filter. + - name: created_at[gt] + in: query + required: false + schema: + $ref: "#/components/schemas/BetaTimestamp" + description: Return dreams with `created_at` strictly after this timestamp (exclusive lower bound, RFC 3339). Unset applies no lower bound. + - name: created_at[lt] + in: query + required: false + schema: + $ref: "#/components/schemas/BetaTimestamp" + description: Return dreams with `created_at` strictly before this timestamp (exclusive upper bound, RFC 3339). Unset applies no upper bound. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy + responses: + "200": + description: Successful response (OK) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaListDreamsResponse" + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "409": + description: Custom error status + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + x-anthropic-beta-required: + - dreaming-2026-04-21 + /v1/dreams/{dream_id}?beta=true: + get: + operationId: BetaGetDream + summary: Get a Dream + parameters: + - name: x-api-key + in: header + required: false + schema: + type: string + - name: anthropic-version + in: header + required: false + schema: + type: string + default: "2023-06-01" + - name: anthropic-beta + in: header + required: false + schema: + type: string + x-stainless-override-schema: + x-stainless-param: betas + x-stainless-extend-default: true + type: array + description: Optional header to specify the beta version(s) you want to use. + items: + $ref: "#/components/schemas/AnthropicBeta" + default: dreaming-2026-04-21 + - name: dream_id + in: path + required: true + schema: + type: string + x-stainless-cli-data-alias: id + description: Path parameter dream_id + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy + responses: + "200": + description: Successful response (OK) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDream" + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "409": + description: Custom error status + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + x-anthropic-beta-required: + - dreaming-2026-04-21 + /v1/dreams/{dream_id}/cancel?beta=true: + post: + operationId: BetaCancelDream + summary: Cancel a Dream + parameters: + - name: anthropic-version + in: header + required: false + schema: + type: string + default: "2023-06-01" + - name: anthropic-beta + in: header + required: false + schema: + type: string + x-stainless-override-schema: + x-stainless-param: betas + x-stainless-extend-default: true + type: array + description: Optional header to specify the beta version(s) you want to use. + items: + $ref: "#/components/schemas/AnthropicBeta" + default: dreaming-2026-04-21 + - name: dream_id + in: path + required: true + schema: + type: string + x-stainless-cli-data-alias: id + description: Path parameter dream_id + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy + responses: + "200": + description: Successful response (OK) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDream" + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "409": + description: Custom error status + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + x-anthropic-beta-required: + - dreaming-2026-04-21 + /v1/dreams/{dream_id}/archive?beta=true: + post: + operationId: BetaArchiveDream + summary: Archive a Dream + parameters: + - name: anthropic-version + in: header + required: false + schema: + type: string + default: "2023-06-01" + - name: anthropic-beta + in: header + required: false + schema: + type: string + x-stainless-override-schema: + x-stainless-param: betas + x-stainless-extend-default: true + type: array + description: Optional header to specify the beta version(s) you want to use. + items: + $ref: "#/components/schemas/AnthropicBeta" + default: dreaming-2026-04-21 + - name: dream_id + in: path + required: true + schema: + type: string + x-stainless-cli-data-alias: id + description: Path parameter dream_id + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy + responses: + "200": + description: Successful response (OK) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDream" + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "409": + description: Custom error status + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaDreamingErrorResponse" + x-anthropic-beta-required: + - dreaming-2026-04-21 +components: + schemas: + BetaCreateDreamRequest: + type: object + required: + - inputs + - model + properties: + inputs: + type: array + items: + $ref: "#/components/schemas/BetaDreamInput" + model: + $ref: "#/components/schemas/BetaDreamModelParams" + instructions: + nullable: true + type: string + minLength: 1 + maxLength: 4096 + output_behavior: + $ref: "#/components/schemas/BetaOutputBehavior" + BetaDream: + description: "An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into an output memory store — a new store by default, or an existing store chosen via output_behavior. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints." + type: object + required: + - type + - id + - inputs + - outputs + - status + - created_at + - ended_at + - archived_at + - error + - model + - instructions + - session_id + - usage + - output_behavior + properties: + type: + type: string + enum: + - dream + id: + type: string + inputs: + type: array + items: + $ref: "#/components/schemas/BetaDreamInput" + outputs: + type: array + items: + $ref: "#/components/schemas/BetaDreamOutput" + status: + $ref: "#/components/schemas/BetaDreamStatus" + created_at: + $ref: "#/components/schemas/BetaTimestamp" + ended_at: + nullable: true + description: A timestamp in RFC 3339 format + type: string + format: date-time + archived_at: + nullable: true + description: A timestamp in RFC 3339 format + type: string + format: date-time + error: + nullable: true + description: Failure detail for a Dream whose `status` is `failed`. + type: object + required: + - type + - message + properties: + type: + type: string + message: + type: string + model: + $ref: "#/components/schemas/BetaDreamModelConfig" + instructions: + nullable: true + type: string + session_id: + nullable: true + type: string + usage: + $ref: "#/components/schemas/BetaDreamUsage" + output_behavior: + $ref: "#/components/schemas/BetaOutputBehavior" + BetaDreamingErrorResponse: + type: object + required: + - type + - error + properties: + type: + type: string + description: Always "error" for error responses + enum: + - error + error: + $ref: "#/components/schemas/BetaDreamingError" + AnthropicBeta: + type: string + enum: + - message-batches-2024-09-24 + - prompt-caching-2024-07-31 + - computer-use-2024-10-22 + - computer-use-2025-01-24 + - pdfs-2024-09-25 + - token-counting-2024-11-01 + - token-efficient-tools-2025-02-19 + - output-128k-2025-02-19 + - files-api-2025-04-14 + - mcp-client-2025-04-04 + - mcp-client-2025-11-20 + - dev-full-thinking-2025-05-14 + - interleaved-thinking-2025-05-14 + - code-execution-2025-05-22 + - extended-cache-ttl-2025-04-11 + - context-1m-2025-08-07 + - context-management-2025-06-27 + - model-context-window-exceeded-2025-08-26 + - skills-2025-10-02 + - fast-mode-2026-02-01 + - output-300k-2026-03-24 + - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 + - advisor-tool-2026-03-01 + - managed-agents-2026-04-01 + - cache-diagnosis-2026-04-07 + - dreaming-2026-04-21 + - thinking-token-count-2026-05-13 + - server-side-fallback-2026-06-01 + - server-side-fallback-2026-07-01 + - fallback-credit-2026-06-01 + - fallback-credit-2026-07-01 + - agent-memory-2026-07-22 + - mid-conversation-tool-changes-2026-07-01 + - compact-2026-01-12 + - computer-use-2025-11-24 + - mcp-tunnels-2026-06-22 + - structured-outputs-2025-11-13 + - task-budgets-2026-03-13 + - thinking-display-updates-2026-08-18 + - ce-user-management-2026-07-13 + - mid-conversation-output-config-2026-07-01 + - thinking-binding-controls-2026-08-01 + - mid-conversation-system-clear-at-2026-08-21 + x-stainless-nominal: false + BetaDreamStatus: + type: string + description: Lifecycle status of a Dream. + enum: + - pending + - running + - completed + - failed + - canceled + BetaTimestamp: + description: A timestamp in RFC 3339 format + type: string + format: date-time + BetaListDreamsResponse: + type: object + required: + - data + - next_page + properties: + data: + type: array + items: + $ref: "#/components/schemas/BetaDream" + next_page: + nullable: true + type: string + BetaDreamInput: + type: object + discriminator: + propertyName: type + mapping: + memory_store: "#/components/schemas/BetaDreamMemoryStoreInput" + sessions: "#/components/schemas/BetaDreamSessionsInput" + description: 'An input memory store the dream reads from. The dream never mutates this store unless it is also the destination: with output_behavior {type: "update_existing"} the job consolidates this store in place.' + required: + - type + - memory_store_id + - session_ids + properties: + type: + type: string + enum: + - memory_store + memory_store_id: + type: string + minLength: 1 + session_ids: + type: array + items: + type: string + BetaDreamModelParams: + type: string + description: Model identifier and configuration applied to every pipeline stage. + required: + - id + properties: + id: + description: Model identifier, e.g. "claude-opus-5". 1-256 characters. + type: string + minLength: 1 + maxLength: 256 + speed: + description: Inference speed mode. Defaults to `standard`. + nullable: true + type: string + enum: + - standard + - fast + BetaOutputBehavior: + type: object + discriminator: + propertyName: type + mapping: + create_new: "#/components/schemas/BetaOutputBehaviorCreateNew" + update_existing: "#/components/schemas/BetaOutputBehaviorUpdateExisting" + description: "The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated." + required: + - type + - memory_store_id + properties: + type: + type: string + enum: + - create_new + memory_store_id: + type: string + minLength: 1 + BetaDreamOutput: + type: object + discriminator: + propertyName: type + mapping: + memory_store: "#/components/schemas/BetaDreamMemoryStoreOutput" + description: An output memory store the dream writes consolidated memories into. + required: + - type + - memory_store_id + properties: + type: + type: string + enum: + - memory_store + memory_store_id: + type: string + BetaDreamError: + description: Failure detail for a Dream whose `status` is `failed`. + type: object + required: + - type + - message + properties: + type: + type: string + message: + type: string + BetaDreamModelConfig: + description: Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig. + type: object + required: + - id + properties: + id: + description: Model identifier, e.g. "claude-opus-5". 1-256 characters. + type: string + minLength: 1 + maxLength: 256 + speed: + description: Inference speed mode. Defaults to `standard`. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + - fast-mode-2026-02-01 + type: string + enum: + - standard + - fast + BetaDreamUsage: + description: Cumulative token usage for the dream across every pipeline stage. + type: object + required: + - input_tokens + - output_tokens + - cache_read_input_tokens + - cache_creation_input_tokens + properties: + input_tokens: + description: Total uncached input tokens consumed across every pipeline stage. + type: integer + format: int32 + output_tokens: + description: Total output tokens generated across every pipeline stage. + type: integer + format: int32 + cache_read_input_tokens: + description: Total tokens read from prompt cache. + type: integer + format: int32 + cache_creation_input_tokens: + description: Total tokens used to create prompt-cache entries (sum of all TTL tiers). + type: integer + format: int32 + BetaDreamingError: + discriminator: + propertyName: type + mapping: + invalid_request_error: "#/components/schemas/BetaInvalidRequestError" + authentication_error: "#/components/schemas/BetaAuthenticationError" + billing_error: "#/components/schemas/BetaBillingError" + permission_error: "#/components/schemas/BetaPermissionError" + not_found_error: "#/components/schemas/BetaNotFoundError" + rate_limit_error: "#/components/schemas/BetaRateLimitError" + timeout_error: "#/components/schemas/BetaGatewayTimeoutError" + api_error: "#/components/schemas/BetaAPIError" + overloaded_error: "#/components/schemas/BetaOverloadedError" + conflict_error: "#/components/schemas/BetaTargetStoreHeldError" + properties: + message: + default: Invalid request + title: Message + type: string + type: + default: invalid_request_error + title: Type + type: string + enum: + - invalid_request_error + required: + - message + - type + title: InvalidRequestError + type: object + description: 'The `output_behavior.memory_store_id` target is still held by a prior `{type: "update_existing"}` dream — one that is `pending` or `running`, or was canceled with its final writes still landing. Rarely the named dream has just finished (`completed`/`failed`) and its execution is still closing; an immediate retry then almost always succeeds. The message names the holding dream when the server can identify it (rarely omitted); poll it to a terminal state or cancel it, then retry. Carried with `x-should-retry: false`.' + BetaDreamMemoryStoreInput: + description: 'An input memory store the dream reads from. The dream never mutates this store unless it is also the destination: with output_behavior {type: "update_existing"} the job consolidates this store in place.' + type: object + required: + - type + - memory_store_id + properties: + type: + type: string + enum: + - memory_store + memory_store_id: + type: string + minLength: 1 + BetaDreamSessionsInput: + description: Input session transcripts the dream reads. + type: object + required: + - type + - session_ids + properties: + type: + type: string + enum: + - sessions + session_ids: + type: array + items: + type: string + BetaDreamModelConfigParams: + description: Model identifier and configuration applied to every pipeline stage. + type: object + required: + - id + properties: + id: + description: Model identifier, e.g. "claude-opus-5". 1-256 characters. + type: string + minLength: 1 + maxLength: 256 + speed: + description: Inference speed mode. Defaults to `standard`. + nullable: true + type: string + enum: + - standard + - fast + BetaOutputBehaviorCreateNew: + description: "The default destination: the job creates a new output memory store as a clone of the memory_store input and writes the consolidated memories into it. The input store is never mutated." + type: object + required: + - type + properties: + type: + type: string + enum: + - create_new + BetaOutputBehaviorUpdateExisting: + description: The job writes the consolidated memories into this existing memory store instead of creating one. In EAP the store must be the job's own memory_store input, so the job consolidates the store in place. + type: object + required: + - type + - memory_store_id + properties: + type: + type: string + enum: + - update_existing + memory_store_id: + type: string + minLength: 1 + BetaDreamMemoryStoreOutput: + description: An output memory store the dream writes consolidated memories into. + type: object + required: + - type + - memory_store_id + properties: + type: + type: string + enum: + - memory_store + memory_store_id: + type: string + BetaSpeed: + type: string + description: 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. + enum: + - standard + - fast + BetaInvalidRequestError: + properties: + message: + default: Invalid request + title: Message + type: string + type: + default: invalid_request_error + title: Type + type: string + enum: + - invalid_request_error + required: + - message + - type + title: InvalidRequestError + type: object + BetaAuthenticationError: + properties: + message: + default: Authentication error + title: Message + type: string + type: + default: authentication_error + title: Type + type: string + enum: + - authentication_error + required: + - message + - type + title: AuthenticationError + type: object + BetaBillingError: + properties: + message: + default: Billing error + title: Message + type: string + type: + default: billing_error + title: Type + type: string + enum: + - billing_error + required: + - message + - type + title: BillingError + type: object + BetaPermissionError: + properties: + message: + default: Permission denied + title: Message + type: string + type: + default: permission_error + title: Type + type: string + enum: + - permission_error + required: + - message + - type + title: PermissionError + type: object + BetaNotFoundError: + properties: + message: + default: Not found + title: Message + type: string + type: + default: not_found_error + title: Type + type: string + enum: + - not_found_error + required: + - message + - type + title: NotFoundError + type: object + BetaRateLimitError: + properties: + message: + default: Rate limited + title: Message + type: string + type: + default: rate_limit_error + title: Type + type: string + enum: + - rate_limit_error + required: + - message + - type + title: RateLimitError + type: object + BetaGatewayTimeoutError: + properties: + message: + default: Request timeout + title: Message + type: string + type: + default: timeout_error + title: Type + type: string + enum: + - timeout_error + required: + - message + - type + title: GatewayTimeoutError + type: object + BetaAPIError: + properties: + message: + default: Internal server error + title: Message + type: string + type: + default: api_error + title: Type + type: string + enum: + - api_error + required: + - message + - type + title: APIError + type: object + BetaOverloadedError: + properties: + message: + default: Overloaded + title: Message + type: string + type: + default: overloaded_error + title: Type + type: string + enum: + - overloaded_error + required: + - message + - type + title: OverloadedError + type: object + BetaTargetStoreHeldError: + description: 'The `output_behavior.memory_store_id` target is still held by a prior `{type: "update_existing"}` dream — one that is `pending` or `running`, or was canceled with its final writes still landing. Rarely the named dream has just finished (`completed`/`failed`) and its execution is still closing; an immediate retry then almost always succeeds. The message names the holding dream when the server can identify it (rarely omitted); poll it to a terminal state or cancel it, then retry. Carried with `x-should-retry: false`.' + type: object + required: + - type + properties: + type: + type: string + enum: + - conflict_error + message: + description: Human-readable description of the conflict, naming the dream that holds the target store when the server can identify it. + type: string + x-stackQL-resources: + dreams: + id: anthropic.dreams.dreams + name: dreams + title: Dreams + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: "#/paths/~1v1~1dreams?beta=true/post" + response: + mediaType: application/json + openAPIDocKey: "200" + request: + mediaType: application/json + list: + operation: + $ref: "#/paths/~1v1~1dreams?beta=true/get" + response: + mediaType: application/json + openAPIDocKey: "200" + objectKey: $.data + config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: $.next_page + location: body + queryParamPushdown: + top: + paramName: limit + get: + operation: + $ref: "#/paths/~1v1~1dreams~1{dream_id}?beta=true/get" + response: + mediaType: application/json + openAPIDocKey: "200" + cancel: + operation: + $ref: "#/paths/~1v1~1dreams~1{dream_id}~1cancel?beta=true/post" + response: + mediaType: application/json + openAPIDocKey: "200" + archive: + operation: + $ref: "#/paths/~1v1~1dreams~1{dream_id}~1archive?beta=true/post" + response: + mediaType: application/json + openAPIDocKey: "200" + sqlVerbs: + select: + - $ref: "#/components/x-stackQL-resources/dreams/methods/get" + - $ref: "#/components/x-stackQL-resources/dreams/methods/list" + insert: + - $ref: "#/components/x-stackQL-resources/dreams/methods/create" + update: [] + delete: [] + replace: [] +servers: + - url: https://api.anthropic.com diff --git a/providers/src/anthropic/v00.00.00000/services/environments.yaml b/providers/src/anthropic/v00.00.00000/services/environments.yaml index c80ce736..e0f5871d 100644 --- a/providers/src/anthropic/v00.00.00000/services/environments.yaml +++ b/providers/src/anthropic/v00.00.00000/services/environments.yaml @@ -47,6 +47,17 @@ paths: The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -60,11 +71,98 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaEnvironment" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -145,6 +243,17 @@ paths: schema: type: string nullable: true + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -152,11 +261,98 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaEnvironmentListResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -217,6 +413,17 @@ paths: schema: type: string nullable: true + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -224,11 +431,98 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaEnvironment" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -283,6 +577,17 @@ paths: The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -296,11 +601,98 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaEnvironment" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -360,6 +752,17 @@ paths: schema: type: string nullable: true + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -367,11 +770,98 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaEnvironmentDeleteResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -426,6 +916,17 @@ paths: The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -433,11 +934,98 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaEnvironment" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -504,18 +1092,116 @@ paths: schema: type: string nullable: true + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/BetaSelfHostedWorkQueueStats" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + $ref: "#/components/schemas/BetaSelfHostedWorkQueueStats" + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -641,6 +1327,11 @@ paths: type: object title: Metadata description: User-provided metadata key-value pairs associated with this work item + secret: + title: Secret + description: Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths. + nullable: true + type: string started_at: title: Started At description: RFC 3339 timestamp when work execution started @@ -682,6 +1373,7 @@ paths: - id - latest_heartbeat_at - metadata + - secret - started_at - state - stop_requested_at @@ -693,11 +1385,98 @@ paths: Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox. - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -774,11 +1553,98 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaSelfHostedWork" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -878,11 +1744,98 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaSelfHostedWorkHeartbeatResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -952,6 +1905,17 @@ paths: schema: type: string nullable: true + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -964,12 +1928,99 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/BetaSelfHostedWork" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + $ref: "#/components/schemas/BetaSelfHostedWork" + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -1039,6 +2090,17 @@ paths: schema: type: string nullable: true + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -1046,11 +2108,98 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaSelfHostedWork" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -1113,6 +2262,17 @@ paths: The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -1126,11 +2286,98 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaSelfHostedWork" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -1220,11 +2467,98 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaSelfHostedWorkListResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -1256,13 +2590,29 @@ components: - fast-mode-2026-02-01 - output-300k-2026-03-24 - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 - advisor-tool-2026-03-01 - managed-agents-2026-04-01 - cache-diagnosis-2026-04-07 + - dreaming-2026-04-21 - thinking-token-count-2026-05-13 - server-side-fallback-2026-06-01 + - server-side-fallback-2026-07-01 - fallback-credit-2026-06-01 + - fallback-credit-2026-07-01 - agent-memory-2026-07-22 + - mid-conversation-tool-changes-2026-07-01 + - compact-2026-01-12 + - computer-use-2025-11-24 + - mcp-tunnels-2026-06-22 + - structured-outputs-2025-11-13 + - task-budgets-2026-03-13 + - thinking-display-updates-2026-08-18 + - ce-user-management-2026-07-13 + - mid-conversation-output-config-2026-07-01 + - thinking-binding-controls-2026-08-01 + - mid-conversation-system-clear-at-2026-08-21 x-stainless-nominal: false BetaPublicEnvironmentCreateRequest: properties: @@ -1292,7 +2642,9 @@ components: - python-data-analysis scope: title: Scope - description: The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. Only applicable for self-hosted environments. If not specified, defaults based on organization type. + description: The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. API organizations support only 'organization'; 'account' is rejected. If not specified, defaults based on organization type. + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true type: string enum: @@ -1397,6 +2749,8 @@ components: packages: $ref: "#/components/schemas/BetaPackages" description: Package manager configuration. + x-anthropic-beta-required: + - managed-agents-2026-04-01 examples: - type: packages pip: @@ -1445,11 +2799,12 @@ components: examples: - "2026-03-15T10:00:00Z" description: - type: string title: Description - description: User-provided description for the environment + description: User-provided description for the environment; null when unset examples: - Python environment with data-analysis packages. + nullable: true + type: string id: type: string title: Id @@ -1475,6 +2830,8 @@ components: - account title: Scope description: The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account. + x-anthropic-beta-required: + - managed-agents-2026-04-01 type: type: string title: Type @@ -1616,7 +2973,7 @@ components: nullable: true description: title: Description - description: Updated description of the environment + description: Updated description of the environment. Omit to preserve; null clears to null; an empty string is stored as an empty string. examples: - Python environment with data-analysis packages. nullable: true @@ -1636,6 +2993,8 @@ components: scope: title: Scope description: The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true type: string enum: @@ -1743,6 +3102,11 @@ components: type: object title: Metadata description: User-provided metadata key-value pairs associated with this work item + secret: + title: Secret + description: Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths. + nullable: true + type: string started_at: title: Started At description: RFC 3339 timestamp when work execution started @@ -1784,6 +3148,7 @@ components: - id - latest_heartbeat_at - metadata + - secret - started_at - state - stop_requested_at @@ -1887,7 +3252,9 @@ components: description: Network configuration policy. Omit on update to preserve the existing value. nullable: true packages: - description: Package manager configuration. Omit on update to preserve the existing value. + description: Package manager configuration. Under `limited` networking, requires `networking.allow_package_managers` to be `true`. Omit on update to preserve the existing value. + x-anthropic-beta-required: + - managed-agents-2026-04-01 examples: - pip: - pandas @@ -2032,6 +3399,8 @@ components: packages: $ref: "#/components/schemas/BetaPackages" description: Package manager configuration. + x-anthropic-beta-required: + - managed-agents-2026-04-01 examples: - type: packages pip: @@ -2285,7 +3654,7 @@ components: type: boolean allow_package_managers: title: Allow Package Managers - description: Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`. + description: Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false` on creation. Must be `true` when `packages` are specified. nullable: true type: boolean allowed_hosts: @@ -2367,6 +3736,8 @@ components: Specify packages (and optionally their versions) available in this environment. When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest. + + Under `limited` networking, requires `networking.allow_package_managers` to be `true`. BetaLimitedNetwork: properties: allow_mcp_servers: diff --git a/providers/src/anthropic/v00.00.00000/services/files.yaml b/providers/src/anthropic/v00.00.00000/services/files.yaml index c283c148..43d01f02 100644 --- a/providers/src/anthropic/v00.00.00000/services/files.yaml +++ b/providers/src/anthropic/v00.00.00000/services/files.yaml @@ -4,33 +4,11 @@ info: description: anthropic files API version: 1.0.0 paths: - /v1/files?beta=true: + /v1/files: post: summary: Upload File - operationId: beta_upload_file_v1_files_post + operationId: upload_file_v1_files_post parameters: - - name: anthropic-beta - in: header - required: false - schema: - type: string - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - title: Anthropic-Beta - x-stainless-override-schema: - x-stainless-param: betas - x-stainless-extend-default: true - type: array - description: Optional header to specify the beta version(s) you want to use. - items: - $ref: "#/components/schemas/AnthropicBeta" - default: files-api-2025-04-14 - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - name: anthropic-version in: header required: false @@ -46,22 +24,120 @@ paths: The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/BetaFileMetadataSchema" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + $ref: "#/components/schemas/FileMetadataSchema" + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error content: application/json: schema: - $ref: "#/components/schemas/BetaErrorResponse" + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" requestBody: content: multipart/form-data: @@ -71,30 +147,35 @@ paths: file: type: string format: binary - description: The file to upload + description: The file to upload. Only the final path component of the part's `filename` is kept; an absent or empty `filename` is replaced with `unnamed` plus the extension for the file's stored `mime_type`, when known. + expires_in_seconds: + type: integer + minimum: 3600 + maximum: 7776000 + description: Seconds from upload until the file expires and its bytes become permanently unavailable. Must be between 3600 (one hour) and 7776000 (ninety days). required: - file required: true get: summary: List Files - operationId: beta_list_files_v1_files_get + operationId: list_files_v1_files_get parameters: - - name: before_id + - name: page in: query required: false schema: type: string - description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - title: Before Id - description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - - name: after_id + description: Opaque page cursor returned in a prior list response's `next_page`. Prefixed `page_`. + nullable: true + description: Opaque page cursor returned in a prior list response's `next_page`. Prefixed `page_`. + - name: ids[] in: query required: false schema: type: string - description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - title: After Id - description: ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. + description: Restrict the result set to Files whose `id` is in this list. At most 100 entries (after de-duplication). Mutually exclusive with `page` and `limit`. When supplied, the response is always a single page (`next_page` is null). IDs that do not resolve to a visible File — including deleted Files — are silently omitted. + nullable: true + description: Restrict the result set to Files whose `id` is in this list. At most 100 entries (after de-duplication). Mutually exclusive with `page` and `limit`. When supplied, the response is always a single page (`next_page` is null). IDs that do not resolve to a visible File — including deleted Files — are silently omitted. - name: limit in: query required: false @@ -112,36 +193,6 @@ paths: Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. - - name: scope_id - in: query - required: false - schema: - type: string - description: Filter by scope ID. Only returns files associated with the specified scope (e.g., a session ID). - title: Scope Id - description: Filter by scope ID. Only returns files associated with the specified scope (e.g., a session ID). - - name: anthropic-beta - in: header - required: false - schema: - type: string - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - title: Anthropic-Beta - x-stainless-override-schema: - x-stainless-param: betas - x-stainless-extend-default: true - type: array - description: Optional header to specify the beta version(s) you want to use. - items: - $ref: "#/components/schemas/AnthropicBeta" - default: files-api-2025-04-14 - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - name: anthropic-version in: header required: false @@ -171,26 +222,124 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/BetaFileListResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + $ref: "#/components/schemas/FileListResponse" + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state content: application/json: schema: - $ref: "#/components/schemas/BetaErrorResponse" - /v1/files/{file_id}?beta=true: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + /v1/files/{file_id}: get: summary: Get File Metadata - operationId: beta_get_file_metadata_v1_files__file_id__get + operationId: get_file_metadata_v1_files__file_id__get parameters: - name: file_id in: path @@ -200,28 +349,6 @@ paths: description: ID of the File. title: File Id description: ID of the File. - - name: anthropic-beta - in: header - required: false - schema: - type: string - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - title: Anthropic-Beta - x-stainless-override-schema: - x-stainless-param: betas - x-stainless-extend-default: true - type: array - description: Optional header to specify the beta version(s) you want to use. - items: - $ref: "#/components/schemas/AnthropicBeta" - default: files-api-2025-04-14 - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - name: anthropic-version in: header required: false @@ -251,25 +378,123 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/BetaFileMetadataSchema" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + $ref: "#/components/schemas/FileMetadataSchema" + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials content: application/json: schema: - $ref: "#/components/schemas/BetaErrorResponse" + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" delete: summary: Delete File - operationId: beta_delete_file_v1_files__file_id__delete + operationId: delete_file_v1_files__file_id__delete parameters: - name: file_id in: path @@ -279,28 +504,6 @@ paths: description: ID of the File. title: File Id description: ID of the File. - - name: anthropic-beta - in: header - required: false - schema: - type: string - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - title: Anthropic-Beta - x-stainless-override-schema: - x-stainless-param: betas - x-stainless-extend-default: true - type: array - description: Optional header to specify the beta version(s) you want to use. - items: - $ref: "#/components/schemas/AnthropicBeta" - default: files-api-2025-04-14 - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - name: anthropic-version in: header required: false @@ -330,26 +533,124 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/BetaFileDeleteResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + $ref: "#/components/schemas/FileDeleteResponse" + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials content: application/json: schema: - $ref: "#/components/schemas/BetaErrorResponse" - /v1/files/{file_id}/content?beta=true: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + /v1/files/{file_id}/content: get: summary: Download File - operationId: beta_download_file_v1_files__file_id__content_get + operationId: download_file_v1_files__file_id__content_get parameters: - name: file_id in: path @@ -359,28 +660,6 @@ paths: description: ID of the File. title: File Id description: ID of the File. - - name: anthropic-beta - in: header - required: false - schema: - type: string - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - title: Anthropic-Beta - x-stainless-override-schema: - x-stainless-param: betas - x-stainless-extend-default: true - type: array - description: Optional header to specify the beta version(s) you want to use. - items: - $ref: "#/components/schemas/AnthropicBeta" - default: files-api-2025-04-14 - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - name: anthropic-version in: header required: false @@ -410,6 +689,17 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -417,127 +707,170 @@ paths: application/octet-stream: schema: type: string - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large content: application/octet-stream: schema: - $ref: "#/components/schemas/BetaErrorResponse" + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/octet-stream: + schema: + $ref: "#/components/schemas/ErrorResponse" components: schemas: - AnthropicBeta: - type: string - enum: - - message-batches-2024-09-24 - - prompt-caching-2024-07-31 - - computer-use-2024-10-22 - - computer-use-2025-01-24 - - pdfs-2024-09-25 - - token-counting-2024-11-01 - - token-efficient-tools-2025-02-19 - - output-128k-2025-02-19 - - files-api-2025-04-14 - - mcp-client-2025-04-04 - - mcp-client-2025-11-20 - - dev-full-thinking-2025-05-14 - - interleaved-thinking-2025-05-14 - - code-execution-2025-05-22 - - extended-cache-ttl-2025-04-11 - - context-1m-2025-08-07 - - context-management-2025-06-27 - - model-context-window-exceeded-2025-08-26 - - skills-2025-10-02 - - fast-mode-2026-02-01 - - output-300k-2026-03-24 - - user-profiles-2026-03-24 - - advisor-tool-2026-03-01 - - managed-agents-2026-04-01 - - cache-diagnosis-2026-04-07 - - thinking-token-count-2026-05-13 - - server-side-fallback-2026-06-01 - - fallback-credit-2026-06-01 - - agent-memory-2026-07-22 - x-stainless-nominal: false - BetaFileMetadataSchema: + FileMetadataSchema: properties: created_at: - type: string - format: date-time - title: Created At description: RFC 3339 datetime string representing when the file was created. examples: - "2025-04-15T18:37:24.100435Z" + format: date-time + title: Created At + type: string downloadable: - type: boolean - title: Downloadable - description: Whether the file can be downloaded. default: false + description: Whether the file can be downloaded. examples: - false - filename: + title: Downloadable + type: boolean + expires_at: + default: null + description: RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value. + examples: + - "2025-05-15T18:37:24.100435Z" + title: Expires At + nullable: true + format: date-time type: string - maxLength: 500 - minLength: 1 - title: Filename + filename: description: Original filename of the uploaded file. examples: - document.pdf - id: + maxLength: 500 + minLength: 1 + title: Filename type: string - title: Id + id: description: |- Unique object identifier. The format and length of IDs may change over time. examples: - file_011CNha8iCJcU1wXNR6q4V8w - mime_type: + title: Id type: string - maxLength: 255 - minLength: 1 - title: Mime Type + mime_type: description: MIME type of the file. examples: - application/pdf - scope: - description: The scope of this file, indicating the context in which it was created (e.g., a session). - nullable: true - properties: - id: - type: string - title: Id - description: The ID of the scoping resource (e.g., the session ID). - type: - type: string - title: Type - description: The type of scope (e.g., `"session"`). - enum: - - session - type: object - required: - - id - - type - title: FileScope + maxLength: 255 + minLength: 1 + title: Mime Type + type: string size_bytes: - type: integer - minimum: 0 - title: Size Bytes description: Size of the file in bytes. examples: - 102400 + minimum: 0 + title: Size Bytes + type: integer type: - type: string - title: Type description: |- Object type. For files, this is always `"file"`. + title: Type + type: string enum: - file - type: object required: - created_at - filename @@ -546,20 +879,21 @@ components: - size_bytes - type title: FileMetadataSchema - BetaErrorResponse: + type: object + ErrorResponse: properties: error: discriminator: mapping: - api_error: "#/components/schemas/BetaAPIError" - authentication_error: "#/components/schemas/BetaAuthenticationError" - billing_error: "#/components/schemas/BetaBillingError" - invalid_request_error: "#/components/schemas/BetaInvalidRequestError" - not_found_error: "#/components/schemas/BetaNotFoundError" - overloaded_error: "#/components/schemas/BetaOverloadedError" - permission_error: "#/components/schemas/BetaPermissionError" - rate_limit_error: "#/components/schemas/BetaRateLimitError" - timeout_error: "#/components/schemas/BetaGatewayTimeoutError" + api_error: "#/components/schemas/APIError" + authentication_error: "#/components/schemas/AuthenticationError" + billing_error: "#/components/schemas/BillingError" + invalid_request_error: "#/components/schemas/InvalidRequestError" + not_found_error: "#/components/schemas/NotFoundError" + overloaded_error: "#/components/schemas/OverloadedError" + permission_error: "#/components/schemas/PermissionError" + rate_limit_error: "#/components/schemas/RateLimitError" + timeout_error: "#/components/schemas/GatewayTimeoutError" propertyName: type title: Error properties: @@ -594,38 +928,24 @@ components: - type title: ErrorResponse type: object - BetaFileListResponse: + FileListResponse: properties: data: items: - $ref: "#/components/schemas/BetaFileMetadataSchema" + $ref: "#/components/schemas/FileMetadataSchema" type: array title: Data description: List of file metadata objects. - first_id: - title: First Id - description: ID of the first file in this page of results. - examples: - - file_011CNha8iCJcU1wXNR6q4V8w - nullable: true - type: string - has_more: - type: boolean - title: Has More - description: Whether there are more results available. - default: false - last_id: - title: Last Id - description: ID of the last file in this page of results. - examples: - - file_013Zva2CMHLNnXjNJJKqJ2EF + next_page: + title: Next Page + description: Opaque cursor for the next page. Supply as `?page=` to fetch the next page; null when there are no more results. nullable: true type: string type: object required: - data title: FileListResponse - BetaFileDeleteResponse: + FileDeleteResponse: properties: id: type: string @@ -647,24 +967,7 @@ components: required: - id title: FileDeleteResponse - BetaFileScope: - properties: - id: - type: string - title: Id - description: The ID of the scoping resource (e.g., the session ID). - type: - type: string - title: Type - description: The type of scope (e.g., `"session"`). - enum: - - session - type: object - required: - - id - - type - title: FileScope - BetaInvalidRequestError: + InvalidRequestError: properties: message: default: Invalid request @@ -681,7 +984,7 @@ components: - type title: InvalidRequestError type: object - BetaAuthenticationError: + AuthenticationError: properties: message: default: Authentication error @@ -698,7 +1001,7 @@ components: - type title: AuthenticationError type: object - BetaBillingError: + BillingError: properties: message: default: Billing error @@ -715,7 +1018,7 @@ components: - type title: BillingError type: object - BetaPermissionError: + PermissionError: properties: message: default: Permission denied @@ -732,7 +1035,7 @@ components: - type title: PermissionError type: object - BetaNotFoundError: + NotFoundError: properties: message: default: Not found @@ -749,7 +1052,7 @@ components: - type title: NotFoundError type: object - BetaRateLimitError: + RateLimitError: properties: message: default: Rate limited @@ -766,7 +1069,7 @@ components: - type title: RateLimitError type: object - BetaGatewayTimeoutError: + GatewayTimeoutError: properties: message: default: Request timeout @@ -783,7 +1086,7 @@ components: - type title: GatewayTimeoutError type: object - BetaAPIError: + APIError: properties: message: default: Internal server error @@ -800,7 +1103,7 @@ components: - type title: APIError type: object - BetaOverloadedError: + OverloadedError: properties: message: default: Overloaded @@ -839,7 +1142,7 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: "#/paths/~1v1~1files?beta=true/post" + $ref: "#/paths/~1v1~1files/post" response: mediaType: application/json openAPIDocKey: "200" @@ -849,31 +1152,38 @@ components: mediaType: multipart/form-data list: operation: - $ref: "#/paths/~1v1~1files?beta=true/get" + $ref: "#/paths/~1v1~1files/get" response: mediaType: application/json openAPIDocKey: "200" objectKey: $.data config: + pagination: + requestToken: + key: page + location: query + responseToken: + key: $.next_page + location: body queryParamPushdown: top: paramName: limit maxValue: 1000 get: operation: - $ref: "#/paths/~1v1~1files~1{file_id}?beta=true/get" + $ref: "#/paths/~1v1~1files~1{file_id}/get" response: mediaType: application/json openAPIDocKey: "200" delete: operation: - $ref: "#/paths/~1v1~1files~1{file_id}?beta=true/delete" + $ref: "#/paths/~1v1~1files~1{file_id}/delete" response: mediaType: application/json openAPIDocKey: "200" download: operation: - $ref: "#/paths/~1v1~1files~1{file_id}~1content?beta=true/get" + $ref: "#/paths/~1v1~1files~1{file_id}~1content/get" response: mediaType: application/octet-stream openAPIDocKey: "200" diff --git a/providers/src/anthropic/v00.00.00000/services/memory_stores.yaml b/providers/src/anthropic/v00.00.00000/services/memory_stores.yaml index a746c285..0ca8ba6a 100644 --- a/providers/src/anthropic/v00.00.00000/services/memory_stores.yaml +++ b/providers/src/anthropic/v00.00.00000/services/memory_stores.yaml @@ -40,6 +40,17 @@ paths: schema: $ref: "#/components/schemas/BetaManagedAgentsMemoryView" description: Query parameter for view + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -143,6 +154,9 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaManagedAgentsErrorResponse" + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 get: operationId: BetaListMemories summary: List memories @@ -183,6 +197,8 @@ paths: schema: type: string description: Optional path prefix filter. Must end with `/` (segment-aligned), e.g., `/notes/`. This value appears in request URLs. Do not include secrets or personally identifiable information. + x-anthropic-beta-required: + - agent-memory-2026-07-22 - name: depth in: query required: false @@ -190,6 +206,8 @@ paths: type: integer format: int32 description: "`0` (or omitted) returns all descendants below `path_prefix` (recursive). `1` returns immediate children only; deeper entries roll up as `memory_prefix` items. `depth=1` behaves like `ls`; omitting `depth` behaves like `find`." + x-anthropic-beta-required: + - agent-memory-2026-07-22 - name: limit in: query required: false @@ -197,18 +215,35 @@ paths: type: integer format: int32 description: Maximum number of items to return per page. Must be between 1 and 100. Defaults to 20 when omitted. Capped at 20 when `view=full`. Both `memory` and `memory_prefix` items count toward the limit. + x-anthropic-beta-required: + - agent-memory-2026-07-22 - name: page in: query required: false schema: type: string description: Opaque pagination cursor (a `page_...` value). Pass the `next_page` value from a previous response to fetch the next page; omit for the first page. + x-anthropic-beta-required: + - agent-memory-2026-07-22 - name: view in: query required: false schema: $ref: "#/components/schemas/BetaManagedAgentsMemoryView" description: Which projection of each `memory` to return. Defaults to `basic` (content omitted). `full` populates `content` on each item and caps `limit` at 20; use this as the bulk-read path for export and sync. + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -306,6 +341,9 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaManagedAgentsErrorResponse" + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 /v1/memory_stores/{memory_store_id}/memories/{memory_id}?beta=true: get: operationId: BetaGetMemory @@ -353,6 +391,17 @@ paths: schema: $ref: "#/components/schemas/BetaManagedAgentsMemoryView" description: Query parameter for view + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -450,6 +499,9 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaManagedAgentsErrorResponse" + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 post: operationId: BetaUpdateMemory summary: Update a memory @@ -492,6 +544,17 @@ paths: schema: $ref: "#/components/schemas/BetaManagedAgentsMemoryView" description: Query parameter for view + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -595,6 +658,9 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaManagedAgentsErrorResponse" + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 delete: operationId: BetaDeleteMemory summary: Delete a memory @@ -641,6 +707,17 @@ paths: schema: type: string description: Query parameter for expected_content_sha256 + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -738,6 +815,9 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaManagedAgentsErrorResponse" + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 /v1/memory_stores/{memory_store_id}/memory_versions?beta=true: get: operationId: BetaListMemoryVersions @@ -791,6 +871,12 @@ paths: schema: type: string description: Query parameter for api_key_id + - name: service_account_id + in: query + required: false + schema: + type: string + description: Query parameter for service_account_id - name: operation in: query required: false @@ -828,6 +914,17 @@ paths: schema: $ref: "#/components/schemas/BetaManagedAgentsMemoryView" description: Query parameter for view + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -925,6 +1022,9 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaManagedAgentsErrorResponse" + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 /v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}?beta=true: get: operationId: BetaGetMemoryVersion @@ -972,6 +1072,17 @@ paths: schema: $ref: "#/components/schemas/BetaManagedAgentsMemoryView" description: Query parameter for view + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1069,6 +1180,9 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaManagedAgentsErrorResponse" + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 /v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact?beta=true: post: operationId: BetaRedactMemoryVersion @@ -1105,6 +1219,17 @@ paths: schema: type: string description: Path parameter memory_version_id + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1202,6 +1327,9 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaManagedAgentsErrorResponse" + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 /v1/memory_stores?beta=true: post: operationId: BetaCreateMemoryStore @@ -1309,6 +1437,9 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 parameters: - name: anthropic-version in: header @@ -1329,6 +1460,17 @@ paths: items: $ref: "#/components/schemas/AnthropicBeta" default: agent-memory-2026-07-22 + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy get: operationId: BetaListMemoryStores summary: List memory stores @@ -1388,6 +1530,17 @@ paths: schema: $ref: "#/components/schemas/BetaTimestamp" description: Return only stores whose `created_at` is at or before this time (inclusive). Sent on the wire as `created_at[lte]`. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1485,6 +1638,9 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 /v1/memory_stores/{memory_store_id}?beta=true: get: operationId: BetaGetMemoryStore @@ -1520,6 +1676,17 @@ paths: schema: type: string description: Path parameter memory_store_id + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1617,6 +1784,9 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 post: operationId: BetaUpdateMemoryStore summary: Update a memory store @@ -1647,6 +1817,17 @@ paths: type: string x-stainless-cli-data-alias: id description: Path parameter memory_store_id + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -1750,6 +1931,9 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 delete: operationId: BetaDeleteMemoryStore summary: Delete a memory store @@ -1784,6 +1968,17 @@ paths: schema: type: string description: Path parameter memory_store_id + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1881,6 +2076,9 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 /v1/memory_stores/{memory_store_id}/archive?beta=true: post: operationId: BetaArchiveMemoryStore @@ -1911,6 +2109,17 @@ paths: schema: type: string description: Path parameter memory_store_id + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -2008,6 +2217,9 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 components: schemas: AnthropicBeta: @@ -2035,13 +2247,29 @@ components: - fast-mode-2026-02-01 - output-300k-2026-03-24 - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 - advisor-tool-2026-03-01 - managed-agents-2026-04-01 - cache-diagnosis-2026-04-07 + - dreaming-2026-04-21 - thinking-token-count-2026-05-13 - server-side-fallback-2026-06-01 + - server-side-fallback-2026-07-01 - fallback-credit-2026-06-01 + - fallback-credit-2026-07-01 - agent-memory-2026-07-22 + - mid-conversation-tool-changes-2026-07-01 + - compact-2026-01-12 + - computer-use-2025-11-24 + - mcp-tunnels-2026-06-22 + - structured-outputs-2025-11-13 + - task-budgets-2026-03-13 + - thinking-display-updates-2026-08-18 + - ce-user-management-2026-07-13 + - mid-conversation-output-config-2026-07-01 + - thinking-binding-controls-2026-08-01 + - mid-conversation-system-clear-at-2026-08-21 x-stainless-nominal: false BetaManagedAgentsMemoryView: type: string @@ -2057,14 +2285,14 @@ components: - content properties: path: - description: Hierarchical path for the new memory, e.g. `/projects/foo/notes.md`. Must start with `/`, contain at least one non-empty segment, and be at most 1,024 bytes. Must not contain empty segments, `.` or `..` segments, control or format characters, and must be NFC-normalized. Paths are case-sensitive. + description: Hierarchical path for the new memory, e.g. `/projects/foo/notes.md`. Must start with `/`, contain at least one non-empty segment, and be at most 1,024 bytes. Must not contain empty segments, `.` or `..` segments, control or format characters, or the Unicode line and paragraph separators (U+2028, U+2029), and must be NFC-normalized. Paths are case-sensitive. type: string minLength: 2 maxLength: 1024 content: description: UTF-8 text content for the new memory. Maximum 100 kB (102,400 bytes). Required; pass `""` explicitly to create an empty memory. - type: string nullable: true + type: string BetaManagedAgentsMemory: description: "A `memory` object: a single text document at a hierarchical path inside a memory store. The `content` field is populated when `view=full` and `null` when `view=basic`; the `content_size_bytes` and `content_sha256` fields are always populated so sync clients can diff without fetching content. Memories are addressed by their `mem_...` ID; the path is the create key and can be changed via update." type: object @@ -2094,8 +2322,8 @@ components: type: string content: description: The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). - type: string nullable: true + type: string content_size_bytes: description: Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`. type: integer @@ -2104,7 +2332,7 @@ components: description: Lowercase hex SHA-256 digest of the UTF-8 `content` bytes (64 characters). The server applies no normalization, so clients can compute the same hash locally for staleness checks and as the value for a `content_sha256` precondition on update. Always populated, regardless of `view`. type: string memory_version_id: - description: ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/en/api/beta/memory_stores/memory_versions/list). + description: ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/en/api/beta/memory_stores/memory_versions/list). type: string created_at: description: When this memory was created, in RFC 3339 format. @@ -2138,22 +2366,22 @@ components: $ref: "#/components/schemas/BetaManagedAgentsMemoryListItem" next_page: description: Opaque cursor for the next page (a `page_...` value), or `null` if there are no more results. Pass as `page` on the next request. - type: string nullable: true + type: string BetaManagedAgentsUpdateMemoryParams: description: "Request parameters for [Update a memory](/en/api/beta/memory_stores/memories/update). At least one of `content` or `path` must be provided. Renaming onto a path occupied by a different memory returns `memory_path_conflict_error` (HTTP 409). Rename never overwrites; delete or rename the blocking memory first. An update where every supplied field already matches the stored value is a no-op: it returns 200 with the existing memory and writes no new version." type: object properties: content: description: New UTF-8 text content for the memory. Maximum 100 kB (102,400 bytes). Omit to leave the content unchanged (e.g., for a rename-only update). - type: string nullable: true + type: string path: - description: New path for the memory (a rename). Must start with `/`, contain at least one non-empty segment, and be at most 1,024 bytes. Must not contain empty segments, `.` or `..` segments, control or format characters, and must be NFC-normalized. Paths are case-sensitive. The memory's `id` is preserved across renames. Omit to leave the path unchanged. + description: New path for the memory (a rename). Must start with `/`, contain at least one non-empty segment, and be at most 1,024 bytes. Must not contain empty segments, `.` or `..` segments, control or format characters, or the Unicode line and paragraph separators (U+2028, U+2029), and must be NFC-normalized. Paths are case-sensitive. The memory's `id` is preserved across renames. Omit to leave the path unchanged. + nullable: true type: string minLength: 2 maxLength: 1024 - nullable: true precondition: description: Optional optimistic-concurrency precondition. When supplied, the update applies only if the memory's current state matches; on mismatch the request returns `memory_precondition_failed_error` (HTTP 409). When omitted, the update is unconditional. type: object @@ -2172,7 +2400,7 @@ components: description: Expected `content_sha256` of the stored memory (64 lowercase hexadecimal characters). Typically the `content_sha256` returned by a prior read or list call. Because the server applies no content normalization, clients can also compute this locally as the SHA-256 of the UTF-8 content bytes. type: string BetaManagedAgentsDeletedMemory: - description: Tombstone returned by [Delete a memory](/en/api/beta/memory_stores/memories/delete). The memory's version history persists and remains listable via [List memory versions](/en/api/beta/memory_stores/memory_versions/list) until the store itself is deleted. + description: "Tombstone returned by [Delete a memory](/en/api/beta/memory_stores/memories/delete). Deleting a memory does not erase its version history: its versions remain listable via [List memory versions](/en/api/beta/memory_stores/memory_versions/list) while they are retained (each version is kept for at least the version retention period after it was written, unless the store itself is deleted)." type: object required: - type @@ -2207,10 +2435,10 @@ components: $ref: "#/components/schemas/BetaManagedAgentsMemoryVersion" next_page: description: Opaque cursor for the next page (a `page_...` value), or `null` if there are no more results. Pass as `page` on the next request. - type: string nullable: true + type: string BetaManagedAgentsMemoryVersion: - description: "A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and persist after the memory is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status." + description: "A `memory_version` object: one immutable, attributed row in a memory's append-only history. Every non-no-op mutation to a memory produces a new version. Versions belong to the store (not the individual memory) and are not deleted with the memory; each version is retained for at least the version retention period after it was written, unless the store itself is deleted. Retrieving a redacted version returns 200 with `content`, `path`, `content_size_bytes`, and `content_sha256` set to `null`; branch on `redacted_at`, not HTTP status." type: object required: - type @@ -2231,12 +2459,12 @@ components: description: ID of the memory store this version belongs to (a `memstore_...` value). type: string memory_id: - description: ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/en/api/beta/memory_stores/memory_versions/list) to retrieve the full lineage including the `deleted` row. + description: ID of the memory this version snapshots (a `mem_...` value). Remains valid after the memory is deleted; pass it as `memory_id` to [List memory versions](/en/api/beta/memory_stores/memory_versions/list) to retrieve the memory's retained versions, including the `deleted` row while the lineage is retained. type: string path: description: The memory's path at the time of this write. `null` if and only if `redacted_at` is set. - type: string nullable: true + type: string operation: description: "The kind of mutation this version records: `created`, `modified`, or `deleted`." type: string @@ -2246,19 +2474,19 @@ components: - deleted content: description: The memory's UTF-8 text content as of this version. `null` when `view=basic`, when `operation` is `deleted`, or when `redacted_at` is set. - type: string nullable: true + type: string content_size_bytes: description: Size of `content` in bytes as of this version. `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. + nullable: true type: integer format: int32 - nullable: true content_sha256: description: Lowercase hex SHA-256 digest of `content` as of this version (64 characters). `null` when `redacted_at` is set or `operation` is `deleted`. Populated regardless of `view` otherwise. - type: string nullable: true + type: string created_by: - description: "Who performed this write: a `session_actor`, `api_actor`, or `user_actor`. Captured at write time and preserved through redaction." + description: "Who performed this write: one of `session_actor`, `api_actor`, `user_actor`, or `service_account_actor`; `null` when no writer is recorded. Captured at write time and preserved through redaction." type: object discriminator: propertyName: type @@ -2266,18 +2494,20 @@ components: session_actor: "#/components/schemas/BetaManagedAgentsSessionActor" api_actor: "#/components/schemas/BetaManagedAgentsApiActor" user_actor: "#/components/schemas/BetaManagedAgentsUserActor" + service_account_actor: "#/components/schemas/BetaManagedAgentsServiceAccountActor" required: - type - session_id - api_key_id - user_id + - service_account_id properties: type: type: string enum: - session_actor session_id: - description: ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/en/api/sessions-retrieve) for further provenance. + description: ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/en/api/beta/sessions/retrieve) for further provenance. type: string minLength: 1 api_key_id: @@ -2288,6 +2518,10 @@ components: description: ID of the user who performed the write (a `user_...` value). type: string minLength: 1 + service_account_id: + description: ID of the service account that performed the write (a `svac_...` value). + type: string + minLength: 1 created_at: description: When this version was written, in RFC 3339 format. type: string @@ -2298,7 +2532,7 @@ components: type: string format: date-time redacted_by: - description: Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor` or `user_actor` (agents do not have a redact capability). + description: Who redacted this version, or `null` if it has not been redacted. In practice always an `api_actor`, `user_actor`, or `service_account_actor` (agents do not have a redact capability). type: object discriminator: propertyName: type @@ -2306,18 +2540,20 @@ components: session_actor: "#/components/schemas/BetaManagedAgentsSessionActor" api_actor: "#/components/schemas/BetaManagedAgentsApiActor" user_actor: "#/components/schemas/BetaManagedAgentsUserActor" + service_account_actor: "#/components/schemas/BetaManagedAgentsServiceAccountActor" required: - type - session_id - api_key_id - user_id + - service_account_id properties: type: type: string enum: - session_actor session_id: - description: ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/en/api/sessions-retrieve) for further provenance. + description: ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/en/api/beta/sessions/retrieve) for further provenance. type: string minLength: 1 api_key_id: @@ -2328,6 +2564,10 @@ components: description: ID of the user who performed the write (a `user_...` value). type: string minLength: 1 + service_account_id: + description: ID of the service account that performed the write (a `svac_...` value). + type: string + minLength: 1 BetaManagedAgentsCreateMemoryStoreRequest: description: Request parameters for creating a `memory_store`. type: object @@ -2448,8 +2688,8 @@ components: $ref: "#/components/schemas/BetaManagedAgentsMemoryStore" next_page: description: Opaque cursor for the next page (a `page_...` value). Pass as `page` on the next request. `null` when there are no more results. - type: string nullable: true + type: string BetaManagedAgentsGetMemoryStoreResponse: description: Response from retrieving a `memory_store`. Returns the store, including archived stores. type: object @@ -2498,19 +2738,19 @@ components: properties: name: description: New human-readable name for the store. 1–255 characters; no control characters. Renaming changes the slug used for the store's `mount_path` in sessions created after the update. + nullable: true type: string minLength: 1 maxLength: 255 - nullable: true description: description: New description for the store, up to 1024 characters. Pass an empty string to clear it. + nullable: true type: string maxLength: 1024 - nullable: true metadata: description: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars. - type: object nullable: true + type: object BetaManagedAgentsUpdateMemoryStoreResponse: description: Response from updating a `memory_store`. Returns the store with the changes applied. type: object @@ -2685,8 +2925,8 @@ components: type: string content: description: The memory's UTF-8 text content. Populated when `view=full`; `null` when `view=basic`. Maximum 100 kB (102,400 bytes). - type: string nullable: true + type: string content_size_bytes: description: Size of `content` in bytes (the UTF-8 plaintext length). Always populated, regardless of `view`. type: integer @@ -2695,7 +2935,7 @@ components: description: Lowercase hex SHA-256 digest of the UTF-8 `content` bytes (64 characters). The server applies no normalization, so clients can compute the same hash locally for staleness checks and as the value for a `content_sha256` precondition on update. Always populated, regardless of `view`. type: string memory_version_id: - description: ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the full history via [List memory versions](/en/api/beta/memory_stores/memory_versions/list). + description: ID of the `memory_version` representing this memory's current content (a `memver_...` value). This is the authoritative head pointer; `memory_version` objects do not carry an `is_latest` flag, so compare against this field instead. Enumerate the history via [List memory versions](/en/api/beta/memory_stores/memory_versions/list). type: string created_at: description: When this memory was created, in RFC 3339 format. @@ -2723,7 +2963,7 @@ components: description: Expected `content_sha256` of the stored memory (64 lowercase hexadecimal characters). Typically the `content_sha256` returned by a prior read or list call. Because the server applies no content normalization, clients can also compute this locally as the SHA-256 of the UTF-8 content bytes. type: string BetaManagedAgentsActor: - description: Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/en/api/sessions-retrieve). + description: Identifies who performed a write or redact operation. Captured at write time on the `memory_version` row. The API key that created a session is not recorded on agent writes; attribution answers who made the write, not who is ultimately responsible. Look up session provenance separately via the [Sessions API](/en/api/beta/sessions/retrieve). type: object discriminator: propertyName: type @@ -2731,18 +2971,20 @@ components: session_actor: "#/components/schemas/BetaManagedAgentsSessionActor" api_actor: "#/components/schemas/BetaManagedAgentsApiActor" user_actor: "#/components/schemas/BetaManagedAgentsUserActor" + service_account_actor: "#/components/schemas/BetaManagedAgentsServiceAccountActor" required: - type - session_id - api_key_id - user_id + - service_account_id properties: type: type: string enum: - session_actor session_id: - description: ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/en/api/sessions-retrieve) for further provenance. + description: ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/en/api/beta/sessions/retrieve) for further provenance. type: string minLength: 1 api_key_id: @@ -2753,6 +2995,10 @@ components: description: ID of the user who performed the write (a `user_...` value). type: string minLength: 1 + service_account_id: + description: ID of the service account that performed the write (a `svac_...` value). + type: string + minLength: 1 BetaManagedAgentsMemoryStore: description: "A `memory_store`: a named container for agent memories, scoped to a workspace. Attach a store to a session via `resources[]` to mount it as a directory the agent can read and write." type: object @@ -3035,7 +3281,7 @@ components: enum: - session_actor session_id: - description: ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/en/api/sessions-retrieve) for further provenance. + description: ID of the session that performed the write (a `sesn_...` value). Look up the session via [Retrieve a session](/en/api/beta/sessions/retrieve) for further provenance. type: string minLength: 1 BetaManagedAgentsApiActor: @@ -3068,6 +3314,21 @@ components: description: ID of the user who performed the write (a `user_...` value). type: string minLength: 1 + BetaManagedAgentsServiceAccountActor: + description: Attribution for a write made by a workload authenticated as a service account, for example via Workload Identity Federation. + type: object + required: + - type + - service_account_id + properties: + type: + type: string + enum: + - service_account_actor + service_account_id: + description: ID of the service account that performed the write (a `svac_...` value). + type: string + minLength: 1 StackqlExecResult: type: object description: Synthetic dispatch-result envelope for EXEC-only methods (see post-pass step 3). diff --git a/providers/src/anthropic/v00.00.00000/services/messages.yaml b/providers/src/anthropic/v00.00.00000/services/messages.yaml index 7a7e86d1..d7c04db6 100644 --- a/providers/src/anthropic/v00.00.00000/services/messages.yaml +++ b/providers/src/anthropic/v00.00.00000/services/messages.yaml @@ -39,6 +39,17 @@ paths: title: Anthropic-User-Profile-Id x-stainless-param: user_profile_id description: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Message object. @@ -46,11 +57,98 @@ paths: application/json: schema: $ref: "#/components/schemas/Message" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -96,6 +194,17 @@ paths: title: Anthropic-User-Profile-Id x-stainless-param: user_profile_id description: The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -103,11 +212,98 @@ paths: application/json: schema: $ref: "#/components/schemas/MessageBatch" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -188,6 +384,17 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -195,11 +402,98 @@ paths: application/json: schema: $ref: "#/components/schemas/ListResponse_MessageBatch_" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -250,6 +544,17 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -257,62 +562,160 @@ paths: application/json: schema: $ref: "#/components/schemas/MessageBatch" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - delete: - summary: Delete a Message Batch - description: |- - Delete a Message Batch. - - Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it. - - Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing) - operationId: message_batches_delete - parameters: - - name: message_batch_id - in: path - required: true - schema: - type: string - description: ID of the Message Batch. - title: Message Batch Id - description: ID of the Message Batch. - - name: anthropic-version - in: header - required: false - schema: - type: string - description: |- - The version of the Claude API you want to use. - - Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). - title: Anthropic-Version - default: "2023-06-01" - description: |- - The version of the Claude API you want to use. - - Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). - - name: x-api-key - in: header - required: false - schema: - type: string - description: |- - Your unique API key for authentication. - - This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. - title: X-Api-Key - description: |- + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + delete: + summary: Delete a Message Batch + description: |- + Delete a Message Batch. + + Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it. + + Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing) + operationId: message_batches_delete + parameters: + - name: message_batch_id + in: path + required: true + schema: + type: string + description: ID of the Message Batch. + title: Message Batch Id + description: ID of the Message Batch. + - name: anthropic-version + in: header + required: false + schema: + type: string + description: |- + The version of the Claude API you want to use. + + Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). + title: Anthropic-Version + default: "2023-06-01" + description: |- + The version of the Claude API you want to use. + + Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). + - name: x-api-key + in: header + required: false + schema: + type: string + description: |- + Your unique API key for authentication. + + This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + title: X-Api-Key + description: |- Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -320,11 +723,98 @@ paths: application/json: schema: $ref: "#/components/schemas/DeleteMessageBatchResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -363,6 +853,17 @@ paths: The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -370,11 +871,98 @@ paths: application/json: schema: $ref: "#/components/schemas/MessageBatch" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -427,6 +1015,17 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -434,23 +1033,110 @@ paths: application/x-jsonl: schema: $ref: "#/components/schemas/MessageBatchIndividualResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" - /v1/messages/count_tokens: - post: - summary: Count tokens in a Message - description: |- - Count the number of tokens in a Message. - - The Token Count API can be used to count the number of tokens in a Message, including tools, images, and documents, without creating it. - + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + /v1/messages/count_tokens: + post: + summary: Count tokens in a Message + description: |- + Count the number of tokens in a Message. + + The Token Count API can be used to count the number of tokens in a Message, including tools, images, and documents, without creating it. + Learn more about token counting in our [user guide](https://platform.claude.com/docs/en/build-with-claude/token-counting) operationId: messages_count_tokens_post parameters: @@ -478,6 +1164,17 @@ paths: title: Anthropic-User-Profile-Id x-stainless-param: user_profile_id description: The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -485,11 +1182,98 @@ paths: application/json: schema: $ref: "#/components/schemas/CountMessageTokensResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -509,7 +1293,7 @@ components: text: Hi! My name is Claude. type: text id: msg_013Zva2CMHLNnXjNJJKqJ2EF - model: claude-opus-4-6 + model: claude-opus-5 role: assistant stop_details: null stop_reason: end_turn @@ -596,6 +1380,7 @@ components: * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations + * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. title: Stop Reason @@ -607,6 +1392,7 @@ components: - tool_use - pause_turn - refusal + - model_context_window_exceeded type: string stop_sequence: default: null @@ -637,14 +1423,23 @@ components: - bio - frontier_llm - reasoning_extraction + - general_harms title: RefusalCategory type: string + x-enum-descriptions: + - The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. + - The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. + - The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. + - The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking). + - The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. explanation: default: null description: |- Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. + examples: + - This request was declined because it conflicts with Anthropic's Usage Policy. title: Explanation nullable: true type: string @@ -690,11 +1485,22 @@ components: type: string id: description: Identifier for the container used in this request + examples: + - container_011CpZohnwH4vuy7gazohgSP title: Id type: string + skills: + default: null + description: Skills loaded in the container + title: Skills + nullable: true + items: + $ref: "#/components/schemas/ContainerSkill" + type: array required: - expires_at - id + - skills title: Container type: object required: @@ -766,7 +1572,7 @@ components: messages: - content: Hello, world role: user - model: claude-opus-4-6 + model: claude-opus-5 properties: model: $ref: "#/components/schemas/Model" @@ -832,7 +1638,21 @@ components: description: Container identifier for reuse across requests. title: Container nullable: true - type: string + properties: + id: + description: Container id + title: Id + nullable: true + type: string + skills: + description: List of skills to load in the container + title: Skills + nullable: true + items: + $ref: "#/components/schemas/SkillParams" + maxItems: 20 + type: array + type: object inference_geo: description: Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. title: Inference Geo @@ -917,6 +1737,8 @@ components: title: Temperature type: number x-stainless-deprecation-message: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 of will be accepted for backwards compatibility, all other values will be rejected with a 400 error. + x-stainless-skip: + - python thinking: $ref: "#/components/schemas/ThinkingConfigParam" tool_choice: @@ -1016,6 +1838,8 @@ components: title: Top K type: integer x-stainless-deprecation-message: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error. + x-stainless-skip: + - python top_p: deprecated: true description: |- @@ -1031,6 +1855,8 @@ components: title: Top P type: number x-stainless-deprecation-message: Deprecated. Models released after Claude Opus 4.6 do not support setting top_p. A value >= 0.99 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. + x-stainless-skip: + - python required: - model - messages @@ -1268,7 +2094,7 @@ components: - messages: - content: Hello, world role: user - model: claude-opus-4-6 + model: claude-opus-5 properties: cache_control: type: string @@ -1465,7 +2291,6 @@ components: type: string type: array text: - maxLength: 5000000 minLength: 0 title: Text type: string @@ -1476,12 +2301,25 @@ components: enum: - text signature: + description: |- + A value used to verify that this thinking block was generated by Claude when it is passed back to the API. + + This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. + + See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details. title: Signature type: string thinking: + description: The text of Claude's thinking process for this block. title: Thinking type: string data: + description: |- + The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. + + Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. + + See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details. title: Data type: string caller: @@ -1520,6 +2358,15 @@ components: minLength: 1 title: Name type: string + toolset_name: + default: null + description: For a toolset member tool_use, the toolset family. + title: Toolset Name + nullable: true + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + type: string content: title: Content properties: @@ -1570,7 +2417,7 @@ components: type: string x-stainless-nominal: false enum: - - claude-sonnet-5 + - claude-fable-5-1 deprecated: true x-stainless-deprecation-message: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. StopReason: @@ -1581,6 +2428,7 @@ components: - tool_use - pause_turn - refusal + - model_context_window_exceeded type: string RefusalStopDetails: description: Structured information about a refusal. @@ -1597,14 +2445,23 @@ components: - bio - frontier_llm - reasoning_extraction + - general_harms title: RefusalCategory type: string + x-enum-descriptions: + - The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. + - The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. + - The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. + - The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking). + - The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. explanation: default: null description: |- Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. + examples: + - This request was declined because it conflicts with Anthropic's Usage Policy. title: Explanation nullable: true type: string @@ -1665,6 +2522,8 @@ components: inference_geo: default: null description: The geographic region where inference was performed for this request. + examples: + - global title: Inference Geo nullable: true type: string @@ -1769,11 +2628,22 @@ components: type: string id: description: Identifier for the container used in this request + examples: + - container_011CpZohnwH4vuy7gazohgSP title: Id type: string + skills: + default: null + description: Skills loaded in the container + title: Skills + nullable: true + items: + $ref: "#/components/schemas/ContainerSkill" + type: array required: - expires_at - id + - skills title: Container type: object InvalidRequestError: @@ -1985,6 +2855,24 @@ components: title: CacheControlEphemeral type: object x-stainless-go-constant-constructor: true + ContainerParams: + description: Container parameters with skills to be loaded. + properties: + id: + description: Container id + title: Id + nullable: true + type: string + skills: + description: List of skills to load in the container + title: Skills + nullable: true + items: + $ref: "#/components/schemas/SkillParams" + maxItems: 20 + type: array + title: ContainerParams + type: object Metadata: properties: user_id: @@ -2007,6 +2895,7 @@ components: How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. + title: Effort nullable: true enum: - low @@ -2014,7 +2903,6 @@ components: - high - xhigh - max - title: EffortLevel type: string format: description: A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) @@ -2412,83 +3300,907 @@ components: - type title: CodeExecutionTool_20260521 type: object - MemoryTool_20250818: + BrowserToolset_20260801: + description: |- + The browser toolset: a single ``tools[]`` entry (carrying no + ``name``) that declares the browser tool family. The model is served + the family's tool with any members disabled via ``configs`` removed + from its schema. properties: - allowed_callers: - items: - $ref: "#/components/schemas/AllowedCaller" - title: Allowed Callers - type: array cache_control: type: string description: Create a cache control breakpoint at this content block. nullable: true - defer_loading: - description: If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - title: Defer Loading - type: boolean - input_examples: - items: - type: object - title: Input Examples - type: array - name: - description: |- - Name of the tool. - - This is how the tool will be called by the model and in `tool_use` blocks. - title: Name - type: string - enum: - - memory - strict: - description: When true, guarantees schema validation on tool names and inputs - title: Strict - type: boolean - type: - title: Type - type: string - enum: - - memory_20250818 - required: - - name - - type - title: MemoryTool_20250818 - type: object - TextEditor_20250124: - properties: - allowed_callers: - items: - $ref: "#/components/schemas/AllowedCaller" - title: Allowed Callers - type: array - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + configs: + description: Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. nullable: true - defer_loading: - description: If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - title: Defer Loading - type: boolean - input_examples: - items: - type: object - title: Input Examples - type: array - name: - description: |- - Name of the tool. - - This is how the tool will be called by the model and in `tool_use` blocks. - title: Name - type: string - enum: - - str_replace_editor - strict: - description: When true, guarantees schema validation on tool names and inputs - title: Strict - type: boolean - type: + properties: + close_tab: + nullable: true + description: "``close_tab``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserCloseTabConfig + type: object + double_click: + nullable: true + description: "``double_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserDoubleClickConfig + type: object + file_upload: + nullable: true + description: "``file_upload``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserFileUploadConfig + type: object + find: + nullable: true + description: "``find``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserFindConfig + type: object + form_input: + nullable: true + description: "``form_input``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserFormInputConfig + type: object + get_page_text: + nullable: true + description: "``get_page_text``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserGetPageTextConfig + type: object + hold_key: + nullable: true + description: "``hold_key``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserHoldKeyConfig + type: object + hover: + nullable: true + description: "``hover``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserHoverConfig + type: object + javascript_exec: + nullable: true + description: "``javascript_exec``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserJavascriptExecConfig + type: object + key: + nullable: true + description: "``key``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserKeyConfig + type: object + left_click: + nullable: true + description: "``left_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserLeftClickConfig + type: object + left_click_drag: + nullable: true + description: "``left_click_drag``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserLeftClickDragConfig + type: object + left_mouse_down: + nullable: true + description: "``left_mouse_down``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserLeftMouseDownConfig + type: object + left_mouse_up: + nullable: true + description: "``left_mouse_up``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserLeftMouseUpConfig + type: object + list_tabs: + nullable: true + description: "``list_tabs``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserListTabsConfig + type: object + middle_click: + nullable: true + description: "``middle_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserMiddleClickConfig + type: object + mouse_move: + nullable: true + description: "``mouse_move``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserMouseMoveConfig + type: object + navigate: + nullable: true + description: "``navigate``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserNavigateConfig + type: object + new_tab: + nullable: true + description: "``new_tab``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserNewTabConfig + type: object + read_console: + nullable: true + description: "``read_console``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserReadConsoleConfig + type: object + read_network: + nullable: true + description: "``read_network``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserReadNetworkConfig + type: object + read_page: + nullable: true + description: "``read_page``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserReadPageConfig + type: object + right_click: + nullable: true + description: "``right_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserRightClickConfig + type: object + screenshot: + nullable: true + description: "``screenshot``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserScreenshotConfig + type: object + scroll: + nullable: true + description: "``scroll``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserScrollConfig + type: object + scroll_to: + nullable: true + description: "``scroll_to``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserScrollToConfig + type: object + switch_tab: + nullable: true + description: "``switch_tab``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserSwitchTabConfig + type: object + triple_click: + nullable: true + description: "``triple_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserTripleClickConfig + type: object + type: + nullable: true + description: "``type``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserTypeConfig + type: object + wait: + nullable: true + description: "``wait``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserWaitConfig + type: object + zoom: + nullable: true + description: "``zoom``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserZoomConfig + type: object + title: BrowserToolsetConfigs + type: object + type: + title: Type + type: string + enum: + - browser_toolset_20260801 + required: + - type + title: BrowserToolset_20260801 + type: object + MemoryTool_20250818: + properties: + allowed_callers: + items: + $ref: "#/components/schemas/AllowedCaller" + title: Allowed Callers + type: array + cache_control: + type: string + description: Create a cache control breakpoint at this content block. + nullable: true + defer_loading: + description: If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + title: Defer Loading + type: boolean + input_examples: + items: + type: object + title: Input Examples + type: array + name: + description: |- + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + title: Name + type: string + enum: + - memory + strict: + description: When true, guarantees schema validation on tool names and inputs + title: Strict + type: boolean + type: + title: Type + type: string + enum: + - memory_20250818 + required: + - name + - type + title: MemoryTool_20250818 + type: object + ComputerToolset_20260801: + description: |- + The computer toolset: a single ``tools[]`` entry (carrying no + ``name``) that declares the computer tool family. The model is + served the family's tool with any members disabled via ``configs`` + removed from its schema. Every member is enabled by default, zoom + included. The single-tool options ``display_number`` and + ``enable_zoom`` are not fields of a toolset entry — it carries only + ``type``, ``configs``, and ``cache_control``; zoom is controlled + via ``configs.zoom.enabled``. + properties: + cache_control: + type: string + description: Create a cache control breakpoint at this content block. + nullable: true + configs: + description: Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. + nullable: true + properties: + cursor_position: + nullable: true + description: "``cursor_position``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerCursorPositionConfig + type: object + double_click: + nullable: true + description: "``double_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerDoubleClickConfig + type: object + hold_key: + nullable: true + description: "``hold_key``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerHoldKeyConfig + type: object + key: + nullable: true + description: "``key``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerKeyConfig + type: object + left_click: + nullable: true + description: "``left_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerLeftClickConfig + type: object + left_click_drag: + nullable: true + description: "``left_click_drag``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerLeftClickDragConfig + type: object + left_mouse_down: + nullable: true + description: "``left_mouse_down``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerLeftMouseDownConfig + type: object + left_mouse_up: + nullable: true + description: "``left_mouse_up``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerLeftMouseUpConfig + type: object + middle_click: + nullable: true + description: "``middle_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerMiddleClickConfig + type: object + mouse_move: + nullable: true + description: "``mouse_move``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerMouseMoveConfig + type: object + right_click: + nullable: true + description: "``right_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerRightClickConfig + type: object + screenshot: + nullable: true + description: "``screenshot``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerScreenshotConfig + type: object + scroll: + nullable: true + description: "``scroll``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerScrollConfig + type: object + triple_click: + nullable: true + description: "``triple_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerTripleClickConfig + type: object + type: + nullable: true + description: "``type``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerTypeConfig + type: object + wait: + nullable: true + description: "``wait``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerWaitConfig + type: object + zoom: + nullable: true + description: "``zoom``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerZoomConfig + type: object + title: ComputerToolsetConfigs + type: object + type: + title: Type + type: string + enum: + - computer_toolset_20260801 + required: + - type + title: ComputerToolset_20260801 + type: object + TextEditor_20250124: + properties: + allowed_callers: + items: + $ref: "#/components/schemas/AllowedCaller" + title: Allowed Callers + type: array + cache_control: + type: string + description: Create a cache control breakpoint at this content block. + nullable: true + defer_loading: + description: If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + title: Defer Loading + type: boolean + input_examples: + items: + type: object + title: Input Examples + type: array + name: + description: |- + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + title: Name + type: string + enum: + - str_replace_editor + strict: + description: When true, guarantees schema validation on tool names and inputs + title: Strict + type: boolean + type: title: Type type: string enum: @@ -3478,7 +5190,6 @@ components: type: string type: array text: - maxLength: 5000000 minLength: 0 title: Text type: string @@ -3497,9 +5208,16 @@ components: ResponseThinkingBlock: properties: signature: + description: |- + A value used to verify that this thinking block was generated by Claude when it is passed back to the API. + + This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. + + See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details. title: Signature type: string thinking: + description: The text of Claude's thinking process for this block. title: Thinking type: string type: @@ -3517,6 +5235,12 @@ components: ResponseRedactedThinkingBlock: properties: data: + description: |- + The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. + + Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. + + See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking#redacted-thinking-blocks) for details. title: Data type: string type: @@ -3568,6 +5292,15 @@ components: minLength: 1 title: Name type: string + toolset_name: + default: null + description: For a toolset member tool_use, the toolset family. + title: Toolset Name + nullable: true + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + type: string type: default: tool_use title: Type @@ -4057,8 +5790,15 @@ components: - bio - frontier_llm - reasoning_extraction + - general_harms title: RefusalCategory type: string + x-enum-descriptions: + - The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. + - The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. + - The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. + - The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking). + - The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. CacheCreation: properties: ephemeral_1h_input_tokens: @@ -4121,6 +5861,43 @@ components: - web_search_requests title: ServerToolUsage type: object + ContainerSkill: + description: A skill that was loaded in a container (response model). + properties: + skill_id: + description: Skill ID + examples: + - pdf + maxLength: 64 + minLength: 1 + title: Skill Id + type: string + type: + description: Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) + enum: + - anthropic + - custom + examples: + - anthropic + title: Type + type: string + x-stainless-naming: + csharp: + type_name: ContainerSkillType + version: + description: "The resolved version: a skill version ID for custom skills." + examples: + - latest + maxLength: 64 + minLength: 1 + title: Version + type: string + required: + - skill_id + - type + - version + title: ContainerSkill + type: object InputContentBlock: discriminator: mapping: @@ -4129,7 +5906,6 @@ components: container_upload: "#/components/schemas/RequestContainerUploadBlock" document: "#/components/schemas/RequestDocumentBlock" image: "#/components/schemas/RequestImageBlock" - mid_conv_system: "#/components/schemas/RequestMidConvSystemBlock" redacted_thinking: "#/components/schemas/RequestRedactedThinkingBlock" search_result: "#/components/schemas/RequestSearchResultBlock" server_tool_use: "#/components/schemas/RequestServerToolUseBlock" @@ -4172,6 +5948,7 @@ components: discriminator: mapping: base64: "#/components/schemas/Base64ImageSource" + file: "#/components/schemas/FileImageSource" url: "#/components/schemas/URLImageSource" propertyName: type title: Source @@ -4196,11 +5973,28 @@ components: url: title: Url type: string + file_id: + title: File Id + type: string required: - data - media_type - type - url + - file_id + type: object + transformations: + description: Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. + nullable: true + properties: + oversized_image: + description: What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. + enum: + - downsize + - error + title: Oversized Image + type: string + title: RequestImageTransformations type: object context: title: Context @@ -4219,12 +6013,18 @@ components: title: Content type: array signature: + description: |- + The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. + + Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. title: Signature type: string thinking: + description: The `thinking` text of this block as returned by the API. title: Thinking type: string data: + description: The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. title: Data type: string caller: @@ -4262,6 +6062,14 @@ components: minLength: 1 title: Name type: string + toolset_name: + description: For a toolset member tool_use, the toolset family this member belongs to. + title: Toolset Name + nullable: true + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ + type: string is_error: title: Is Error type: boolean @@ -4291,16 +6099,52 @@ components: description: |- A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - EffortLevel: - description: All possible effort levels. - enum: - - low - - medium - - high - - xhigh - - max - title: EffortLevel - type: string + SkillParams: + description: Specification for a skill to be loaded in a container (request model). + properties: + skill_id: + description: Skill ID + examples: + - pdf + maxLength: 64 + minLength: 1 + title: Skill Id + type: string + type: + description: Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) + enum: + - anthropic + - custom + examples: + - anthropic + title: Type + type: string + x-stainless-naming: + csharp: + type_name: SkillParamsType + version: + description: Skill version or 'latest' for most recent version + examples: + - latest + maxLength: 64 + minLength: 1 + title: Version + type: string + required: + - skill_id + - type + title: SkillParams + type: object + EffortLevel: + description: All possible effort levels. + enum: + - low + - medium + - high + - xhigh + - max + title: EffortLevel + type: string JsonOutputFormat: properties: schema: @@ -4320,6 +6164,8 @@ components: RequestCharLocationCitation: properties: cited_text: + examples: + - The grass is green. The sky is blue. title: Cited Text type: string document_index: @@ -4329,7 +6175,7 @@ components: document_title: title: Document Title nullable: true - maxLength: 255 + maxLength: 500 minLength: 1 type: string end_char_index: @@ -4356,6 +6202,8 @@ components: RequestPageLocationCitation: properties: cited_text: + examples: + - The grass is green. The sky is blue. title: Cited Text type: string document_index: @@ -4365,7 +6213,7 @@ components: document_title: title: Document Title nullable: true - maxLength: 255 + maxLength: 500 minLength: 1 type: string end_page_number: @@ -4396,6 +6244,8 @@ components: The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. + examples: + - The grass is green. The sky is blue. title: Cited Text type: string document_index: @@ -4405,7 +6255,7 @@ components: document_title: title: Document Title nullable: true - maxLength: 255 + maxLength: 500 minLength: 1 type: string end_block_index: @@ -4437,6 +6287,8 @@ components: RequestWebSearchResultLocationCitation: properties: cited_text: + examples: + - The grass is green. The sky is blue. title: Cited Text type: string encrypted_index: @@ -4454,7 +6306,6 @@ components: enum: - web_search_result_location url: - maxLength: 2048 minLength: 1 title: Url type: string @@ -4473,6 +6324,8 @@ components: The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. + examples: + - The grass is green. The sky is blue. title: Cited Text type: string end_block_index: @@ -4691,1467 +6544,3017 @@ components: title: AllowedCaller type: string JsonValue: {} - UserLocation: + BrowserToolsetConfigs: + description: |- + Per-member configuration for ``browser_toolset_20260801``: one + optional field per member tool, keyed by the member name — the same + name the member's ``tool_use`` blocks carry. Every member is an + accepted key, and a member's defaults apply wherever its key is + absent. Unknown keys are rejected: the field set is this toolset + version's complete member set. properties: - city: - description: The city of the user. - examples: - - New York - - Tokyo - - Los Angeles - title: City + close_tab: nullable: true - maxLength: 255 - minLength: 1 - type: string - country: - description: The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. - examples: - - US - - JP - - GB - title: Country + description: "``close_tab``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserCloseTabConfig + type: object + double_click: nullable: true - maxLength: 2 - minLength: 2 - type: string - region: - description: The region of the user. - examples: - - California - - Ontario - - Wales - title: Region + description: "``double_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserDoubleClickConfig + type: object + file_upload: nullable: true - maxLength: 255 - minLength: 1 - type: string - timezone: - description: The [IANA timezone](https://nodatime.org/TimeZones) of the user. - examples: - - America/New_York - - Asia/Tokyo - - Europe/London - title: Timezone + description: "``file_upload``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserFileUploadConfig + type: object + find: nullable: true - maxLength: 255 - minLength: 1 - type: string - type: - title: Type - type: string - enum: - - approximate - required: - - type - title: UserLocation - type: object - RequestCitationsConfig: - properties: - enabled: - title: Enabled - type: boolean - title: RequestCitationsConfig - type: object - ResponseCharLocationCitation: - properties: - cited_text: - title: Cited Text - type: string - document_index: - minimum: 0 - title: Document Index - type: integer - document_title: - title: Document Title + description: "``find``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserFindConfig + type: object + form_input: nullable: true - type: string - end_char_index: - title: End Char Index - type: integer - file_id: - default: null - title: File Id + description: "``form_input``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserFormInputConfig + type: object + get_page_text: nullable: true - type: string - start_char_index: - minimum: 0 - title: Start Char Index - type: integer - type: - default: char_location - title: Type - type: string - enum: - - char_location - required: - - cited_text - - document_index - - document_title - - end_char_index - - file_id - - start_char_index - - type - title: ResponseCharLocationCitation - type: object - ResponsePageLocationCitation: - properties: - cited_text: - title: Cited Text - type: string - document_index: - minimum: 0 - title: Document Index - type: integer - document_title: - title: Document Title + description: "``get_page_text``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserGetPageTextConfig + type: object + hold_key: nullable: true - type: string - end_page_number: - title: End Page Number - type: integer - file_id: - default: null - title: File Id + description: "``hold_key``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserHoldKeyConfig + type: object + hover: nullable: true - type: string - start_page_number: - minimum: 1 - title: Start Page Number - type: integer - type: - default: page_location - title: Type - type: string - enum: - - page_location - required: - - cited_text - - document_index - - document_title - - end_page_number - - file_id - - start_page_number - - type - title: ResponsePageLocationCitation - type: object - ResponseContentBlockLocationCitation: - properties: - cited_text: - description: |- - The full text of the cited block range, concatenated. - - Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - title: Cited Text - type: string - document_index: - minimum: 0 - title: Document Index - type: integer - document_title: - title: Document Title + description: "``hover``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserHoverConfig + type: object + javascript_exec: nullable: true + description: "``javascript_exec``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserJavascriptExecConfig + type: object + key: + nullable: true + description: "``key``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserKeyConfig + type: object + left_click: + nullable: true + description: "``left_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserLeftClickConfig + type: object + left_click_drag: + nullable: true + description: "``left_click_drag``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserLeftClickDragConfig + type: object + left_mouse_down: + nullable: true + description: "``left_mouse_down``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserLeftMouseDownConfig + type: object + left_mouse_up: + nullable: true + description: "``left_mouse_up``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserLeftMouseUpConfig + type: object + list_tabs: + nullable: true + description: "``list_tabs``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserListTabsConfig + type: object + middle_click: + nullable: true + description: "``middle_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserMiddleClickConfig + type: object + mouse_move: + nullable: true + description: "``mouse_move``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserMouseMoveConfig + type: object + navigate: + nullable: true + description: "``navigate``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserNavigateConfig + type: object + new_tab: + nullable: true + description: "``new_tab``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserNewTabConfig + type: object + read_console: + nullable: true + description: "``read_console``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserReadConsoleConfig + type: object + read_network: + nullable: true + description: "``read_network``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserReadNetworkConfig + type: object + read_page: + nullable: true + description: "``read_page``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserReadPageConfig + type: object + right_click: + nullable: true + description: "``right_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserRightClickConfig + type: object + screenshot: + nullable: true + description: "``screenshot``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserScreenshotConfig + type: object + scroll: + nullable: true + description: "``scroll``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserScrollConfig + type: object + scroll_to: + nullable: true + description: "``scroll_to``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserScrollToConfig + type: object + switch_tab: + nullable: true + description: "``switch_tab``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserSwitchTabConfig + type: object + triple_click: + nullable: true + description: "``triple_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserTripleClickConfig + type: object + type: + nullable: true + description: "``type``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserTypeConfig + type: object + wait: + nullable: true + description: "``wait``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserWaitConfig + type: object + zoom: + nullable: true + description: "``zoom``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserZoomConfig + type: object + title: BrowserToolsetConfigs + type: object + ComputerToolsetConfigs: + description: |- + Per-member configuration for ``computer_toolset_20260801``: one + optional field per member tool, keyed by the member name — the same + name the member's ``tool_use`` blocks carry. Every member is an + accepted key, and a member's defaults apply wherever its key is + absent. Unknown keys are rejected: the field set is this toolset + version's complete member set. + properties: + cursor_position: + nullable: true + description: "``cursor_position``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerCursorPositionConfig + type: object + double_click: + nullable: true + description: "``double_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerDoubleClickConfig + type: object + hold_key: + nullable: true + description: "``hold_key``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerHoldKeyConfig + type: object + key: + nullable: true + description: "``key``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerKeyConfig + type: object + left_click: + nullable: true + description: "``left_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerLeftClickConfig + type: object + left_click_drag: + nullable: true + description: "``left_click_drag``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerLeftClickDragConfig + type: object + left_mouse_down: + nullable: true + description: "``left_mouse_down``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerLeftMouseDownConfig + type: object + left_mouse_up: + nullable: true + description: "``left_mouse_up``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerLeftMouseUpConfig + type: object + middle_click: + nullable: true + description: "``middle_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerMiddleClickConfig + type: object + mouse_move: + nullable: true + description: "``mouse_move``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerMouseMoveConfig + type: object + right_click: + nullable: true + description: "``right_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerRightClickConfig + type: object + screenshot: + nullable: true + description: "``screenshot``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerScreenshotConfig + type: object + scroll: + nullable: true + description: "``scroll``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerScrollConfig + type: object + triple_click: + nullable: true + description: "``triple_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerTripleClickConfig + type: object + type: + nullable: true + description: "``type``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerTypeConfig + type: object + wait: + nullable: true + description: "``wait``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerWaitConfig + type: object + zoom: + nullable: true + description: "``zoom``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerZoomConfig + type: object + title: ComputerToolsetConfigs + type: object + UserLocation: + properties: + city: + description: The city of the user. + examples: + - New York + - Tokyo + - Los Angeles + title: City + nullable: true + maxLength: 255 + minLength: 1 + type: string + country: + description: The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. + examples: + - US + - JP + - GB + title: Country + nullable: true + maxLength: 2 + minLength: 2 + type: string + region: + description: The region of the user. + examples: + - California + - Ontario + - Wales + title: Region + nullable: true + maxLength: 255 + minLength: 1 + type: string + timezone: + description: The [IANA timezone](https://nodatime.org/TimeZones) of the user. + examples: + - America/New_York + - Asia/Tokyo + - Europe/London + title: Timezone + nullable: true + maxLength: 255 + minLength: 1 + type: string + type: + title: Type + type: string + enum: + - approximate + required: + - type + title: UserLocation + type: object + RequestCitationsConfig: + properties: + enabled: + title: Enabled + type: boolean + title: RequestCitationsConfig + type: object + ResponseCharLocationCitation: + properties: + cited_text: + examples: + - The grass is green. The sky is blue. + title: Cited Text + type: string + document_index: + minimum: 0 + title: Document Index + type: integer + document_title: + examples: + - My Document + title: Document Title + nullable: true + type: string + end_char_index: + title: End Char Index + type: integer + file_id: + default: null + examples: + - file_011CNha8iCJcU1wXNR6q4V8w + title: File Id + nullable: true + type: string + start_char_index: + minimum: 0 + title: Start Char Index + type: integer + type: + default: char_location + title: Type + type: string + enum: + - char_location + required: + - cited_text + - document_index + - document_title + - end_char_index + - file_id + - start_char_index + - type + title: ResponseCharLocationCitation + type: object + ResponsePageLocationCitation: + properties: + cited_text: + examples: + - The grass is green. The sky is blue. + title: Cited Text + type: string + document_index: + minimum: 0 + title: Document Index + type: integer + document_title: + examples: + - My Document + title: Document Title + nullable: true + type: string + end_page_number: + title: End Page Number + type: integer + file_id: + default: null + examples: + - file_011CNha8iCJcU1wXNR6q4V8w + title: File Id + nullable: true + type: string + start_page_number: + minimum: 1 + title: Start Page Number + type: integer + type: + default: page_location + title: Type + type: string + enum: + - page_location + required: + - cited_text + - document_index + - document_title + - end_page_number + - file_id + - start_page_number + - type + title: ResponsePageLocationCitation + type: object + ResponseContentBlockLocationCitation: + properties: + cited_text: + description: |- + The full text of the cited block range, concatenated. + + Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. + examples: + - The grass is green. The sky is blue. + title: Cited Text + type: string + document_index: + minimum: 0 + title: Document Index + type: integer + document_title: + examples: + - My Document + title: Document Title + nullable: true + type: string + end_block_index: + description: |- + Exclusive 0-based end index of the cited block range in the source's `content` array. + + Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. + title: End Block Index + type: integer + file_id: + default: null + examples: + - file_011CNha8iCJcU1wXNR6q4V8w + title: File Id + nullable: true + type: string + start_block_index: + description: 0-based index of the first cited block in the source's `content` array. + minimum: 0 + title: Start Block Index + type: integer + type: + default: content_block_location + title: Type + type: string + enum: + - content_block_location + required: + - cited_text + - document_index + - document_title + - end_block_index + - file_id + - start_block_index + - type + title: ResponseContentBlockLocationCitation + type: object + ResponseWebSearchResultLocationCitation: + properties: + cited_text: + examples: + - The grass is green. The sky is blue. + title: Cited Text + type: string + encrypted_index: + title: Encrypted Index + type: string + title: + title: Title + nullable: true + maxLength: 512 + type: string + type: + default: web_search_result_location + title: Type + type: string + enum: + - web_search_result_location + url: + title: Url + type: string + required: + - cited_text + - encrypted_index + - title + - type + - url + title: ResponseWebSearchResultLocationCitation + type: object + ResponseSearchResultLocationCitation: + properties: + cited_text: + description: |- + The full text of the cited block range, concatenated. + + Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. + examples: + - The grass is green. The sky is blue. + title: Cited Text + type: string + end_block_index: + description: |- + Exclusive 0-based end index of the cited block range in the source's `content` array. + + Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. + title: End Block Index + type: integer + search_result_index: + description: |- + 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. + + Counted separately from `document_index`; server-side web search results are not included in this count. + minimum: 0 + title: Search Result Index + type: integer + source: + title: Source + type: string + start_block_index: + description: 0-based index of the first cited block in the source's `content` array. + minimum: 0 + title: Start Block Index + type: integer + title: + title: Title + nullable: true + type: string + type: + default: search_result_location + title: Type + type: string + enum: + - search_result_location + required: + - cited_text + - end_block_index + - search_result_index + - source + - start_block_index + - title + - type + title: ResponseSearchResultLocationCitation + type: object + DirectCaller: + description: Tool invocation directly from the model. + properties: + type: + title: Type + type: string + enum: + - direct + required: + - type + title: DirectCaller + type: object + ServerToolCaller: + description: Tool invocation generated by a server-side tool. + properties: + tool_id: + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + title: Tool Id + type: string + type: + title: Type + type: string + enum: + - code_execution_20250825 + required: + - tool_id + - type + title: ServerToolCaller + type: object + ServerToolCaller_20260120: + properties: + tool_id: + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + title: Tool Id + type: string + type: + title: Type + type: string + enum: + - code_execution_20260120 + required: + - tool_id + - type + title: ServerToolCaller_20260120 + type: object + ResponseWebSearchToolResultError: + properties: + error_code: + $ref: "#/components/schemas/WebSearchToolResultErrorCode" + type: + default: web_search_tool_result_error + title: Type + type: string + enum: + - web_search_tool_result_error + required: + - error_code + - type + title: ResponseWebSearchToolResultError + type: object + ResponseWebSearchResultBlock: + properties: + encrypted_content: + title: Encrypted Content + type: string + page_age: + default: null + title: Page Age + nullable: true + type: string + title: + title: Title + type: string + type: + default: web_search_result + title: Type + type: string + enum: + - web_search_result + url: + title: Url + type: string + required: + - encrypted_content + - page_age + - title + - type + - url + title: ResponseWebSearchResultBlock + type: object + ResponseWebFetchToolResultError: + properties: + error_code: + $ref: "#/components/schemas/WebFetchToolResultErrorCode" + type: + default: web_fetch_tool_result_error + title: Type + type: string + enum: + - web_fetch_tool_result_error + required: + - error_code + - type + title: ResponseWebFetchToolResultError + type: object + ResponseWebFetchResultBlock: + properties: + content: + $ref: "#/components/schemas/ResponseDocumentBlock" + retrieved_at: + default: null + description: ISO 8601 timestamp when the content was retrieved + title: Retrieved At + nullable: true + type: string + type: + default: web_fetch_result + title: Type + type: string + enum: + - web_fetch_result + url: + description: Fetched content URL + title: Url + type: string + required: + - content + - retrieved_at + - type + - url + title: ResponseWebFetchResultBlock + type: object + ResponseCodeExecutionToolResultError: + properties: + error_code: + $ref: "#/components/schemas/CodeExecutionToolResultErrorCode" + type: + default: code_execution_tool_result_error + title: Type + type: string + enum: + - code_execution_tool_result_error + required: + - error_code + - type + title: ResponseCodeExecutionToolResultError + type: object + ResponseCodeExecutionResultBlock: + properties: + content: + items: + $ref: "#/components/schemas/ResponseCodeExecutionOutputBlock" + title: Content + type: array + return_code: + title: Return Code + type: integer + stderr: + title: Stderr + type: string + stdout: + title: Stdout + type: string + type: + default: code_execution_result + title: Type + type: string + enum: + - code_execution_result + required: + - content + - return_code + - stderr + - stdout + - type + title: ResponseCodeExecutionResultBlock + type: object + ResponseEncryptedCodeExecutionResultBlock: + description: Code execution result with encrypted stdout for PFC + web_search results. + properties: + content: + items: + $ref: "#/components/schemas/ResponseCodeExecutionOutputBlock" + title: Content + type: array + encrypted_stdout: + title: Encrypted Stdout + type: string + return_code: + title: Return Code + type: integer + stderr: + title: Stderr + type: string + type: + default: encrypted_code_execution_result + title: Type + type: string + enum: + - encrypted_code_execution_result + required: + - content + - encrypted_stdout + - return_code + - stderr + - type + title: ResponseEncryptedCodeExecutionResultBlock + type: object + ResponseBashCodeExecutionToolResultError: + properties: + error_code: + $ref: "#/components/schemas/BashCodeExecutionToolResultErrorCode" + type: + default: bash_code_execution_tool_result_error + title: Type + type: string + enum: + - bash_code_execution_tool_result_error + required: + - error_code + - type + title: ResponseBashCodeExecutionToolResultError + type: object + ResponseBashCodeExecutionResultBlock: + properties: + content: + items: + $ref: "#/components/schemas/ResponseBashCodeExecutionOutputBlock" + title: Content + type: array + return_code: + title: Return Code + type: integer + stderr: + title: Stderr + type: string + stdout: + title: Stdout + type: string + type: + default: bash_code_execution_result + title: Type + type: string + enum: + - bash_code_execution_result + required: + - content + - return_code + - stderr + - stdout + - type + title: ResponseBashCodeExecutionResultBlock + type: object + ResponseTextEditorCodeExecutionToolResultError: + properties: + error_code: + $ref: "#/components/schemas/TextEditorCodeExecutionToolResultErrorCode" + error_message: + default: null + title: Error Message + nullable: true + type: string + type: + default: text_editor_code_execution_tool_result_error + title: Type + type: string + enum: + - text_editor_code_execution_tool_result_error + required: + - error_code + - error_message + - type + title: ResponseTextEditorCodeExecutionToolResultError + type: object + ResponseTextEditorCodeExecutionViewResultBlock: + properties: + content: + title: Content + type: string + file_type: + enum: + - text + - image + - pdf + title: File Type + type: string + num_lines: + default: null + title: Num Lines + nullable: true + type: integer + start_line: + default: null + title: Start Line + nullable: true + type: integer + total_lines: + default: null + title: Total Lines + nullable: true + type: integer + type: + default: text_editor_code_execution_view_result + title: Type + type: string + enum: + - text_editor_code_execution_view_result + required: + - content + - file_type + - num_lines + - start_line + - total_lines + - type + title: ResponseTextEditorCodeExecutionViewResultBlock + type: object + ResponseTextEditorCodeExecutionCreateResultBlock: + properties: + is_file_update: + title: Is File Update + type: boolean + type: + default: text_editor_code_execution_create_result + title: Type + type: string + enum: + - text_editor_code_execution_create_result + required: + - is_file_update + - type + title: ResponseTextEditorCodeExecutionCreateResultBlock + type: object + ResponseTextEditorCodeExecutionStrReplaceResultBlock: + properties: + lines: + default: null + title: Lines + nullable: true + items: + type: string + type: array + new_lines: + default: null + title: New Lines + nullable: true + type: integer + new_start: + default: null + title: New Start + nullable: true + type: integer + old_lines: + default: null + title: Old Lines + nullable: true + type: integer + old_start: + default: null + title: Old Start + nullable: true + type: integer + type: + default: text_editor_code_execution_str_replace_result + title: Type + type: string + enum: + - text_editor_code_execution_str_replace_result + required: + - lines + - new_lines + - new_start + - old_lines + - old_start + - type + title: ResponseTextEditorCodeExecutionStrReplaceResultBlock + type: object + ResponseToolSearchToolResultError: + properties: + error_code: + $ref: "#/components/schemas/ToolSearchToolResultErrorCode" + error_message: + default: null + title: Error Message + nullable: true + type: string + type: + default: tool_search_tool_result_error + title: Type + type: string + enum: + - tool_search_tool_result_error + required: + - error_code + - error_message + - type + title: ResponseToolSearchToolResultError + type: object + ResponseToolSearchToolSearchResultBlock: + properties: + tool_references: + items: + $ref: "#/components/schemas/ResponseToolReferenceBlock" + title: Tool References + type: array + type: + default: tool_search_tool_search_result + title: Type + type: string + enum: + - tool_search_tool_search_result + required: + - tool_references + - type + title: ResponseToolSearchToolSearchResultBlock + type: object + RequestImageBlock: + properties: + cache_control: type: string - end_block_index: + description: Create a cache control breakpoint at this content block. + nullable: true + source: + discriminator: + mapping: + base64: "#/components/schemas/Base64ImageSource" + file: "#/components/schemas/FileImageSource" + url: "#/components/schemas/URLImageSource" + propertyName: type + title: Source + properties: + data: + format: byte + title: Data + type: string + media_type: + enum: + - image/jpeg + - image/png + - image/gif + - image/webp + title: Media Type + type: string + type: + title: Type + type: string + enum: + - base64 + url: + title: Url + type: string + file_id: + title: File Id + type: string + required: + - data + - media_type + - type + - url + - file_id + type: object + transformations: + description: Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. + nullable: true + properties: + oversized_image: + description: What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. + enum: + - downsize + - error + title: Oversized Image + type: string + title: RequestImageTransformations + type: object + type: + title: Type + type: string + enum: + - image + required: + - source + - type + title: RequestImageBlock + type: object + RequestDocumentBlock: + properties: + cache_control: + type: string + description: Create a cache control breakpoint at this content block. + nullable: true + citations: + nullable: true + properties: + enabled: + title: Enabled + type: boolean + title: RequestCitationsConfig + type: object + context: + title: Context + nullable: true + minLength: 1 + type: string + source: + discriminator: + mapping: + base64: "#/components/schemas/Base64PDFSource" + content: "#/components/schemas/ContentBlockSource" + file: "#/components/schemas/FileDocumentSource" + text: "#/components/schemas/PlainTextSource" + url: "#/components/schemas/URLPDFSource" + propertyName: type + title: Source + properties: + data: + format: byte + title: Data + type: string + media_type: + title: Media Type + type: string + enum: + - application/pdf + type: + title: Type + type: string + enum: + - base64 + content: + title: Content + type: string + items: + type: string + url: + title: Url + type: string + file_id: + title: File Id + type: string + required: + - data + - media_type + - type + - content + - url + - file_id + type: object + title: + title: Title + nullable: true + maxLength: 500 + minLength: 1 + type: string + type: + title: Type + type: string + enum: + - document + required: + - source + - type + title: RequestDocumentBlock + type: object + RequestSearchResultBlock: + properties: + cache_control: + type: string + description: Create a cache control breakpoint at this content block. + nullable: true + citations: + $ref: "#/components/schemas/RequestCitationsConfig" + content: + items: + $ref: "#/components/schemas/RequestTextBlock" + title: Content + type: array + source: + title: Source + type: string + title: + title: Title + type: string + type: + title: Type + type: string + enum: + - search_result + required: + - content + - source + - title + - type + title: RequestSearchResultBlock + type: object + RequestThinkingBlock: + properties: + signature: description: |- - Exclusive 0-based end index of the cited block range in the source's `content` array. + The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. - Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - title: End Block Index - type: integer - file_id: - default: null - title: File Id + Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. + title: Signature + type: string + thinking: + description: The `thinking` text of this block as returned by the API. + title: Thinking + type: string + type: + title: Type + type: string + enum: + - thinking + required: + - signature + - thinking + - type + title: RequestThinkingBlock + type: object + RequestRedactedThinkingBlock: + properties: + data: + description: The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. + title: Data + type: string + type: + title: Type + type: string + enum: + - redacted_thinking + required: + - data + - type + title: RequestRedactedThinkingBlock + type: object + RequestToolUseBlock: + properties: + cache_control: + type: string + description: Create a cache control breakpoint at this content block. nullable: true + caller: + discriminator: + mapping: + code_execution_20250825: "#/components/schemas/ServerToolCaller" + code_execution_20260120: "#/components/schemas/ServerToolCaller_20260120" + direct: "#/components/schemas/DirectCaller" + propertyName: type + title: Caller + description: Tool invocation directly from the model. + properties: + type: + title: Type + type: string + enum: + - direct + tool_id: + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + title: Tool Id + type: string + required: + - type + - tool_id + type: object + id: + pattern: ^[a-zA-Z0-9_-]+$ + title: Id + type: string + input: + title: Input + type: object + name: + maxLength: 200 + minLength: 1 + title: Name + type: string + toolset_name: + description: For a toolset member tool_use, the toolset family this member belongs to. + title: Toolset Name + nullable: true + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ type: string - start_block_index: - description: 0-based index of the first cited block in the source's `content` array. - minimum: 0 - title: Start Block Index - type: integer type: - default: content_block_location title: Type type: string enum: - - content_block_location + - tool_use required: - - cited_text - - document_index - - document_title - - end_block_index - - file_id - - start_block_index + - id + - input + - name - type - title: ResponseContentBlockLocationCitation + title: RequestToolUseBlock type: object - ResponseWebSearchResultLocationCitation: + RequestToolResultBlock: properties: - cited_text: - title: Cited Text + cache_control: type: string - encrypted_index: - title: Encrypted Index + description: Create a cache control breakpoint at this content block. + nullable: true + content: + title: Content type: string - title: - title: Title + x-stainless-skip: + - go + - cli + items: + type: string + x-stainless-naming: + python: + type_name: Content + ruby: + type_name: Content + php: + type_name: Content + is_error: + title: Is Error + type: boolean + tool_use_id: + pattern: ^[a-zA-Z0-9_-]+$ + title: Tool Use Id + type: string + toolset_name: + description: For a toolset member tool_result, the toolset family of the paired tool_use. + title: Toolset Name nullable: true - maxLength: 512 + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9_-]+$ type: string type: - default: web_search_result_location title: Type type: string enum: - - web_search_result_location - url: - title: Url - type: string + - tool_result required: - - cited_text - - encrypted_index - - title + - tool_use_id - type - - url - title: ResponseWebSearchResultLocationCitation + title: RequestToolResultBlock type: object - ResponseSearchResultLocationCitation: + RequestServerToolUseBlock: properties: - cited_text: - description: |- - The full text of the cited block range, concatenated. - - Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - title: Cited Text - type: string - end_block_index: - description: |- - Exclusive 0-based end index of the cited block range in the source's `content` array. - - Always greater than `start_block_index`; a single-block citation has `end_block_index = start_block_index + 1`. - title: End Block Index - type: integer - search_result_index: - description: |- - 0-based index of the cited search result among all `search_result` content blocks in the request, in the order they appear across messages and tool results. - - Counted separately from `document_index`; server-side web search results are not included in this count. - minimum: 0 - title: Search Result Index - type: integer - source: - title: Source + cache_control: type: string - start_block_index: - description: 0-based index of the first cited block in the source's `content` array. - minimum: 0 - title: Start Block Index - type: integer - title: - title: Title + description: Create a cache control breakpoint at this content block. nullable: true + caller: + discriminator: + mapping: + code_execution_20250825: "#/components/schemas/ServerToolCaller" + code_execution_20260120: "#/components/schemas/ServerToolCaller_20260120" + direct: "#/components/schemas/DirectCaller" + propertyName: type + title: Caller + description: Tool invocation directly from the model. + properties: + type: + title: Type + type: string + enum: + - direct + tool_id: + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + title: Tool Id + type: string + required: + - type + - tool_id + type: object + id: + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + title: Id + type: string + input: + title: Input + type: object + name: + enum: + - web_search + - web_fetch + - code_execution + - bash_code_execution + - text_editor_code_execution + - tool_search_tool_regex + - tool_search_tool_bm25 + title: Name type: string type: - default: search_result_location title: Type type: string enum: - - search_result_location + - server_tool_use required: - - cited_text - - end_block_index - - search_result_index - - source - - start_block_index - - title + - id + - input + - name - type - title: ResponseSearchResultLocationCitation + title: RequestServerToolUseBlock type: object - DirectCaller: - description: Tool invocation directly from the model. + RequestWebSearchToolResultBlock: properties: + cache_control: + type: string + description: Create a cache control breakpoint at this content block. + nullable: true + caller: + discriminator: + mapping: + code_execution_20250825: "#/components/schemas/ServerToolCaller" + code_execution_20260120: "#/components/schemas/ServerToolCaller_20260120" + direct: "#/components/schemas/DirectCaller" + propertyName: type + title: Caller + description: Tool invocation directly from the model. + properties: + type: + title: Type + type: string + enum: + - direct + tool_id: + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + title: Tool Id + type: string + required: + - type + - tool_id + type: object + content: + title: Content + items: + $ref: "#/components/schemas/RequestWebSearchResultBlock" + type: array + properties: + error_code: + $ref: "#/components/schemas/WebSearchToolResultErrorCode" + type: + title: Type + type: string + enum: + - web_search_tool_result_error + required: + - error_code + - type + tool_use_id: + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + title: Tool Use Id + type: string type: title: Type type: string enum: - - direct + - web_search_tool_result required: + - content + - tool_use_id - type - title: DirectCaller + title: RequestWebSearchToolResultBlock type: object - ServerToolCaller: - description: Tool invocation generated by a server-side tool. + RequestWebFetchToolResultBlock: properties: - tool_id: + cache_control: + type: string + description: Create a cache control breakpoint at this content block. + nullable: true + caller: + discriminator: + mapping: + code_execution_20250825: "#/components/schemas/ServerToolCaller" + code_execution_20260120: "#/components/schemas/ServerToolCaller_20260120" + direct: "#/components/schemas/DirectCaller" + propertyName: type + title: Caller + description: Tool invocation directly from the model. + properties: + type: + title: Type + type: string + enum: + - direct + tool_id: + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + title: Tool Id + type: string + required: + - type + - tool_id + type: object + content: + title: Content + properties: + error_code: + $ref: "#/components/schemas/WebFetchToolResultErrorCode" + type: + title: Type + type: string + enum: + - web_fetch_tool_result_error + content: + $ref: "#/components/schemas/RequestDocumentBlock" + retrieved_at: + description: ISO 8601 timestamp when the content was retrieved + title: Retrieved At + nullable: true + type: string + url: + description: Fetched content URL + title: Url + type: string + required: + - error_code + - type + - content + - url + type: object + tool_use_id: pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - title: Tool Id + title: Tool Use Id type: string type: title: Type type: string enum: - - code_execution_20250825 + - web_fetch_tool_result required: - - tool_id + - content + - tool_use_id - type - title: ServerToolCaller + title: RequestWebFetchToolResultBlock type: object - ServerToolCaller_20260120: + RequestCodeExecutionToolResultBlock: properties: - tool_id: - pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - title: Tool Id + cache_control: type: string - type: - title: Type + description: Create a cache control breakpoint at this content block. + nullable: true + content: + title: Content + properties: + error_code: + $ref: "#/components/schemas/CodeExecutionToolResultErrorCode" + type: + title: Type + type: string + enum: + - code_execution_tool_result_error + content: + items: + $ref: "#/components/schemas/RequestCodeExecutionOutputBlock" + title: Content + type: array + return_code: + title: Return Code + type: integer + stderr: + title: Stderr + type: string + stdout: + title: Stdout + type: string + encrypted_stdout: + title: Encrypted Stdout + type: string + required: + - error_code + - type + - content + - return_code + - stderr + - stdout + - encrypted_stdout + type: object + description: Code execution result with encrypted stdout for PFC + web_search results. + tool_use_id: + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + title: Tool Use Id type: string - enum: - - code_execution_20260120 - required: - - tool_id - - type - title: ServerToolCaller_20260120 - type: object - ResponseWebSearchToolResultError: - properties: - error_code: - $ref: "#/components/schemas/WebSearchToolResultErrorCode" type: - default: web_search_tool_result_error title: Type type: string enum: - - web_search_tool_result_error + - code_execution_tool_result required: - - error_code + - content + - tool_use_id - type - title: ResponseWebSearchToolResultError + title: RequestCodeExecutionToolResultBlock type: object - ResponseWebSearchResultBlock: + RequestBashCodeExecutionToolResultBlock: properties: - encrypted_content: - title: Encrypted Content + cache_control: type: string - page_age: - default: null - title: Page Age + description: Create a cache control breakpoint at this content block. nullable: true - type: string - title: - title: Title + content: + title: Content + properties: + error_code: + $ref: "#/components/schemas/BashCodeExecutionToolResultErrorCode" + type: + title: Type + type: string + enum: + - bash_code_execution_tool_result_error + content: + items: + $ref: "#/components/schemas/RequestBashCodeExecutionOutputBlock" + title: Content + type: array + return_code: + title: Return Code + type: integer + stderr: + title: Stderr + type: string + stdout: + title: Stdout + type: string + required: + - error_code + - type + - content + - return_code + - stderr + - stdout + type: object + tool_use_id: + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + title: Tool Use Id type: string type: - default: web_search_result title: Type type: string enum: - - web_search_result - url: - title: Url - type: string + - bash_code_execution_tool_result required: - - encrypted_content - - page_age - - title + - content + - tool_use_id - type - - url - title: ResponseWebSearchResultBlock + title: RequestBashCodeExecutionToolResultBlock type: object - ResponseWebFetchToolResultError: + RequestTextEditorCodeExecutionToolResultBlock: properties: - error_code: - $ref: "#/components/schemas/WebFetchToolResultErrorCode" - type: - default: web_fetch_tool_result_error - title: Type + cache_control: type: string - enum: - - web_fetch_tool_result_error - required: - - error_code - - type - title: ResponseWebFetchToolResultError - type: object - ResponseWebFetchResultBlock: - properties: - content: - $ref: "#/components/schemas/ResponseDocumentBlock" - retrieved_at: - default: null - description: ISO 8601 timestamp when the content was retrieved - title: Retrieved At + description: Create a cache control breakpoint at this content block. nullable: true + content: + title: Content + properties: + error_code: + $ref: "#/components/schemas/TextEditorCodeExecutionToolResultErrorCode" + error_message: + title: Error Message + nullable: true + type: string + type: + title: Type + type: string + enum: + - text_editor_code_execution_tool_result_error + content: + title: Content + type: string + file_type: + enum: + - text + - image + - pdf + title: File Type + type: string + num_lines: + title: Num Lines + nullable: true + type: integer + start_line: + title: Start Line + nullable: true + type: integer + total_lines: + title: Total Lines + nullable: true + type: integer + is_file_update: + title: Is File Update + type: boolean + lines: + title: Lines + nullable: true + items: + type: string + type: array + new_lines: + title: New Lines + nullable: true + type: integer + new_start: + title: New Start + nullable: true + type: integer + old_lines: + title: Old Lines + nullable: true + type: integer + old_start: + title: Old Start + nullable: true + type: integer + required: + - error_code + - type + - content + - file_type + - is_file_update + type: object + tool_use_id: + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + title: Tool Use Id type: string type: - default: web_fetch_result - title: Type - type: string - enum: - - web_fetch_result - url: - description: Fetched content URL - title: Url - type: string - required: - - content - - retrieved_at - - type - - url - title: ResponseWebFetchResultBlock - type: object - ResponseCodeExecutionToolResultError: - properties: - error_code: - $ref: "#/components/schemas/CodeExecutionToolResultErrorCode" - type: - default: code_execution_tool_result_error title: Type type: string enum: - - code_execution_tool_result_error + - text_editor_code_execution_tool_result required: - - error_code + - content + - tool_use_id - type - title: ResponseCodeExecutionToolResultError + title: RequestTextEditorCodeExecutionToolResultBlock type: object - ResponseCodeExecutionResultBlock: + RequestToolSearchToolResultBlock: properties: + cache_control: + type: string + description: Create a cache control breakpoint at this content block. + nullable: true content: - items: - $ref: "#/components/schemas/ResponseCodeExecutionOutputBlock" title: Content - type: array - return_code: - title: Return Code - type: integer - stderr: - title: Stderr - type: string - stdout: - title: Stdout + properties: + error_code: + $ref: "#/components/schemas/ToolSearchToolResultErrorCode" + error_message: + title: Error Message + nullable: true + type: string + type: + title: Type + type: string + enum: + - tool_search_tool_result_error + tool_references: + items: + $ref: "#/components/schemas/RequestToolReferenceBlock" + title: Tool References + type: array + required: + - error_code + - type + - tool_references + type: object + tool_use_id: + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + title: Tool Use Id type: string type: - default: code_execution_result title: Type type: string enum: - - code_execution_result + - tool_search_tool_result required: - content - - return_code - - stderr - - stdout + - tool_use_id - type - title: ResponseCodeExecutionResultBlock + title: RequestToolSearchToolResultBlock type: object - ResponseEncryptedCodeExecutionResultBlock: - description: Code execution result with encrypted stdout for PFC + web_search results. + RequestContainerUploadBlock: + description: |- + A content block that represents a file to be uploaded to the container + Files uploaded via this block will be available in the container's input directory. properties: - content: - items: - $ref: "#/components/schemas/ResponseCodeExecutionOutputBlock" - title: Content - type: array - encrypted_stdout: - title: Encrypted Stdout + cache_control: type: string - return_code: - title: Return Code - type: integer - stderr: - title: Stderr + description: Create a cache control breakpoint at this content block. + nullable: true + file_id: + title: File Id type: string type: - default: encrypted_code_execution_result title: Type type: string enum: - - encrypted_code_execution_result + - container_upload required: - - content - - encrypted_stdout - - return_code - - stderr + - file_id - type - title: ResponseEncryptedCodeExecutionResultBlock + title: RequestContainerUploadBlock type: object - ResponseBashCodeExecutionToolResultError: + ThinkingDisplayMode: + enum: + - summarized + - omitted + title: ThinkingDisplayMode + type: string + BrowserCloseTabConfig: + description: "``close_tab``'s config overrides." properties: - error_code: - $ref: "#/components/schemas/BashCodeExecutionToolResultErrorCode" - type: - default: bash_code_execution_tool_result_error - title: Type - type: string - enum: - - bash_code_execution_tool_result_error - required: - - error_code - - type - title: ResponseBashCodeExecutionToolResultError + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserCloseTabConfig type: object - ResponseBashCodeExecutionResultBlock: + BrowserDoubleClickConfig: + description: "``double_click``'s config overrides." properties: - content: - items: - $ref: "#/components/schemas/ResponseBashCodeExecutionOutputBlock" - title: Content - type: array - return_code: - title: Return Code - type: integer - stderr: - title: Stderr - type: string - stdout: - title: Stdout - type: string - type: - default: bash_code_execution_result - title: Type - type: string - enum: - - bash_code_execution_result - required: - - content - - return_code - - stderr - - stdout - - type - title: ResponseBashCodeExecutionResultBlock + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserDoubleClickConfig + type: object + BrowserFileUploadConfig: + description: "``file_upload``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserFileUploadConfig + type: object + BrowserFindConfig: + description: "``find``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserFindConfig + type: object + BrowserFormInputConfig: + description: "``form_input``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserFormInputConfig + type: object + BrowserGetPageTextConfig: + description: "``get_page_text``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserGetPageTextConfig + type: object + BrowserHoldKeyConfig: + description: "``hold_key``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserHoldKeyConfig + type: object + BrowserHoverConfig: + description: "``hover``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserHoverConfig + type: object + BrowserJavascriptExecConfig: + description: "``javascript_exec``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserJavascriptExecConfig + type: object + BrowserKeyConfig: + description: "``key``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserKeyConfig + type: object + BrowserLeftClickConfig: + description: "``left_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserLeftClickConfig type: object - ResponseTextEditorCodeExecutionToolResultError: + BrowserLeftClickDragConfig: + description: "``left_click_drag``'s config overrides." properties: - error_code: - $ref: "#/components/schemas/TextEditorCodeExecutionToolResultErrorCode" - error_message: - default: null - title: Error Message + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - type: string - type: - default: text_editor_code_execution_tool_result_error - title: Type - type: string - enum: - - text_editor_code_execution_tool_result_error - required: - - error_code - - error_message - - type - title: ResponseTextEditorCodeExecutionToolResultError + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserLeftClickDragConfig type: object - ResponseTextEditorCodeExecutionViewResultBlock: + BrowserLeftMouseDownConfig: + description: "``left_mouse_down``'s config overrides." properties: - content: - title: Content - type: string - file_type: - enum: - - text - - image - - pdf - title: File Type - type: string - num_lines: - default: null - title: Num Lines - nullable: true - type: integer - start_line: - default: null - title: Start Line + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - type: integer - total_lines: - default: null - title: Total Lines + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled nullable: true - type: integer - type: - default: text_editor_code_execution_view_result - title: Type - type: string - enum: - - text_editor_code_execution_view_result - required: - - content - - file_type - - num_lines - - start_line - - total_lines - - type - title: ResponseTextEditorCodeExecutionViewResultBlock + type: boolean + title: BrowserLeftMouseDownConfig type: object - ResponseTextEditorCodeExecutionCreateResultBlock: + BrowserLeftMouseUpConfig: + description: "``left_mouse_up``'s config overrides." properties: - is_file_update: - title: Is File Update + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true type: boolean - type: - default: text_editor_code_execution_create_result - title: Type - type: string - enum: - - text_editor_code_execution_create_result - required: - - is_file_update - - type - title: ResponseTextEditorCodeExecutionCreateResultBlock + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserLeftMouseUpConfig type: object - ResponseTextEditorCodeExecutionStrReplaceResultBlock: + BrowserListTabsConfig: + description: "``list_tabs``'s config overrides." properties: - lines: - default: null - title: Lines + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - items: - type: string - type: array - new_lines: - default: null - title: New Lines + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled nullable: true - type: integer - new_start: - default: null - title: New Start + type: boolean + title: BrowserListTabsConfig + type: object + BrowserMiddleClickConfig: + description: "``middle_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - type: integer - old_lines: - default: null - title: Old Lines + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled nullable: true - type: integer - old_start: - default: null - title: Old Start + type: boolean + title: BrowserMiddleClickConfig + type: object + BrowserMouseMoveConfig: + description: "``mouse_move``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - type: integer - type: - default: text_editor_code_execution_str_replace_result - title: Type - type: string - enum: - - text_editor_code_execution_str_replace_result - required: - - lines - - new_lines - - new_start - - old_lines - - old_start - - type - title: ResponseTextEditorCodeExecutionStrReplaceResultBlock + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserMouseMoveConfig type: object - ResponseToolSearchToolResultError: + BrowserNavigateConfig: + description: "``navigate``'s config overrides." properties: - error_code: - $ref: "#/components/schemas/ToolSearchToolResultErrorCode" - error_message: - default: null - title: Error Message + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - type: string - type: - default: tool_search_tool_result_error - title: Type - type: string - enum: - - tool_search_tool_result_error - required: - - error_code - - error_message - - type - title: ResponseToolSearchToolResultError + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserNavigateConfig type: object - ResponseToolSearchToolSearchResultBlock: + BrowserNewTabConfig: + description: "``new_tab``'s config overrides." properties: - tool_references: - items: - $ref: "#/components/schemas/ResponseToolReferenceBlock" - title: Tool References - type: array - type: - default: tool_search_tool_search_result - title: Type - type: string - enum: - - tool_search_tool_search_result - required: - - tool_references - - type - title: ResponseToolSearchToolSearchResultBlock + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserNewTabConfig type: object - RequestImageBlock: + BrowserReadConsoleConfig: + description: "``read_console``'s config overrides." properties: - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - source: - discriminator: - mapping: - base64: "#/components/schemas/Base64ImageSource" - url: "#/components/schemas/URLImageSource" - propertyName: type - title: Source - properties: - data: - format: byte - title: Data - type: string - media_type: - enum: - - image/jpeg - - image/png - - image/gif - - image/webp - title: Media Type - type: string - type: - title: Type - type: string - enum: - - base64 - url: - title: Url - type: string - required: - - data - - media_type - - type - - url - type: object - type: - title: Type - type: string - enum: - - image - required: - - source - - type - title: RequestImageBlock + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserReadConsoleConfig + type: object + BrowserReadNetworkConfig: + description: "``read_network``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserReadNetworkConfig type: object - RequestDocumentBlock: + BrowserReadPageConfig: + description: "``read_page``'s config overrides." properties: - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - citations: + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled nullable: true - properties: - enabled: - title: Enabled - type: boolean - title: RequestCitationsConfig - type: object - context: - title: Context + type: boolean + title: BrowserReadPageConfig + type: object + BrowserRightClickConfig: + description: "``right_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - minLength: 1 - type: string - source: - discriminator: - mapping: - base64: "#/components/schemas/Base64PDFSource" - content: "#/components/schemas/ContentBlockSource" - text: "#/components/schemas/PlainTextSource" - url: "#/components/schemas/URLPDFSource" - propertyName: type - title: Source - properties: - data: - format: byte - title: Data - type: string - media_type: - title: Media Type - type: string - enum: - - application/pdf - type: - title: Type - type: string - enum: - - base64 - content: - title: Content - type: string - items: - type: string - url: - title: Url - type: string - required: - - data - - media_type - - type - - content - - url - type: object - title: - title: Title + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled nullable: true - maxLength: 500 - minLength: 1 - type: string - type: - title: Type - type: string - enum: - - document - required: - - source - - type - title: RequestDocumentBlock + type: boolean + title: BrowserRightClickConfig type: object - RequestSearchResultBlock: + BrowserScreenshotConfig: + description: "``screenshot``'s config overrides." properties: - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - citations: - $ref: "#/components/schemas/RequestCitationsConfig" - content: - items: - $ref: "#/components/schemas/RequestTextBlock" - title: Content - type: array - source: - title: Source - type: string - title: - title: Title - type: string - type: - title: Type - type: string - enum: - - search_result - required: - - content - - source - - title - - type - title: RequestSearchResultBlock + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserScreenshotConfig type: object - RequestThinkingBlock: + BrowserScrollConfig: + description: "``scroll``'s config overrides." properties: - signature: - title: Signature - type: string - thinking: - title: Thinking - type: string - type: - title: Type - type: string - enum: - - thinking - required: - - signature - - thinking - - type - title: RequestThinkingBlock + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserScrollConfig type: object - RequestRedactedThinkingBlock: + BrowserScrollToConfig: + description: "``scroll_to``'s config overrides." properties: - data: - title: Data - type: string - type: - title: Type - type: string - enum: - - redacted_thinking - required: - - data - - type - title: RequestRedactedThinkingBlock + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserScrollToConfig type: object - RequestToolUseBlock: + BrowserSwitchTabConfig: + description: "``switch_tab``'s config overrides." properties: - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - caller: - discriminator: - mapping: - code_execution_20250825: "#/components/schemas/ServerToolCaller" - code_execution_20260120: "#/components/schemas/ServerToolCaller_20260120" - direct: "#/components/schemas/DirectCaller" - propertyName: type - title: Caller - description: Tool invocation directly from the model. - properties: - type: - title: Type - type: string - enum: - - direct - tool_id: - pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - title: Tool Id - type: string - required: - - type - - tool_id - type: object - id: - pattern: ^[a-zA-Z0-9_-]+$ - title: Id - type: string - input: - title: Input - type: object - name: - maxLength: 200 - minLength: 1 - title: Name - type: string - type: - title: Type - type: string - enum: - - tool_use - required: - - id - - input - - name - - type - title: RequestToolUseBlock + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserSwitchTabConfig + type: object + BrowserTripleClickConfig: + description: "``triple_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserTripleClickConfig + type: object + BrowserTypeConfig: + description: "``type``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserTypeConfig + type: object + BrowserWaitConfig: + description: "``wait``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserWaitConfig type: object - RequestToolResultBlock: + BrowserZoomConfig: + description: "``zoom``'s config overrides." properties: - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - content: - title: Content - type: string - x-stainless-skip: - - go - - cli - items: - type: string - x-stainless-naming: - python: - type_name: Content - ruby: - type_name: Content - php: - type_name: Content - is_error: - title: Is Error type: boolean - tool_use_id: - pattern: ^[a-zA-Z0-9_-]+$ - title: Tool Use Id - type: string - type: - title: Type - type: string - enum: - - tool_result - required: - - tool_use_id - - type - title: RequestToolResultBlock + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: BrowserZoomConfig type: object - RequestServerToolUseBlock: + ComputerCursorPositionConfig: + description: "``cursor_position``'s config overrides." properties: - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - caller: - discriminator: - mapping: - code_execution_20250825: "#/components/schemas/ServerToolCaller" - code_execution_20260120: "#/components/schemas/ServerToolCaller_20260120" - direct: "#/components/schemas/DirectCaller" - propertyName: type - title: Caller - description: Tool invocation directly from the model. - properties: - type: - title: Type - type: string - enum: - - direct - tool_id: - pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - title: Tool Id - type: string - required: - - type - - tool_id - type: object - id: - pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - title: Id - type: string - input: - title: Input - type: object - name: - enum: - - web_search - - web_fetch - - code_execution - - bash_code_execution - - text_editor_code_execution - - tool_search_tool_regex - - tool_search_tool_bm25 - title: Name - type: string - type: - title: Type - type: string - enum: - - server_tool_use - required: - - id - - input - - name - - type - title: RequestServerToolUseBlock + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerCursorPositionConfig type: object - RequestWebSearchToolResultBlock: + ComputerDoubleClickConfig: + description: "``double_click``'s config overrides." properties: - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - caller: - discriminator: - mapping: - code_execution_20250825: "#/components/schemas/ServerToolCaller" - code_execution_20260120: "#/components/schemas/ServerToolCaller_20260120" - direct: "#/components/schemas/DirectCaller" - propertyName: type - title: Caller - description: Tool invocation directly from the model. - properties: - type: - title: Type - type: string - enum: - - direct - tool_id: - pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - title: Tool Id - type: string - required: - - type - - tool_id - type: object - content: - title: Content - items: - $ref: "#/components/schemas/RequestWebSearchResultBlock" - type: array - properties: - error_code: - $ref: "#/components/schemas/WebSearchToolResultErrorCode" - type: - title: Type - type: string - enum: - - web_search_tool_result_error - required: - - error_code - - type - tool_use_id: - pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - title: Tool Use Id - type: string - type: - title: Type - type: string - enum: - - web_search_tool_result - required: - - content - - tool_use_id - - type - title: RequestWebSearchToolResultBlock + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerDoubleClickConfig type: object - RequestWebFetchToolResultBlock: + ComputerHoldKeyConfig: + description: "``hold_key``'s config overrides." properties: - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - caller: - discriminator: - mapping: - code_execution_20250825: "#/components/schemas/ServerToolCaller" - code_execution_20260120: "#/components/schemas/ServerToolCaller_20260120" - direct: "#/components/schemas/DirectCaller" - propertyName: type - title: Caller - description: Tool invocation directly from the model. - properties: - type: - title: Type - type: string - enum: - - direct - tool_id: - pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - title: Tool Id - type: string - required: - - type - - tool_id - type: object - content: - title: Content - properties: - error_code: - $ref: "#/components/schemas/WebFetchToolResultErrorCode" - type: - title: Type - type: string - enum: - - web_fetch_tool_result_error - content: - $ref: "#/components/schemas/RequestDocumentBlock" - retrieved_at: - description: ISO 8601 timestamp when the content was retrieved - title: Retrieved At - nullable: true - type: string - url: - description: Fetched content URL - title: Url - type: string - required: - - error_code - - type - - content - - url - type: object - tool_use_id: - pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - title: Tool Use Id - type: string - type: - title: Type - type: string - enum: - - web_fetch_tool_result - required: - - content - - tool_use_id - - type - title: RequestWebFetchToolResultBlock + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerHoldKeyConfig + type: object + ComputerKeyConfig: + description: "``key``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerKeyConfig + type: object + ComputerLeftClickConfig: + description: "``left_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerLeftClickConfig type: object - RequestCodeExecutionToolResultBlock: + ComputerLeftClickDragConfig: + description: "``left_click_drag``'s config overrides." properties: - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - content: - title: Content - properties: - error_code: - $ref: "#/components/schemas/CodeExecutionToolResultErrorCode" - type: - title: Type - type: string - enum: - - code_execution_tool_result_error - content: - items: - $ref: "#/components/schemas/RequestCodeExecutionOutputBlock" - title: Content - type: array - return_code: - title: Return Code - type: integer - stderr: - title: Stderr - type: string - stdout: - title: Stdout - type: string - encrypted_stdout: - title: Encrypted Stdout - type: string - required: - - error_code - - type - - content - - return_code - - stderr - - stdout - - encrypted_stdout - type: object - description: Code execution result with encrypted stdout for PFC + web_search results. - tool_use_id: - pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - title: Tool Use Id - type: string - type: - title: Type - type: string - enum: - - code_execution_tool_result - required: - - content - - tool_use_id - - type - title: RequestCodeExecutionToolResultBlock + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerLeftClickDragConfig type: object - RequestBashCodeExecutionToolResultBlock: + ComputerLeftMouseDownConfig: + description: "``left_mouse_down``'s config overrides." properties: - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - content: - title: Content - properties: - error_code: - $ref: "#/components/schemas/BashCodeExecutionToolResultErrorCode" - type: - title: Type - type: string - enum: - - bash_code_execution_tool_result_error - content: - items: - $ref: "#/components/schemas/RequestBashCodeExecutionOutputBlock" - title: Content - type: array - return_code: - title: Return Code - type: integer - stderr: - title: Stderr - type: string - stdout: - title: Stdout - type: string - required: - - error_code - - type - - content - - return_code - - stderr - - stdout - type: object - tool_use_id: - pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - title: Tool Use Id - type: string - type: - title: Type - type: string - enum: - - bash_code_execution_tool_result - required: - - content - - tool_use_id - - type - title: RequestBashCodeExecutionToolResultBlock + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerLeftMouseDownConfig type: object - RequestTextEditorCodeExecutionToolResultBlock: + ComputerLeftMouseUpConfig: + description: "``left_mouse_up``'s config overrides." properties: - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - content: - title: Content - properties: - error_code: - $ref: "#/components/schemas/TextEditorCodeExecutionToolResultErrorCode" - error_message: - title: Error Message - nullable: true - type: string - type: - title: Type - type: string - enum: - - text_editor_code_execution_tool_result_error - content: - title: Content - type: string - file_type: - enum: - - text - - image - - pdf - title: File Type - type: string - num_lines: - title: Num Lines - nullable: true - type: integer - start_line: - title: Start Line - nullable: true - type: integer - total_lines: - title: Total Lines - nullable: true - type: integer - is_file_update: - title: Is File Update - type: boolean - lines: - title: Lines - nullable: true - items: - type: string - type: array - new_lines: - title: New Lines - nullable: true - type: integer - new_start: - title: New Start - nullable: true - type: integer - old_lines: - title: Old Lines - nullable: true - type: integer - old_start: - title: Old Start - nullable: true - type: integer - required: - - error_code - - type - - content - - file_type - - is_file_update - type: object - tool_use_id: - pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - title: Tool Use Id - type: string - type: - title: Type - type: string - enum: - - text_editor_code_execution_tool_result - required: - - content - - tool_use_id - - type - title: RequestTextEditorCodeExecutionToolResultBlock + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerLeftMouseUpConfig + type: object + ComputerMiddleClickConfig: + description: "``middle_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerMiddleClickConfig + type: object + ComputerMouseMoveConfig: + description: "``mouse_move``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerMouseMoveConfig + type: object + ComputerRightClickConfig: + description: "``right_click``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerRightClickConfig + type: object + ComputerScreenshotConfig: + description: "``screenshot``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerScreenshotConfig type: object - RequestToolSearchToolResultBlock: + ComputerScrollConfig: + description: "``scroll``'s config overrides." properties: - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - content: - title: Content - properties: - error_code: - $ref: "#/components/schemas/ToolSearchToolResultErrorCode" - error_message: - title: Error Message - nullable: true - type: string - type: - title: Type - type: string - enum: - - tool_search_tool_result_error - tool_references: - items: - $ref: "#/components/schemas/RequestToolReferenceBlock" - title: Tool References - type: array - required: - - error_code - - type - - tool_references - type: object - tool_use_id: - pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - title: Tool Use Id - type: string - type: - title: Type - type: string - enum: - - tool_search_tool_result - required: - - content - - tool_use_id - - type - title: RequestToolSearchToolResultBlock + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerScrollConfig type: object - RequestContainerUploadBlock: - description: |- - A content block that represents a file to be uploaded to the container - Files uploaded via this block will be available in the container's input directory. + ComputerTripleClickConfig: + description: "``triple_click``'s config overrides." properties: - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - file_id: - title: File Id - type: string - type: - title: Type - type: string - enum: - - container_upload - required: - - file_id - - type - title: RequestContainerUploadBlock + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerTripleClickConfig type: object - RequestMidConvSystemBlock: - description: |- - System instructions that appear mid-conversation. - - Use this block to provide or update system-level instructions at a specific - point in the conversation, rather than only via the top-level `system` parameter. + ComputerTypeConfig: + description: "``type``'s config overrides." properties: - cache_control: - type: string - description: Create a cache control breakpoint at this content block. + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading nullable: true - content: - description: System instruction text blocks. - items: - type: string - title: Content - type: array - type: - title: Type - type: string - enum: - - mid_conv_system - required: - - content - - type - title: RequestMidConvSystemBlock + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerTypeConfig + type: object + ComputerWaitConfig: + description: "``wait``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerWaitConfig + type: object + ComputerZoomConfig: + description: "``zoom``'s config overrides." + properties: + defer_loading: + description: Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. + title: Defer Loading + nullable: true + type: boolean + enabled: + description: Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. + title: Enabled + nullable: true + type: boolean + title: ComputerZoomConfig type: object - ThinkingDisplayMode: - enum: - - summarized - - omitted - title: ThinkingDisplayMode - type: string WebSearchToolResultErrorCode: enum: - invalid_tool_input @@ -6173,6 +9576,7 @@ components: - too_many_requests - max_uses_exceeded - unavailable + - content_too_large title: WebFetchToolResultErrorCode type: string ResponseDocumentBlock: @@ -6361,6 +9765,33 @@ components: - url title: URLImageSource type: object + FileImageSource: + properties: + file_id: + title: File Id + type: string + type: + title: Type + type: string + enum: + - file + required: + - file_id + - type + title: FileImageSource + type: object + RequestImageTransformations: + description: Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. + properties: + oversized_image: + description: What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. + enum: + - downsize + - error + title: Oversized Image + type: string + title: RequestImageTransformations + type: object Base64PDFSource: properties: data: @@ -6436,6 +9867,21 @@ components: - url title: URLPDFSource type: object + FileDocumentSource: + properties: + file_id: + title: File Id + type: string + type: + title: Type + type: string + enum: + - file + required: + - file_id + - type + title: FileDocumentSource + type: object RequestToolReferenceBlock: description: Tool reference block that can be included in tool_result content. properties: @@ -6459,6 +9905,46 @@ components: - type title: RequestToolReferenceBlock type: object + RequestBrowserStateBlock: + description: |- + The caller's browser state after a browser toolset member call — + the full inventory of open tabs, which tab is active, and any side + effects (tabs opened, download state changes) the call produced. + + At most one per `tool_result`, only on a non-error result answering a + browser toolset member `tool_use`. The server renders the + model-visible text from it; the model never sees the raw fields. + properties: + cache_control: + type: string + description: Create a cache control breakpoint at this content block. + nullable: true + state_changes: + description: Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. + title: State Changes + nullable: true + items: + type: string + maxItems: 200 + minItems: 1 + type: array + tabs: + description: "All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`." + items: + $ref: "#/components/schemas/BrowserStateTabEntry" + maxItems: 100 + title: Tabs + type: array + type: + title: Type + type: string + enum: + - browser_state + required: + - tabs + - type + title: RequestBrowserStateBlock + type: object RequestWebSearchResultBlock: properties: encrypted_content: @@ -6800,6 +10286,178 @@ components: - enabled title: ResponseCitationsConfig type: object + BrowserStateChangeTabOpened: + description: |- + A tab this call's execution opened that remains open at its end — + the creation delta of the `tabs` inventory, not an event log. + + Carries only the `tab_id`; the tab's `title` and `url` live on its + `tabs` entry, which must include the same `tab_id`. A tab opened + during a failed call gets no deferred `tab_opened`; it simply appears + in the next result's `tabs` inventory. + properties: + tab_id: + description: The `tab_id` of the opened tab, present in `tabs`. + maxLength: 4096 + minLength: 1 + pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + title: Tab Id + type: string + type: + title: Type + type: string + enum: + - tab_opened + required: + - tab_id + - type + title: BrowserStateChangeTabOpened + type: object + BrowserStateChangeDownloadStarted: + description: A file download that started during this call. + properties: + download_id: + description: The caller-assigned identifier for this download, stable across the state changes reporting it. + maxLength: 4096 + minLength: 1 + pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + title: Download Id + type: string + type: + title: Type + type: string + enum: + - download_started + url: + description: The final post-redirect URL the download was served from. + maxLength: 4096 + pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + title: Url + type: string + required: + - download_id + - type + - url + title: BrowserStateChangeDownloadStarted + type: object + BrowserStateChangeDownloadCompleted: + description: |- + A file download that finished during this call, reported with the + same `download_id` as its `download_started` — or without a prior + `download_started`, when the download finished during the call that + started it (at most one state change per `download_id` per result). + properties: + download_id: + description: The caller-assigned identifier for this download, stable across the state changes reporting it. + maxLength: 4096 + minLength: 1 + pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + title: Download Id + type: string + path: + description: Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. + pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + title: Path + nullable: true + maxLength: 4096 + type: string + size_bytes: + description: The completed download's size. + title: Size Bytes + nullable: true + minimum: 0 + type: integer + type: + title: Type + type: string + enum: + - download_completed + url: + description: The final post-redirect URL the download was served from. + maxLength: 4096 + pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + title: Url + type: string + required: + - download_id + - type + - url + title: BrowserStateChangeDownloadCompleted + type: object + BrowserStateChangeDownloadFailed: + description: A file download that failed — or was cancelled — during this call. + properties: + download_id: + description: The caller-assigned identifier for this download, stable across the state changes reporting it. + maxLength: 4096 + minLength: 1 + pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + title: Download Id + type: string + error: + description: The failure or cancellation detail, when known. + pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + title: Error + nullable: true + maxLength: 4096 + type: string + type: + title: Type + type: string + enum: + - download_failed + url: + description: The final post-redirect URL the download was served from. + maxLength: 4096 + pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + title: Url + type: string + required: + - download_id + - type + - url + title: BrowserStateChangeDownloadFailed + type: object + BrowserStateTabEntry: + description: |- + One open browser tab reported in a `browser_state` block's `tabs` + inventory. + + `tab_id` is the caller-assigned identifier for the tab; `title` and + `url` describe the page the tab is currently showing and may be empty + strings (a blank tab legitimately has both empty). `active` marks the + tab that is active after this call; whenever `tabs` is non-empty, + exactly one entry is marked. + properties: + active: + description: "Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`." + title: Active + type: boolean + tab_id: + description: The caller-assigned identifier for this tab, unique within the inventory. + maxLength: 4096 + minLength: 1 + pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + title: Tab Id + type: string + title: + description: The title of the page the tab is showing. May be empty. + maxLength: 4096 + pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + title: Title + type: string + url: + description: The URL of the page the tab is showing. May be empty. + maxLength: 4096 + pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + title: Url + type: string + required: + - tab_id + - title + - url + title: BrowserStateTabEntry + type: object RequestCodeExecutionOutputBlock: properties: file_id: diff --git a/providers/src/anthropic/v00.00.00000/services/models.yaml b/providers/src/anthropic/v00.00.00000/services/models.yaml index c10aae5e..0c7ed5c4 100644 --- a/providers/src/anthropic/v00.00.00000/services/models.yaml +++ b/providers/src/anthropic/v00.00.00000/services/models.yaml @@ -98,6 +98,17 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -105,11 +116,98 @@ paths: application/json: schema: $ref: "#/components/schemas/ListResponse_ModelInfo_" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -183,6 +281,17 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -190,11 +299,98 @@ paths: application/json: schema: $ref: "#/components/schemas/ModelInfo" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/json: schema: @@ -226,13 +422,29 @@ components: - fast-mode-2026-02-01 - output-300k-2026-03-24 - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 - advisor-tool-2026-03-01 - managed-agents-2026-04-01 - cache-diagnosis-2026-04-07 + - dreaming-2026-04-21 - thinking-token-count-2026-05-13 - server-side-fallback-2026-06-01 + - server-side-fallback-2026-07-01 - fallback-credit-2026-06-01 + - fallback-credit-2026-07-01 - agent-memory-2026-07-22 + - mid-conversation-tool-changes-2026-07-01 + - compact-2026-01-12 + - computer-use-2025-11-24 + - mcp-tunnels-2026-06-22 + - structured-outputs-2025-11-13 + - task-budgets-2026-03-13 + - thinking-display-updates-2026-08-18 + - ce-user-management-2026-07-13 + - mid-conversation-output-config-2026-07-01 + - thinking-binding-controls-2026-08-01 + - mid-conversation-system-clear-at-2026-08-21 x-stainless-nominal: false ListResponse_ModelInfo_: properties: @@ -361,19 +573,19 @@ components: title: Created At description: RFC 3339 datetime string representing the time at which the model was released. May be set to an epoch value if the release date is unknown. examples: - - "2026-02-04T00:00:00Z" + - "2026-07-24T00:00:00Z" display_name: type: string title: Display Name description: A human-readable name for the model. examples: - - Claude Opus 4.6 + - Claude Opus 5 id: type: string title: Id description: Unique model identifier. examples: - - claude-opus-4-6 + - claude-opus-5 max_input_tokens: title: Max Input Tokens description: Maximum input context window size in tokens for this model. diff --git a/providers/src/anthropic/v00.00.00000/services/sessions.yaml b/providers/src/anthropic/v00.00.00000/services/sessions.yaml index b26eb0f7..b1e8d1b4 100644 --- a/providers/src/anthropic/v00.00.00000/services/sessions.yaml +++ b/providers/src/anthropic/v00.00.00000/services/sessions.yaml @@ -111,6 +111,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 parameters: - name: anthropic-version in: header @@ -131,6 +133,17 @@ paths: items: $ref: "#/components/schemas/AnthropicBeta" default: managed-agents-2026-04-01 + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy get: operationId: BetaListSessions summary: List Sessions @@ -214,19 +227,19 @@ paths: schema: type: integer format: int32 - description: Filter by agent version. Only applies when agent_id is also set. + description: Filter by agent version. Only applies when `agent_id` is also set. - name: order in: query required: false schema: $ref: "#/components/schemas/BetaManagedAgentsListOrder" - description: Sort direction for results, ordered by created_at. Defaults to desc (newest first). + description: Sort direction for results, ordered by `created_at`. Defaults to `desc` (newest first). - name: memory_store_id in: query required: false schema: type: string - description: Filter sessions whose resources contain a memory_store with this memory store ID. + description: Filter sessions whose resources contain a `memory_store` with this memory store ID. - name: deployment_id in: query required: false @@ -243,6 +256,17 @@ paths: items: $ref: "#/components/schemas/BetaManagedAgentsSessionStatus" description: Filter by session status. Repeat the parameter to match any of multiple statuses. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -340,6 +364,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/sessions/{session_id}?beta=true: get: operationId: BetaGetSession @@ -376,6 +402,17 @@ paths: type: string description: Path parameter session_id example: sesn_011CZkZAtmR3yMPDzynEDxu7 + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -473,6 +510,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 post: operationId: BetaUpdateSession summary: Update Session @@ -504,6 +543,17 @@ paths: x-stainless-cli-data-alias: id description: Path parameter session_id example: sesn_011CZkZAtmR3yMPDzynEDxu7 + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -607,6 +657,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 delete: operationId: BetaDeleteSession summary: Delete Session @@ -642,6 +694,17 @@ paths: type: string description: Path parameter session_id example: sesn_011CZkZAtmR3yMPDzynEDxu7 + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -739,6 +802,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/sessions/{session_id}/events?beta=true: get: operationId: BetaListEvents @@ -787,13 +852,13 @@ paths: required: false schema: type: string - description: Opaque pagination cursor from a previous response's next_page. + description: Opaque pagination cursor from a previous response's `next_page`. - name: order in: query required: false schema: $ref: "#/components/schemas/BetaManagedAgentsListOrder" - description: Sort direction for results, ordered by created_at. Defaults to asc (chronological). + description: Sort direction for results, ordered by the event's `processed_at`. Defaults to `asc` (chronological). - name: types[] in: query required: false @@ -809,25 +874,36 @@ paths: required: false schema: $ref: "#/components/schemas/BetaTimestamp" - description: Return events created at or after this time (inclusive). + description: Return events created at or after this time (inclusive). Compared against the event's `processed_at` value. - name: created_at[gt] in: query required: false schema: $ref: "#/components/schemas/BetaTimestamp" - description: Return events created after this time (exclusive). + description: Return events created after this time (exclusive). Compared against the event's `processed_at` value. - name: created_at[lte] in: query required: false schema: $ref: "#/components/schemas/BetaTimestamp" - description: Return events created at or before this time (inclusive). + description: Return events created at or before this time (inclusive). Compared against the event's `processed_at` value. - name: created_at[lt] in: query required: false schema: $ref: "#/components/schemas/BetaTimestamp" - description: Return events created before this time (exclusive). + description: Return events created before this time (exclusive). Compared against the event's `processed_at` value. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -925,6 +1001,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 post: operationId: BetaSendEvents summary: Send Events @@ -955,6 +1033,17 @@ paths: type: string description: Path parameter session_id example: sesn_011CZkZAtmR3yMPDzynEDxu7 + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -1058,6 +1147,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/sessions/{session_id}/archive?beta=true: post: operationId: BetaArchiveSession @@ -1089,6 +1180,17 @@ paths: type: string description: Path parameter session_id example: sesn_011CZkZAtmR3yMPDzynEDxu7 + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1186,6 +1288,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/sessions/{session_id}/threads?beta=true: get: operationId: BetaListSessionThreads @@ -1234,7 +1338,18 @@ paths: required: false schema: type: string - description: Opaque pagination cursor from a previous response's next_page. Forward-only. + description: Opaque pagination cursor from a previous response's `next_page`. Forward-only. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1332,6 +1447,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/sessions/{session_id}/threads/{thread_id}?beta=true: get: operationId: BetaGetSessionThread @@ -1375,6 +1492,17 @@ paths: type: string description: Path parameter thread_id example: sthr_011CZkZVWa6oIjw0rgXZpnBt + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1472,6 +1600,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/sessions/{session_id}/threads/{thread_id}/events?beta=true: get: operationId: BetaListSessionThreadEvents @@ -1528,6 +1658,17 @@ paths: schema: type: string description: Query parameter for page + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1625,6 +1766,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/sessions/{session_id}/threads/{thread_id}/archive?beta=true: post: operationId: BetaArchiveSessionThread @@ -1663,6 +1806,17 @@ paths: type: string description: Path parameter thread_id example: sthr_011CZkZVWa6oIjw0rgXZpnBt + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1760,6 +1914,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/sessions/{session_id}/resources?beta=true: get: operationId: BetaListResources @@ -1808,7 +1964,18 @@ paths: required: false schema: type: string - description: Opaque cursor from a previous response's next_page field. + description: Opaque cursor from a previous response's `next_page` field. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1906,6 +2073,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 post: operationId: BetaAddResource summary: Add Session Resource @@ -1936,6 +2105,17 @@ paths: type: string description: Path parameter session_id example: sesn_011CZkZAtmR3yMPDzynEDxu7 + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -2039,6 +2219,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/sessions/{session_id}/resources/{resource_id}?beta=true: get: operationId: BetaGetResource @@ -2082,6 +2264,17 @@ paths: type: string description: Path parameter resource_id example: sesrsc_011CZkZBJq5dWxk9fVLNcPht + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -2179,6 +2372,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 delete: operationId: BetaDeleteResource summary: Delete Session Resource @@ -2221,6 +2416,17 @@ paths: type: string description: Path parameter resource_id example: sesrsc_011CZkZBJq5dWxk9fVLNcPht + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -2318,6 +2524,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 post: operationId: BetaUpdateResource summary: Update Session Resource @@ -2356,6 +2564,17 @@ paths: x-stainless-cli-data-alias: id description: Path parameter resource_id example: sesrsc_011CZkZBJq5dWxk9fVLNcPht + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -2459,6 +2678,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 components: schemas: BetaManagedAgentsCreateSessionParams: @@ -2480,11 +2701,11 @@ components: - env_011CZkZ9X2dpNyB7HsEFoRfW title: description: Human-readable session title. - type: string - maxLength: 500 - nullable: true examples: - "Order #1234 inquiry" + nullable: true + type: string + maxLength: 500 metadata: description: Arbitrary key-value metadata attached to the session. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. type: object @@ -2498,6 +2719,52 @@ components: type: array items: type: string + initial_events: + description: Initial events to send to the `session` at creation, processed in order. Supports `user.message` and `user.define_outcome` events. Maximum 50 events. + type: array + items: + $ref: "#/components/schemas/BetaManagedAgentsSessionInitialEventParams" + x-anthropic-beta-required: + - managed-agents-2026-04-01 + budget: + description: Enforced spend ceiling for the session. Omit to create an uncapped session. Every model the session can run — the agent's model and each callable agent's model — must have a public list price, or the request is rejected with reason `model_not_budgetable`. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + type: object + discriminator: + propertyName: type + mapping: + limit: "#/components/schemas/BetaManagedAgentsBudgetLimit" + required: + - type + - max_list_cost + properties: + type: + type: string + enum: + - limit + max_list_cost: + description: Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" example: agent: agent_011CZkYpogX7uDKUyvBTophP environment_id: env_011CZkZ9X2dpNyB7HsEFoRfW @@ -2521,6 +2788,7 @@ components: - usage - stats - archived_at + - budget properties: type: type: string @@ -2549,10 +2817,10 @@ components: examples: - env_011CZkZ9X2dpNyB7HsEFoRfW title: - type: string - nullable: true examples: - "Order #1234 inquiry" + nullable: true + type: string metadata: type: object examples: @@ -2566,7 +2834,7 @@ components: name: My First Agent description: A general-purpose starter agent. model: - id: claude-sonnet-4-6 + id: claude-opus-5 speed: standard system: You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end. tools: @@ -2616,10 +2884,12 @@ components: examples: - - vlt_011CZkZDLs7fYzm1hXNPeRjv outcome_evaluations: - description: Per-outcome evaluation state. One entry per define_outcome event sent to the session. + description: Per-outcome evaluation state. One entry per `define_outcome` event sent to the session. type: array items: $ref: "#/components/schemas/BetaManagedAgentsOutcomeEvaluationResource" + x-anthropic-beta-required: + - managed-agents-2026-04-01 examples: - - type: outcome_evaluation outcome_id: outc_011CZkZRSw2kEfs6ncTVljxP @@ -2660,6 +2930,59 @@ components: description: Tokens used to create 5-minute ephemeral cache entries. type: integer format: int32 + list_cost: + description: Cumulative list cost of the session across all turns, priced at public list rates. Absent until cost tracking is available for the session. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" + server_tool_use: + description: Cumulative server-executed tool usage across all turns. Absent until server-tool tracking is available for the session. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: object + properties: + web_search_requests: + description: Number of server-executed web search requests. + type: integer + format: int32 + examples: + - 3 + web_fetch_requests: + description: Number of server-executed web fetch requests. + type: integer + format: int32 + examples: + - 0 + example: + web_search_requests: 3 + web_fetch_requests: 0 + active_seconds: + description: Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once, unlike `stats.active_seconds`, which sums each thread's own active time. This is the duration the session's runtime cost is priced on. + type: number + format: double + x-anthropic-beta-required: + - managed-agents-2026-04-01 stats: description: Timing statistics for the session. examples: @@ -2672,20 +2995,64 @@ components: type: number format: double active_seconds: - description: Cumulative time in seconds the session spent in running status. Excludes idle time. + description: Cumulative time in seconds the session spent in `running` status. Excludes idle time. type: number format: double archived_at: description: When the session was archived. Null if not archived. - nullable: true examples: - null + nullable: true type: string format: date-time deployment_id: description: Deployment ID when the session was created from a deployment reference. Null otherwise. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true type: string + budget: + description: The session's enforced spend ceiling, or null when no budget is set. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + examples: + - null nullable: true + type: object + discriminator: + propertyName: type + mapping: + limit: "#/components/schemas/BetaManagedAgentsBudgetLimit" + required: + - type + - max_list_cost + properties: + type: + type: string + enum: + - limit + max_list_cost: + description: Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" example: type: session id: sesn_011CZkZAtmR3yMPDzynEDxu7 @@ -2693,6 +3060,7 @@ components: created_at: "2026-03-15T10:00:00Z" updated_at: "2026-03-15T10:00:00Z" archived_at: null + budget: null environment_id: env_011CZkZ9X2dpNyB7HsEFoRfW title: "Order #1234 inquiry" metadata: {} @@ -2703,7 +3071,7 @@ components: name: My First Agent description: A general-purpose starter agent. model: - id: claude-sonnet-4-6 + id: claude-opus-5 speed: standard system: You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end. tools: @@ -2831,13 +3199,29 @@ components: - fast-mode-2026-02-01 - output-300k-2026-03-24 - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 - advisor-tool-2026-03-01 - managed-agents-2026-04-01 - cache-diagnosis-2026-04-07 + - dreaming-2026-04-21 - thinking-token-count-2026-05-13 - server-side-fallback-2026-06-01 + - server-side-fallback-2026-07-01 - fallback-credit-2026-06-01 + - fallback-credit-2026-07-01 - agent-memory-2026-07-22 + - mid-conversation-tool-changes-2026-07-01 + - compact-2026-01-12 + - computer-use-2025-11-24 + - mcp-tunnels-2026-06-22 + - structured-outputs-2025-11-13 + - task-budgets-2026-03-13 + - thinking-display-updates-2026-08-18 + - ce-user-management-2026-07-13 + - mid-conversation-output-config-2026-07-01 + - thinking-binding-controls-2026-08-01 + - mid-conversation-system-clear-at-2026-08-21 x-stainless-nominal: false BetaTimestamp: description: A timestamp in RFC 3339 format @@ -2874,16 +3258,18 @@ components: description: Opaque cursor for the next page. Null when no more results. x-stainless-pagination-property: purpose: next_cursor_field - type: string - nullable: true examples: - page_MjAyNS0wNS0xNFQwMDowMDowMFo= + nullable: true + type: string prev_page: description: Opaque cursor for the previous page. Null when on the first page. Pass as the `page` parameter to navigate backward. - type: string - nullable: true + x-anthropic-beta-required: + - managed-agents-2026-04-01 examples: - page_MjAyNS0wNS0xM1QwMDowMDowMFo= + nullable: true + type: string example: data: [] next_page: page_MjAyNS0wNS0xNFQwMDowMDowMFo= @@ -2894,16 +3280,16 @@ components: properties: title: description: Human-readable session title. + examples: + - "Order #1234 inquiry" + nullable: true type: string minLength: 1 maxLength: 500 - nullable: true - examples: - - "Order #1234 inquiry" metadata: description: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. - type: object nullable: true + type: object vault_ids: description: Vault IDs (`vlt_*`) to attach to the session. Not yet supported; requests setting this field are rejected. Reserved for future use. type: array @@ -2911,6 +3297,8 @@ components: type: string agent: description: Agent configuration update. Only `tools` and `mcp_servers` are updatable mid-session. Only valid for sessions created from an agent or deployment reference. The session must not be running. + x-anthropic-beta-required: + - managed-agents-2026-04-01 type: object properties: tools: @@ -2923,6 +3311,46 @@ components: type: array items: $ref: "#/components/schemas/BetaManagedAgentsMCPServerParams" + budget: + description: Enforced spend ceiling for the session. Set an object to replace the budget of a session that was created with one, or `null` to remove it; omit to preserve. A budget cannot be added to a session created without one (rejected with reason `budget_create_only`), and a removed budget cannot be re-added. Allowed in any non-terminated status. Lowering `max_list_cost` to at or below the session's consumed list cost is rejected with reason `budget_not_raised`, and every model the session can run must have a public list price or the request is rejected with reason `model_not_budgetable`. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: object + discriminator: + propertyName: type + mapping: + limit: "#/components/schemas/BetaManagedAgentsBudgetLimit" + required: + - type + - max_list_cost + properties: + type: + type: string + enum: + - limit + max_list_cost: + description: Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" example: title: "Order #1234 inquiry" BetaManagedAgentsDeletedSession: @@ -2950,7 +3378,7 @@ components: type: object properties: data: - description: Events for the session, ordered by `created_at`. + description: Events for the session, ordered by `processed_at`. x-stainless-pagination-property: purpose: items type: array @@ -2973,10 +3401,10 @@ components: description: Opaque cursor for the next page. Null when no more results. x-stainless-pagination-property: purpose: next_cursor_field - type: string - nullable: true examples: - page_MjAyNS0wNS0xNFQwMDowMDowMFo= + nullable: true + type: string example: data: - type: user.message @@ -3046,7 +3474,7 @@ components: name: Researcher description: A focused research subagent. model: - id: claude-sonnet-4-6 + id: claude-opus-5 speed: standard system: You are a research subagent that gathers and summarises sources for the coordinating agent. tools: @@ -3077,10 +3505,10 @@ components: description: Opaque cursor for the next page. Null when no more results. x-stainless-pagination-property: purpose: next_cursor_field - type: string - nullable: true examples: - page_MjAyNS0wNS0xNFQwMDowMDowMFo= + nullable: true + type: string example: data: - type: session_thread @@ -3094,7 +3522,7 @@ components: name: Researcher description: A focused research subagent. model: - id: claude-sonnet-4-6 + id: claude-opus-5 speed: standard system: You are a research subagent that gathers and summarises sources for the coordinating agent. tools: @@ -3173,7 +3601,7 @@ components: name: Researcher description: A focused research subagent. model: - id: claude-sonnet-4-6 + id: claude-opus-5 speed: standard system: You are a research subagent that gathers and summarises sources for the coordinating agent. tools: @@ -3185,6 +3613,11 @@ components: configs: [] mcp_servers: [] skills: [] + discriminator: + propertyName: type + mapping: + agent: "#/components/schemas/BetaManagedAgentsSessionThreadAgent" + advisor: "#/components/schemas/BetaManagedAgentsAdvisor" type: object required: - type @@ -3218,20 +3651,20 @@ components: examples: - Researcher description: - type: string - nullable: true examples: - A focused research subagent. + nullable: true + type: string model: $ref: "#/components/schemas/BetaManagedAgentsModelConfig" examples: - - id: claude-sonnet-4-6 + - id: claude-opus-5 speed: standard system: - type: string - nullable: true examples: - You are a research subagent that gathers and summarises sources for the coordinating agent. + nullable: true + type: string tools: type: array items: @@ -3262,7 +3695,7 @@ components: name: Researcher description: A focused research subagent. model: - id: claude-sonnet-4-6 + id: claude-opus-5 speed: standard system: You are a research subagent that gathers and summarises sources for the coordinating agent. tools: @@ -3276,10 +3709,10 @@ components: skills: [] parent_thread_id: description: Parent thread that spawned this thread. Null for the primary thread. - type: string - nullable: true examples: - null + nullable: true + type: string created_at: description: When the thread was created. examples: @@ -3294,14 +3727,13 @@ components: format: date-time archived_at: description: When the thread was archived. Null if not archived. - nullable: true examples: - null + nullable: true type: string format: date-time usage: description: Cumulative token usage for this thread. Null until the thread's first idle transition. - nullable: true examples: - input_tokens: 0 output_tokens: 0 @@ -3309,6 +3741,7 @@ components: cache_creation: ephemeral_5m_input_tokens: 0 ephemeral_1h_input_tokens: 0 + nullable: true type: object properties: input_tokens: @@ -3335,13 +3768,66 @@ components: description: Tokens used to create 5-minute ephemeral cache entries. type: integer format: int32 + list_cost: + description: Cumulative list cost of this thread across all turns, priced at public list rates. Absent until cost tracking is available for the thread. Each figure is rounded to the nearest cent independently and the session's aggregate `usage.list_cost` additionally includes session runtime, so per-thread costs do not sum exactly to the session figure; the session figure is authoritative and is what a budget is enforced against. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" + active_seconds: + description: Cumulative time in seconds this thread spent in running status. Equal to `stats.active_seconds`; surfaced here so a thread's usage carries every quantity its cost is priced on. + type: number + format: double + x-anthropic-beta-required: + - managed-agents-2026-04-01 + server_tool_use: + description: Cumulative server-executed tool usage across all turns of this thread. Absent until server-tool tracking is available for the thread. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: object + properties: + web_search_requests: + description: Number of server-executed web search requests. + type: integer + format: int32 + examples: + - 3 + web_fetch_requests: + description: Number of server-executed web fetch requests. + type: integer + format: int32 + examples: + - 0 + example: + web_search_requests: 3 + web_fetch_requests: 0 stats: description: Timing statistics for this thread. Null until the thread's first status transition. - nullable: true examples: - duration_seconds: 0 startup_seconds: 0 active_seconds: 0 + nullable: true type: object properties: duration_seconds: @@ -3368,7 +3854,7 @@ components: name: Researcher description: A focused research subagent. model: - id: claude-sonnet-4-6 + id: claude-opus-5 speed: standard system: You are a research subagent that gathers and summarises sources for the coordinating agent. tools: @@ -3400,7 +3886,7 @@ components: type: object properties: data: - description: Events for the thread, ordered by `created_at`. + description: Events for the thread, ordered by `processed_at`. x-stainless-pagination-property: purpose: items type: array @@ -3410,8 +3896,8 @@ components: description: Opaque cursor for the next page. Null when no more results. x-stainless-pagination-property: purpose: next_cursor_field - type: string nullable: true + type: string BetaManagedAgentsListSessionResources: description: Paginated list of resources attached to a session. type: object @@ -3445,10 +3931,10 @@ components: description: Opaque cursor for the next page. Null when no more results. x-stainless-pagination-property: purpose: next_cursor_field - type: string - nullable: true examples: - page_MjAyNS0wNS0xNFQwMDowMDowMFo= + nullable: true + type: string example: data: - type: file @@ -3497,12 +3983,12 @@ components: - file_011CNha8iCJcU1wXNR6q4V8w mount_path: description: Mount path in the container. Defaults to `/mnt/session/uploads/`. + examples: + - /uploads/receipt.pdf + nullable: true type: string minLength: 1 maxLength: 4096 - nullable: true - examples: - - /uploads/receipt.pdf BetaManagedAgentsAddSessionResource: description: The added session resource. type: object @@ -3589,11 +4075,42 @@ components: examples: - /workspace/example-repo checkout: - $ref: "#/components/schemas/BetaManagedAgentsRepositoryCheckout" - nullable: true examples: - type: branch name: main + nullable: true + type: object + discriminator: + propertyName: type + mapping: + branch: "#/components/schemas/BetaManagedAgentsBranchCheckout" + commit: "#/components/schemas/BetaManagedAgentsCommitCheckout" + required: + - type + - name + - sha + properties: + type: + type: string + enum: + - branch + examples: + - branch + name: + description: Branch name to check out. + type: string + minLength: 1 + maxLength: 255 + examples: + - main + sha: + description: Full commit SHA to check out. + type: string + minLength: 7 + maxLength: 64 + example: + type: branch + name: main created_at: $ref: "#/components/schemas/BetaTimestamp" examples: @@ -3610,7 +4127,7 @@ components: description: The memory store ID (memstore_...). Must belong to the caller's organization and workspace. type: string access: - description: Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem. + description: Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. nullable: true type: string enum: @@ -3618,16 +4135,25 @@ components: - read_only name: description: Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - type: string + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 nullable: true + type: string description: description: Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. type: string + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 instructions: description: Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 + nullable: true type: string maxLength: 4096 - nullable: true example: type: github_repository id: sesrsc_011CZkZCKr6eXyl0gWMOdQiu @@ -3712,11 +4238,42 @@ components: examples: - /workspace/example-repo checkout: - $ref: "#/components/schemas/BetaManagedAgentsRepositoryCheckout" - nullable: true examples: - type: branch name: main + nullable: true + type: object + discriminator: + propertyName: type + mapping: + branch: "#/components/schemas/BetaManagedAgentsBranchCheckout" + commit: "#/components/schemas/BetaManagedAgentsCommitCheckout" + required: + - type + - name + - sha + properties: + type: + type: string + enum: + - branch + examples: + - branch + name: + description: Branch name to check out. + type: string + minLength: 1 + maxLength: 255 + examples: + - main + sha: + description: Full commit SHA to check out. + type: string + minLength: 7 + maxLength: 64 + example: + type: branch + name: main created_at: $ref: "#/components/schemas/BetaTimestamp" examples: @@ -3733,7 +4290,7 @@ components: description: The memory store ID (memstore_...). Must belong to the caller's organization and workspace. type: string access: - description: Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem. + description: Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. nullable: true type: string enum: @@ -3741,16 +4298,25 @@ components: - read_only name: description: Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - type: string + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 nullable: true + type: string description: description: Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. type: string + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 instructions: description: Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 + nullable: true type: string maxLength: 4096 - nullable: true example: type: github_repository id: sesrsc_011CZkZCKr6eXyl0gWMOdQiu @@ -3782,7 +4348,6 @@ components: required: - type - url - - authorization_token - file_id - memory_store_id properties: @@ -3800,18 +4365,19 @@ components: examples: - https://github.com/example-org/example-repo authorization_token: - description: GitHub authorization token used to clone the repository. + description: GitHub authorization token used to clone the repository. Required for private repositories; optional for public ones. type: string minLength: 1 maxLength: 4096 examples: - ghp_exampletoken + x-stainless-go-json: omitzero mount_path: description: Mount path in the container. Defaults to `/workspace/`. + nullable: true type: string minLength: 1 maxLength: 4096 - nullable: true checkout: description: Branch or commit to check out. Defaults to the repository's default branch. nullable: true @@ -3866,9 +4432,136 @@ components: - read_only instructions: description: Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 + nullable: true type: string maxLength: 4096 + BetaManagedAgentsSessionInitialEventParams: + description: An event sent to the `session` immediately after it is created. Supports `user.message` and `user.define_outcome`. + type: object + discriminator: + propertyName: type + mapping: + user.message: "#/components/schemas/BetaManagedAgentsUserMessageEventParams" + user.define_outcome: "#/components/schemas/BetaManagedAgentsUserDefineOutcomeEventParams" + required: + - type + - content + - description + - rubric + properties: + type: + type: string + enum: + - user.message + examples: + - user.message + content: + description: Array of content blocks for the user message. + type: array + items: + $ref: "#/components/schemas/BetaManagedAgentsUserContentBlock" + examples: + - - type: text + text: "Where is my order #1234?" + description: + description: What the agent should produce. This is the task specification. + type: string + examples: + - Produce a 2-page summary as summary.md + rubric: + description: How to grade the outcome. Text or file reference. + examples: + - type: text + content: Must cover all five sections; cite sources inline. + discriminator: + propertyName: type + mapping: + file: "#/components/schemas/BetaManagedAgentsFileRubricParams" + text: "#/components/schemas/BetaManagedAgentsTextRubricParams" + type: object + required: + - type + - file_id + - content + properties: + type: + type: string + enum: + - file + examples: + - file + file_id: + description: ID of the rubric file. + type: string + examples: + - file_011CNha8iCJcU1wXNR6q4V8w + content: + description: Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. + type: string + maxLength: 262144 + examples: + - Must cover all five sections; cite sources inline. + example: + type: file + file_id: file_011CNha8iCJcU1wXNR6q4V8w + content: Must cover all five sections; cite sources inline. + max_iterations: + description: Eval→revision cycles before giving up. Default 3, max 20. + examples: + - 3 nullable: true + type: integer + format: int32 + example: + type: user.message + content: + - type: text + text: "Where is my order #1234?" + description: Produce a 2-page summary as summary.md + rubric: + type: text + content: Must cover all five sections; cite sources inline. + max_iterations: 3 + BetaManagedAgentsBudget: + description: An enforced spend ceiling on a session. Discriminated on `type`; `limit` is the only kind currently supported. + type: object + discriminator: + propertyName: type + mapping: + limit: "#/components/schemas/BetaManagedAgentsBudgetLimit" + required: + - type + - max_list_cost + properties: + type: + type: string + enum: + - limit + max_list_cost: + description: Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" BetaManagedAgentsSessionAgent: description: Resolved `agent` definition for a `session`. Snapshot of the `agent` at `session` creation time. type: object @@ -3905,20 +4598,20 @@ components: examples: - My First Agent description: - type: string - nullable: true examples: - A general-purpose starter agent. + nullable: true + type: string model: $ref: "#/components/schemas/BetaManagedAgentsModelConfig" examples: - - id: claude-sonnet-4-6 + - id: claude-opus-5 speed: standard system: - type: string - nullable: true examples: - You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end. + nullable: true + type: string tools: type: array items: @@ -3951,9 +4644,11 @@ components: version: "2" multiagent: description: Resolved multiagent orchestration configuration. Null when the agent is single-threaded. - nullable: true + x-anthropic-beta-required: + - managed-agents-2026-04-01 examples: - null + nullable: true discriminator: propertyName: type mapping: @@ -3971,7 +4666,7 @@ components: description: Full `agent` definitions the coordinator may spawn as session threads. type: array items: - $ref: "#/components/schemas/BetaManagedAgentsSessionThreadAgent" + $ref: "#/components/schemas/BetaManagedAgentsSessionRosterEntry" example: type: agent id: agent_011CZkYpogX7uDKUyvBTophP @@ -3979,7 +4674,7 @@ components: name: My First Agent description: A general-purpose starter agent. model: - id: claude-sonnet-4-6 + id: claude-opus-5 speed: standard system: You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end. tools: @@ -4038,11 +4733,42 @@ components: examples: - /workspace/example-repo checkout: - $ref: "#/components/schemas/BetaManagedAgentsRepositoryCheckout" - nullable: true examples: - type: branch name: main + nullable: true + type: object + discriminator: + propertyName: type + mapping: + branch: "#/components/schemas/BetaManagedAgentsBranchCheckout" + commit: "#/components/schemas/BetaManagedAgentsCommitCheckout" + required: + - type + - name + - sha + properties: + type: + type: string + enum: + - branch + examples: + - branch + name: + description: Branch name to check out. + type: string + minLength: 1 + maxLength: 255 + examples: + - main + sha: + description: Full commit SHA to check out. + type: string + minLength: 7 + maxLength: 64 + example: + type: branch + name: main created_at: $ref: "#/components/schemas/BetaTimestamp" examples: @@ -4059,7 +4785,7 @@ components: description: The memory store ID (memstore_...). Must belong to the caller's organization and workspace. type: string access: - description: Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem. + description: Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. nullable: true type: string enum: @@ -4067,16 +4793,25 @@ components: - read_only name: description: Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - type: string + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 nullable: true + type: string description: description: Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. type: string + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 instructions: description: Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 + nullable: true type: string maxLength: 4096 - nullable: true example: type: github_repository id: sesrsc_011CZkZCKr6eXyl0gWMOdQiu @@ -4090,7 +4825,7 @@ components: file_id: file_011CNha8iCJcU1wXNR6q4V8w description: A memory store attached to an agent session. BetaManagedAgentsOutcomeEvaluationResource: - description: Evaluation state for a single outcome defined via a define_outcome event. + description: Evaluation state for a single outcome defined via a `define_outcome` event. type: object required: - type @@ -4129,18 +4864,18 @@ components: examples: - 0 completed_at: - description: When the outcome reached a terminal result. Null while pending/running/evaluating. - nullable: true + description: When the outcome reached a terminal result. Null while `pending`/`running`/`evaluating`. examples: - "2026-03-15T10:02:31Z" + nullable: true type: string format: date-time explanation: - description: Grader's verdict text from the most recent evaluation. For satisfied, explains why criteria are met; for needs_revision (intermediate), what's missing; for failed, why unrecoverable. - type: string - nullable: true + description: Grader's verdict text from the most recent evaluation. For `satisfied`, explains why criteria are met; for `needs_revision` (intermediate), what's missing; for `failed`, why unrecoverable. examples: - All five sections present with inline citations. + nullable: true + type: string example: type: outcome_evaluation outcome_id: outc_011CZkZRSw2kEfs6ncTVljxP @@ -4177,20 +4912,73 @@ components: description: Tokens used to create 5-minute ephemeral cache entries. type: integer format: int32 - BetaManagedAgentsSessionStats: - description: Timing statistics for a session. - type: object - properties: - duration_seconds: - description: Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. - type: number - format: double - active_seconds: - description: Cumulative time in seconds the session spent in running status. Excludes idle time. - type: number - format: double - BetaInvalidRequestError: - properties: + list_cost: + description: Cumulative list cost of the session across all turns, priced at public list rates. Absent until cost tracking is available for the session. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" + server_tool_use: + description: Cumulative server-executed tool usage across all turns. Absent until server-tool tracking is available for the session. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: object + properties: + web_search_requests: + description: Number of server-executed web search requests. + type: integer + format: int32 + examples: + - 3 + web_fetch_requests: + description: Number of server-executed web fetch requests. + type: integer + format: int32 + examples: + - 0 + example: + web_search_requests: 3 + web_fetch_requests: 0 + active_seconds: + description: Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once, unlike `stats.active_seconds`, which sums each thread's own active time. This is the duration the session's runtime cost is priced on. + type: number + format: double + x-anthropic-beta-required: + - managed-agents-2026-04-01 + BetaManagedAgentsSessionStats: + description: Timing statistics for a session. + type: object + properties: + duration_seconds: + description: Elapsed time since session creation in seconds. For terminated sessions, frozen at the final update. + type: number + format: double + active_seconds: + description: Cumulative time in seconds the session spent in `running` status. Excludes idle time. + type: number + format: double + BetaInvalidRequestError: + properties: message: default: Invalid request title: Message @@ -4396,6 +5184,7 @@ components: session.thread_status_rescheduled: "#/components/schemas/BetaManagedAgentsSessionThreadStatusRescheduledEvent" session.updated: "#/components/schemas/BetaManagedAgentsSessionUpdatedEvent" system.message: "#/components/schemas/BetaManagedAgentsSystemMessageEvent" + session.usage: "#/components/schemas/BetaManagedAgentsSessionUsageEvent" required: - type - id @@ -4447,15 +5236,17 @@ components: text: "Where is my order #1234?" processed_at: description: Timestamp when the agent finished processing this message. - nullable: true examples: - "2026-03-15T10:00:00Z" + nullable: true type: string format: date-time session_thread_id: description: If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true + type: string tool_use_id: description: The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. type: string @@ -4467,16 +5258,16 @@ components: - deny deny_message: description: Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. + nullable: true type: string maxLength: 10000 - nullable: true custom_tool_use_id: description: The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. type: string is_error: description: Whether the tool execution resulted in an error. - type: boolean nullable: true + type: boolean name: description: Name of the custom tool being called. type: string @@ -4493,23 +5284,67 @@ components: - allow - ask - deny + evaluation: + description: "Which resolved permission_policy produced evaluated_permission: always_allow, always_ask, or auto (with the server's per-invocation judgement). Absent only when the server refused the call before any policy applied (for example, the named tool is not enabled in the session); such a refusal has evaluated_permission deny. An event recorded before this field existed reads as the arm its evaluated_permission implies (always_allow for allow, always_ask for ask)." + x-anthropic-beta-required: + - managed-agents-2026-04-01 + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAgentToolEvaluationAlwaysAllow" + always_ask: "#/components/schemas/BetaManagedAgentsAgentToolEvaluationAlwaysAsk" + auto: "#/components/schemas/BetaManagedAgentsAgentToolEvaluationAuto" + type: object + required: + - type + - evaluated_permission + properties: + type: + type: string + enum: + - always_allow + evaluated_permission: + description: The server's judgement for this invocation. + discriminator: + propertyName: type + mapping: + allow: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionAllow" + ask: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionAsk" + deny: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionDeny" + type: object + required: + - type + - reason_code + properties: + type: + type: string + enum: + - allow + reason_code: + description: The judgement's grounds in registry-bound terms, for client branching and audit rather than end-user display. Open registry; currently "indeterminate" (no judgement was reached). Clients must tolerate values outside this set. + type: string + maxLength: 64 mcp_tool_use_id: description: The id of the `agent.mcp_tool_use` event this result corresponds to. type: string from_agent_name: description: Name of the callable agent this message came from. Absent when received from the primary agent. - type: string nullable: true + type: string from_session_thread_id: description: Public `sthr_` ID of the thread that sent the message. type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 to_agent_name: description: Name of the callable agent this message was sent to. Absent when sent to the primary agent. - type: string nullable: true + type: string to_session_thread_id: description: Public `sthr_` ID of the thread the message was sent to. type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 error: type: object discriminator: @@ -4572,6 +5407,7 @@ components: end_turn: "#/components/schemas/BetaManagedAgentsSessionEndTurn" requires_action: "#/components/schemas/BetaManagedAgentsSessionRequiresAction" retries_exhausted: "#/components/schemas/BetaManagedAgentsSessionRetriesExhausted" + budget_reached: "#/components/schemas/BetaManagedAgentsSessionBudgetReached" description: The agent completed its turn naturally and is ready for the next user message. required: - type @@ -4644,6 +5480,9 @@ components: format: int32 speed: description: Inference speed tier this request actually ran at. Mirrors `usage.speed` on /v1/messages. Only present when the fast-mode beta is active. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + - fast-mode-2026-02-01 nullable: true type: string enum: @@ -4676,6 +5515,9 @@ components: format: int32 speed: description: Inference speed tier this request actually ran at. Mirrors `usage.speed` on /v1/messages. Only present when the fast-mode beta is active. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + - fast-mode-2026-02-01 nullable: true type: string enum: @@ -4691,11 +5533,11 @@ components: - Produce a 2-page summary as summary.md max_iterations: description: Evaluate-then-revise cycles before giving up. Default 3, max 20. - type: integer - format: int32 - nullable: true examples: - 3 + nullable: true + type: integer + format: int32 rubric: description: How to grade the outcome. File rubrics are currently resolved to their text content; clients should handle both variants. examples: @@ -4724,8 +5566,8 @@ components: type: string title: description: The session's new title. Present only when the update changed it. - type: string nullable: true + type: string metadata: description: The session's full metadata bag after the update. Present when the update set non-empty metadata; absent when metadata was unchanged or cleared to empty. type: object @@ -4766,20 +5608,20 @@ components: examples: - My First Agent description: - type: string - nullable: true examples: - A general-purpose starter agent. + nullable: true + type: string model: $ref: "#/components/schemas/BetaManagedAgentsModelConfig" examples: - - id: claude-sonnet-4-6 + - id: claude-opus-5 speed: standard system: - type: string - nullable: true examples: - You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end. + nullable: true + type: string tools: type: array items: @@ -4812,9 +5654,11 @@ components: version: "2" multiagent: description: Resolved multiagent orchestration configuration. Null when the agent is single-threaded. - nullable: true + x-anthropic-beta-required: + - managed-agents-2026-04-01 examples: - null + nullable: true discriminator: propertyName: type mapping: @@ -4832,7 +5676,7 @@ components: description: Full `agent` definitions the coordinator may spawn as session threads. type: array items: - $ref: "#/components/schemas/BetaManagedAgentsSessionThreadAgent" + $ref: "#/components/schemas/BetaManagedAgentsSessionRosterEntry" example: type: agent id: agent_011CZkYpogX7uDKUyvBTophP @@ -4840,7 +5684,7 @@ components: name: My First Agent description: A general-purpose starter agent. model: - id: claude-sonnet-4-6 + id: claude-opus-5 speed: standard system: You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end. tools: @@ -4862,6 +5706,46 @@ components: skill_id: skill_011CZkZFNu9hAbo3jZPRgTlx version: "2" multiagent: null + budget: + description: "The session's budget after the update: the new budget when set or replaced, or null when the update removed it. Present only when the update changed the budget." + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: object + discriminator: + propertyName: type + mapping: + limit: "#/components/schemas/BetaManagedAgentsBudgetLimit" + required: + - type + - max_list_cost + properties: + type: + type: string + enum: + - limit + max_list_cost: + description: Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" example: type: user.message id: sevt_011CZkZGOp0iBcp4kaQSihUmy @@ -4926,8 +5810,10 @@ components: text: "Where is my order #1234?" session_thread_id: description: If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true + type: string tool_use_id: description: The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. type: string @@ -4941,9 +5827,9 @@ components: - deny deny_message: description: Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. + nullable: true type: string maxLength: 10000 - nullable: true custom_tool_use_id: description: The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. type: string @@ -4951,8 +5837,8 @@ components: maxLength: 128 is_error: description: Whether the tool execution resulted in an error. - type: boolean nullable: true + type: boolean description: description: What the agent should produce. This is the task specification. type: string @@ -4997,11 +5883,11 @@ components: content: Must cover all five sections; cite sources inline. max_iterations: description: Eval→revision cycles before giving up. Default 3, max 20. - type: integer - format: int32 - nullable: true examples: - 3 + nullable: true + type: integer + format: int32 example: type: user.message content: @@ -5059,15 +5945,17 @@ components: text: "Where is my order #1234?" processed_at: description: Timestamp when the agent finished processing this message. - nullable: true examples: - "2026-03-15T10:00:00Z" + nullable: true type: string format: date-time session_thread_id: description: If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true + type: string tool_use_id: description: The id of the `agent.tool_use` or `agent.mcp_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. type: string @@ -5079,16 +5967,16 @@ components: - deny deny_message: description: Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. + nullable: true type: string maxLength: 10000 - nullable: true custom_tool_use_id: description: The id of the `agent.custom_tool_use` event this result corresponds to, which can be found in the last `session.status_idle` [event's](https://platform.claude.com/docs/en/api/beta/sessions/events/list#beta_managed_agents_session_requires_action.event_ids) `stop_reason.event_ids` field. type: string is_error: description: Whether the tool execution resulted in an error. - type: boolean nullable: true + type: boolean outcome_id: description: Server-generated `outc_` ID for this outcome. Referenced by `span.outcome_evaluation_*` events and the session's `outcome_evaluations` list. type: string @@ -5101,11 +5989,11 @@ components: - Produce a 2-page summary as summary.md max_iterations: description: Evaluate-then-revise cycles before giving up. Default 3, max 20. - type: integer - format: int32 - nullable: true examples: - 3 + nullable: true + type: integer + format: int32 rubric: description: How to grade the outcome. File rubrics are currently resolved to their text content; clients should handle both variants. examples: @@ -5153,8 +6041,13 @@ components: - idle - rescheduling - terminated - BetaManagedAgentsSessionThreadAgent: - description: 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`. + BetaManagedAgentsSessionThreadAgentEntry: + description: "The resolved agent a session thread runs: a saved-agent snapshot, the platform advisor entry, or an inline-defined (ephemeral) agent snapshot." + discriminator: + propertyName: type + mapping: + agent: "#/components/schemas/BetaManagedAgentsSessionThreadAgent" + advisor: "#/components/schemas/BetaManagedAgentsAdvisor" type: object required: - type @@ -5188,20 +6081,20 @@ components: examples: - Researcher description: - type: string - nullable: true examples: - A focused research subagent. + nullable: true + type: string model: $ref: "#/components/schemas/BetaManagedAgentsModelConfig" examples: - - id: claude-sonnet-4-6 + - id: claude-opus-5 speed: standard system: - type: string - nullable: true examples: - You are a research subagent that gathers and summarises sources for the coordinating agent. + nullable: true + type: string tools: type: array items: @@ -5232,7 +6125,7 @@ components: name: Researcher description: A focused research subagent. model: - id: claude-sonnet-4-6 + id: claude-opus-5 speed: standard system: You are a research subagent that gathers and summarises sources for the coordinating agent. tools: @@ -5272,6 +6165,59 @@ components: description: Tokens used to create 5-minute ephemeral cache entries. type: integer format: int32 + list_cost: + description: Cumulative list cost of this thread across all turns, priced at public list rates. Absent until cost tracking is available for the thread. Each figure is rounded to the nearest cent independently and the session's aggregate `usage.list_cost` additionally includes session runtime, so per-thread costs do not sum exactly to the session figure; the session figure is authoritative and is what a budget is enforced against. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" + active_seconds: + description: Cumulative time in seconds this thread spent in running status. Equal to `stats.active_seconds`; surfaced here so a thread's usage carries every quantity its cost is priced on. + type: number + format: double + x-anthropic-beta-required: + - managed-agents-2026-04-01 + server_tool_use: + description: Cumulative server-executed tool usage across all turns of this thread. Absent until server-tool tracking is available for the thread. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: object + properties: + web_search_requests: + description: Number of server-executed web search requests. + type: integer + format: int32 + examples: + - 3 + web_fetch_requests: + description: Number of server-executed web fetch requests. + type: integer + format: int32 + examples: + - 0 + example: + web_search_requests: 3 + web_fetch_requests: 0 BetaManagedAgentsSessionThreadStats: description: Timing statistics for a session thread. type: object @@ -5310,12 +6256,12 @@ components: - file_011CNha8iCJcU1wXNR6q4V8w mount_path: description: Mount path in the container. Defaults to `/mnt/session/uploads/`. + examples: + - /uploads/receipt.pdf + nullable: true type: string minLength: 1 maxLength: 4096 - nullable: true - examples: - - /uploads/receipt.pdf example: type: file file_id: file_011CNha8iCJcU1wXNR6q4V8w @@ -5392,11 +6338,42 @@ components: examples: - /workspace/example-repo checkout: - $ref: "#/components/schemas/BetaManagedAgentsRepositoryCheckout" - nullable: true examples: - type: branch name: main + nullable: true + type: object + discriminator: + propertyName: type + mapping: + branch: "#/components/schemas/BetaManagedAgentsBranchCheckout" + commit: "#/components/schemas/BetaManagedAgentsCommitCheckout" + required: + - type + - name + - sha + properties: + type: + type: string + enum: + - branch + examples: + - branch + name: + description: Branch name to check out. + type: string + minLength: 1 + maxLength: 255 + examples: + - main + sha: + description: Full commit SHA to check out. + type: string + minLength: 7 + maxLength: 64 + example: + type: branch + name: main created_at: $ref: "#/components/schemas/BetaTimestamp" examples: @@ -5430,7 +6407,7 @@ components: description: The memory store ID (memstore_...). Must belong to the caller's organization and workspace. type: string access: - description: Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem. + description: Access mode for the mounted store. Defaults to `read_write`. `read_only` mounts the store as a read-only filesystem. nullable: true type: string enum: @@ -5438,20 +6415,32 @@ components: - read_only name: description: Display name of the memory store, snapshotted at attach time. Later edits to the store's name do not propagate to this resource. - type: string + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 nullable: true + type: string description: description: Description of the memory store, snapshotted at attach time. Rendered into the agent's system prompt. Empty string when the store has no description. type: string + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 instructions: description: Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 + nullable: true type: string maxLength: 4096 - nullable: true mount_path: description: Filesystem path where the store is mounted in the session container, e.g. /mnt/memory/user-preferences. Derived from the store's name. Output-only. - type: string + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 nullable: true + type: string BetaManagedAgentsAgentParams: description: Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version type: object @@ -5493,7 +6482,7 @@ components: type: integer format: int32 model: - description: Replacement model. Accepts the model string, e.g. `claude-opus-4-6`, or a `model_config` object. Omit to use the agent's model. + description: Replacement model. Accepts the model string, e.g. `claude-opus-5`, or a `model_config` object. Omit to use the agent's model. title: BetaManagedAgentsModel x-stainless-skip: - go @@ -5501,7 +6490,7 @@ components: type: string x-stainless-nominal: false enum: - - claude-sonnet-5 + - claude-fable-5-1 required: - id properties: @@ -5514,13 +6503,46 @@ components: enum: - standard - fast + effort: + description: 'How hard Claude works on each inference call. Accepts a bare level string (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged.' + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: string + enum: + - low + - medium + - high + - xhigh + - max + discriminator: + propertyName: type + mapping: + low: "#/components/schemas/BetaManagedAgentsEffortLow" + medium: "#/components/schemas/BetaManagedAgentsEffortMedium" + high: "#/components/schemas/BetaManagedAgentsEffortHigh" + xhigh: "#/components/schemas/BetaManagedAgentsEffortXhigh" + max: "#/components/schemas/BetaManagedAgentsEffortMax" + required: + - type + properties: + type: + type: string + enum: + - low + inference_geo: + description: Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: string example: - id: claude-opus-4-6 + id: claude-opus-5 system: description: Replacement system prompt. Up to 100,000 characters. Set to null to clear the agent's system prompt; omit to preserve it. + nullable: true type: string maxLength: 100000 - nullable: true tools: description: "Replacement tool list. Full replacement: the provided array becomes the tool configuration. Send an empty array to clear; omit to preserve the agent's tools." type: array @@ -5542,7 +6564,6 @@ components: required: - type - url - - authorization_token properties: type: type: string @@ -5558,18 +6579,19 @@ components: examples: - https://github.com/example-org/example-repo authorization_token: - description: GitHub authorization token used to clone the repository. + description: GitHub authorization token used to clone the repository. Required for private repositories; optional for public ones. type: string minLength: 1 maxLength: 4096 examples: - ghp_exampletoken + x-stainless-go-json: omitzero mount_path: description: Mount path in the container. Defaults to `/workspace/`. + nullable: true type: string minLength: 1 maxLength: 4096 - nullable: true checkout: description: Branch or commit to check out. Defaults to the repository's default branch. nullable: true @@ -5632,31 +6654,191 @@ components: - read_only instructions: description: Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. + x-anthropic-beta-required: + - agent-memory-2026-07-22 + - managed-agents-2026-04-01 + nullable: true type: string maxLength: 4096 - nullable: true - BetaManagedAgentsModelConfig: - description: Model identifier and configuration. + BetaManagedAgentsUserMessageEventParams: + description: Parameters for sending a user message to the session. type: object required: - - id + - type + - content properties: - id: - $ref: "#/components/schemas/BetaManagedAgentsModel" - speed: - description: Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - examples: - - standard + type: type: string enum: - - standard - - fast - example: - id: claude-opus-4-6 - speed: standard - BetaManagedAgentsAgentTool: - description: Union type for tool configurations returned in API responses. - type: object + - user.message + examples: + - user.message + content: + description: Array of content blocks for the user message. + type: array + items: + $ref: "#/components/schemas/BetaManagedAgentsUserContentBlock" + examples: + - - type: text + text: "Where is my order #1234?" + example: + type: user.message + content: + - type: text + text: "Where is my order #1234?" + BetaManagedAgentsUserDefineOutcomeEventParams: + description: Parameters for defining an outcome the agent should work toward. The agent begins work on receipt. + type: object + required: + - type + - description + - rubric + properties: + type: + type: string + enum: + - user.define_outcome + examples: + - user.define_outcome + description: + description: What the agent should produce. This is the task specification. + type: string + examples: + - Produce a 2-page summary as summary.md + rubric: + description: How to grade the outcome. Text or file reference. + examples: + - type: text + content: Must cover all five sections; cite sources inline. + discriminator: + propertyName: type + mapping: + file: "#/components/schemas/BetaManagedAgentsFileRubricParams" + text: "#/components/schemas/BetaManagedAgentsTextRubricParams" + type: object + required: + - type + - file_id + - content + properties: + type: + type: string + enum: + - file + examples: + - file + file_id: + description: ID of the rubric file. + type: string + examples: + - file_011CNha8iCJcU1wXNR6q4V8w + content: + description: Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. + type: string + maxLength: 262144 + examples: + - Must cover all five sections; cite sources inline. + example: + type: file + file_id: file_011CNha8iCJcU1wXNR6q4V8w + content: Must cover all five sections; cite sources inline. + max_iterations: + description: Eval→revision cycles before giving up. Default 3, max 20. + examples: + - 3 + nullable: true + type: integer + format: int32 + example: + type: user.define_outcome + description: Produce a 2-page summary as summary.md + rubric: + type: text + content: Must cover all five sections; cite sources inline. + max_iterations: 3 + BetaManagedAgentsBudgetLimit: + description: A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`. + type: object + required: + - type + - max_list_cost + properties: + type: + type: string + enum: + - limit + max_list_cost: + description: Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" + BetaManagedAgentsModelConfig: + description: Model identifier and configuration. + type: object + required: + - id + properties: + id: + $ref: "#/components/schemas/BetaManagedAgentsModel" + speed: + description: Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + - fast-mode-2026-02-01 + examples: + - standard + type: string + enum: + - standard + - fast + effort: + description: How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + type: object + discriminator: + propertyName: type + mapping: + low: "#/components/schemas/BetaManagedAgentsEffortLow" + medium: "#/components/schemas/BetaManagedAgentsEffortMedium" + high: "#/components/schemas/BetaManagedAgentsEffortHigh" + xhigh: "#/components/schemas/BetaManagedAgentsEffortXhigh" + max: "#/components/schemas/BetaManagedAgentsEffortMax" + required: + - type + properties: + type: + type: string + enum: + - low + inference_geo: + description: Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. + type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 + example: + id: claude-opus-5 + speed: standard + BetaManagedAgentsAgentTool: + description: Union type for tool configurations returned in API responses. + type: object discriminator: propertyName: type mapping: @@ -5681,7 +6863,7 @@ components: configs: type: array items: - $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfig" + $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfigUnion" mcp_server_name: type: string name: @@ -5770,7 +6952,7 @@ components: description: Full `agent` definitions the coordinator may spawn as session threads. type: array items: - $ref: "#/components/schemas/BetaManagedAgentsSessionThreadAgent" + $ref: "#/components/schemas/BetaManagedAgentsSessionRosterEntry" BetaManagedAgentsCacheCreationUsage: description: Prompt-cache creation token usage broken down by cache lifetime. type: object @@ -5783,6 +6965,47 @@ components: description: Tokens used to create 5-minute ephemeral cache entries. type: integer format: int32 + BetaMonetaryAmount: + description: A monetary amount in a specific currency. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" + BetaManagedAgentsServerToolUsage: + description: Cumulative count of server-executed tool invocations, broken down by tool. + type: object + properties: + web_search_requests: + description: Number of server-executed web search requests. + type: integer + format: int32 + examples: + - 3 + web_fetch_requests: + description: Number of server-executed web fetch requests. + type: integer + format: int32 + examples: + - 0 + example: + web_search_requests: 3 + web_fetch_requests: 0 BetaManagedAgentsAgentToolParams: description: Union type for tool configurations in the tools array. type: object @@ -5810,8 +7033,8 @@ components: properties: enabled: description: Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - type: boolean nullable: true + type: boolean permission_policy: description: Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation. nullable: true @@ -5821,6 +7044,7 @@ components: mapping: always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" required: - type properties: @@ -5832,7 +7056,7 @@ components: description: Per-tool configuration overrides. type: array items: - $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfigParams" + $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfigUnionParams" mcp_server_name: description: Name of the MCP server. Must match a server name from the mcp_servers array. 1-255 characters. type: string @@ -5844,10 +7068,9 @@ components: minLength: 1 maxLength: 128 description: - description: Description of what the tool does, shown to the agent to help it decide when to use the tool. 1-1024 characters. + description: Description of what the tool does, shown to the agent to help it decide when to use the tool. type: string minLength: 1 - maxLength: 1024 input_schema: description: JSON Schema defining the expected input parameters for the tool. properties: @@ -5935,9 +7158,9 @@ components: text: "Where is my order #1234?" processed_at: description: Timestamp when the agent finished processing this message. - nullable: true examples: - "2026-03-15T10:00:00Z" + nullable: true type: string format: date-time example: @@ -5968,8 +7191,10 @@ components: format: date-time session_thread_id: description: If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true + type: string BetaManagedAgentsUserToolConfirmationEvent: description: A tool confirmation event that approves or denies a pending tool execution. type: object @@ -5997,9 +7222,9 @@ components: - deny deny_message: description: Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. + nullable: true type: string maxLength: 10000 - nullable: true processed_at: description: Timestamp when the confirmation was processed. nullable: true @@ -6007,8 +7232,10 @@ components: format: date-time session_thread_id: description: When set, the confirmation routes to this subagent's thread rather than the primary. Echo this from the `session_thread_id` on the `agent.tool_use` or `agent.mcp_tool_use` event that prompted the approval. - type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true + type: string BetaManagedAgentsUserCustomToolResultEvent: description: Event sent by the client providing the result of a custom tool execution. type: object @@ -6034,8 +7261,8 @@ components: $ref: "#/components/schemas/BetaManagedAgentsToolResultContentBlock" is_error: description: Whether the tool execution resulted in an error. - type: boolean nullable: true + type: boolean processed_at: description: Timestamp when this result was processed. nullable: true @@ -6043,8 +7270,10 @@ components: format: date-time session_thread_id: description: Routes this result to a subagent thread. Copy from the `agent.custom_tool_use` event's `session_thread_id`. - type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true + type: string BetaManagedAgentsAgentCustomToolUseEvent: description: Event emitted when the agent calls a custom tool. The session goes idle until the client sends a `user.custom_tool_result` event with the result. type: object @@ -6074,8 +7303,10 @@ components: format: date-time session_thread_id: description: When set, this event was cross-posted from a subagent's thread to surface its custom tool use on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.custom_tool_result` event to route the result back. - type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true + type: string BetaManagedAgentsAgentMessageEvent: description: An agent response event in the session conversation. type: object @@ -6100,7 +7331,7 @@ components: description: Array of text blocks comprising the agent response. type: array items: - $ref: "#/components/schemas/BetaManagedAgentsTextBlock" + $ref: "#/components/schemas/BetaManagedAgentsAgentMessageContentBlock" examples: - - type: text text: "Let me look up order #1234 for you." @@ -6176,8 +7407,50 @@ components: - deny session_thread_id: description: When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true + type: string + evaluation: + description: "Which resolved permission_policy produced evaluated_permission: always_allow, always_ask, or auto (with the server's per-invocation judgement). Absent only when the server refused the call before any policy applied (for example, the named tool is not enabled in the session); such a refusal has evaluated_permission deny. An event recorded before this field existed reads as the arm its evaluated_permission implies (always_allow for allow, always_ask for ask)." + x-anthropic-beta-required: + - managed-agents-2026-04-01 + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAgentToolEvaluationAlwaysAllow" + always_ask: "#/components/schemas/BetaManagedAgentsAgentToolEvaluationAlwaysAsk" + auto: "#/components/schemas/BetaManagedAgentsAgentToolEvaluationAuto" + type: object + required: + - type + - evaluated_permission + properties: + type: + type: string + enum: + - always_allow + evaluated_permission: + description: The server's judgement for this invocation. + discriminator: + propertyName: type + mapping: + allow: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionAllow" + ask: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionAsk" + deny: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionDeny" + type: object + required: + - type + - reason_code + properties: + type: + type: string + enum: + - allow + reason_code: + description: The judgement's grounds in registry-bound terms, for client branching and audit rather than end-user display. Open registry; currently "indeterminate" (no judgement was reached). Clients must tolerate values outside this set. + type: string + maxLength: 64 BetaManagedAgentsAgentMcpToolResultEvent: description: Event representing the result of an MCP tool execution. type: object @@ -6204,8 +7477,8 @@ components: $ref: "#/components/schemas/BetaManagedAgentsToolResultContentBlock" is_error: description: Whether the tool execution resulted in an error. - type: boolean nullable: true + type: boolean processed_at: description: Timestamp when this event was processed. type: string @@ -6246,8 +7519,50 @@ components: - deny session_thread_id: description: When set, this event was cross-posted from a subagent's thread to surface its permission request on the primary thread's stream. Empty on the thread's own events. Echo this on a `user.tool_confirmation` event to route the approval back. - type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true + type: string + evaluation: + description: "Which resolved permission_policy produced evaluated_permission: always_allow, always_ask, or auto (with the server's per-invocation judgement). Absent only when the server refused the call before any policy applied (for example, the named tool is not enabled in the session); such a refusal has evaluated_permission deny. An event recorded before this field existed reads as the arm its evaluated_permission implies (always_allow for allow, always_ask for ask)." + x-anthropic-beta-required: + - managed-agents-2026-04-01 + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAgentToolEvaluationAlwaysAllow" + always_ask: "#/components/schemas/BetaManagedAgentsAgentToolEvaluationAlwaysAsk" + auto: "#/components/schemas/BetaManagedAgentsAgentToolEvaluationAuto" + type: object + required: + - type + - evaluated_permission + properties: + type: + type: string + enum: + - always_allow + evaluated_permission: + description: The server's judgement for this invocation. + discriminator: + propertyName: type + mapping: + allow: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionAllow" + ask: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionAsk" + deny: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionDeny" + type: object + required: + - type + - reason_code + properties: + type: + type: string + enum: + - allow + reason_code: + description: The judgement's grounds in registry-bound terms, for client branching and audit rather than end-user display. Open registry; currently "indeterminate" (no judgement was reached). Clients must tolerate values outside this set. + type: string + maxLength: 64 BetaManagedAgentsAgentToolResultEvent: description: Event representing the result of an agent tool execution. type: object @@ -6274,8 +7589,8 @@ components: $ref: "#/components/schemas/BetaManagedAgentsToolResultContentBlock" is_error: description: Whether the tool execution resulted in an error. - type: boolean nullable: true + type: boolean processed_at: description: Timestamp when this event was processed. type: string @@ -6303,8 +7618,8 @@ components: format: date-time from_agent_name: description: Name of the callable agent this message came from. Absent when received from the primary agent. - type: string nullable: true + type: string content: description: Message content blocks. type: array @@ -6313,6 +7628,8 @@ components: from_session_thread_id: description: Public `sthr_` ID of the thread that sent the message. type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 BetaManagedAgentsAgentThreadMessageSentEvent: description: Observability event emitted to the sender's output stream when an agent-to-agent message is sent. type: object @@ -6336,8 +7653,8 @@ components: format: date-time to_agent_name: description: Name of the callable agent this message was sent to. Absent when sent to the primary agent. - type: string nullable: true + type: string content: description: Message content blocks. type: array @@ -6346,6 +7663,8 @@ components: to_session_thread_id: description: Public `sthr_` ID of the thread the message was sent to. type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 BetaManagedAgentsAgentThreadContextCompactedEvent: description: Indicates that context compaction (summarization) occurred during the session. type: object @@ -6505,6 +7824,7 @@ components: end_turn: "#/components/schemas/BetaManagedAgentsSessionEndTurn" requires_action: "#/components/schemas/BetaManagedAgentsSessionRequiresAction" retries_exhausted: "#/components/schemas/BetaManagedAgentsSessionRetriesExhausted" + budget_reached: "#/components/schemas/BetaManagedAgentsSessionBudgetReached" description: The agent completed its turn naturally and is ready for the next user message. required: - type @@ -6573,6 +7893,8 @@ components: session_thread_id: description: Public `sthr_` ID of the newly created thread. type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 examples: - sthr_011CZkZVWa6oIjw0rgXZpnBt example: @@ -6709,6 +8031,9 @@ components: format: int32 speed: description: Inference speed tier this request actually ran at. Mirrors `usage.speed` on /v1/messages. Only present when the fast-mode beta is active. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + - fast-mode-2026-02-01 nullable: true type: string enum: @@ -6776,8 +8101,8 @@ components: format: date-time is_error: description: Whether the model request resulted in an error. - type: boolean nullable: true + type: boolean model_usage: description: Token usage for this model request. type: object @@ -6805,6 +8130,9 @@ components: format: int32 speed: description: Inference speed tier this request actually ran at. Mirrors `usage.speed` on /v1/messages. Only present when the fast-mode beta is active. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + - fast-mode-2026-02-01 nullable: true type: string enum: @@ -6898,11 +8226,11 @@ components: - Produce a 2-page summary as summary.md max_iterations: description: Evaluate-then-revise cycles before giving up. Default 3, max 20. - type: integer - format: int32 - nullable: true examples: - 3 + nullable: true + type: integer + format: int32 rubric: description: How to grade the outcome. File rubrics are currently resolved to their text content; clients should handle both variants. examples: @@ -7031,6 +8359,7 @@ components: end_turn: "#/components/schemas/BetaManagedAgentsSessionEndTurn" requires_action: "#/components/schemas/BetaManagedAgentsSessionRequiresAction" retries_exhausted: "#/components/schemas/BetaManagedAgentsSessionRetriesExhausted" + budget_reached: "#/components/schemas/BetaManagedAgentsSessionBudgetReached" examples: - type: end_turn description: The agent completed its turn naturally and is ready for the next user message. @@ -7107,8 +8436,8 @@ components: $ref: "#/components/schemas/BetaManagedAgentsToolResultContentBlock" is_error: description: Whether the tool execution resulted in an error. - type: boolean nullable: true + type: boolean processed_at: description: Timestamp when this result was processed. nullable: true @@ -7116,8 +8445,10 @@ components: format: date-time session_thread_id: description: Routes this result to a subagent thread. Copy from the `agent.tool_use` event's `session_thread_id`. - type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true + type: string BetaManagedAgentsSessionThreadStatusRescheduledEvent: description: A session thread hit a transient error and is retrying automatically. Emitted on the thread's own stream and cross-posted to the primary stream for child threads. type: object @@ -7166,8 +8497,8 @@ components: format: date-time title: description: The session's new title. Present only when the update changed it. - type: string nullable: true + type: string metadata: description: The session's full metadata bag after the update. Present when the update set non-empty metadata; absent when metadata was unchanged or cleared to empty. type: object @@ -7208,20 +8539,20 @@ components: examples: - My First Agent description: - type: string - nullable: true examples: - A general-purpose starter agent. + nullable: true + type: string model: $ref: "#/components/schemas/BetaManagedAgentsModelConfig" examples: - - id: claude-sonnet-4-6 + - id: claude-opus-5 speed: standard system: - type: string - nullable: true examples: - You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end. + nullable: true + type: string tools: type: array items: @@ -7254,9 +8585,11 @@ components: version: "2" multiagent: description: Resolved multiagent orchestration configuration. Null when the agent is single-threaded. - nullable: true + x-anthropic-beta-required: + - managed-agents-2026-04-01 examples: - null + nullable: true discriminator: propertyName: type mapping: @@ -7274,7 +8607,7 @@ components: description: Full `agent` definitions the coordinator may spawn as session threads. type: array items: - $ref: "#/components/schemas/BetaManagedAgentsSessionThreadAgent" + $ref: "#/components/schemas/BetaManagedAgentsSessionRosterEntry" example: type: agent id: agent_011CZkYpogX7uDKUyvBTophP @@ -7282,7 +8615,7 @@ components: name: My First Agent description: A general-purpose starter agent. model: - id: claude-sonnet-4-6 + id: claude-opus-5 speed: standard system: You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end. tools: @@ -7304,12 +8637,52 @@ components: skill_id: skill_011CZkZFNu9hAbo3jZPRgTlx version: "2" multiagent: null - BetaManagedAgentsSystemMessageEvent: - description: 'A mid-conversation system message event. Carries system-role content that is appended to the session as a `role: "system"` turn.' - type: object - required: - - type - - id + budget: + description: "The session's budget after the update: the new budget when set or replaced, or null when the update removed it. Present only when the update changed the budget." + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: object + discriminator: + propertyName: type + mapping: + limit: "#/components/schemas/BetaManagedAgentsBudgetLimit" + required: + - type + - max_list_cost + properties: + type: + type: string + enum: + - limit + max_list_cost: + description: Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" + BetaManagedAgentsSystemMessageEvent: + description: 'A mid-conversation system message event. Carries system-role content that is appended to the session as a `role: "system"` turn.' + type: object + required: + - type + - id - content properties: type: @@ -7329,32 +8702,137 @@ components: nullable: true type: string format: date-time - BetaManagedAgentsUserMessageEventParams: - description: Parameters for sending a user message to the session. + BetaManagedAgentsSessionUsageEvent: + description: Periodic snapshot of the session's cumulative usage and tracked list cost. type: object required: - type - - content + - id + - processed_at + - usage properties: type: type: string enum: - - user.message - examples: - - user.message - content: - description: Array of content blocks for the user message. - type: array - items: - $ref: "#/components/schemas/BetaManagedAgentsUserContentBlock" - examples: - - - type: text - text: "Where is my order #1234?" - example: - type: user.message - content: - - type: text - text: "Where is my order #1234?" + - session.usage + id: + description: Unique identifier for this event. + type: string + processed_at: + description: Timestamp when the snapshot was taken. + type: string + format: date-time + usage: + description: The session's cumulative usage at the snapshot time. + type: object + properties: + input_tokens: + description: Total input tokens consumed across all turns. + type: integer + format: int32 + output_tokens: + description: Total output tokens generated across all turns. + type: integer + format: int32 + cache_read_input_tokens: + description: Total tokens read from prompt cache. + type: integer + format: int32 + cache_creation: + description: Tokens used to create prompt cache entries, broken down by cache TTL. + type: object + properties: + ephemeral_1h_input_tokens: + description: Tokens used to create 1-hour ephemeral cache entries. + type: integer + format: int32 + ephemeral_5m_input_tokens: + description: Tokens used to create 5-minute ephemeral cache entries. + type: integer + format: int32 + list_cost: + description: Cumulative list cost of the session across all turns, priced at public list rates. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" + server_tool_use: + description: Cumulative server-executed tool usage across all turns. + type: object + properties: + web_search_requests: + description: Number of server-executed web search requests. + type: integer + format: int32 + examples: + - 3 + web_fetch_requests: + description: Number of server-executed web fetch requests. + type: integer + format: int32 + examples: + - 0 + example: + web_search_requests: 3 + web_fetch_requests: 0 + active_seconds: + description: Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once. This is the duration the session's runtime cost is priced on. + type: number + format: double + budget: + description: The session's configured budget at the snapshot time, or null when the session has no budget. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + limit: "#/components/schemas/BetaManagedAgentsBudgetLimit" + required: + - type + - max_list_cost + properties: + type: + type: string + enum: + - limit + max_list_cost: + description: Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" BetaManagedAgentsUserInterruptEventParams: description: Parameters for sending an interrupt to pause the agent. type: object @@ -7367,8 +8845,10 @@ components: - user.interrupt session_thread_id: description: If absent, interrupts every non-archived thread in a multiagent session (or the primary alone in a single-agent session). If present, interrupts only the named thread. - type: string + x-anthropic-beta-required: + - managed-agents-2026-04-01 nullable: true + type: string BetaManagedAgentsUserToolConfirmationEventParams: description: Parameters for confirming or denying a tool execution request. type: object @@ -7394,9 +8874,9 @@ components: - deny deny_message: description: Optional message providing context for a 'deny' decision. Only allowed when result is 'deny'. + nullable: true type: string maxLength: 10000 - nullable: true BetaManagedAgentsUserCustomToolResultEventParams: description: Parameters for providing the result of a custom tool execution. type: object @@ -7420,78 +8900,8 @@ components: $ref: "#/components/schemas/BetaManagedAgentsToolResultContentBlock" is_error: description: Whether the tool execution resulted in an error. - type: boolean - nullable: true - BetaManagedAgentsUserDefineOutcomeEventParams: - description: Parameters for defining an outcome the agent should work toward. The agent begins work on receipt. - type: object - required: - - type - - description - - rubric - properties: - type: - type: string - enum: - - user.define_outcome - examples: - - user.define_outcome - description: - description: What the agent should produce. This is the task specification. - type: string - examples: - - Produce a 2-page summary as summary.md - rubric: - description: How to grade the outcome. Text or file reference. - examples: - - type: text - content: Must cover all five sections; cite sources inline. - discriminator: - propertyName: type - mapping: - file: "#/components/schemas/BetaManagedAgentsFileRubricParams" - text: "#/components/schemas/BetaManagedAgentsTextRubricParams" - type: object - required: - - type - - file_id - - content - properties: - type: - type: string - enum: - - file - examples: - - file - file_id: - description: ID of the rubric file. - type: string - examples: - - file_011CNha8iCJcU1wXNR6q4V8w - content: - description: Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. - type: string - maxLength: 262144 - examples: - - Must cover all five sections; cite sources inline. - example: - type: file - file_id: file_011CNha8iCJcU1wXNR6q4V8w - content: Must cover all five sections; cite sources inline. - max_iterations: - description: Eval→revision cycles before giving up. Default 3, max 20. - type: integer - format: int32 nullable: true - examples: - - 3 - example: - type: user.define_outcome - description: Produce a 2-page summary as summary.md - rubric: - type: text - content: Must cover all five sections; cite sources inline. - max_iterations: 3 + type: boolean BetaManagedAgentsUserToolResultEventParams: description: Parameters for providing the result of an agent-toolset tool execution. Only valid on `self_hosted` environments, where sandbox-routed tools are executed by the client rather than the server. type: object @@ -7515,8 +8925,8 @@ components: $ref: "#/components/schemas/BetaManagedAgentsToolResultContentBlock" is_error: description: Whether the tool execution resulted in an error. - type: boolean nullable: true + type: boolean BetaManagedAgentsSystemMessageEventParams: description: "Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a `role: \"system\"` turn rather than replacing the top-level system prompt. At most one per request: it must be the final event and immediately follow the `user.message`, `user.tool_result`, or `user.custom_tool_result` it accompanies. Only supported on models that accept mid-conversation system messages." type: object @@ -7533,62 +8943,167 @@ components: type: array items: $ref: "#/components/schemas/BetaManagedAgentsSystemContentBlock" - BetaManagedAgentsRepositoryCheckout: + BetaManagedAgentsSessionThreadAgent: + description: Resolved `agent` definition for a single `session_thread`. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from `Session.agent`. type: object - discriminator: - propertyName: type - mapping: - branch: "#/components/schemas/BetaManagedAgentsBranchCheckout" - commit: "#/components/schemas/BetaManagedAgentsCommitCheckout" required: - type + - id + - version - name - - sha + - description + - model + - system + - tools + - mcp_servers + - skills properties: type: type: string enum: - - branch + - agent examples: - - branch + - agent + id: + type: string + examples: + - agent_011CZkYqphY8vELVzwCUpqiQ + version: + type: integer + format: int32 + examples: + - 1 name: - description: Branch name to check out. type: string - minLength: 1 - maxLength: 255 examples: - - main - sha: - description: Full commit SHA to check out. + - Researcher + description: + examples: + - A focused research subagent. + nullable: true type: string - minLength: 7 - maxLength: 64 - example: - type: branch - name: main - BetaManagedAgentsMountMode: - type: string - description: Access mode for an attached memory store. - enum: - - read_write - - read_only - BetaManagedAgentsModelParams: - title: BetaManagedAgentsModel - x-stainless-skip: - - go - - cli - description: |- - The model that will power your agent. - - See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - type: string - x-stainless-nominal: false - enum: - - claude-sonnet-5 - required: - - id - properties: - id: + model: + $ref: "#/components/schemas/BetaManagedAgentsModelConfig" + examples: + - id: claude-opus-5 + speed: standard + system: + examples: + - You are a research subagent that gathers and summarises sources for the coordinating agent. + nullable: true + type: string + tools: + type: array + items: + $ref: "#/components/schemas/BetaManagedAgentsAgentTool" + examples: + - - type: agent_toolset_20260401 + default_config: + enabled: true + permission_policy: + type: always_ask + configs: [] + mcp_servers: + type: array + items: + $ref: "#/components/schemas/BetaManagedAgentsMCPServer" + examples: + - [] + skills: + type: array + items: + $ref: "#/components/schemas/BetaManagedAgentsSkill" + examples: + - [] + example: + type: agent + id: agent_011CZkYqphY8vELVzwCUpqiQ + version: 1 + name: Researcher + description: A focused research subagent. + model: + id: claude-opus-5 + speed: standard + system: You are a research subagent that gathers and summarises sources for the coordinating agent. + tools: + - type: agent_toolset_20260401 + default_config: + enabled: true + permission_policy: + type: always_ask + configs: [] + mcp_servers: [] + skills: [] + BetaManagedAgentsAdvisor: + description: "Platform advisor roster entry: a model the session's primary thread may consult mid-turn." + type: object + required: + - type + - model + properties: + type: + type: string + enum: + - advisor + model: + description: The advisor model id. + type: string + BetaManagedAgentsRepositoryCheckout: + type: object + discriminator: + propertyName: type + mapping: + branch: "#/components/schemas/BetaManagedAgentsBranchCheckout" + commit: "#/components/schemas/BetaManagedAgentsCommitCheckout" + required: + - type + - name + - sha + properties: + type: + type: string + enum: + - branch + examples: + - branch + name: + description: Branch name to check out. + type: string + minLength: 1 + maxLength: 255 + examples: + - main + sha: + description: Full commit SHA to check out. + type: string + minLength: 7 + maxLength: 64 + example: + type: branch + name: main + BetaManagedAgentsMountMode: + type: string + description: Access mode for an attached memory store. + enum: + - read_write + - read_only + BetaManagedAgentsModelParams: + title: BetaManagedAgentsModel + x-stainless-skip: + - go + - cli + description: |- + The model that will power your agent. + + See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. + type: string + x-stainless-nominal: false + enum: + - claude-fable-5-1 + required: + - id + properties: + id: $ref: "#/components/schemas/BetaManagedAgentsModel" speed: description: Inference speed mode. Defaults to `standard`. @@ -7597,8 +9112,41 @@ components: enum: - standard - fast + effort: + description: 'How hard Claude works on each inference call. Accepts a bare level string (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged.' + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: string + enum: + - low + - medium + - high + - xhigh + - max + discriminator: + propertyName: type + mapping: + low: "#/components/schemas/BetaManagedAgentsEffortLow" + medium: "#/components/schemas/BetaManagedAgentsEffortMedium" + high: "#/components/schemas/BetaManagedAgentsEffortHigh" + xhigh: "#/components/schemas/BetaManagedAgentsEffortXhigh" + max: "#/components/schemas/BetaManagedAgentsEffortMax" + required: + - type + properties: + type: + type: string + enum: + - low + inference_geo: + description: Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: string example: - id: claude-opus-4-6 + id: claude-opus-5 BetaManagedAgentsSkillParams: description: Skill to load in the session container. discriminator: @@ -7626,16 +9174,124 @@ components: - xlsx version: description: Version to pin. Defaults to latest if omitted. + examples: + - "1" + nullable: true type: string minLength: 1 maxLength: 64 - nullable: true - examples: - - "1" example: type: anthropic skill_id: xlsx version: "1" + BetaManagedAgentsUserContentBlock: + description: Content block in a user message. Can be `text`, `image`, or `document`. + type: object + discriminator: + propertyName: type + mapping: + text: "#/components/schemas/BetaManagedAgentsTextBlock" + image: "#/components/schemas/BetaManagedAgentsImageBlock" + document: "#/components/schemas/BetaManagedAgentsDocumentBlock" + redacted: "#/components/schemas/BetaManagedAgentsRedactedBlock" + required: + - type + - text + - source + properties: + type: + type: string + enum: + - text + examples: + - text + text: + description: The text content. + type: string + minLength: 1 + examples: + - "Where is my order #1234?" + source: + description: The source of the image data. + type: object + discriminator: + propertyName: type + mapping: + base64: "#/components/schemas/BetaManagedAgentsBase64ImageSource" + url: "#/components/schemas/BetaManagedAgentsURLImageSource" + file: "#/components/schemas/BetaManagedAgentsFileImageSource" + required: + - type + - media_type + - data + - url + - file_id + properties: + type: + type: string + enum: + - base64 + media_type: + description: MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + type: string + minLength: 1 + data: + description: Base64-encoded image data. + type: string + minLength: 1 + url: + description: URL of the image to fetch. + type: string + minLength: 1 + file_id: + description: ID of a previously uploaded file. + type: string + minLength: 1 + title: + description: The title of the document. + nullable: true + type: string + context: + description: Additional context about the document for the model. + nullable: true + type: string + example: + type: text + text: "Where is my order #1234?" + BetaManagedAgentsRubricParams: + description: Rubric for grading the quality of an outcome. + discriminator: + propertyName: type + mapping: + file: "#/components/schemas/BetaManagedAgentsFileRubricParams" + text: "#/components/schemas/BetaManagedAgentsTextRubricParams" + type: object + required: + - type + - file_id + - content + properties: + type: + type: string + enum: + - file + examples: + - file + file_id: + description: ID of the rubric file. + type: string + examples: + - file_011CNha8iCJcU1wXNR6q4V8w + content: + description: Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. + type: string + maxLength: 262144 + examples: + - Must cover all five sections; cite sources inline. + example: + type: file + file_id: file_011CNha8iCJcU1wXNR6q4V8w + content: Must cover all five sections; cite sources inline. BetaManagedAgentsModel: title: BetaManagedAgentsModel description: |- @@ -7645,13 +9301,31 @@ components: type: string x-stainless-nominal: false enum: - - claude-sonnet-5 + - claude-fable-5-1 BetaManagedAgentsSpeed: type: string description: 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. enum: - standard - fast + BetaManagedAgentsEffort: + description: How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes. + type: object + discriminator: + propertyName: type + mapping: + low: "#/components/schemas/BetaManagedAgentsEffortLow" + medium: "#/components/schemas/BetaManagedAgentsEffortMedium" + high: "#/components/schemas/BetaManagedAgentsEffortHigh" + xhigh: "#/components/schemas/BetaManagedAgentsEffortXhigh" + max: "#/components/schemas/BetaManagedAgentsEffortMax" + required: + - type + properties: + type: + type: string + enum: + - low BetaManagedAgentsAgentToolset20260401: type: object required: @@ -7668,7 +9342,7 @@ components: configs: type: array items: - $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfig" + $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfigUnion" BetaManagedAgentsMCPToolset: type: object required: @@ -7801,7 +9475,11 @@ components: description: Full `agent` definitions the coordinator may spawn as session threads. type: array items: - $ref: "#/components/schemas/BetaManagedAgentsSessionThreadAgent" + $ref: "#/components/schemas/BetaManagedAgentsSessionRosterEntry" + BetaCurrency: + type: string + enum: + - USD BetaManagedAgentsAgentToolset20260401Params: description: Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent. type: object @@ -7819,8 +9497,8 @@ components: properties: enabled: description: Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - type: boolean nullable: true + type: boolean permission_policy: description: Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation. nullable: true @@ -7830,6 +9508,7 @@ components: mapping: always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" required: - type properties: @@ -7841,7 +9520,7 @@ components: description: Per-tool configuration overrides. type: array items: - $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfigParams" + $ref: "#/components/schemas/BetaManagedAgentsAgentToolConfigUnionParams" BetaManagedAgentsMCPToolsetParams: description: Configuration for tools from an MCP server defined in `mcp_servers`. type: object @@ -7865,8 +9544,8 @@ components: properties: enabled: description: Whether tools are enabled by default. Defaults to true if not specified. - type: boolean nullable: true + type: boolean permission_policy: description: Default permission policy for tools from this server. nullable: true @@ -7876,6 +9555,7 @@ components: mapping: always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" required: - type properties: @@ -7907,10 +9587,9 @@ components: minLength: 1 maxLength: 128 description: - description: Description of what the tool does, shown to the agent to help it decide when to use the tool. 1-1024 characters. + description: Description of what the tool does, shown to the agent to help it decide when to use the tool. type: string minLength: 1 - maxLength: 1024 input_schema: description: JSON Schema defining the expected input parameters for the tool. properties: @@ -7965,79 +9644,6 @@ components: type: url name: example-mcp url: https://example-server.modelcontextprotocol.io/sse - BetaManagedAgentsUserContentBlock: - description: Content block in a user message. Can be `text`, `image`, or `document`. - type: object - discriminator: - propertyName: type - mapping: - text: "#/components/schemas/BetaManagedAgentsTextBlock" - image: "#/components/schemas/BetaManagedAgentsImageBlock" - document: "#/components/schemas/BetaManagedAgentsDocumentBlock" - required: - - type - - text - - source - properties: - type: - type: string - enum: - - text - examples: - - text - text: - description: The text content. - type: string - minLength: 1 - examples: - - "Where is my order #1234?" - source: - description: The source of the image data. - type: object - discriminator: - propertyName: type - mapping: - base64: "#/components/schemas/BetaManagedAgentsBase64ImageSource" - url: "#/components/schemas/BetaManagedAgentsURLImageSource" - file: "#/components/schemas/BetaManagedAgentsFileImageSource" - required: - - type - - media_type - - data - - url - - file_id - properties: - type: - type: string - enum: - - base64 - media_type: - description: MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - type: string - minLength: 1 - data: - description: Base64-encoded image data. - type: string - minLength: 1 - url: - description: URL of the image to fetch. - type: string - minLength: 1 - file_id: - description: ID of a previously uploaded file. - type: string - minLength: 1 - title: - description: The title of the document. - type: string - nullable: true - context: - description: Additional context about the document for the model. - type: string - nullable: true - example: - type: text - text: "Where is my order #1234?" BetaManagedAgentsUserToolConfirmationResult: type: string description: UserToolConfirmationResult enum @@ -8112,12 +9718,12 @@ components: minLength: 1 title: description: The title of the document. - type: string nullable: true + type: string context: description: Additional context about the document for the model. - type: string nullable: true + type: string content: description: Array of text content blocks from the search result. type: array @@ -8137,9 +9743,14 @@ components: text: "Where is my order #1234?" BetaManagedAgentsStruct: type: object - BetaManagedAgentsTextBlock: - description: Regular text content. + BetaManagedAgentsAgentMessageContentBlock: + description: Content block in an agent message. type: object + discriminator: + propertyName: type + mapping: + text: "#/components/schemas/BetaManagedAgentsTextBlock" + redacted: "#/components/schemas/BetaManagedAgentsRedactedBlock" required: - type - text @@ -8166,6 +9777,44 @@ components: - allow - ask - deny + BetaManagedAgentsAgentToolEvaluation: + description: "Names the resolved permission_policy that produced evaluated_permission, and under auto carries the judgement. Open union: clients must tolerate unknown variants." + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAgentToolEvaluationAlwaysAllow" + always_ask: "#/components/schemas/BetaManagedAgentsAgentToolEvaluationAlwaysAsk" + auto: "#/components/schemas/BetaManagedAgentsAgentToolEvaluationAuto" + type: object + required: + - type + - evaluated_permission + properties: + type: + type: string + enum: + - always_allow + evaluated_permission: + description: The server's judgement for this invocation. + discriminator: + propertyName: type + mapping: + allow: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionAllow" + ask: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionAsk" + deny: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionDeny" + type: object + required: + - type + - reason_code + properties: + type: + type: string + enum: + - allow + reason_code: + description: The judgement's grounds in registry-bound terms, for client branching and audit rather than end-user display. Open registry; currently "indeterminate" (no judgement was reached). Clients must tolerate values outside this set. + type: string + maxLength: 64 BetaManagedAgentsUnknownError: description: An unknown or unexpected error occurred during session execution. A fallback variant; clients that don't recognize a new error code can match on `retry_status` and `message` alone. type: object @@ -8457,7 +10106,7 @@ components: items: type: string BetaManagedAgentsSessionRetriesExhausted: - description: "The turn ended because the retry budget was exhausted (`max_iterations` hit or an error escalated to `retry_status: 'exhausted'`)." + description: "The turn ended because repeated errors exhausted the retry budget or an error escalated to `retry_status: 'exhausted'`." type: object required: - type @@ -8466,6 +10115,16 @@ components: type: string enum: - retries_exhausted + BetaManagedAgentsSessionBudgetReached: + description: The agent stopped because the session's tracked list cost reached its budget, or because its usage includes a model with no list price (which the budget cannot measure). Raise the budget to continue — or, if raising is rejected because a model has no list price, remove the budget. + type: object + required: + - type + properties: + type: + type: string + enum: + - budget_reached BetaManagedAgentsSpanModelUsage: description: Token usage for a single model request. type: object @@ -8493,6 +10152,9 @@ components: format: int32 speed: description: Inference speed tier this request actually ran at. Mirrors `usage.speed` on /v1/messages. Only present when the fast-mode beta is active. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + - fast-mode-2026-02-01 nullable: true type: string enum: @@ -8547,40 +10209,79 @@ components: example: type: text text: "Where is my order #1234?" - BetaManagedAgentsRubricParams: - description: Rubric for grading the quality of an outcome. - discriminator: - propertyName: type - mapping: - file: "#/components/schemas/BetaManagedAgentsFileRubricParams" - text: "#/components/schemas/BetaManagedAgentsTextRubricParams" + BetaManagedAgentsSessionUsageSnapshot: + description: Point-in-time snapshot of a session's cumulative usage. type: object - required: - - type - - file_id - - content properties: - type: - type: string - enum: - - file - examples: - - file - file_id: - description: ID of the rubric file. - type: string - examples: - - file_011CNha8iCJcU1wXNR6q4V8w - content: - description: Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. - type: string - maxLength: 262144 - examples: - - Must cover all five sections; cite sources inline. - example: - type: file - file_id: file_011CNha8iCJcU1wXNR6q4V8w - content: Must cover all five sections; cite sources inline. + input_tokens: + description: Total input tokens consumed across all turns. + type: integer + format: int32 + output_tokens: + description: Total output tokens generated across all turns. + type: integer + format: int32 + cache_read_input_tokens: + description: Total tokens read from prompt cache. + type: integer + format: int32 + cache_creation: + description: Tokens used to create prompt cache entries, broken down by cache TTL. + type: object + properties: + ephemeral_1h_input_tokens: + description: Tokens used to create 1-hour ephemeral cache entries. + type: integer + format: int32 + ephemeral_5m_input_tokens: + description: Tokens used to create 5-minute ephemeral cache entries. + type: integer + format: int32 + list_cost: + description: Cumulative list cost of the session across all turns, priced at public list rates. + type: object + required: + - currency + - amount + properties: + currency: + description: 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. + examples: + - USD + type: string + enum: + - USD + amount: + description: '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.' + type: string + examples: + - "2500" + example: + currency: USD + amount: "2500" + server_tool_use: + description: Cumulative server-executed tool usage across all turns. + type: object + properties: + web_search_requests: + description: Number of server-executed web search requests. + type: integer + format: int32 + examples: + - 3 + web_fetch_requests: + description: Number of server-executed web fetch requests. + type: integer + format: int32 + examples: + - 0 + example: + web_search_requests: 3 + web_fetch_requests: 0 + active_seconds: + description: Cumulative time in seconds during which the session had at least one thread in running status. Overlapping activity from concurrent threads is counted once. This is the duration the session's runtime cost is priced on. + type: number + format: double BetaManagedAgentsBranchCheckout: type: object required: @@ -8633,8 +10334,41 @@ components: enum: - standard - fast + effort: + description: 'How hard Claude works on each inference call. Accepts a bare level string (`"high"`) or `{"type": "high"}`. On create, omitting it resolves the per-model default; on update, omitting it leaves the stored value unchanged.' + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: string + enum: + - low + - medium + - high + - xhigh + - max + discriminator: + propertyName: type + mapping: + low: "#/components/schemas/BetaManagedAgentsEffortLow" + medium: "#/components/schemas/BetaManagedAgentsEffortMedium" + high: "#/components/schemas/BetaManagedAgentsEffortHigh" + xhigh: "#/components/schemas/BetaManagedAgentsEffortXhigh" + max: "#/components/schemas/BetaManagedAgentsEffortMax" + required: + - type + properties: + type: + type: string + enum: + - low + inference_geo: + description: Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. On update, `model` is whole-object replacement — omitting inference_geo clears it. + x-anthropic-beta-required: + - managed-agents-2026-04-01 + nullable: true + type: string example: - id: claude-opus-4-6 + id: claude-opus-5 BetaManagedAgentsAnthropicSkillParams: description: An Anthropic-managed skill. type: object @@ -8657,12 +10391,12 @@ components: - xlsx version: description: Version to pin. Defaults to latest if omitted. + examples: + - "1" + nullable: true type: string minLength: 1 maxLength: 64 - nullable: true - examples: - - "1" example: type: anthropic skill_id: xlsx @@ -8689,202 +10423,44 @@ components: - skill_011CZkZFNu9hAbo3jZPRgTlx version: description: Version to pin. Defaults to latest if omitted. + examples: + - "2" + nullable: true type: string minLength: 1 maxLength: 64 - nullable: true - examples: - - "2" example: type: custom skill_id: skill_011CZkZFNu9hAbo3jZPRgTlx version: "2" - BetaManagedAgentsAgentToolsetDefaultConfig: - description: Resolved default configuration for agent tools. + BetaManagedAgentsTextBlock: + description: Regular text content. type: object required: - - enabled - - permission_policy + - type + - text properties: - enabled: - type: boolean - permission_policy: - $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" - BetaManagedAgentsAgentToolConfig: - description: Configuration for a specific agent tool. + type: + type: string + enum: + - text + examples: + - text + text: + description: The text content. + type: string + minLength: 1 + examples: + - "Where is my order #1234?" + example: + type: text + text: "Where is my order #1234?" + BetaManagedAgentsImageBlock: + description: Image content specified directly as base64 data or as a reference via a URL. type: object required: - - name - - enabled - - permission_policy - properties: - name: - $ref: "#/components/schemas/BetaManagedAgentsAgentToolName" - enabled: - type: boolean - permission_policy: - $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" - BetaManagedAgentsMCPToolsetDefaultConfig: - description: Resolved default configuration for all tools from an MCP server. - type: object - required: - - enabled - - permission_policy - properties: - enabled: - type: boolean - permission_policy: - $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" - BetaManagedAgentsMCPToolConfig: - description: Resolved configuration for a specific MCP tool. - type: object - required: - - name - - enabled - - permission_policy - properties: - name: - type: string - enabled: - type: boolean - permission_policy: - $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" - BetaManagedAgentsCustomToolInputSchema: - description: JSON Schema for custom tool input parameters. - properties: - properties: - title: Properties - x-stainless-skip: - - terraform - nullable: true - type: object - required: - title: Required - nullable: true - items: - type: string - type: array - type: - title: Type - type: string - enum: - - object - required: - - type - type: object - BetaManagedAgentsAgentToolsetDefaultConfigParams: - description: Default configuration for all tools in a toolset. - type: object - properties: - enabled: - description: Whether tools are enabled and available to Claude by default. Defaults to true if not specified. - type: boolean - nullable: true - permission_policy: - description: Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation. - nullable: true - type: object - discriminator: - propertyName: type - mapping: - always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" - always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" - required: - - type - properties: - type: - type: string - enum: - - always_allow - BetaManagedAgentsAgentToolConfigParams: - description: Configuration override for a specific tool within a toolset. - type: object - required: - - name - properties: - name: - $ref: "#/components/schemas/BetaManagedAgentsAgentToolName" - enabled: - description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. - type: boolean - nullable: true - permission_policy: - description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. - nullable: true - type: object - discriminator: - propertyName: type - mapping: - always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" - always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" - required: - - type - properties: - type: - type: string - enum: - - always_allow - BetaManagedAgentsMCPToolsetDefaultConfigParams: - description: Default configuration for all tools from an MCP server. - type: object - properties: - enabled: - description: Whether tools are enabled by default. Defaults to true if not specified. - type: boolean - nullable: true - permission_policy: - description: Default permission policy for tools from this server. - nullable: true - type: object - discriminator: - propertyName: type - mapping: - always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" - always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" - required: - - type - properties: - type: - type: string - enum: - - always_allow - BetaManagedAgentsMCPToolConfigParams: - description: Configuration override for a specific MCP tool. - type: object - required: - - name - properties: - name: - description: Name of the MCP tool to configure. 1-128 characters. - type: string - minLength: 1 - maxLength: 128 - enabled: - description: Whether this tool is enabled. Overrides the `default_config` setting. - type: boolean - nullable: true - permission_policy: - description: Permission policy for this tool. Overrides the `default_config` setting. - nullable: true - type: object - discriminator: - propertyName: type - mapping: - always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" - always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" - required: - - type - properties: - type: - type: string - enum: - - always_allow - BetaManagedAgentsImageBlock: - description: Image content specified directly as base64 data or as a reference via a URL. - type: object - required: - - type - - source + - type + - source properties: type: type: string @@ -8976,92 +10552,22 @@ components: minLength: 1 title: description: The title of the document. - type: string nullable: true + type: string context: description: Additional context about the document for the model. - type: string nullable: true - BetaManagedAgentsSearchResultBlock: - description: A block containing a web search result. - type: object - required: - - type - - source - - title - - content - - citations - properties: - type: - type: string - enum: - - search_result - source: - description: The URL source of the search result. - type: string - minLength: 1 - title: - description: The title of the search result. - type: string - minLength: 1 - content: - description: Array of text content blocks from the search result. - type: array - items: - $ref: "#/components/schemas/BetaManagedAgentsSearchResultContent" - citations: - description: Citation settings for this search result. - type: object - required: - - enabled - properties: - enabled: - description: Whether citations are enabled for this search result. - type: boolean - BetaManagedAgentsRetryStatus: - description: What the client should do next in response to this error. - type: object - discriminator: - propertyName: type - mapping: - retrying: "#/components/schemas/BetaManagedAgentsRetryStatusRetrying" - exhausted: "#/components/schemas/BetaManagedAgentsRetryStatusExhausted" - terminal: "#/components/schemas/BetaManagedAgentsRetryStatusTerminal" - required: - - type - properties: - type: - type: string - enum: - - retrying - BetaManagedAgentsFileRubric: - description: Rubric referenced by a file uploaded via the Files API. - type: object - required: - - type - - file_id - properties: - type: - type: string - enum: - - file - file_id: - description: ID of the rubric file. type: string - BetaManagedAgentsTextRubric: - description: Rubric content provided inline as text. + BetaManagedAgentsRedactedBlock: + description: Placeholder for content withheld by Anthropic model policy. type: object required: - type - - content properties: type: type: string enum: - - text - content: - description: Rubric content. Plain text or markdown — the grader treats it as freeform text. - type: string + - redacted BetaManagedAgentsFileRubricParams: description: Rubric referenced by a file uploaded via the Files API. type: object @@ -9105,106 +10611,1281 @@ components: example: type: text content: Must cover all five sections; cite sources inline. - BetaManagedAgentsPermissionPolicy: - description: Permission policy for tool execution. + BetaManagedAgentsEffortLow: + description: Low effort. Favors latency over reasoning depth. type: object - discriminator: - propertyName: type - mapping: - always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" - always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" required: - type properties: type: type: string enum: - - always_allow - BetaManagedAgentsAgentToolName: - type: string - description: Built-in agent tool identifier. - enum: - - bash - - edit - - read - - write - - glob - - grep - - web_fetch - - web_search - BetaManagedAgentsImageSource: - description: Union type for image source variants. + - low + BetaManagedAgentsEffortMedium: + description: Medium effort. Balances latency and reasoning depth. + type: object + required: + - type + properties: + type: + type: string + enum: + - medium + BetaManagedAgentsEffortHigh: + description: High effort. Favors reasoning depth. + type: object + required: + - type + properties: + type: + type: string + enum: + - high + BetaManagedAgentsEffortXhigh: + description: Extra-high effort. Not all models accept this level. + type: object + required: + - type + properties: + type: + type: string + enum: + - xhigh + BetaManagedAgentsEffortMax: + description: Maximum effort. Favors reasoning depth over latency. + type: object + required: + - type + properties: + type: + type: string + enum: + - max + BetaManagedAgentsAgentToolsetDefaultConfig: + description: Resolved default configuration for agent tools. + type: object + required: + - enabled + - permission_policy + properties: + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsAgentToolConfigUnion: + description: Configuration for a specific agent tool. + type: object + discriminator: + propertyName: type + mapping: + bash: "#/components/schemas/BetaManagedAgentsBashToolConfig" + edit: "#/components/schemas/BetaManagedAgentsEditToolConfig" + read: "#/components/schemas/BetaManagedAgentsReadToolConfig" + write: "#/components/schemas/BetaManagedAgentsWriteToolConfig" + glob: "#/components/schemas/BetaManagedAgentsGlobToolConfig" + grep: "#/components/schemas/BetaManagedAgentsGrepToolConfig" + web_fetch: "#/components/schemas/BetaManagedAgentsWebFetchToolConfig" + web_search: "#/components/schemas/BetaManagedAgentsWebSearchToolConfig" + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - bash + name: + type: string + enum: + - bash + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + allowed_domains: + type: array + items: + type: string + blocked_domains: + type: array + items: + type: string + max_content_tokens: + nullable: true + type: integer + format: int32 + user_location: + nullable: true + description: Approximate user location for search result localization. + type: object + required: + - type + properties: + type: + description: Location precision. Only "approximate" is supported. + type: string + enum: + - approximate + city: + description: City name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + region: + description: Region or state name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + country: + description: Two-letter ISO 3166-1 country code, uppercase. + nullable: true + type: string + timezone: + description: IANA timezone identifier, e.g. "America/Los_Angeles". + nullable: true + type: string + minLength: 1 + maxLength: 255 + BetaManagedAgentsMCPToolsetDefaultConfig: + description: Resolved default configuration for all tools from an MCP server. + type: object + required: + - enabled + - permission_policy + properties: + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsMCPToolConfig: + description: Resolved configuration for a specific MCP tool. + type: object + required: + - name + - enabled + - permission_policy + properties: + name: + type: string + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsCustomToolInputSchema: + description: JSON Schema for custom tool input parameters. + properties: + properties: + title: Properties + x-stainless-skip: + - terraform + nullable: true + type: object + required: + title: Required + nullable: true + items: + type: string + type: array + type: + title: Type + type: string + enum: + - object + required: + - type + type: object + BetaManagedAgentsSessionRosterEntry: + description: A session-resolved multiagent roster entry. + discriminator: + propertyName: type + mapping: + agent: "#/components/schemas/BetaManagedAgentsSessionThreadAgent" + advisor: "#/components/schemas/BetaManagedAgentsAdvisor" + type: object + required: + - type + - id + - version + - name + - description + - model + - system + - tools + - mcp_servers + - skills + properties: + type: + type: string + enum: + - agent + examples: + - agent + id: + type: string + examples: + - agent_011CZkYqphY8vELVzwCUpqiQ + version: + type: integer + format: int32 + examples: + - 1 + name: + type: string + examples: + - Researcher + description: + examples: + - A focused research subagent. + nullable: true + type: string + model: + $ref: "#/components/schemas/BetaManagedAgentsModelConfig" + examples: + - id: claude-opus-5 + speed: standard + system: + examples: + - You are a research subagent that gathers and summarises sources for the coordinating agent. + nullable: true + type: string + tools: + type: array + items: + $ref: "#/components/schemas/BetaManagedAgentsAgentTool" + examples: + - - type: agent_toolset_20260401 + default_config: + enabled: true + permission_policy: + type: always_ask + configs: [] + mcp_servers: + type: array + items: + $ref: "#/components/schemas/BetaManagedAgentsMCPServer" + examples: + - [] + skills: + type: array + items: + $ref: "#/components/schemas/BetaManagedAgentsSkill" + examples: + - [] + example: + type: agent + id: agent_011CZkYqphY8vELVzwCUpqiQ + version: 1 + name: Researcher + description: A focused research subagent. + model: + id: claude-opus-5 + speed: standard + system: You are a research subagent that gathers and summarises sources for the coordinating agent. + tools: + - type: agent_toolset_20260401 + default_config: + enabled: true + permission_policy: + type: always_ask + configs: [] + mcp_servers: [] + skills: [] + BetaManagedAgentsAgentToolsetDefaultConfigParams: + description: Default configuration for all tools in a toolset. + type: object + properties: + enabled: + description: Whether tools are enabled and available to Claude by default. Defaults to true if not specified. + nullable: true + type: boolean + permission_policy: + description: Default permission policy for tools. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsAgentToolConfigUnionParams: + description: Configuration override for a specific tool within a toolset. + type: object + discriminator: + propertyName: type + mapping: + bash: "#/components/schemas/BetaManagedAgentsBashToolConfigParams" + edit: "#/components/schemas/BetaManagedAgentsEditToolConfigParams" + read: "#/components/schemas/BetaManagedAgentsReadToolConfigParams" + write: "#/components/schemas/BetaManagedAgentsWriteToolConfigParams" + glob: "#/components/schemas/BetaManagedAgentsGlobToolConfigParams" + grep: "#/components/schemas/BetaManagedAgentsGrepToolConfigParams" + web_fetch: "#/components/schemas/BetaManagedAgentsWebFetchToolConfigParams" + web_search: "#/components/schemas/BetaManagedAgentsWebSearchToolConfigParams" + required: + - name + properties: + type: + type: string + enum: + - bash + name: + description: Must be "bash". + type: string + enum: + - bash + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + allowed_domains: + description: 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. + type: array + items: + type: string + blocked_domains: + description: 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. + type: array + items: + type: string + max_content_tokens: + description: Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. + nullable: true + type: integer + format: int32 + user_location: + description: Approximate user location for search result localization. + nullable: true + type: object + required: + - type + properties: + type: + description: Location precision. Only "approximate" is supported. + type: string + enum: + - approximate + city: + description: City name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + region: + description: Region or state name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + country: + description: Two-letter ISO 3166-1 country code, uppercase. + nullable: true + type: string + timezone: + description: IANA timezone identifier, e.g. "America/Los_Angeles". + nullable: true + type: string + minLength: 1 + maxLength: 255 + BetaManagedAgentsMCPToolsetDefaultConfigParams: + description: Default configuration for all tools from an MCP server. + type: object + properties: + enabled: + description: Whether tools are enabled by default. Defaults to true if not specified. + nullable: true + type: boolean + permission_policy: + description: Default permission policy for tools from this server. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsMCPToolConfigParams: + description: Configuration override for a specific MCP tool. + type: object + required: + - name + properties: + name: + description: Name of the MCP tool to configure. 1-128 characters. + type: string + minLength: 1 + maxLength: 128 + enabled: + description: Whether this tool is enabled. Overrides the `default_config` setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Overrides the `default_config` setting. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsSearchResultBlock: + description: A block containing a web search result. + type: object + required: + - type + - source + - title + - content + - citations + properties: + type: + type: string + enum: + - search_result + source: + description: The URL source of the search result. + type: string + minLength: 1 + title: + description: The title of the search result. + type: string + minLength: 1 + content: + description: Array of text content blocks from the search result. + type: array + items: + $ref: "#/components/schemas/BetaManagedAgentsSearchResultContent" + citations: + description: Citation settings for this search result. + type: object + required: + - enabled + properties: + enabled: + description: Whether citations are enabled for this search result. + type: boolean + BetaManagedAgentsAgentToolEvaluationAlwaysAllow: + description: The resolved permission_policy was always_allow; accompanies evaluated_permission "allow". + type: object + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsAgentToolEvaluationAlwaysAsk: + description: The resolved permission_policy was always_ask; accompanies evaluated_permission "ask". + type: object + required: + - type + properties: + type: + type: string + enum: + - always_ask + BetaManagedAgentsAgentToolEvaluationAuto: + description: "The resolved permission_policy was auto: the server judged this invocation individually." + type: object + required: + - type + - evaluated_permission + properties: + type: + type: string + enum: + - auto + evaluated_permission: + description: The server's judgement for this invocation. + discriminator: + propertyName: type + mapping: + allow: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionAllow" + ask: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionAsk" + deny: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionDeny" + type: object + required: + - type + - reason_code + properties: + type: + type: string + enum: + - allow + reason_code: + description: The judgement's grounds in registry-bound terms, for client branching and audit rather than end-user display. Open registry; currently "indeterminate" (no judgement was reached). Clients must tolerate values outside this set. + type: string + maxLength: 64 + BetaManagedAgentsRetryStatus: + description: What the client should do next in response to this error. + type: object + discriminator: + propertyName: type + mapping: + retrying: "#/components/schemas/BetaManagedAgentsRetryStatusRetrying" + exhausted: "#/components/schemas/BetaManagedAgentsRetryStatusExhausted" + terminal: "#/components/schemas/BetaManagedAgentsRetryStatusTerminal" + required: + - type + properties: + type: + type: string + enum: + - retrying + BetaManagedAgentsFileRubric: + description: Rubric referenced by a file uploaded via the Files API. + type: object + required: + - type + - file_id + properties: + type: + type: string + enum: + - file + file_id: + description: ID of the rubric file. + type: string + BetaManagedAgentsTextRubric: + description: Rubric content provided inline as text. + type: object + required: + - type + - content + properties: + type: + type: string + enum: + - text + content: + description: Rubric content. Plain text or markdown — the grader treats it as freeform text. + type: string + BetaManagedAgentsEffortParams: + type: string + description: How hard Claude works on each turn. Higher levels favor reasoning depth over latency. Not all models accept every level; invalid combinations are rejected at create time. + enum: + - low + - medium + - high + - xhigh + - max + discriminator: + propertyName: type + mapping: + low: "#/components/schemas/BetaManagedAgentsEffortLow" + medium: "#/components/schemas/BetaManagedAgentsEffortMedium" + high: "#/components/schemas/BetaManagedAgentsEffortHigh" + xhigh: "#/components/schemas/BetaManagedAgentsEffortXhigh" + max: "#/components/schemas/BetaManagedAgentsEffortMax" + required: + - type + properties: + type: + type: string + enum: + - low + BetaManagedAgentsImageSource: + description: Union type for image source variants. + type: object + discriminator: + propertyName: type + mapping: + base64: "#/components/schemas/BetaManagedAgentsBase64ImageSource" + url: "#/components/schemas/BetaManagedAgentsURLImageSource" + file: "#/components/schemas/BetaManagedAgentsFileImageSource" + required: + - type + - media_type + - data + - url + - file_id + properties: + type: + type: string + enum: + - base64 + media_type: + description: MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + type: string + minLength: 1 + data: + description: Base64-encoded image data. + type: string + minLength: 1 + url: + description: URL of the image to fetch. + type: string + minLength: 1 + file_id: + description: ID of a previously uploaded file. + type: string + minLength: 1 + BetaManagedAgentsDocumentSource: + description: Union type for document source variants. + type: object + discriminator: + propertyName: type + mapping: + base64: "#/components/schemas/BetaManagedAgentsBase64DocumentSource" + text: "#/components/schemas/BetaManagedAgentsPlainTextDocumentSource" + url: "#/components/schemas/BetaManagedAgentsURLDocumentSource" + file: "#/components/schemas/BetaManagedAgentsFileDocumentSource" + required: + - type + - media_type + - data + - url + - file_id + properties: + type: + type: string + enum: + - base64 + media_type: + description: MIME type of the document (e.g., "application/pdf"). + type: string + minLength: 1 + data: + description: Base64-encoded document data. + type: string + minLength: 1 + url: + description: URL of the document to fetch. + type: string + minLength: 1 + file_id: + description: ID of a previously uploaded file. + type: string + minLength: 1 + BetaManagedAgentsPermissionPolicy: + description: Permission policy for tool execution. + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsBashToolConfig: + description: Configuration for the bash tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - bash + name: + type: string + enum: + - bash + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsEditToolConfig: + description: Configuration for the edit tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - edit + name: + type: string + enum: + - edit + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsReadToolConfig: + description: Configuration for the read tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - read + name: + type: string + enum: + - read + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsWriteToolConfig: + description: Configuration for the write tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - write + name: + type: string + enum: + - write + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsGlobToolConfig: + description: Configuration for the glob tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - glob + name: + type: string + enum: + - glob + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsGrepToolConfig: + description: Configuration for the grep tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - grep + name: + type: string + enum: + - grep + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + BetaManagedAgentsWebFetchToolConfig: + description: Configuration for the web_fetch tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - web_fetch + name: + type: string + enum: + - web_fetch + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + allowed_domains: + type: array + items: + type: string + blocked_domains: + type: array + items: + type: string + max_content_tokens: + nullable: true + type: integer + format: int32 + BetaManagedAgentsWebSearchToolConfig: + description: Configuration for the web_search tool. + type: object + required: + - type + - name + - enabled + - permission_policy + properties: + type: + type: string + enum: + - web_search + name: + type: string + enum: + - web_search + enabled: + type: boolean + permission_policy: + $ref: "#/components/schemas/BetaManagedAgentsPermissionPolicy" + allowed_domains: + type: array + items: + type: string + blocked_domains: + type: array + items: + type: string + user_location: + nullable: true + description: Approximate user location for search result localization. + type: object + required: + - type + properties: + type: + description: Location precision. Only "approximate" is supported. + type: string + enum: + - approximate + city: + description: City name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + region: + description: Region or state name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + country: + description: Two-letter ISO 3166-1 country code, uppercase. + nullable: true + type: string + timezone: + description: IANA timezone identifier, e.g. "America/Los_Angeles". + nullable: true + type: string + minLength: 1 + maxLength: 255 + BetaManagedAgentsBashToolConfigParams: + description: Configuration override for the bash tool. + type: object + required: + - name + properties: + type: + type: string + enum: + - bash + name: + description: Must be "bash". + type: string + enum: + - bash + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsEditToolConfigParams: + description: Configuration override for the edit tool. + type: object + required: + - name + properties: + type: + type: string + enum: + - edit + name: + description: Must be "edit". + type: string + enum: + - edit + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsReadToolConfigParams: + description: Configuration override for the read tool. + type: object + required: + - name + properties: + type: + type: string + enum: + - read + name: + description: Must be "read". + type: string + enum: + - read + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsWriteToolConfigParams: + description: Configuration override for the write tool. + type: object + required: + - name + properties: + type: + type: string + enum: + - write + name: + description: Must be "write". + type: string + enum: + - write + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsGlobToolConfigParams: + description: Configuration override for the glob tool. + type: object + required: + - name + properties: + type: + type: string + enum: + - glob + name: + description: Must be "glob". + type: string + enum: + - glob + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsGrepToolConfigParams: + description: Configuration override for the grep tool. + type: object + required: + - name + properties: + type: + type: string + enum: + - grep + name: + description: Must be "grep". + type: string + enum: + - grep + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsWebFetchToolConfigParams: + description: Configuration override for the web_fetch tool. type: object - discriminator: - propertyName: type - mapping: - base64: "#/components/schemas/BetaManagedAgentsBase64ImageSource" - url: "#/components/schemas/BetaManagedAgentsURLImageSource" - file: "#/components/schemas/BetaManagedAgentsFileImageSource" required: - - type - - media_type - - data - - url - - file_id + - name properties: type: type: string enum: - - base64 - media_type: - description: MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - type: string - minLength: 1 - data: - description: Base64-encoded image data. - type: string - minLength: 1 - url: - description: URL of the image to fetch. - type: string - minLength: 1 - file_id: - description: ID of a previously uploaded file. + - web_fetch + name: + description: Must be "web_fetch". type: string - minLength: 1 - BetaManagedAgentsDocumentSource: - description: Union type for document source variants. + enum: + - web_fetch + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + allowed_domains: + description: 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. + type: array + items: + type: string + blocked_domains: + description: 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. + type: array + items: + type: string + max_content_tokens: + description: Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs. + nullable: true + type: integer + format: int32 + BetaManagedAgentsWebSearchToolConfigParams: + description: Configuration override for the web_search tool. type: object - discriminator: - propertyName: type - mapping: - base64: "#/components/schemas/BetaManagedAgentsBase64DocumentSource" - text: "#/components/schemas/BetaManagedAgentsPlainTextDocumentSource" - url: "#/components/schemas/BetaManagedAgentsURLDocumentSource" - file: "#/components/schemas/BetaManagedAgentsFileDocumentSource" required: - - type - - media_type - - data - - url - - file_id + - name properties: type: type: string enum: - - base64 - media_type: - description: MIME type of the document (e.g., "application/pdf"). - type: string - minLength: 1 - data: - description: Base64-encoded document data. - type: string - minLength: 1 - url: - description: URL of the document to fetch. - type: string - minLength: 1 - file_id: - description: ID of a previously uploaded file. + - web_search + name: + description: Must be "web_search". type: string - minLength: 1 + enum: + - web_search + enabled: + description: Whether this tool is enabled and available to Claude. Overrides the default_config setting. + nullable: true + type: boolean + permission_policy: + description: Permission policy for this tool. Controls whether tool calls are auto-approved or require confirmation. + nullable: true + type: object + discriminator: + propertyName: type + mapping: + always_allow: "#/components/schemas/BetaManagedAgentsAlwaysAllowPolicy" + always_ask: "#/components/schemas/BetaManagedAgentsAlwaysAskPolicy" + auto: "#/components/schemas/BetaManagedAgentsAutoPolicy" + required: + - type + properties: + type: + type: string + enum: + - always_allow + allowed_domains: + description: 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. + type: array + items: + type: string + blocked_domains: + description: 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. + type: array + items: + type: string + user_location: + description: Approximate user location for search result localization. + nullable: true + type: object + required: + - type + properties: + type: + description: Location precision. Only "approximate" is supported. + type: string + enum: + - approximate + city: + description: City name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + region: + description: Region or state name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + country: + description: Two-letter ISO 3166-1 country code, uppercase. + nullable: true + type: string + timezone: + description: IANA timezone identifier, e.g. "America/Los_Angeles". + nullable: true + type: string + minLength: 1 + maxLength: 255 BetaManagedAgentsSearchResultContent: description: Text content within a search result. type: object @@ -9229,6 +11910,27 @@ components: enabled: description: Whether citations are enabled for this search result. type: boolean + BetaManagedAgentsAgentAutoEvaluatedPermission: + description: "The server's per-invocation judgement under the auto permission policy. Its type always equals the event's top-level evaluated_permission. Open union: clients must tolerate unknown variants." + discriminator: + propertyName: type + mapping: + allow: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionAllow" + ask: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionAsk" + deny: "#/components/schemas/BetaManagedAgentsAgentAutoEvaluatedPermissionDeny" + type: object + required: + - type + - reason_code + properties: + type: + type: string + enum: + - allow + reason_code: + description: The judgement's grounds in registry-bound terms, for client branching and audit rather than end-user display. Open registry; currently "indeterminate" (no judgement was reached). Clients must tolerate values outside this set. + type: string + maxLength: 64 BetaManagedAgentsRetryStatusRetrying: description: The server is retrying automatically. Client should wait; the same error type may fire again as retrying, then once as exhausted when the retry budget runs out. type: object @@ -9259,26 +11961,15 @@ components: type: string enum: - terminal - BetaManagedAgentsAlwaysAllowPolicy: - description: Tool calls are automatically approved without user confirmation. - type: object - required: - - type - properties: - type: - type: string - enum: - - always_allow - BetaManagedAgentsAlwaysAskPolicy: - description: Tool calls require user confirmation before execution. - type: object - required: - - type - properties: - type: - type: string - enum: - - always_ask + BetaManagedAgentsEffortLevel: + type: string + description: How hard Claude works on each turn. Higher levels favor reasoning depth over latency. Not all models accept every level; invalid combinations are rejected at create time. + enum: + - low + - medium + - high + - xhigh + - max BetaManagedAgentsBase64ImageSource: description: Base64-encoded image data. type: object @@ -9400,6 +12091,109 @@ components: description: ID of a previously uploaded file. type: string minLength: 1 + BetaManagedAgentsAlwaysAllowPolicy: + description: Tool calls are automatically approved without user confirmation. + type: object + required: + - type + properties: + type: + type: string + enum: + - always_allow + BetaManagedAgentsAlwaysAskPolicy: + description: Tool calls require user confirmation before execution. + type: object + required: + - type + properties: + type: + type: string + enum: + - always_ask + BetaManagedAgentsAutoPolicy: + description: "The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask." + type: object + required: + - type + properties: + type: + type: string + enum: + - auto + BetaManagedAgentsUserLocation: + description: Approximate user location for search result localization. + type: object + required: + - type + properties: + type: + description: Location precision. Only "approximate" is supported. + type: string + enum: + - approximate + city: + description: City name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + region: + description: Region or state name. + nullable: true + type: string + minLength: 1 + maxLength: 255 + country: + description: Two-letter ISO 3166-1 country code, uppercase. + nullable: true + type: string + timezone: + description: IANA timezone identifier, e.g. "America/Los_Angeles". + nullable: true + type: string + minLength: 1 + maxLength: 255 + BetaManagedAgentsAgentAutoEvaluatedPermissionAllow: + description: The server judged the invocation safe to execute without client approval. + type: object + required: + - type + properties: + type: + type: string + enum: + - allow + BetaManagedAgentsAgentAutoEvaluatedPermissionAsk: + description: The server reached no judgement; the invocation is held for client approval. + type: object + required: + - type + - reason_code + properties: + type: + type: string + enum: + - ask + reason_code: + description: The judgement's grounds in registry-bound terms, for client branching and audit rather than end-user display. Open registry; currently "indeterminate" (no judgement was reached). Clients must tolerate values outside this set. + type: string + maxLength: 64 + BetaManagedAgentsAgentAutoEvaluatedPermissionDeny: + description: The server judged the invocation high-risk; it does not execute and a synthetic error tool result is appended. + type: object + required: + - type + - reason_code + properties: + type: + type: string + enum: + - deny + reason_code: + description: The judgement's grounds in registry-bound terms. Open registry; currently "high_risk" (judged high-risk; the call does not run). Clients must tolerate values outside this set. + type: string + maxLength: 64 StackqlExecResult: type: object description: Synthetic dispatch-result envelope for EXEC-only methods (see post-pass step 3). diff --git a/providers/src/anthropic/v00.00.00000/services/skills.yaml b/providers/src/anthropic/v00.00.00000/services/skills.yaml index 45b6e5f7..47e2e4c4 100644 --- a/providers/src/anthropic/v00.00.00000/services/skills.yaml +++ b/providers/src/anthropic/v00.00.00000/services/skills.yaml @@ -4,33 +4,11 @@ info: description: anthropic skills API version: 1.0.0 paths: - /v1/skills?beta=true: + /v1/skills: post: summary: Create Skill - operationId: beta_create_skill_v1_skills_post + operationId: create_skill_v1_skills_post parameters: - - name: anthropic-beta - in: header - required: false - schema: - type: string - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - title: Anthropic-Beta - x-stainless-override-schema: - x-stainless-param: betas - x-stainless-extend-default: true - type: array - description: Optional header to specify the beta version(s) you want to use. - items: - $ref: "#/components/schemas/AnthropicBeta" - default: skills-2025-10-02 - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - name: anthropic-version in: header required: false @@ -46,31 +24,129 @@ paths: The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: multipart/form-data: schema: - $ref: "#/components/schemas/BetaBody_create_skill_v1_skills_post" + $ref: "#/components/schemas/Body_create_skill_v1_skills_post" responses: "200": description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/BetaCreateSkillResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + $ref: "#/components/schemas/Skill" + "400": + description: Invalid argument - The client specified an invalid argument content: application/json: schema: - $ref: "#/components/schemas/BetaErrorResponse" + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" get: summary: List Skills - operationId: beta_list_skills_v1_skills_get + operationId: list_skills_v1_skills_get parameters: - name: page in: query @@ -94,13 +170,15 @@ paths: description: |- Number of results to return per page. - Maximum value is 100. Defaults to 20. + Ranges from `1` to `1000`. Defaults to `20`. default: 20 title: Limit + minimum: 1 + maximum: 1000 description: |- Number of results to return per page. - Maximum value is 100. Defaults to 20. + Ranges from `1` to `1000`. Defaults to `20`. - name: source in: query required: false @@ -119,28 +197,6 @@ paths: If provided, only skills from the specified source will be returned: * `"custom"`: only return user-created skills * `"anthropic"`: only return Anthropic-created skills - - name: anthropic-beta - in: header - required: false - schema: - type: string - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - title: Anthropic-Beta - x-stainless-override-schema: - x-stainless-param: betas - x-stainless-extend-default: true - type: array - description: Optional header to specify the beta version(s) you want to use. - items: - $ref: "#/components/schemas/AnthropicBeta" - default: skills-2025-10-02 - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - name: anthropic-version in: header required: false @@ -170,26 +226,124 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/BetaListSkillsResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + $ref: "#/components/schemas/ListSkillsResponse" + "400": + description: Invalid argument - The client specified an invalid argument content: application/json: schema: - $ref: "#/components/schemas/BetaErrorResponse" - /v1/skills/{skill_id}?beta=true: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + /v1/skills/{skill_id}: get: summary: Get Skill - operationId: beta_get_skill_v1_skills__skill_id__get + operationId: get_skill_v1_skills__skill_id__get parameters: - name: skill_id in: path @@ -205,28 +359,6 @@ paths: Unique identifier for the skill. The format and length of IDs may change over time. - - name: anthropic-beta - in: header - required: false - schema: - type: string - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - title: Anthropic-Beta - x-stainless-override-schema: - x-stainless-param: betas - x-stainless-extend-default: true - type: array - description: Optional header to specify the beta version(s) you want to use. - items: - $ref: "#/components/schemas/AnthropicBeta" - default: skills-2025-10-02 - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - name: anthropic-version in: header required: false @@ -256,25 +388,123 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/BetaGetSkillResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + $ref: "#/components/schemas/Skill" + "400": + description: Invalid argument - The client specified an invalid argument content: application/json: schema: - $ref: "#/components/schemas/BetaErrorResponse" + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" delete: summary: Delete Skill - operationId: beta_delete_skill_v1_skills__skill_id__delete + operationId: delete_skill_v1_skills__skill_id__delete parameters: - name: skill_id in: path @@ -290,28 +520,6 @@ paths: Unique identifier for the skill. The format and length of IDs may change over time. - - name: anthropic-beta - in: header - required: false - schema: - type: string - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - title: Anthropic-Beta - x-stainless-override-schema: - x-stainless-param: betas - x-stainless-extend-default: true - type: array - description: Optional header to specify the beta version(s) you want to use. - items: - $ref: "#/components/schemas/AnthropicBeta" - default: skills-2025-10-02 - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - name: anthropic-version in: header required: false @@ -341,26 +549,124 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/BetaDeleteSkillResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + $ref: "#/components/schemas/DeletedSkill" + "400": + description: Invalid argument - The client specified an invalid argument content: application/json: schema: - $ref: "#/components/schemas/BetaErrorResponse" - /v1/skills/{skill_id}/versions?beta=true: - post: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + /v1/skills/{skill_id}/versions: + post: summary: Create Skill Version - operationId: beta_create_skill_version_v1_skills__skill_id__versions_post + operationId: create_skill_version_v1_skills__skill_id__versions_post parameters: - name: skill_id in: path @@ -376,28 +682,6 @@ paths: Unique identifier for the skill. The format and length of IDs may change over time. - - name: anthropic-beta - in: header - required: false - schema: - type: string - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - title: Anthropic-Beta - x-stainless-override-schema: - x-stainless-param: betas - x-stainless-extend-default: true - type: array - description: Optional header to specify the beta version(s) you want to use. - items: - $ref: "#/components/schemas/AnthropicBeta" - default: skills-2025-10-02 - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - name: anthropic-version in: header required: false @@ -413,31 +697,129 @@ paths: The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: multipart/form-data: schema: - $ref: "#/components/schemas/BetaBody_create_skill_version_v1_skills__skill_id__versions_post" + $ref: "#/components/schemas/Body_create_skill_version_v1_skills__skill_id__versions_post" responses: "200": description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/BetaCreateSkillVersionResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + $ref: "#/components/schemas/SkillVersion" + "400": + description: Invalid argument - The client specified an invalid argument content: application/json: schema: - $ref: "#/components/schemas/BetaErrorResponse" + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" get: summary: List Skill Versions - operationId: beta_list_skill_versions_v1_skills__skill_id__versions_get + operationId: list_skill_versions_v1_skills__skill_id__versions_get parameters: - name: skill_id in: path @@ -467,36 +849,15 @@ paths: schema: type: integer description: |- - Number of items to return per page. + Number of results to return per page. - Defaults to `20`. Ranges from `1` to `1000`. + Ranges from `1` to `1000`. Defaults to `20`. nullable: true + default: 20 description: |- - Number of items to return per page. - - Defaults to `20`. Ranges from `1` to `1000`. - - name: anthropic-beta - in: header - required: false - schema: - type: string - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - title: Anthropic-Beta - x-stainless-override-schema: - x-stainless-param: betas - x-stainless-extend-default: true - type: array - description: Optional header to specify the beta version(s) you want to use. - items: - $ref: "#/components/schemas/AnthropicBeta" - default: skills-2025-10-02 - description: |- - Optional header to specify the beta version(s) you want to use. + Number of results to return per page. - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. + Ranges from `1` to `1000`. Defaults to `20`. - name: anthropic-version in: header required: false @@ -526,26 +887,124 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/BetaListSkillVersionsResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + $ref: "#/components/schemas/ListSkillVersionsResponse" + "400": + description: Invalid argument - The client specified an invalid argument content: application/json: schema: - $ref: "#/components/schemas/BetaErrorResponse" - /v1/skills/{skill_id}/versions/{version}?beta=true: + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + /v1/skills/{skill_id}/versions/{version}: get: summary: Get Skill Version - operationId: beta_get_skill_version_v1_skills__skill_id__versions__version__get + operationId: get_skill_version_v1_skills__skill_id__versions__version__get parameters: - name: skill_id in: path @@ -567,36 +1026,14 @@ paths: schema: type: string description: |- - Version identifier for the skill. + Identifies the skill version: a version ID, or the literal `latest` for the skill's most recent version. - Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). + Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). title: Version description: |- - Version identifier for the skill. - - Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - - name: anthropic-beta - in: header - required: false - schema: - type: string - description: |- - Optional header to specify the beta version(s) you want to use. - - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - title: Anthropic-Beta - x-stainless-override-schema: - x-stainless-param: betas - x-stainless-extend-default: true - type: array - description: Optional header to specify the beta version(s) you want to use. - items: - $ref: "#/components/schemas/AnthropicBeta" - default: skills-2025-10-02 - description: |- - Optional header to specify the beta version(s) you want to use. + Identifies the skill version: a version ID, or the literal `latest` for the skill's most recent version. - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. + Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). - name: anthropic-version in: header required: false @@ -626,76 +1063,152 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/BetaGetSkillVersionResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + $ref: "#/components/schemas/SkillVersion" + "400": + description: Invalid argument - The client specified an invalid argument content: application/json: schema: - $ref: "#/components/schemas/BetaErrorResponse" - delete: - summary: Delete Skill Version - operationId: beta_delete_skill_version_v1_skills__skill_id__versions__version__delete - parameters: - - name: skill_id - in: path - required: true - schema: - type: string - description: |- - Unique identifier for the skill. - - The format and length of IDs may change over time. - title: Skill Id - description: |- - Unique identifier for the skill. - - The format and length of IDs may change over time. - - name: version - in: path - required: true - schema: - type: string - description: |- - Version identifier for the skill. - - Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - title: Version - description: |- - Version identifier for the skill. - - Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - - name: anthropic-beta - in: header - required: false + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + delete: + summary: Delete Skill Version + operationId: delete_skill_version_v1_skills__skill_id__versions__version__delete + parameters: + - name: skill_id + in: path + required: true schema: type: string description: |- - Optional header to specify the beta version(s) you want to use. + Unique identifier for the skill. - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. - title: Anthropic-Beta - x-stainless-override-schema: - x-stainless-param: betas - x-stainless-extend-default: true - type: array - description: Optional header to specify the beta version(s) you want to use. - items: - $ref: "#/components/schemas/AnthropicBeta" - default: skills-2025-10-02 + The format and length of IDs may change over time. + title: Skill Id description: |- - Optional header to specify the beta version(s) you want to use. + Unique identifier for the skill. - To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. + The format and length of IDs may change over time. + - name: version + in: path + required: true + schema: + type: string + description: |- + Identifies the skill version by its version ID. + + Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). + title: Version + description: |- + Identifies the skill version by its version ID. + + Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). - name: anthropic-version in: header required: false @@ -725,22 +1238,120 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/BetaDeleteSkillVersionResponse" - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + $ref: "#/components/schemas/DeletedSkillVersion" + "400": + description: Invalid argument - The client specified an invalid argument content: application/json: schema: - $ref: "#/components/schemas/BetaErrorResponse" + $ref: "#/components/schemas/ErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "500": + description: Internal - Internal server error + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" /v1/skills/{skill_id}/versions/{version}/content?beta=true: get: summary: Download Skill Version Content @@ -767,14 +1378,14 @@ paths: schema: type: string description: |- - Version identifier for the skill. + Identifies the skill version by its version ID. - Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). + Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). title: Version description: |- - Version identifier for the skill. + Identifies the skill version by its version ID. - Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). + Requests carrying the `skills-2025-10-02` beta header address versions by their Unix epoch timestamp instead (e.g., "1759178010641129"). - name: anthropic-beta in: header required: false @@ -792,7 +1403,6 @@ paths: description: Optional header to specify the beta version(s) you want to use. items: $ref: "#/components/schemas/AnthropicBeta" - default: skills-2025-10-02 description: |- Optional header to specify the beta version(s) you want to use. @@ -826,6 +1436,17 @@ paths: Your unique API key for authentication. This key is required in the header of all API requests, to authenticate your account and access Anthropic's services. Get your API key through the [Console](https://console.anthropic.com/settings/keys). Each key is scoped to a Workspace. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful Response @@ -833,51 +1454,105 @@ paths: application/zip: schema: type: string - 4XX: - description: |- - Error response. - - See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. + "400": + description: Invalid argument - The client specified an invalid argument + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "401": + description: Unauthenticated - The request does not have valid authentication credentials + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "403": + description: Permission denied - The caller does not have permission to execute the specified operation + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "404": + description: Not found - Some requested entity was not found + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "408": + description: Deadline exceeded - The deadline expired before the operation could complete + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "409": + description: Aborted - The operation was aborted due to concurrency issue + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "412": + description: Failed precondition - Operation was rejected because the system is not in required state + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "413": + description: Out of range - Operation was attempted past the valid range + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "429": + description: Resource exhausted - Some resource has been exhausted (rate limiting) + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "431": + description: Request header fields too large - Request metadata was too large + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "499": + description: Cancelled - The operation was cancelled by the client + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "500": + description: Internal - Internal server error + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "501": + description: Unimplemented - The operation is not implemented or supported + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "503": + description: Unavailable - The service is currently unavailable + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "504": + description: Deadline exceeded - Upstream service did not respond in time + content: + application/zip: + schema: + $ref: "#/components/schemas/BetaErrorResponse" + "529": + description: Overloaded - The service is temporarily overloaded content: application/zip: schema: $ref: "#/components/schemas/BetaErrorResponse" components: schemas: - AnthropicBeta: - type: string - enum: - - message-batches-2024-09-24 - - prompt-caching-2024-07-31 - - computer-use-2024-10-22 - - computer-use-2025-01-24 - - pdfs-2024-09-25 - - token-counting-2024-11-01 - - token-efficient-tools-2025-02-19 - - output-128k-2025-02-19 - - files-api-2025-04-14 - - mcp-client-2025-04-04 - - mcp-client-2025-11-20 - - dev-full-thinking-2025-05-14 - - interleaved-thinking-2025-05-14 - - code-execution-2025-05-22 - - extended-cache-ttl-2025-04-11 - - context-1m-2025-08-07 - - context-management-2025-06-27 - - model-context-window-exceeded-2025-08-26 - - skills-2025-10-02 - - fast-mode-2026-02-01 - - output-300k-2026-03-24 - - user-profiles-2026-03-24 - - advisor-tool-2026-03-01 - - managed-agents-2026-04-01 - - cache-diagnosis-2026-04-07 - - thinking-token-count-2026-05-13 - - server-side-fallback-2026-06-01 - - fallback-credit-2026-06-01 - - agent-memory-2026-07-22 - x-stainless-nominal: false - BetaBody_create_skill_v1_skills_post: + Body_create_skill_v1_skills_post: properties: files: items: @@ -889,36 +1564,34 @@ components: Files to upload for the skill. All files must be in the same top-level directory and must include a SKILL.md file at the root of that directory. - display_title: - title: Display Title + display_name: + title: Display Name description: |- - Display title for the skill. - - This is a human-readable label that is not included in the prompt sent to the model. + Human-readable, single-line label for the Skill. Maximum 255 characters. + Always set: derived from the SKILL.md frontmatter `name` when omitted at + creation. Not unique. nullable: true type: string type: object required: - files title: Body_create_skill_v1_skills_post - BetaCreateSkillResponse: + Skill: properties: created_at: type: string + format: date-time title: Created At description: ISO 8601 timestamp of when the skill was created. examples: - "2024-10-30T23:58:27.427722Z" - display_title: - title: Display Title - description: |- - Display title for the skill. - - This is a human-readable label that is not included in the prompt sent to the model. - examples: - - My Custom Skill - nullable: true + display_name: type: string + title: Display Name + description: |- + Human-readable, single-line label for the Skill. Maximum 255 characters. + Always set: derived from the SKILL.md frontmatter `name` when omitted at + creation. Not unique. id: type: string title: Id @@ -928,27 +1601,20 @@ components: The format and length of IDs may change over time. examples: - skill_01JAbcdefghijklmnopqrstuvw - latest_version: - title: Latest Version - description: |- - The latest version identifier for the skill. - - This represents the most recent version of the skill that has been created. - examples: - - "1759178010641129" - nullable: true + latest_version_id: type: string + title: Latest Version Id + description: "ID of the newest Skill Version — what `latest` references resolve to. Always set: a Skill holds at least one version." source: - type: string - title: Source + $ref: "#/components/schemas/SkillSource" description: |- - Source of the skill. + Where the Skill comes from. - This may be one of the following values: - * `"custom"`: the skill was created by a user - * `"anthropic"`: the skill was created by Anthropic - examples: - - custom + Possible values: + * `"custom"`: authored by the platform user; private to their workspace + * `"anthropic"`: published by Anthropic; shared and read-only + * `"anthropic_example"`: Anthropic-published sample Skill + * `"plugin"`: resolved from an installed plugin type: type: string title: Type @@ -957,8 +1623,11 @@ components: For Skills, this is always `"skill"`. default: skill + enum: + - skill updated_at: type: string + format: date-time title: Updated At description: ISO 8601 timestamp of when the skill was last updated. examples: @@ -966,27 +1635,27 @@ components: type: object required: - created_at - - display_title + - display_name - id - - latest_version + - latest_version_id - source - type - updated_at - title: CreateSkillResponse - BetaErrorResponse: + title: Skill + ErrorResponse: properties: error: discriminator: mapping: - api_error: "#/components/schemas/BetaAPIError" - authentication_error: "#/components/schemas/BetaAuthenticationError" - billing_error: "#/components/schemas/BetaBillingError" - invalid_request_error: "#/components/schemas/BetaInvalidRequestError" - not_found_error: "#/components/schemas/BetaNotFoundError" - overloaded_error: "#/components/schemas/BetaOverloadedError" - permission_error: "#/components/schemas/BetaPermissionError" - rate_limit_error: "#/components/schemas/BetaRateLimitError" - timeout_error: "#/components/schemas/BetaGatewayTimeoutError" + api_error: "#/components/schemas/APIError" + authentication_error: "#/components/schemas/AuthenticationError" + billing_error: "#/components/schemas/BillingError" + invalid_request_error: "#/components/schemas/InvalidRequestError" + not_found_error: "#/components/schemas/NotFoundError" + overloaded_error: "#/components/schemas/OverloadedError" + permission_error: "#/components/schemas/PermissionError" + rate_limit_error: "#/components/schemas/RateLimitError" + timeout_error: "#/components/schemas/GatewayTimeoutError" propertyName: type title: Error properties: @@ -1021,115 +1690,28 @@ components: - type title: ErrorResponse type: object - BetaListSkillsResponse: + ListSkillsResponse: properties: data: items: - $ref: "#/components/schemas/Betaapi__schemas__skills__Skill" + $ref: "#/components/schemas/Skill" type: array title: Data description: List of skills. - x-stainless-pagination-property: - purpose: items - has_more: - type: boolean - title: Has More - description: |- - Whether there are more results available. - - If `true`, there are additional results that can be fetched using the `next_page` token. next_page: title: Next Page description: |- Token for fetching the next page of results. - If `null`, there are no more results available. Pass this value to the `page_token` parameter in the next request to get the next page. - examples: - - page_MjAyNS0wNS0xNFQwMDowMDowMFo= - - null - x-stainless-pagination-property: - purpose: next_cursor_field + If `null`, there are no more results available. Pass this value to the `page` parameter in the next request to get the next page. nullable: true type: string type: object required: - data - - has_more - next_page title: ListSkillsResponse - BetaGetSkillResponse: - properties: - created_at: - type: string - title: Created At - description: ISO 8601 timestamp of when the skill was created. - examples: - - "2024-10-30T23:58:27.427722Z" - display_title: - title: Display Title - description: |- - Display title for the skill. - - This is a human-readable label that is not included in the prompt sent to the model. - examples: - - My Custom Skill - nullable: true - type: string - id: - type: string - title: Id - description: |- - Unique identifier for the skill. - - The format and length of IDs may change over time. - examples: - - skill_01JAbcdefghijklmnopqrstuvw - latest_version: - title: Latest Version - description: |- - The latest version identifier for the skill. - - This represents the most recent version of the skill that has been created. - examples: - - "1759178010641129" - nullable: true - type: string - source: - type: string - title: Source - description: |- - Source of the skill. - - This may be one of the following values: - * `"custom"`: the skill was created by a user - * `"anthropic"`: the skill was created by Anthropic - examples: - - custom - type: - type: string - title: Type - description: |- - Object type. - - For Skills, this is always `"skill"`. - default: skill - updated_at: - type: string - title: Updated At - description: ISO 8601 timestamp of when the skill was last updated. - examples: - - "2024-10-30T23:58:27.427722Z" - type: object - required: - - created_at - - display_title - - id - - latest_version - - source - - type - - updated_at - title: GetSkillResponse - BetaDeleteSkillResponse: + DeletedSkill: properties: id: type: string @@ -1148,12 +1730,14 @@ components: For Skills, this is always `"skill_deleted"`. default: skill_deleted + enum: + - skill_deleted type: object required: - id - type - title: DeleteSkillResponse - BetaBody_create_skill_version_v1_skills__skill_id__versions_post: + title: DeletedSkill + Body_create_skill_version_v1_skills__skill_id__versions_post: properties: files: items: @@ -1169,12 +1753,13 @@ components: required: - files title: Body_create_skill_version_v1_skills__skill_id__versions_post - BetaCreateSkillVersionResponse: + SkillVersion: properties: created_at: type: string + format: date-time title: Created At - description: ISO 8601 timestamp of when the skill version was created. + description: ISO 8601 timestamp of when the skill was created. examples: - "2024-10-30T23:58:27.427722Z" description: @@ -1184,39 +1769,27 @@ components: Description of the skill version. This is extracted from the SKILL.md file in the skill upload. - examples: - - A custom skill for doing something useful - directory: - type: string - title: Directory - description: |- - Directory name of the skill version. - - This is the top-level directory name that was extracted from the uploaded files. - examples: - - my-skill id: type: string title: Id description: |- - Unique identifier for the skill version. - - The format and length of IDs may change over time. - examples: - - skillver_01JAbcdefghijklmnopqrstuvw + Unique identifier for this Skill Version. The id addresses the version in + paths and pins it in references. name: type: string title: Name description: |- - Human-readable name of the skill version. - - This is extracted from the SKILL.md file in the skill upload. - examples: - - my-skill + The Skill's immutable kebab-case slug, set at creation from the first + upload's SKILL.md frontmatter `name` (or its enclosing directory). Every + later upload must resolve to the same value. Also the top-level directory + of the Skill's mounted files and the base name of a downloaded archive. skill_id: type: string title: Skill Id - description: Identifier for the skill that this version belongs to. + description: |- + Unique identifier for the skill. + + The format and length of IDs may change over time. examples: - skill_01JAbcdefghijklmnopqrstuvw type: @@ -1227,159 +1800,181 @@ components: For Skill Versions, this is always `"skill_version"`. default: skill_version - version: - type: string - title: Version - description: |- - Version identifier for the skill. - - Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - examples: - - "1759178010641129" + enum: + - skill_version type: object required: - created_at - description - - directory - id - name - skill_id - type - - version - title: CreateSkillVersionResponse - BetaListSkillVersionsResponse: + title: SkillVersion + ListSkillVersionsResponse: properties: data: items: - $ref: "#/components/schemas/BetaSkillVersion" + $ref: "#/components/schemas/SkillVersion" type: array title: Data - description: List of skill versions. - x-stainless-pagination-property: - purpose: items - has_more: - type: boolean - title: Has More - description: Indicates if there are more results in the requested page direction. + description: List of skills. next_page: title: Next Page - description: Token to provide in as `page` in the subsequent request to retrieve the next page of data. - examples: - - page_MjAyNS0wNS0xNFQwMDowMDowMFo= - - null - x-stainless-pagination-property: - purpose: next_cursor_field + description: |- + Token for fetching the next page of results. + + If `null`, there are no more results available. Pass this value to the `page` parameter in the next request to get the next page. nullable: true type: string type: object required: - data - - has_more - next_page title: ListSkillVersionsResponse - BetaGetSkillVersionResponse: + DeletedSkillVersion: properties: - created_at: - type: string - title: Created At - description: ISO 8601 timestamp of when the skill version was created. - examples: - - "2024-10-30T23:58:27.427722Z" - description: - type: string - title: Description - description: |- - Description of the skill version. - - This is extracted from the SKILL.md file in the skill upload. - examples: - - A custom skill for doing something useful - directory: - type: string - title: Directory - description: |- - Directory name of the skill version. - - This is the top-level directory name that was extracted from the uploaded files. - examples: - - my-skill id: type: string title: Id description: |- - Unique identifier for the skill version. - - The format and length of IDs may change over time. - examples: - - skillver_01JAbcdefghijklmnopqrstuvw - name: - type: string - title: Name - description: |- - Human-readable name of the skill version. - - This is extracted from the SKILL.md file in the skill upload. - examples: - - my-skill - skill_id: - type: string - title: Skill Id - description: Identifier for the skill that this version belongs to. - examples: - - skill_01JAbcdefghijklmnopqrstuvw + Unique identifier for this Skill Version. The id addresses the version in + paths and pins it in references. type: type: string title: Type description: |- - Object type. - - For Skill Versions, this is always `"skill_version"`. - default: skill_version - version: - type: string - title: Version - description: |- - Version identifier for the skill. + Deleted object type. - Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - examples: - - "1759178010641129" + For Skill Versions, this is always `"skill_version_deleted"`. + default: skill_version_deleted + enum: + - skill_version_deleted type: object required: - - created_at - - description - - directory - id - - name - - skill_id - type - - version - title: GetSkillVersionResponse - BetaDeleteSkillVersionResponse: + title: DeletedSkillVersion + AnthropicBeta: + type: string + enum: + - message-batches-2024-09-24 + - prompt-caching-2024-07-31 + - computer-use-2024-10-22 + - computer-use-2025-01-24 + - pdfs-2024-09-25 + - token-counting-2024-11-01 + - token-efficient-tools-2025-02-19 + - output-128k-2025-02-19 + - files-api-2025-04-14 + - mcp-client-2025-04-04 + - mcp-client-2025-11-20 + - dev-full-thinking-2025-05-14 + - interleaved-thinking-2025-05-14 + - code-execution-2025-05-22 + - extended-cache-ttl-2025-04-11 + - context-1m-2025-08-07 + - context-management-2025-06-27 + - model-context-window-exceeded-2025-08-26 + - skills-2025-10-02 + - fast-mode-2026-02-01 + - output-300k-2026-03-24 + - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 + - advisor-tool-2026-03-01 + - managed-agents-2026-04-01 + - cache-diagnosis-2026-04-07 + - dreaming-2026-04-21 + - thinking-token-count-2026-05-13 + - server-side-fallback-2026-06-01 + - server-side-fallback-2026-07-01 + - fallback-credit-2026-06-01 + - fallback-credit-2026-07-01 + - agent-memory-2026-07-22 + - mid-conversation-tool-changes-2026-07-01 + - compact-2026-01-12 + - computer-use-2025-11-24 + - mcp-tunnels-2026-06-22 + - structured-outputs-2025-11-13 + - task-budgets-2026-03-13 + - thinking-display-updates-2026-08-18 + - ce-user-management-2026-07-13 + - mid-conversation-output-config-2026-07-01 + - thinking-binding-controls-2026-08-01 + - mid-conversation-system-clear-at-2026-08-21 + x-stainless-nominal: false + BetaErrorResponse: properties: - id: + error: + discriminator: + mapping: + api_error: "#/components/schemas/BetaAPIError" + authentication_error: "#/components/schemas/BetaAuthenticationError" + billing_error: "#/components/schemas/BetaBillingError" + invalid_request_error: "#/components/schemas/BetaInvalidRequestError" + not_found_error: "#/components/schemas/BetaNotFoundError" + overloaded_error: "#/components/schemas/BetaOverloadedError" + permission_error: "#/components/schemas/BetaPermissionError" + rate_limit_error: "#/components/schemas/BetaRateLimitError" + timeout_error: "#/components/schemas/BetaGatewayTimeoutError" + propertyName: type + title: Error + properties: + message: + default: Invalid request + title: Message + type: string + type: + default: invalid_request_error + title: Type + type: string + enum: + - invalid_request_error + required: + - message + - type + type: object + request_id: + default: null + title: Request Id + nullable: true type: string - title: Id - description: |- - Version identifier for the skill. - - Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - examples: - - "1759178010641129" + type: + default: error + title: Type + type: string + enum: + - error + required: + - error + - request_id + - type + title: ErrorResponse + type: object + SkillSource: + properties: type: type: string + enum: + - custom + - anthropic + - anthropic_example + - plugin title: Type description: |- - Deleted object type. + Where the Skill comes from. - For Skill Versions, this is always `"skill_version_deleted"`. - default: skill_version_deleted + Possible values: + * `"custom"`: authored by the platform user; private to their workspace + * `"anthropic"`: published by Anthropic; shared and read-only + * `"anthropic_example"`: Anthropic-published sample Skill + * `"plugin"`: resolved from an installed plugin type: object required: - - id - type - title: DeleteSkillVersionResponse - BetaInvalidRequestError: + title: SkillSource + InvalidRequestError: properties: message: default: Invalid request @@ -1396,7 +1991,7 @@ components: - type title: InvalidRequestError type: object - BetaAuthenticationError: + AuthenticationError: properties: message: default: Authentication error @@ -1413,7 +2008,7 @@ components: - type title: AuthenticationError type: object - BetaBillingError: + BillingError: properties: message: default: Billing error @@ -1430,7 +2025,7 @@ components: - type title: BillingError type: object - BetaPermissionError: + PermissionError: properties: message: default: Permission denied @@ -1447,7 +2042,7 @@ components: - type title: PermissionError type: object - BetaNotFoundError: + NotFoundError: properties: message: default: Not found @@ -1464,7 +2059,7 @@ components: - type title: NotFoundError type: object - BetaRateLimitError: + RateLimitError: properties: message: default: Rate limited @@ -1481,7 +2076,7 @@ components: - type title: RateLimitError type: object - BetaGatewayTimeoutError: + GatewayTimeoutError: properties: message: default: Request timeout @@ -1498,7 +2093,7 @@ components: - type title: GatewayTimeoutError type: object - BetaAPIError: + APIError: properties: message: default: Internal server error @@ -1515,7 +2110,7 @@ components: - type title: APIError type: object - BetaOverloadedError: + OverloadedError: properties: message: default: Overloaded @@ -1532,156 +2127,159 @@ components: - type title: OverloadedError type: object - Betaapi__schemas__skills__Skill: + BetaInvalidRequestError: properties: - created_at: + message: + default: Invalid request + title: Message type: string - title: Created At - description: ISO 8601 timestamp of when the skill was created. - examples: - - "2024-10-30T23:58:27.427722Z" - display_title: - title: Display Title - description: |- - Display title for the skill. - - This is a human-readable label that is not included in the prompt sent to the model. - examples: - - My Custom Skill - nullable: true + type: + default: invalid_request_error + title: Type type: string - id: + enum: + - invalid_request_error + required: + - message + - type + title: InvalidRequestError + type: object + BetaAuthenticationError: + properties: + message: + default: Authentication error + title: Message type: string - title: Id - description: |- - Unique identifier for the skill. - - The format and length of IDs may change over time. - examples: - - skill_01JAbcdefghijklmnopqrstuvw - latest_version: - title: Latest Version - description: |- - The latest version identifier for the skill. - - This represents the most recent version of the skill that has been created. - examples: - - "1759178010641129" - nullable: true + type: + default: authentication_error + title: Type type: string - source: + enum: + - authentication_error + required: + - message + - type + title: AuthenticationError + type: object + BetaBillingError: + properties: + message: + default: Billing error + title: Message type: string - title: Source - description: |- - Source of the skill. - - This may be one of the following values: - * `"custom"`: the skill was created by a user - * `"anthropic"`: the skill was created by Anthropic - examples: - - custom type: - type: string + default: billing_error title: Type - description: |- - Object type. - - For Skills, this is always `"skill"`. - default: skill - updated_at: type: string - title: Updated At - description: ISO 8601 timestamp of when the skill was last updated. - examples: - - "2024-10-30T23:58:27.427722Z" - type: object + enum: + - billing_error required: - - created_at - - display_title - - id - - latest_version - - source + - message - type - - updated_at - title: Skill - BetaSkillVersion: + title: BillingError + type: object + BetaPermissionError: properties: - created_at: + message: + default: Permission denied + title: Message type: string - title: Created At - description: ISO 8601 timestamp of when the skill version was created. - examples: - - "2024-10-30T23:58:27.427722Z" - description: + type: + default: permission_error + title: Type type: string - title: Description - description: |- - Description of the skill version. - - This is extracted from the SKILL.md file in the skill upload. - examples: - - A custom skill for doing something useful - directory: + enum: + - permission_error + required: + - message + - type + title: PermissionError + type: object + BetaNotFoundError: + properties: + message: + default: Not found + title: Message type: string - title: Directory - description: |- - Directory name of the skill version. - - This is the top-level directory name that was extracted from the uploaded files. - examples: - - my-skill - id: + type: + default: not_found_error + title: Type type: string - title: Id - description: |- - Unique identifier for the skill version. - - The format and length of IDs may change over time. - examples: - - skillver_01JAbcdefghijklmnopqrstuvw - name: + enum: + - not_found_error + required: + - message + - type + title: NotFoundError + type: object + BetaRateLimitError: + properties: + message: + default: Rate limited + title: Message type: string - title: Name - description: |- - Human-readable name of the skill version. - - This is extracted from the SKILL.md file in the skill upload. - examples: - - my-skill - skill_id: + type: + default: rate_limit_error + title: Type + type: string + enum: + - rate_limit_error + required: + - message + - type + title: RateLimitError + type: object + BetaGatewayTimeoutError: + properties: + message: + default: Request timeout + title: Message type: string - title: Skill Id - description: Identifier for the skill that this version belongs to. - examples: - - skill_01JAbcdefghijklmnopqrstuvw type: + default: timeout_error + title: Type + type: string + enum: + - timeout_error + required: + - message + - type + title: GatewayTimeoutError + type: object + BetaAPIError: + properties: + message: + default: Internal server error + title: Message type: string + type: + default: api_error title: Type - description: |- - Object type. - - For Skill Versions, this is always `"skill_version"`. - default: skill_version - version: type: string - title: Version - description: |- - Version identifier for the skill. - - Each version is identified by a Unix epoch timestamp (e.g., "1759178010641129"). - examples: - - "1759178010641129" + enum: + - api_error + required: + - message + - type + title: APIError type: object + BetaOverloadedError: + properties: + message: + default: Overloaded + title: Message + type: string + type: + default: overloaded_error + title: Type + type: string + enum: + - overloaded_error required: - - created_at - - description - - directory - - id - - name - - skill_id + - message - type - - version - title: SkillVersion + title: OverloadedError + type: object StackqlExecResult: type: object description: Synthetic dispatch-result envelope for EXEC-only methods (see post-pass step 3). @@ -1704,7 +2302,7 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: "#/paths/~1v1~1skills?beta=true/post" + $ref: "#/paths/~1v1~1skills/post" response: mediaType: application/json openAPIDocKey: "200" @@ -1714,7 +2312,7 @@ components: mediaType: multipart/form-data list: operation: - $ref: "#/paths/~1v1~1skills?beta=true/get" + $ref: "#/paths/~1v1~1skills/get" response: mediaType: application/json openAPIDocKey: "200" @@ -1730,15 +2328,16 @@ components: queryParamPushdown: top: paramName: limit + maxValue: 1000 get: operation: - $ref: "#/paths/~1v1~1skills~1{skill_id}?beta=true/get" + $ref: "#/paths/~1v1~1skills~1{skill_id}/get" response: mediaType: application/json openAPIDocKey: "200" delete: operation: - $ref: "#/paths/~1v1~1skills~1{skill_id}?beta=true/delete" + $ref: "#/paths/~1v1~1skills~1{skill_id}/delete" response: mediaType: application/json openAPIDocKey: "200" @@ -1761,7 +2360,7 @@ components: requestBodyTranslate: algorithm: naive operation: - $ref: "#/paths/~1v1~1skills~1{skill_id}~1versions?beta=true/post" + $ref: "#/paths/~1v1~1skills~1{skill_id}~1versions/post" response: mediaType: application/json openAPIDocKey: "200" @@ -1771,7 +2370,7 @@ components: mediaType: multipart/form-data list: operation: - $ref: "#/paths/~1v1~1skills~1{skill_id}~1versions?beta=true/get" + $ref: "#/paths/~1v1~1skills~1{skill_id}~1versions/get" response: mediaType: application/json openAPIDocKey: "200" @@ -1789,13 +2388,13 @@ components: paramName: limit get: operation: - $ref: "#/paths/~1v1~1skills~1{skill_id}~1versions~1{version}?beta=true/get" + $ref: "#/paths/~1v1~1skills~1{skill_id}~1versions~1{version}/get" response: mediaType: application/json openAPIDocKey: "200" delete: operation: - $ref: "#/paths/~1v1~1skills~1{skill_id}~1versions~1{version}?beta=true/delete" + $ref: "#/paths/~1v1~1skills~1{skill_id}~1versions~1{version}/delete" response: mediaType: application/json openAPIDocKey: "200" diff --git a/providers/src/anthropic/v00.00.00000/services/user_profiles.yaml b/providers/src/anthropic/v00.00.00000/services/user_profiles.yaml index f0561f07..11c64844 100644 --- a/providers/src/anthropic/v00.00.00000/services/user_profiles.yaml +++ b/providers/src/anthropic/v00.00.00000/services/user_profiles.yaml @@ -111,6 +111,10 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 parameters: - name: anthropic-version in: header @@ -130,7 +134,7 @@ paths: description: Optional header to specify the beta version(s) you want to use. items: $ref: "#/components/schemas/AnthropicBeta" - default: user-profiles-2026-03-24 + default: user-profiles-2026-08-18 get: operationId: BetaListUserProfiles summary: List User Profiles @@ -158,7 +162,7 @@ paths: description: Optional header to specify the beta version(s) you want to use. items: $ref: "#/components/schemas/AnthropicBeta" - default: user-profiles-2026-03-24 + default: user-profiles-2026-08-18 - name: limit in: query required: false @@ -178,6 +182,12 @@ paths: schema: $ref: "#/components/schemas/BetaUserProfileListOrder" description: Query parameter for order + - name: order_by + in: query + required: false + schema: + $ref: "#/components/schemas/BetaUserProfileListOrderBy" + description: Query parameter for order_by responses: "200": description: Successful response (OK) @@ -275,6 +285,10 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 /v1/user_profiles/{user_profile_id}?beta=true: get: operationId: BetaGetUserProfile @@ -303,7 +317,7 @@ paths: description: Optional header to specify the beta version(s) you want to use. items: $ref: "#/components/schemas/AnthropicBeta" - default: user-profiles-2026-03-24 + default: user-profiles-2026-08-18 - name: user_profile_id in: path required: true @@ -408,6 +422,10 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 post: operationId: BetaUpdateUserProfile summary: Update User Profile @@ -430,7 +448,7 @@ paths: description: Optional header to specify the beta version(s) you want to use. items: $ref: "#/components/schemas/AnthropicBeta" - default: user-profiles-2026-03-24 + default: user-profiles-2026-08-18 - name: user_profile_id in: path required: true @@ -541,6 +559,10 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 /v1/user_profiles/{user_profile_id}/enrollment_url?beta=true: post: operationId: BetaCreateEnrollmentUrl @@ -564,7 +586,7 @@ paths: description: Optional header to specify the beta version(s) you want to use. items: $ref: "#/components/schemas/AnthropicBeta" - default: user-profiles-2026-03-24 + default: user-profiles-2026-08-18 - name: user_profile_id in: path required: true @@ -669,32 +691,98 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 components: schemas: BetaCreateUserProfileRequest: type: object properties: external_id: - description: Platform's own identifier for this user. Not enforced unique. Maximum 255 characters. + description: Platform's own identifier for this user. Not enforced unique. Maximum 255 characters. Accepted under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` send `external_user_details.reference_id` instead. + x-anthropic-beta-required: + - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + examples: + - user_12345 + nullable: true type: string minLength: 1 maxLength: 255 - nullable: true - examples: - - user_12345 name: - description: Display name of the entity this profile represents. Required when relationship is `resold` (the resold-to company's name); optional otherwise. Maximum 255 characters. + description: Optional for all profiles. Real-world name of the entity this profile represents (company or individual); for a company the platform resells Claude access to (`access_type` `passthrough`), that company's name where known. Maximum 255 characters. + nullable: true type: string minLength: 1 maxLength: 255 - nullable: true - relationship: - description: "How the entity relates to the platform. `external` (default): an individual end-user. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage." + access_type: + description: "How the platform uses the API for this entity. `application` (default): the profile represents an individual end-user of the platform's product. `passthrough`: the profile identifies a company the platform resells Claude access to." + x-anthropic-beta-required: + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 type: string enum: - - external - - resold - - internal + - application + - passthrough + external_user_onboarded_at: + description: "When the entity this profile represents opened its account with the platform, in RFC 3339 format: for an `application` profile, when the end-user signed up; for a `passthrough` profile, when the company became the platform's customer. Must be a complete timestamp no more than 1 minute in the future. Optional. Accepted under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` send `external_user_details.onboarded_at` instead." + x-anthropic-beta-required: + - user-profiles-2026-08-18 + examples: + - "2024-11-02T08:15:00Z" + type: string + format: date-time + external_user_details: + description: Details about the entity this profile represents, as the platform states them. Every field is optional. Accepted under the `user-profiles-2026-09-04` beta header only. + x-anthropic-beta-required: + - user-profiles-2026-09-04 + type: object + properties: + reference_id: + description: The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters. + nullable: true + type: string + minLength: 1 + maxLength: 255 + onboarded_at: + description: "When the entity opened its account with the platform, in RFC 3339 format: for an `application` profile, when the end-user signed up; for a `passthrough` profile, when the company became the platform's customer. Must be a complete timestamp no more than 1 minute in the future." + type: string + format: date-time + account_status: + description: "The status of the entity's account on the platform: `active`, `suspended` or `blocked`." + nullable: true + type: string + enum: + - active + - suspended + - blocked + entity_type: + description: "What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`." + nullable: true + type: string + enum: + - individual + - business + - non_profit + - government + country: + description: "The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked." + nullable: true + type: string + name_hash: + description: A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters. + nullable: true + type: string + minLength: 1 + maxLength: 255 + email_hash: + description: A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters. + nullable: true + type: string + minLength: 1 + maxLength: 255 metadata: description: Free-form key-value data to attach to this user profile. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. Values must be non-empty strings. type: object @@ -702,13 +790,13 @@ components: - {} example: external_id: user_12345 + external_user_onboarded_at: "2024-11-02T08:15:00Z" metadata: {} BetaUserProfile: type: object required: - id - type - - relationship - trust_grants - created_at - metadata @@ -727,26 +815,92 @@ components: examples: - user_profile external_id: - description: Platform's own identifier for this user. Not enforced unique. - type: string - nullable: true + description: Platform's own identifier for this user. Not enforced unique. Present under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` the value is `external_user_details.reference_id`. + x-anthropic-beta-required: + - user-profiles-2026-03-24 + - user-profiles-2026-08-18 examples: - user_12345 - name: - description: Display name of the entity this profile represents. For `resold` this is the resold-to company's name. - type: string nullable: true + type: string + name: + description: Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. examples: - Example User - relationship: - description: How the entity relates to the platform. `external` (default), `resold`, or `internal`. + nullable: true + type: string + access_type: + description: "How the platform uses the API for this entity: `application` (default) or `passthrough`. Present under the `user-profiles-2026-08-18` and later beta headers." + x-anthropic-beta-required: + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 examples: - - external + - application type: string enum: - - external - - resold - - internal + - application + - passthrough + external_user_onboarded_at: + description: When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Present under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` the value is `external_user_details.onboarded_at`. + x-anthropic-beta-required: + - user-profiles-2026-08-18 + examples: + - "2024-11-02T08:15:00Z" + nullable: true + type: string + format: date-time + external_user_details: + description: Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Present under the `user-profiles-2026-09-04` beta header, with every field present and `null` until the platform supplies a value; the earlier beta headers serve `reference_id` as the top-level `external_id`, and `user-profiles-2026-08-18` serves `onboarded_at` as `external_user_onboarded_at`. + x-anthropic-beta-required: + - user-profiles-2026-09-04 + type: object + required: + - reference_id + - onboarded_at + - account_status + - entity_type + - country + - name_hash + - email_hash + properties: + reference_id: + description: The platform's own reference for the entity. `null` until the platform supplies one. + nullable: true + type: string + onboarded_at: + description: When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. + nullable: true + type: string + format: date-time + account_status: + description: "The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one." + nullable: true + type: string + enum: + - active + - suspended + - blocked + entity_type: + description: "What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one." + nullable: true + type: string + enum: + - individual + - business + - non_profit + - government + country: + description: The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. + nullable: true + type: string + name_hash: + description: The platform-computed hash of the entity's name. `null` until the platform supplies one. + nullable: true + type: string + email_hash: + description: The platform-computed hash of the entity's email address. `null` until the platform supplies one. + nullable: true + type: string trust_grants: description: Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. type: object @@ -775,10 +929,11 @@ components: type: user_profile external_id: user_12345 name: Example User - relationship: external + access_type: application trust_grants: cyber: status: active + external_user_onboarded_at: "2024-11-02T08:15:00Z" metadata: {} created_at: "2026-03-15T10:00:00Z" updated_at: "2026-03-15T10:00:00Z" @@ -855,13 +1010,29 @@ components: - fast-mode-2026-02-01 - output-300k-2026-03-24 - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 - advisor-tool-2026-03-01 - managed-agents-2026-04-01 - cache-diagnosis-2026-04-07 + - dreaming-2026-04-21 - thinking-token-count-2026-05-13 - server-side-fallback-2026-06-01 + - server-side-fallback-2026-07-01 - fallback-credit-2026-06-01 + - fallback-credit-2026-07-01 - agent-memory-2026-07-22 + - mid-conversation-tool-changes-2026-07-01 + - compact-2026-01-12 + - computer-use-2025-11-24 + - mcp-tunnels-2026-06-22 + - structured-outputs-2025-11-13 + - task-budgets-2026-03-13 + - thinking-display-updates-2026-08-18 + - ce-user-management-2026-07-13 + - mid-conversation-output-config-2026-07-01 + - thinking-binding-controls-2026-08-01 + - mid-conversation-system-clear-at-2026-08-21 x-stainless-nominal: false BetaUserProfileListOrder: type: string @@ -869,6 +1040,12 @@ components: enum: - asc - desc + BetaUserProfileListOrderBy: + type: string + description: "Sort field for listing user profiles: `created_at` (default) or `name` (case-insensitive; profiles without a name sort last)." + enum: + - created_at + - name BetaListUserProfilesResponse: type: object required: @@ -885,29 +1062,31 @@ components: type: user_profile external_id: user_12345 name: Example User - relationship: external + access_type: application trust_grants: cyber: status: active + external_user_onboarded_at: "2024-11-02T08:15:00Z" metadata: {} created_at: "2026-03-15T10:00:00Z" updated_at: "2026-03-15T10:00:00Z" next_page: description: Cursor for the next page, or `null` when there are no more results. - type: string - nullable: true examples: - page_MjAyNS0wNS0xNFQwMDowMDowMFo= + nullable: true + type: string example: data: - id: uprof_011CZkZCu8hGbp5mYRQgUmz9 type: user_profile external_id: user_12345 name: Example User - relationship: external + access_type: application trust_grants: cyber: status: active + external_user_onboarded_at: "2024-11-02T08:15:00Z" metadata: {} created_at: "2026-03-15T10:00:00Z" updated_at: "2026-03-15T10:00:00Z" @@ -916,30 +1095,90 @@ components: type: object properties: external_id: - description: If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. + description: If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. Accepted under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; under `user-profiles-2026-09-04` send `external_user_details.reference_id` instead. + x-anthropic-beta-required: + - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + examples: + - user_12345 + nullable: true type: string minLength: 1 maxLength: 255 - nullable: true - examples: - - user_12345 metadata: description: Key-value pairs to merge into the stored metadata. Keys provided overwrite existing values. To remove a key, set its value to an empty string. Keys not provided are left unchanged. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. type: object name: description: If present, replaces the stored name. Omit to leave unchanged. Maximum 255 characters. + nullable: true type: string minLength: 1 maxLength: 255 - nullable: true - relationship: - description: If present, replaces the stored relationship. Omit to leave unchanged. + access_type: + description: If present, replaces the stored access type. Omit to leave unchanged. + x-anthropic-beta-required: + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 nullable: true type: string enum: - - external - - resold - - internal + - application + - passthrough + external_user_onboarded_at: + description: If present, replaces the stored account creation time. Omit to leave unchanged; once set, the value cannot be cleared and `null` is rejected. Must be a complete RFC 3339 timestamp no more than 1 minute in the future. Accepted under the `user-profiles-2026-08-18` beta header; under `user-profiles-2026-09-04` send `external_user_details.onboarded_at` instead. + x-anthropic-beta-required: + - user-profiles-2026-08-18 + type: string + format: date-time + external_user_details: + description: Details about the entity this profile represents, as the platform states them. Each field sent replaces the stored value; omit a field to leave it unchanged. Once set, a value cannot be cleared and `null` is rejected. Accepted under the `user-profiles-2026-09-04` beta header only. + x-anthropic-beta-required: + - user-profiles-2026-09-04 + type: object + properties: + reference_id: + description: The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters. + nullable: true + type: string + minLength: 1 + maxLength: 255 + onboarded_at: + description: "When the entity opened its account with the platform, in RFC 3339 format: for an `application` profile, when the end-user signed up; for a `passthrough` profile, when the company became the platform's customer. Must be a complete timestamp no more than 1 minute in the future." + type: string + format: date-time + account_status: + description: "The status of the entity's account on the platform: `active`, `suspended` or `blocked`." + nullable: true + type: string + enum: + - active + - suspended + - blocked + entity_type: + description: "What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`." + nullable: true + type: string + enum: + - individual + - business + - non_profit + - government + country: + description: "The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked." + nullable: true + type: string + name_hash: + description: A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters. + nullable: true + type: string + minLength: 1 + maxLength: 255 + email_hash: + description: A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters. + nullable: true + type: string + minLength: 1 + maxLength: 255 example: external_id: user_12345 BetaEnrollmentUrl: @@ -971,13 +1210,112 @@ components: type: enrollment_url url: https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1 expires_at: "2026-03-15T10:15:00Z" - BetaUserProfileRelationship: + BetaUserProfileAccessType: type: string - description: "How the entity behind a user profile relates to the platform that owns the API key. `external`: an individual end-user of the platform. `resold`: a company the platform resells Claude access to. `internal`: the platform's own usage." + description: "How the platform uses the API on behalf of the entity this profile represents. `application`: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. `passthrough`: the platform resells raw inference, and the profile identifies the resold-to company." enum: - - external - - resold - - internal + - application + - passthrough + BetaTimestamp: + description: A timestamp in RFC 3339 format + type: string + format: date-time + BetaUserProfileExternalUserDetailsParams: + type: object + properties: + reference_id: + description: The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters. + nullable: true + type: string + minLength: 1 + maxLength: 255 + onboarded_at: + description: "When the entity opened its account with the platform, in RFC 3339 format: for an `application` profile, when the end-user signed up; for a `passthrough` profile, when the company became the platform's customer. Must be a complete timestamp no more than 1 minute in the future." + type: string + format: date-time + account_status: + description: "The status of the entity's account on the platform: `active`, `suspended` or `blocked`." + nullable: true + type: string + enum: + - active + - suspended + - blocked + entity_type: + description: "What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`." + nullable: true + type: string + enum: + - individual + - business + - non_profit + - government + country: + description: "The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked." + nullable: true + type: string + name_hash: + description: A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters. + nullable: true + type: string + minLength: 1 + maxLength: 255 + email_hash: + description: A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters. + nullable: true + type: string + minLength: 1 + maxLength: 255 + BetaUserProfileExternalUserDetails: + description: Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value. + type: object + required: + - reference_id + - onboarded_at + - account_status + - entity_type + - country + - name_hash + - email_hash + properties: + reference_id: + description: The platform's own reference for the entity. `null` until the platform supplies one. + nullable: true + type: string + onboarded_at: + description: When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. + nullable: true + type: string + format: date-time + account_status: + description: "The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one." + nullable: true + type: string + enum: + - active + - suspended + - blocked + entity_type: + description: "What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one." + nullable: true + type: string + enum: + - individual + - business + - non_profit + - government + country: + description: The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. + nullable: true + type: string + name_hash: + description: The platform-computed hash of the entity's name. `null` until the platform supplies one. + nullable: true + type: string + email_hash: + description: The platform-computed hash of the entity's email address. `null` until the platform supplies one. + nullable: true + type: string BetaUserProfileTrustGrant: type: object required: @@ -994,10 +1332,6 @@ components: - active example: status: active - BetaTimestamp: - description: A timestamp in RFC 3339 format - type: string - format: date-time BetaInvalidRequestError: properties: message: @@ -1151,6 +1485,21 @@ components: - type title: OverloadedError type: object + BetaUserProfileExternalUserAccountStatus: + type: string + description: "The status of the entity's account on the platform, as the platform states it: `active`; `suspended`, when the platform has restricted the account and may restore it; or `blocked`, when the platform has barred it. It records the platform's decision only; the statuses in `trust_grants` are Anthropic's and do not follow it." + enum: + - active + - suspended + - blocked + BetaUserProfileExternalUserEntityType: + type: string + description: "What kind of entity the profile represents, as the platform states it: `individual`, `business`, `non_profit` or `government`." + enum: + - individual + - business + - non_profit + - government StackqlExecResult: type: object description: Synthetic dispatch-result envelope for EXEC-only methods (see post-pass step 3). diff --git a/providers/src/anthropic/v00.00.00000/services/vaults.yaml b/providers/src/anthropic/v00.00.00000/services/vaults.yaml index 800393be..4750887c 100644 --- a/providers/src/anthropic/v00.00.00000/services/vaults.yaml +++ b/providers/src/anthropic/v00.00.00000/services/vaults.yaml @@ -111,6 +111,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 parameters: - name: anthropic-version in: header @@ -131,6 +133,17 @@ paths: items: $ref: "#/components/schemas/AnthropicBeta" default: managed-agents-2026-04-01 + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy get: operationId: BetaListVaults summary: List Vaults @@ -178,6 +191,17 @@ paths: schema: type: boolean description: Whether to include archived vaults in the results. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -275,6 +299,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/vaults/{vault_id}?beta=true: get: operationId: BetaGetVault @@ -311,6 +337,17 @@ paths: type: string description: Path parameter vault_id example: vlt_011CZkZDLs7fYzm1hXNPeRjv + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -408,6 +445,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 post: operationId: BetaUpdateVault summary: Update Vault @@ -439,6 +478,17 @@ paths: x-stainless-cli-data-alias: id description: Path parameter vault_id example: vlt_011CZkZDLs7fYzm1hXNPeRjv + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -542,6 +592,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 delete: operationId: BetaDeleteVault summary: Delete Vault @@ -577,6 +629,17 @@ paths: type: string description: Path parameter vault_id example: vlt_011CZkZDLs7fYzm1hXNPeRjv + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -674,6 +737,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/vaults/{vault_id}/archive?beta=true: post: operationId: BetaArchiveVault @@ -705,6 +770,17 @@ paths: type: string description: Path parameter vault_id example: vlt_011CZkZDLs7fYzm1hXNPeRjv + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -802,6 +878,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/vaults/{vault_id}/credentials?beta=true: post: operationId: BetaCreateCredential @@ -833,6 +911,17 @@ paths: type: string description: Path parameter vault_id example: vlt_011CZkZDLs7fYzm1hXNPeRjv + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -936,6 +1025,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 get: operationId: BetaListCredentials summary: List Credentials @@ -990,6 +1081,17 @@ paths: schema: type: boolean description: Whether to include archived credentials in the results. + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1087,6 +1189,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/vaults/{vault_id}/credentials/{credential_id}?beta=true: get: operationId: BetaGetCredential @@ -1130,6 +1234,17 @@ paths: type: string description: Path parameter credential_id example: vcrd_011CZkZEMt8gZan2iYOQfSkw + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1227,6 +1342,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 post: operationId: BetaUpdateCredential summary: Update Credential @@ -1265,6 +1382,17 @@ paths: x-stainless-cli-data-alias: id description: Path parameter credential_id example: vcrd_011CZkZEMt8gZan2iYOQfSkw + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy requestBody: required: true content: @@ -1368,6 +1496,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 delete: operationId: BetaDeleteCredential summary: Delete Credential @@ -1410,6 +1540,17 @@ paths: type: string description: Path parameter credential_id example: vcrd_011CZkZEMt8gZan2iYOQfSkw + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1507,6 +1648,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/vaults/{vault_id}/credentials/{credential_id}/archive?beta=true: post: operationId: BetaArchiveCredential @@ -1545,6 +1688,17 @@ paths: type: string description: Path parameter credential_id example: vcrd_011CZkZEMt8gZan2iYOQfSkw + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1642,6 +1796,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 /v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate?beta=true: post: operationId: BetaValidateCredential @@ -1680,6 +1836,17 @@ paths: type: string description: Path parameter credential_id example: vcrd_011CZkZEMt8gZan2iYOQfSkw + - name: anthropic-workspace-id + in: header + required: false + schema: + type: string + x-stainless-param: workspace_id + description: |- + Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). + + Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. + example: wrkspc_011CZkZaBF1tNoB5wlCeusgy responses: "200": description: Successful response (OK) @@ -1777,6 +1944,8 @@ paths: application/json: schema: $ref: "#/components/schemas/BetaErrorResponse" + x-anthropic-beta-required: + - managed-agents-2026-04-01 components: schemas: BetaManagedAgentsCreateVaultRequest: @@ -1844,9 +2013,9 @@ components: - "2026-03-15T10:00:00Z" archived_at: description: When the vault was archived. Null if not archived. - nullable: true examples: - null + nullable: true type: string format: date-time example: @@ -1931,13 +2100,29 @@ components: - fast-mode-2026-02-01 - output-300k-2026-03-24 - user-profiles-2026-03-24 + - user-profiles-2026-08-18 + - user-profiles-2026-09-04 - advisor-tool-2026-03-01 - managed-agents-2026-04-01 - cache-diagnosis-2026-04-07 + - dreaming-2026-04-21 - thinking-token-count-2026-05-13 - server-side-fallback-2026-06-01 + - server-side-fallback-2026-07-01 - fallback-credit-2026-06-01 + - fallback-credit-2026-07-01 - agent-memory-2026-07-22 + - mid-conversation-tool-changes-2026-07-01 + - compact-2026-01-12 + - computer-use-2025-11-24 + - mcp-tunnels-2026-06-22 + - structured-outputs-2025-11-13 + - task-budgets-2026-03-13 + - thinking-display-updates-2026-08-18 + - ce-user-management-2026-07-13 + - mid-conversation-output-config-2026-07-01 + - thinking-binding-controls-2026-08-01 + - mid-conversation-system-clear-at-2026-08-21 x-stainless-nominal: false BetaManagedAgentsListVaultsResponse: description: Response containing a paginated list of vaults. @@ -1959,10 +2144,10 @@ components: archived_at: null next_page: description: Pagination token for the next page, or null if no more results. - type: string - nullable: true examples: - page_MjAyNS0wNS0xNFQwMDowMDowMFo= + nullable: true + type: string example: data: - type: vault @@ -1979,18 +2164,18 @@ components: properties: display_name: description: Updated human-readable name for the vault. 1-255 characters. + examples: + - Example vault + nullable: true type: string minLength: 1 maxLength: 255 - nullable: true - examples: - - Example vault metadata: description: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omitted keys are preserved. - type: object - nullable: true examples: - environment: production + nullable: true + type: object example: display_name: Example vault metadata: @@ -2062,8 +2247,10 @@ components: minLength: 1 maxLength: 8192 expires_at: - $ref: "#/components/schemas/BetaTimestamp" nullable: true + description: A timestamp in RFC 3339 format + type: string + format: date-time refresh: description: Refresh token configuration, if the credential supports token refresh. nullable: true @@ -2078,7 +2265,7 @@ components: description: OAuth refresh token. type: string minLength: 1 - maxLength: 4096 + maxLength: 8192 token_endpoint: description: Token endpoint URL used to refresh the access token. type: string @@ -2091,16 +2278,16 @@ components: maxLength: 1024 scope: description: OAuth scope for the refresh request. + nullable: true type: string minLength: 1 maxLength: 8192 - nullable: true resource: description: OAuth resource indicator. + nullable: true type: string minLength: 1 maxLength: 2047 - nullable: true token_endpoint_auth: type: object discriminator: @@ -2163,6 +2350,8 @@ components: type: string injection_location: description: Where in the outbound request the secret value may be substituted. + x-anthropic-beta-required: + - managed-agents-2026-04-01 type: object properties: header: @@ -2173,11 +2362,11 @@ components: type: boolean display_name: description: Human-readable name for the credential. Up to 255 characters. - type: string - maxLength: 255 - nullable: true examples: - Example credential + nullable: true + type: string + maxLength: 255 metadata: description: Arbitrary key-value metadata to attach to the credential. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. type: object @@ -2222,10 +2411,10 @@ components: - vlt_011CZkZDLs7fYzm1hXNPeRjv display_name: description: Human-readable name for the credential. - type: string - nullable: true examples: - Example credential + nullable: true + type: string metadata: description: Arbitrary key-value metadata attached to the credential. type: object @@ -2241,9 +2430,9 @@ components: - "2026-03-15T10:00:00Z" archived_at: description: When the credential was archived. Null if not archived. - nullable: true examples: - null + nullable: true type: string format: date-time auth: @@ -2276,8 +2465,10 @@ components: description: URL of the MCP server this credential authenticates against. type: string expires_at: - $ref: "#/components/schemas/BetaTimestamp" nullable: true + description: A timestamp in RFC 3339 format + type: string + format: date-time refresh: description: Refresh token configuration, if the credential supports token refresh. nullable: true @@ -2295,12 +2486,12 @@ components: type: string resource: description: OAuth resource indicator. - type: string nullable: true + type: string scope: description: OAuth scope for the refresh request. - type: string nullable: true + type: string token_endpoint_auth: type: object discriminator: @@ -2343,6 +2534,8 @@ components: type: string injection_location: description: Where in the outbound request the secret value is substituted. + x-anthropic-beta-required: + - managed-agents-2026-04-01 type: object required: - header @@ -2391,10 +2584,10 @@ components: mcp_server_url: https://example-server.modelcontextprotocol.io/sse next_page: description: Pagination token for the next page, or null if no more results. - type: string - nullable: true examples: - page_MjAyNS0wNS0xNFQwMDowMDowMFo= + nullable: true + type: string example: data: - type: vault_credential @@ -2415,18 +2608,18 @@ components: properties: display_name: description: Updated human-readable name for the credential. 1-255 characters. + examples: + - Example credential + nullable: true type: string minLength: 1 maxLength: 255 - nullable: true - examples: - - Example credential metadata: description: Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omitted keys are preserved. - type: object - nullable: true examples: - environment: production + nullable: true + type: object auth: description: Updated authentication configuration. The `type` is immutable; the variant sent must match the stored credential's type. type: object @@ -2445,13 +2638,15 @@ components: - mcp_oauth access_token: description: Updated OAuth access token. + nullable: true type: string minLength: 1 maxLength: 8192 - nullable: true expires_at: - $ref: "#/components/schemas/BetaTimestamp" nullable: true + description: A timestamp in RFC 3339 format + type: string + format: date-time refresh: description: Updated refresh token configuration. nullable: true @@ -2459,15 +2654,15 @@ components: properties: refresh_token: description: Updated OAuth refresh token. + nullable: true type: string minLength: 1 - maxLength: 4096 - nullable: true + maxLength: 8192 scope: description: Updated OAuth scope for the refresh request. + nullable: true type: string maxLength: 8192 - nullable: true token_endpoint_auth: type: object discriminator: @@ -2485,22 +2680,22 @@ components: - client_secret_basic client_secret: description: Updated OAuth client secret. + nullable: true type: string minLength: 1 maxLength: 512 - nullable: true token: description: Updated static bearer token value. + nullable: true type: string minLength: 1 maxLength: 8192 - nullable: true secret_value: description: Updated secret value. + nullable: true type: string minLength: 1 maxLength: 4096 - nullable: true networking: description: Updated networking scope. Full replacement. nullable: true @@ -2525,6 +2720,8 @@ components: type: string injection_location: description: Updated injection location. + x-anthropic-beta-required: + - managed-agents-2026-04-01 type: object properties: header: @@ -2609,9 +2806,9 @@ components: - true mcp_probe: description: Details of the failing MCP probe step. Null when the probe succeeded. - nullable: true examples: - null + nullable: true type: object required: - method @@ -2645,9 +2842,9 @@ components: type: boolean refresh: description: Details of the refresh-token exchange attempted on a 401. Null when no refresh was attempted. - nullable: true examples: - null + nullable: true type: object required: - status @@ -2887,8 +3084,10 @@ components: minLength: 1 maxLength: 8192 expires_at: - $ref: "#/components/schemas/BetaTimestamp" nullable: true + description: A timestamp in RFC 3339 format + type: string + format: date-time refresh: description: Refresh token configuration, if the credential supports token refresh. nullable: true @@ -2903,7 +3102,7 @@ components: description: OAuth refresh token. type: string minLength: 1 - maxLength: 4096 + maxLength: 8192 token_endpoint: description: Token endpoint URL used to refresh the access token. type: string @@ -2916,16 +3115,16 @@ components: maxLength: 1024 scope: description: OAuth scope for the refresh request. + nullable: true type: string minLength: 1 maxLength: 8192 - nullable: true resource: description: OAuth resource indicator. + nullable: true type: string minLength: 1 maxLength: 2047 - nullable: true token_endpoint_auth: type: object discriminator: @@ -2988,6 +3187,8 @@ components: type: string injection_location: description: Where in the outbound request the secret value may be substituted. + x-anthropic-beta-required: + - managed-agents-2026-04-01 type: object properties: header: @@ -3023,8 +3224,10 @@ components: description: URL of the MCP server this credential authenticates against. type: string expires_at: - $ref: "#/components/schemas/BetaTimestamp" nullable: true + description: A timestamp in RFC 3339 format + type: string + format: date-time refresh: description: Refresh token configuration, if the credential supports token refresh. nullable: true @@ -3042,12 +3245,12 @@ components: type: string resource: description: OAuth resource indicator. - type: string nullable: true + type: string scope: description: OAuth scope for the refresh request. - type: string nullable: true + type: string token_endpoint_auth: type: object discriminator: @@ -3090,6 +3293,8 @@ components: type: string injection_location: description: Where in the outbound request the secret value is substituted. + x-anthropic-beta-required: + - managed-agents-2026-04-01 type: object required: - header @@ -3119,13 +3324,15 @@ components: - mcp_oauth access_token: description: Updated OAuth access token. + nullable: true type: string minLength: 1 maxLength: 8192 - nullable: true expires_at: - $ref: "#/components/schemas/BetaTimestamp" nullable: true + description: A timestamp in RFC 3339 format + type: string + format: date-time refresh: description: Updated refresh token configuration. nullable: true @@ -3133,15 +3340,15 @@ components: properties: refresh_token: description: Updated OAuth refresh token. + nullable: true type: string minLength: 1 - maxLength: 4096 - nullable: true + maxLength: 8192 scope: description: Updated OAuth scope for the refresh request. + nullable: true type: string maxLength: 8192 - nullable: true token_endpoint_auth: type: object discriminator: @@ -3159,22 +3366,22 @@ components: - client_secret_basic client_secret: description: Updated OAuth client secret. + nullable: true type: string minLength: 1 maxLength: 512 - nullable: true token: description: Updated static bearer token value. + nullable: true type: string minLength: 1 maxLength: 8192 - nullable: true secret_value: description: Updated secret value. + nullable: true type: string minLength: 1 maxLength: 4096 - nullable: true networking: description: Updated networking scope. Full replacement. nullable: true @@ -3199,6 +3406,8 @@ components: type: string injection_location: description: Updated injection location. + x-anthropic-beta-required: + - managed-agents-2026-04-01 type: object properties: header: @@ -3308,8 +3517,10 @@ components: minLength: 1 maxLength: 8192 expires_at: - $ref: "#/components/schemas/BetaTimestamp" nullable: true + description: A timestamp in RFC 3339 format + type: string + format: date-time refresh: description: Refresh token configuration, if the credential supports token refresh. nullable: true @@ -3324,7 +3535,7 @@ components: description: OAuth refresh token. type: string minLength: 1 - maxLength: 4096 + maxLength: 8192 token_endpoint: description: Token endpoint URL used to refresh the access token. type: string @@ -3337,16 +3548,16 @@ components: maxLength: 1024 scope: description: OAuth scope for the refresh request. + nullable: true type: string minLength: 1 maxLength: 8192 - nullable: true resource: description: OAuth resource indicator. + nullable: true type: string minLength: 1 maxLength: 2047 - nullable: true token_endpoint_auth: type: object discriminator: @@ -3447,6 +3658,8 @@ components: type: string injection_location: description: Where in the outbound request the secret value may be substituted. + x-anthropic-beta-required: + - managed-agents-2026-04-01 type: object properties: header: @@ -3470,8 +3683,10 @@ components: description: URL of the MCP server this credential authenticates against. type: string expires_at: - $ref: "#/components/schemas/BetaTimestamp" nullable: true + description: A timestamp in RFC 3339 format + type: string + format: date-time refresh: description: Refresh token configuration, if the credential supports token refresh. nullable: true @@ -3489,12 +3704,12 @@ components: type: string resource: description: OAuth resource indicator. - type: string nullable: true + type: string scope: description: OAuth scope for the refresh request. - type: string nullable: true + type: string token_endpoint_auth: type: object discriminator: @@ -3571,6 +3786,8 @@ components: type: string injection_location: description: Where in the outbound request the secret value is substituted. + x-anthropic-beta-required: + - managed-agents-2026-04-01 type: object required: - header @@ -3594,13 +3811,15 @@ components: - mcp_oauth access_token: description: Updated OAuth access token. + nullable: true type: string minLength: 1 maxLength: 8192 - nullable: true expires_at: - $ref: "#/components/schemas/BetaTimestamp" nullable: true + description: A timestamp in RFC 3339 format + type: string + format: date-time refresh: description: Updated refresh token configuration. nullable: true @@ -3608,15 +3827,15 @@ components: properties: refresh_token: description: Updated OAuth refresh token. + nullable: true type: string minLength: 1 - maxLength: 4096 - nullable: true + maxLength: 8192 scope: description: Updated OAuth scope for the refresh request. + nullable: true type: string maxLength: 8192 - nullable: true token_endpoint_auth: type: object discriminator: @@ -3634,10 +3853,10 @@ components: - client_secret_basic client_secret: description: Updated OAuth client secret. + nullable: true type: string minLength: 1 maxLength: 512 - nullable: true BetaManagedAgentsStaticBearerUpdateParams: description: Parameters for updating a static bearer token credential. The `mcp_server_url` is immutable. type: object @@ -3650,10 +3869,10 @@ components: - static_bearer token: description: Updated static bearer token value. + nullable: true type: string minLength: 1 maxLength: 8192 - nullable: true BetaManagedAgentsEnvironmentVariableUpdateParams: description: Parameters for updating an environment variable credential. `secret_name` is immutable. type: object @@ -3666,10 +3885,10 @@ components: - environment_variable secret_value: description: Updated secret value. + nullable: true type: string minLength: 1 maxLength: 4096 - nullable: true networking: description: Updated networking scope. Full replacement. nullable: true @@ -3694,6 +3913,8 @@ components: type: string injection_location: description: Updated injection location. + x-anthropic-beta-required: + - managed-agents-2026-04-01 type: object properties: header: @@ -3745,7 +3966,7 @@ components: description: OAuth refresh token. type: string minLength: 1 - maxLength: 4096 + maxLength: 8192 token_endpoint: description: Token endpoint URL used to refresh the access token. type: string @@ -3758,16 +3979,16 @@ components: maxLength: 1024 scope: description: OAuth scope for the refresh request. + nullable: true type: string minLength: 1 maxLength: 8192 - nullable: true resource: description: OAuth resource indicator. + nullable: true type: string minLength: 1 maxLength: 2047 - nullable: true token_endpoint_auth: type: object discriminator: @@ -3837,12 +4058,12 @@ components: type: string resource: description: OAuth resource indicator. - type: string nullable: true + type: string scope: description: OAuth scope for the refresh request. - type: string nullable: true + type: string token_endpoint_auth: type: object discriminator: @@ -3899,15 +4120,15 @@ components: properties: refresh_token: description: Updated OAuth refresh token. + nullable: true type: string minLength: 1 - maxLength: 4096 - nullable: true + maxLength: 8192 scope: description: Updated OAuth scope for the refresh request. + nullable: true type: string maxLength: 8192 - nullable: true token_endpoint_auth: type: object discriminator: @@ -3925,10 +4146,10 @@ components: - client_secret_basic client_secret: description: Updated OAuth client secret. + nullable: true type: string minLength: 1 maxLength: 512 - nullable: true BetaManagedAgentsInjectionLocationUpdateParams: description: Updated injection location. type: object @@ -4075,10 +4296,10 @@ components: - client_secret_basic client_secret: description: Updated OAuth client secret. + nullable: true type: string minLength: 1 maxLength: 512 - nullable: true BetaManagedAgentsTokenEndpointAuthPostUpdateParam: description: Updated POST body authentication parameters for the token endpoint. type: object @@ -4091,10 +4312,10 @@ components: - client_secret_post client_secret: description: Updated OAuth client secret. + nullable: true type: string minLength: 1 maxLength: 512 - nullable: true StackqlExecResult: type: object description: Synthetic dispatch-result envelope for EXEC-only methods (see post-pass step 3).