--- title: Archive Agent url: https://platform.claude.com/docs/en/api/typescript/beta/agents/archive --- # Archive Agent `client.beta.agents.archive(agentID, params?, options?): BetaManagedAgentsAgent` **POST** `/v1/agents/{agent_id}/archive` Archive Agent ## Parameters - `agentID: string` (path parameter) Unique identifier of the agent to archive. - `params: AgentArchiveParams` - `betas?: Array` (header parameter) Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"user-profiles-2026-08-18"` - `"user-profiles-2026-09-04"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"dreaming-2026-04-21"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"server-side-fallback-2026-07-01"` - `"fallback-credit-2026-06-01"` - `"fallback-credit-2026-07-01"` - `"agent-memory-2026-07-22"` - `"mid-conversation-tool-changes-2026-07-01"` - `"compact-2026-01-12"` - `"computer-use-2025-11-24"` - `"mcp-tunnels-2026-06-22"` - `"structured-outputs-2025-11-13"` - `"task-budgets-2026-03-13"` - `"thinking-display-updates-2026-08-18"` - `"ce-user-management-2026-07-13"` - `"mid-conversation-output-config-2026-07-01"` - `"thinking-binding-controls-2026-08-01"` - `"mid-conversation-system-clear-at-2026-08-21"` - `"compact-2026-09-04"` - `"inline-tools-2026-09-15"` - `"mcp-client-2026-09-15"` - `"ce-plugins-2026-09-01"` - `"spend-limit-reads-2026-09-26"` - `workspace_id?: string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ## Returns - `interface BetaManagedAgentsAgent` A Managed Agents `agent`. - `type: "agent"` - `id: string` - `archived_at: string | null` When the agent was archived. Null if not archived. format: date-time - `created_at: string` A timestamp in RFC 3339 format format: date-time - `description: string | null` - `mcp_servers: Array` - `type: "url"` - `name: string` - `url: string` - `metadata: Record` - `model: BetaManagedAgentsModelConfig` Model identifier and configuration. - `id: BetaManagedAgentsModel` The model that will power your agent. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `"claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `"claude-sonnet-5-5"` Efficient model for coding and agents - `"claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `"claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `"claude-sonnet-5"` Efficient model for coding and agents - `"claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `"claude-opus-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-6"` Best combination of speed and intelligence - `"claude-haiku-4-5"` - `"claude-haiku-4-5-20251001"` - `"claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `"claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `"claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `"claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `(string & {})` - `effort?: BetaManagedAgentsEffortLow | BetaManagedAgentsEffortMedium | BetaManagedAgentsEffortHigh | 2 more` How hard Claude works on each inference call. One of `low`, `medium`, `high`, `xhigh`, `max`. Always present; resolved to the per-model default at save time when not supplied. - `interface BetaManagedAgentsEffortLow` Low effort. Favors latency over reasoning depth. - `type: "low"` - `interface BetaManagedAgentsEffortMedium` Medium effort. Balances latency and reasoning depth. - `type: "medium"` - `interface BetaManagedAgentsEffortHigh` High effort. Favors reasoning depth. - `type: "high"` - `interface BetaManagedAgentsEffortXhigh` Extra-high effort. Not all models accept this level. - `type: "xhigh"` - `interface BetaManagedAgentsEffortMax` Maximum effort. Favors reasoning depth over latency. - `type: "max"` - `inference_geo?: string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo. - `speed?: "standard" | "fast"` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Defaults to `standard`. Not all models support `fast`; invalid combinations are rejected at create time. - `"standard"` - `"fast"` - `multiagent: BetaManagedAgentsMultiagent | null` Multiagent orchestration configuration. Null when the agent is single-threaded. - `interface BetaManagedAgentsMultiagentCoordinator` Resolved coordinator topology with a concrete agent roster. - `type: "coordinator"` - `agents: Array` Agents the coordinator may spawn as session threads, each resolved to a specific version. - `interface BetaManagedAgentsAgentReference` A resolved agent reference with a concrete version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `interface BetaManagedAgentsAdvisor` Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `type: "advisor"` - `model: string` The advisor model id. - `interface BetaManagedAgentsMultiagent20261001` Resolved multiagent configuration with three members, each enabled or disabled on its own. - `type: "multiagent_20261001"` - `advisor: BetaManagedAgentsMultiagentAdvisor` Whether the session's primary thread can consult an advisor model. - `interface BetaManagedAgentsMultiagentAdvisorEnabled` The session's primary thread can consult `model` mid-turn. - `type: "enabled"` - `model: string` The advisor model id. - `interface BetaManagedAgentsMultiagentAdvisorDisabled` The agent has no advisor. - `type: "disabled"` - `subagents: BetaManagedAgentsMultiagentSubagents` Whether the agent can spawn session threads. - `interface BetaManagedAgentsMultiagentSubagentsEnabled` The agent can spawn session threads. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether the agent can define inline agents, which are not saved, when it spawns session threads. - `interface BetaManagedAgentsMultiagentInlineAgentsEnabled` The agent can define inline agents. - `type: "enabled"` - `interface BetaManagedAgentsMultiagentInlineAgentsDisabled` The agent cannot define inline agents. - `type: "disabled"` - `predefined_agents: Array` Predefined agents, which are saved agents that this agent can spawn as session threads, each resolved to a specific version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `interface BetaManagedAgentsMultiagentSubagentsDisabled` The agent cannot spawn session threads. - `type: "disabled"` - `workflows: BetaManagedAgentsMultiagentWorkflows` Whether the agent can start workflow runs. - `interface BetaManagedAgentsMultiagentWorkflowsEnabled` The agent can start workflow runs. - `type: "enabled"` - `inline_agents: BetaManagedAgentsMultiagentInlineAgents` Whether a run's plan can define inline agents, which are not saved. - `predefined_agents: Array` Predefined agents, which are saved agents that a run's plan can use, each resolved to a specific version. - `type: "agent"` - `id: string` - `version: number` format: int32 - `interface BetaManagedAgentsMultiagentWorkflowsDisabled` The agent cannot start workflow runs. - `type: "disabled"` - `name: string` - `skills: Array` - `interface BetaManagedAgentsAnthropicSkill` A resolved Anthropic-managed skill. - `type: "anthropic"` - `skill_id: string` - `version: string` - `interface BetaManagedAgentsCustomSkill` A resolved user-created custom skill. - `type: "custom"` - `skill_id: string` - `version: string` - `system: string | null` - `tools: Array` - `interface BetaManagedAgentsAgentToolset20260401` - `type: "agent_toolset_20260401"` - `configs: Array` - `interface BetaManagedAgentsBashToolConfig` Configuration for the bash tool. - `type: "bash"` - `enabled: boolean` - `name: "bash"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy | BetaManagedAgentsAlwaysAskPolicy | BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `interface BetaManagedAgentsAlwaysAllowPolicy` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - `interface BetaManagedAgentsAlwaysAskPolicy` Tool calls require user confirmation before execution. - `type: "always_ask"` - `interface BetaManagedAgentsAutoPolicy` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `type: "auto"` - `interface BetaManagedAgentsEditToolConfig` Configuration for the edit tool. - `type: "edit"` - `enabled: boolean` - `name: "edit"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy | BetaManagedAgentsAlwaysAskPolicy | BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `interface BetaManagedAgentsAlwaysAllowPolicy` Tool calls are automatically approved without user confirmation. - `interface BetaManagedAgentsAlwaysAskPolicy` Tool calls require user confirmation before execution. - `interface BetaManagedAgentsAutoPolicy` 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. - `interface BetaManagedAgentsReadToolConfig` Configuration for the read tool. - `type: "read"` - `enabled: boolean` - `name: "read"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy | BetaManagedAgentsAlwaysAskPolicy | BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `interface BetaManagedAgentsAlwaysAllowPolicy` Tool calls are automatically approved without user confirmation. - `interface BetaManagedAgentsAlwaysAskPolicy` Tool calls require user confirmation before execution. - `interface BetaManagedAgentsAutoPolicy` 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. - `interface BetaManagedAgentsWriteToolConfig` Configuration for the write tool. - `type: "write"` - `enabled: boolean` - `name: "write"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy | BetaManagedAgentsAlwaysAskPolicy | BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `interface BetaManagedAgentsAlwaysAllowPolicy` Tool calls are automatically approved without user confirmation. - `interface BetaManagedAgentsAlwaysAskPolicy` Tool calls require user confirmation before execution. - `interface BetaManagedAgentsAutoPolicy` 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. - `interface BetaManagedAgentsGlobToolConfig` Configuration for the glob tool. - `type: "glob"` - `enabled: boolean` - `name: "glob"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy | BetaManagedAgentsAlwaysAskPolicy | BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `interface BetaManagedAgentsAlwaysAllowPolicy` Tool calls are automatically approved without user confirmation. - `interface BetaManagedAgentsAlwaysAskPolicy` Tool calls require user confirmation before execution. - `interface BetaManagedAgentsAutoPolicy` 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. - `interface BetaManagedAgentsGrepToolConfig` Configuration for the grep tool. - `type: "grep"` - `enabled: boolean` - `name: "grep"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy | BetaManagedAgentsAlwaysAskPolicy | BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `interface BetaManagedAgentsAlwaysAllowPolicy` Tool calls are automatically approved without user confirmation. - `interface BetaManagedAgentsAlwaysAskPolicy` Tool calls require user confirmation before execution. - `interface BetaManagedAgentsAutoPolicy` 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. - `interface BetaManagedAgentsWebFetchToolConfig` Configuration for the web_fetch tool. - `type: "web_fetch"` - `enabled: boolean` - `name: "web_fetch"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy | BetaManagedAgentsAlwaysAskPolicy | BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `interface BetaManagedAgentsAlwaysAllowPolicy` Tool calls are automatically approved without user confirmation. - `interface BetaManagedAgentsAlwaysAskPolicy` Tool calls require user confirmation before execution. - `interface BetaManagedAgentsAutoPolicy` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `url_sources: BetaManagedAgentsWebFetchURLSources | null` Which sources contribute URLs the tool may fetch, always in the object form. Null when not set, which allows every source. - `client_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter | null` Which custom tools' results contribute URLs that may be fetched. Null when not set, which allows every custom tool's results. - `interface BetaManagedAgentsWebFetchURLSourceAll` Every URL from this source may be fetched. This is the default. - `type: "all"` - `interface BetaManagedAgentsWebFetchURLSourceNone` This source contributes no URLs that may be fetched. - `type: "none"` - `interface BetaManagedAgentsWebFetchURLSourceOnly` Only the named tools' results contribute URLs that may be fetched. - `type: "only"` - `tools: Array` The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `interface BetaManagedAgentsWebFetchURLSourceExcept` Every tool's results contribute URLs that may be fetched, except the named tools' results. - `type: "except"` - `tools: Array` The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results. - `type: "tool_reference"` Must be "tool_reference". - `name: string` Name of the tool. Compared exactly, so upper and lower case letters are different. minLength: 1, maxLength: 128 - `server_tool_results: BetaManagedAgentsWebFetchURLSourceToolFilter | null` Which of the web_search and web_fetch tools' results contribute URLs that may be fetched. Null when not set, which allows both. - `user_input: BetaManagedAgentsWebFetchURLSourceUserInput | null` Whether URLs in the text of user messages may be fetched. Null when not set, which allows them. - `interface BetaManagedAgentsWebFetchURLSourceAll` Every URL from this source may be fetched. This is the default. - `interface BetaManagedAgentsWebFetchURLSourceNone` This source contributes no URLs that may be fetched. - `allowed_domains?: Array` - `blocked_domains?: Array` - `max_content_tokens?: number | null` format: int32 - `interface BetaManagedAgentsWebSearchToolConfig` Configuration for the web_search tool. - `type: "web_search"` - `enabled: boolean` - `name: "web_search"` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy | BetaManagedAgentsAlwaysAskPolicy | BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `interface BetaManagedAgentsAlwaysAllowPolicy` Tool calls are automatically approved without user confirmation. - `interface BetaManagedAgentsAlwaysAskPolicy` Tool calls require user confirmation before execution. - `interface BetaManagedAgentsAutoPolicy` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `allowed_domains?: Array` - `blocked_domains?: Array` - `user_location?: BetaManagedAgentsUserLocation | null` Approximate user location for search result localization. - `type: "approximate"` Location precision. Only "approximate" is supported. - `city?: string | null` City name. minLength: 1, maxLength: 255 - `country?: string | null` Two-letter ISO 3166-1 country code, uppercase. - `region?: string | null` Region or state name. minLength: 1, maxLength: 255 - `timezone?: string | null` IANA timezone identifier, e.g. "America/Los_Angeles". minLength: 1, maxLength: 255 - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy | BetaManagedAgentsAlwaysAskPolicy | BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `interface BetaManagedAgentsAlwaysAllowPolicy` Tool calls are automatically approved without user confirmation. - `interface BetaManagedAgentsAlwaysAskPolicy` Tool calls require user confirmation before execution. - `interface BetaManagedAgentsAutoPolicy` 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. - `interface BetaManagedAgentsMCPToolset` - `type: "mcp_toolset"` - `configs: Array` - `enabled: boolean` - `name: string` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy | BetaManagedAgentsAlwaysAskPolicy | BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `interface BetaManagedAgentsAlwaysAllowPolicy` Tool calls are automatically approved without user confirmation. - `interface BetaManagedAgentsAlwaysAskPolicy` Tool calls require user confirmation before execution. - `interface BetaManagedAgentsAutoPolicy` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `default_config: BetaManagedAgentsMCPToolsetDefaultConfig` Resolved default configuration for all tools from an MCP server. - `enabled: boolean` - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy | BetaManagedAgentsAlwaysAskPolicy | BetaManagedAgentsAutoPolicy` Permission policy for tool execution. - `interface BetaManagedAgentsAlwaysAllowPolicy` Tool calls are automatically approved without user confirmation. - `interface BetaManagedAgentsAlwaysAskPolicy` Tool calls require user confirmation before execution. - `interface BetaManagedAgentsAutoPolicy` The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask. - `mcp_server_name: string` - `interface BetaManagedAgentsCustomTool` A custom tool as returned in API responses. - `type: "custom"` - `description: string` - `input_schema: BetaManagedAgentsCustomToolInputSchema` JSON Schema for custom tool input parameters. - `type: "object"` - `properties?: Record | null` - `required?: Array | null` - `name: string` - `updated_at: string` A timestamp in RFC 3339 format format: date-time - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. format: int32 ## Example ```typescript import Anthropic from "@anthropic-ai/sdk"; const client = new Anthropic({ apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted }); const betaManagedAgentsAgent = await client.beta.agents.archive( "agent_011CZkYpogX7uDKUyvBTophP" ); console.log(betaManagedAgentsAgent.id); ``` ### Response (200) ```json { "id": "agent_011CZkYpogX7uDKUyvBTophP", "archived_at": null, "created_at": "2026-03-15T10:00:00Z", "description": "A general-purpose starter agent.", "mcp_servers": [ { "name": "example-mcp", "type": "url", "url": "https://example-server.modelcontextprotocol.io/sse" } ], "metadata": { "foo": "bar" }, "model": { "id": "claude-opus-5", "effort": { "type": "low" }, "inference_geo": "inference_geo", "speed": "standard" }, "multiagent": { "advisor": { "type": "disabled" }, "subagents": { "inline_agents": { "type": "enabled" }, "predefined_agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "enabled" }, "type": "multiagent_20261001", "workflows": { "inline_agents": { "type": "enabled" }, "predefined_agents": [ { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 } ], "type": "enabled" } }, "name": "My First Agent", "skills": [ { "skill_id": "xlsx", "type": "anthropic", "version": "1" }, { "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTmx", "type": "custom", "version": "2" } ], "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.", "tools": [ { "configs": [ { "enabled": true, "name": "bash", "permission_policy": { "type": "always_allow" }, "type": "bash" } ], "default_config": { "enabled": true, "permission_policy": { "type": "always_ask" } }, "type": "agent_toolset_20260401" } ], "type": "agent", "updated_at": "2026-03-15T10:00:00Z", "version": 1 } ```