SPB Git
spboucher.ai

Repository Public

spbdoc-api

archive.md 21.9 KB

# title: Archive Agent url: https://platform.claude.com/docs/en/api/beta/agents/archive

# Archive Agent

POST /v1/agents/{agent_id}/archive

Archive Agent

# Path parameters

  • agent_id: string

# Headers

  • "anthropic-beta": optional array of AnthropicBeta

    Optional header to specify the beta version(s) you want to use.

    • string

    • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more

      • "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"

  • "anthropic-workspace-id": optional string

# Returns

  • BetaManagedAgentsAgent object

    A Managed Agents agent.

    • type: "agent"

    • id: string

    • archived_at: string or null

      A timestamp in RFC 3339 format

      format: date-time

    • created_at: string

      A timestamp in RFC 3339 format

      format: date-time

    • description: string or null

    • mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition

      • type: "url"

      • name: string

      • url: string

    • metadata: map[string]

    • model: BetaManagedAgentsModelConfig

      Model identifier and configuration.

      • id: BetaManagedAgentsModel

        The model that will power your agent.

        See models for additional details and options.

        • "claude-fable-5-1" or "claude-sonnet-5" or "claude-fable-5" or 11 more

          The model that will power your agent.

          See models for additional details and options.

          • "claude-fable-5-1"

            Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows

          • "claude-sonnet-5"

            High-performance model for coding and agents

          • "claude-fable-5"

            Next generation of intelligence for the hardest knowledge work and coding problems

          • "claude-opus-5"

            Powerful intelligence for long-running agents and coding

          • "claude-opus-4-8"

            Powerful intelligence for long-running agents and coding

          • "claude-opus-4-7"

            Powerful intelligence for long-running agents and coding

          • "claude-opus-4-6"

            Powerful intelligence for long-running agents and coding

          • "claude-sonnet-4-6"

            Best combination of speed and intelligence

          • "claude-haiku-4-5"

            Fastest model with near-frontier intelligence

          • "claude-haiku-4-5-20251001"

            Fastest model with near-frontier intelligence

          • "claude-opus-4-5"

            Powerful intelligence for long-running agents and coding

          • "claude-opus-4-5-20251101"

            Powerful intelligence for long-running agents and coding

          • "claude-sonnet-4-5"

            High-performance model for agents and coding

          • "claude-sonnet-4-5-20250929"

            High-performance model for agents and coding

        • string

      • effort: optional BetaManagedAgentsEffortLow or BetaManagedAgentsEffortMedium or BetaManagedAgentsEffortHigh or 2 more

        How hard Claude works on each turn. Sets output_config.effort on every Messages call the session makes.

        • BetaManagedAgentsEffortLow object

          Low effort. Favors latency over reasoning depth.

          • type: "low"

        • BetaManagedAgentsEffortMedium object

          Medium effort. Balances latency and reasoning depth.

          • type: "medium"

        • BetaManagedAgentsEffortHigh object

          High effort. Favors reasoning depth.

          • type: "high"

        • BetaManagedAgentsEffortXhigh object

          Extra-high effort. Not all models accept this level.

          • type: "xhigh"

        • BetaManagedAgentsEffortMax object

          Maximum effort. Favors reasoning depth over latency.

          • type: "max"

      • inference_geo: optional string

        Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo.

      • speed: optional "standard" or "fast"

        Inference speed mode. fast provides significantly faster output token generation at premium pricing. Not all models support fast; invalid combinations are rejected at create time.

        • "standard"

        • "fast"

    • multiagent: BetaManagedAgentsMultiagent or null

      Resolved coordinator topology with a concrete agent roster.

      • type: "coordinator"

      • agents: array of BetaManagedAgentsAgentReference or BetaManagedAgentsAdvisor

        Agents the coordinator may spawn as session threads, each resolved to a specific version.

        • BetaManagedAgentsAgentReference object

          A resolved agent reference with a concrete version.

          • type: "agent"

          • id: string

          • version: number

            format: int32

        • BetaManagedAgentsAdvisor object

          Platform advisor roster entry: a model the session's primary thread may consult mid-turn.

          • type: "advisor"

          • model: string

            The advisor model id.

    • name: string

    • skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill

      • BetaManagedAgentsAnthropicSkill object

        A resolved Anthropic-managed skill.

        • type: "anthropic"

        • skill_id: string

        • version: string

      • BetaManagedAgentsCustomSkill object

        A resolved user-created custom skill.

        • type: "custom"

        • skill_id: string

        • version: string

    • system: string or null

    • tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool

      • BetaManagedAgentsAgentToolset20260401 object

        • type: "agent_toolset_20260401"

        • configs: array of BetaManagedAgentsAgentToolConfig

          • BetaManagedAgentsBashToolConfig object

            Configuration for the bash tool.

            • type: "bash"

            • enabled: boolean

            • name: "bash"

            • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy

              Permission policy for tool execution.

              • BetaManagedAgentsAlwaysAllowPolicy object

                Tool calls are automatically approved without user confirmation.

                • type: "always_allow"

              • BetaManagedAgentsAlwaysAskPolicy object

                Tool calls require user confirmation before execution.

                • type: "always_ask"

              • BetaManagedAgentsAutoPolicy object

                The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.

                • type: "auto"

          • BetaManagedAgentsEditToolConfig object

            Configuration for the edit tool.

            • type: "edit"

            • enabled: boolean

            • name: "edit"

            • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy

              Permission policy for tool execution.

              • BetaManagedAgentsAlwaysAllowPolicy object

                Tool calls are automatically approved without user confirmation.

              • BetaManagedAgentsAlwaysAskPolicy object

                Tool calls require user confirmation before execution.

              • BetaManagedAgentsAutoPolicy object

                The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.

          • BetaManagedAgentsReadToolConfig object

            Configuration for the read tool.

            • type: "read"

            • enabled: boolean

            • name: "read"

            • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy

              Permission policy for tool execution.

              • BetaManagedAgentsAlwaysAllowPolicy object

                Tool calls are automatically approved without user confirmation.

              • BetaManagedAgentsAlwaysAskPolicy object

                Tool calls require user confirmation before execution.

              • BetaManagedAgentsAutoPolicy object

                The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.

          • BetaManagedAgentsWriteToolConfig object

            Configuration for the write tool.

            • type: "write"

            • enabled: boolean

            • name: "write"

            • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy

              Permission policy for tool execution.

              • BetaManagedAgentsAlwaysAllowPolicy object

                Tool calls are automatically approved without user confirmation.

              • BetaManagedAgentsAlwaysAskPolicy object

                Tool calls require user confirmation before execution.

              • BetaManagedAgentsAutoPolicy object

                The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.

          • BetaManagedAgentsGlobToolConfig object

            Configuration for the glob tool.

            • type: "glob"

            • enabled: boolean

            • name: "glob"

            • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy

              Permission policy for tool execution.

              • BetaManagedAgentsAlwaysAllowPolicy object

                Tool calls are automatically approved without user confirmation.

              • BetaManagedAgentsAlwaysAskPolicy object

                Tool calls require user confirmation before execution.

              • BetaManagedAgentsAutoPolicy object

                The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.

          • BetaManagedAgentsGrepToolConfig object

            Configuration for the grep tool.

            • type: "grep"

            • enabled: boolean

            • name: "grep"

            • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy

              Permission policy for tool execution.

              • BetaManagedAgentsAlwaysAllowPolicy object

                Tool calls are automatically approved without user confirmation.

              • BetaManagedAgentsAlwaysAskPolicy object

                Tool calls require user confirmation before execution.

              • BetaManagedAgentsAutoPolicy object

                The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.

          • BetaManagedAgentsWebFetchToolConfig object

            Configuration for the web_fetch tool.

            • type: "web_fetch"

            • enabled: boolean

            • name: "web_fetch"

            • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy

              Permission policy for tool execution.

              • BetaManagedAgentsAlwaysAllowPolicy object

                Tool calls are automatically approved without user confirmation.

              • BetaManagedAgentsAlwaysAskPolicy object

                Tool calls require user confirmation before execution.

              • BetaManagedAgentsAutoPolicy object

                The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.

            • allowed_domains: optional array of string

            • blocked_domains: optional array of string

            • max_content_tokens: optional number or null

              format: int32

          • BetaManagedAgentsWebSearchToolConfig object

            Configuration for the web_search tool.

            • type: "web_search"

            • enabled: boolean

            • name: "web_search"

            • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy

              Permission policy for tool execution.

              • BetaManagedAgentsAlwaysAllowPolicy object

                Tool calls are automatically approved without user confirmation.

              • BetaManagedAgentsAlwaysAskPolicy object

                Tool calls require user confirmation before execution.

              • BetaManagedAgentsAutoPolicy object

                The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.

            • allowed_domains: optional array of string

            • blocked_domains: optional array of string

            • user_location: optional BetaManagedAgentsUserLocation or null

              Approximate user location for search result localization.

              • type: "approximate"

                Location precision. Only "approximate" is supported.

              • city: optional string or null

                City name.

                minLength: 1, maxLength: 255

              • country: optional string or null

                Two-letter ISO 3166-1 country code, uppercase.

              • region: optional string or null

                Region or state name.

                minLength: 1, maxLength: 255

              • timezone: optional string or null

                IANA timezone identifier, e.g. "America/Los_Angeles".

                minLength: 1, maxLength: 255

        • default_config: BetaManagedAgentsAgentToolsetDefaultConfig

          Resolved default configuration for agent tools.

          • enabled: boolean

          • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy

            Permission policy for tool execution.

            • BetaManagedAgentsAlwaysAllowPolicy object

              Tool calls are automatically approved without user confirmation.

            • BetaManagedAgentsAlwaysAskPolicy object

              Tool calls require user confirmation before execution.

            • BetaManagedAgentsAutoPolicy object

              The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.

      • BetaManagedAgentsMCPToolset object

        • type: "mcp_toolset"

        • configs: array of BetaManagedAgentsMCPToolConfig

          • enabled: boolean

          • name: string

          • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy

            Permission policy for tool execution.

            • BetaManagedAgentsAlwaysAllowPolicy object

              Tool calls are automatically approved without user confirmation.

            • BetaManagedAgentsAlwaysAskPolicy object

              Tool calls require user confirmation before execution.

            • BetaManagedAgentsAutoPolicy object

              The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.

        • default_config: BetaManagedAgentsMCPToolsetDefaultConfig

          Resolved default configuration for all tools from an MCP server.

          • enabled: boolean

          • permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy or BetaManagedAgentsAutoPolicy

            Permission policy for tool execution.

            • BetaManagedAgentsAlwaysAllowPolicy object

              Tool calls are automatically approved without user confirmation.

            • BetaManagedAgentsAlwaysAskPolicy object

              Tool calls require user confirmation before execution.

            • BetaManagedAgentsAutoPolicy object

              The server decides each tool call individually: it judges, from the tool, its input, and the session content so far, whether the call is safe to execute or high-risk, and evaluates it to allow when judged safe and to deny when judged high-risk. A call the server cannot reach a judgement on evaluates to ask.

        • mcp_server_name: string

      • BetaManagedAgentsCustomTool object

        A custom tool as returned in API responses.

        • type: "custom"

        • description: string

        • input_schema: BetaManagedAgentsCustomToolInputSchema

          JSON Schema for custom tool input parameters.

          • type: "object"

          • properties: optional map[unknown] or null

          • required: optional array of string or null

        • name: string

    • updated_at: string

      A timestamp in RFC 3339 format

      format: date-time

    • version: number

      The agent's current version. Starts at 1 and increments when the agent is modified.

      format: int32

# Example

bash
curl https://api.anthropic.com/v1/agents/$AGENT_ID/archive \
    -X POST \
    -H 'anthropic-version: 2023-06-01' \
    -H 'anthropic-beta: managed-agents-2026-04-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

# Response (200)

json
{
  "id": "agent_011CZkYpogX7uDKUyvBTophP",
  "archived_at": null,
  "created_at": "2026-03-15T10:00:00Z",
  "description": "A general-purpose starter agent.",
  "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": {
    "agents": [
      {
        "id": "agent_011CZkYqphY8vELVzwCUpqiQ",
        "type": "agent",
        "version": 1
      }
    ],
    "type": "coordinator"
  },
  "name": "My First Agent",
  "skills": [
    {
      "skill_id": "xlsx",
      "type": "anthropic",
      "version": "1"
    },
    {
      "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTlx",
      "type": "custom",
      "version": "2"
    }
  ],
  "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.",
  "tools": [
    {
      "configs": [
        {
          "enabled": true,
          "name": "bash",
          "permission_policy": {
            "type": "always_allow"
          },
          "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
}
Files main
Menu

Theme
↑↓navigate ↵open escclose /⌘Kanywhere