Claude Platform Docs

Update Agent

$ ant beta:agents update
POST/v1/agents/{agent_id}
Requires anthropic-beta: managed-agents-2026-04-01. Learn how to send beta headers.

Update Agent

Parameters
--agent-id: string⁠Path parameter

Unique identifier of the agent to update.

--description: optional string

Description. Omit to preserve; send empty string or null to clear.

maxLength2048
--execution-identity: optional BetaManagedAgentsExecutionIdentityParams

Execution principal for runs of this agent. Full replacement. Omit to preserve; send null or {"type": "service_account"} to restore the default.

One of the following:
beta_managed_agents_aws_role_execution_identity_params: object{ type: "aws_role", role_arn }

An AWS IAM role principal.

type: "aws_role"
role_arn: string

The IAM role's ARN, e.g. "arn:aws:iam::123456789012:role/my-agent-runner". Maximum 2048 characters.

maxLength2048
pattern^arn:aws(-[a-z]+)*:iam::[0-9]{12}:role/[\w+=,.@/-]+$
beta_managed_agents_service_account_execution_identity_params: object{ type: "service_account" }

The Anthropic-managed service account — the default execution principal. Carries no identifier.

type: "service_account"
--mcp-server: optional array of BetaManagedAgentsURLMCPServerParams { type: "url", name, url }

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.

type: "url"
name: string

Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.

minLength1
maxLength255
url: string

Endpoint URL for the MCP server.

maxLength2048
--metadata: optional map[string]

Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars.

Model identifier. Accepts the model string, e.g. claude-opus-5-5, or a model_config object for additional configuration control. Omit to preserve. Cannot be cleared.

One of the following:
union_member_0: "claude-fable-5-2" or "claude-haiku-5-5" or "claude-sonnet-5-5" or 15 more

The model that will power your agent.

See models for additional details and options.

"claude-fable-5-2"

Built for the most ambitious work in coding, enterprise workflows, and the sciences

"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

High-performance model for agents and coding

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.
"claude-sonnet-4-5-20250929"⁠Deprecated

High-performance model for agents and coding

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.
beta_managed_agents_model_config_params: object{ id, effort, inference_geo, speed }

An object that defines additional configuration control over model use

--multiagent: optional BetaManagedAgentsMultiagentParams

Multiagent orchestration configuration. Full replacement. Omit to preserve; send null to clear.

One of the following:
beta_managed_agents_multiagent_coordinator_params: object{ type: "coordinator", agents }

Recommendation: use multiagent_20261001 instead of coordinator. A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the agents roster.

beta_managed_agents_multiagent20261001_params: object{ type: "multiagent_20261001", advisor, subagents, workflows }

Multiagent configuration with three members, each enabled or disabled on its own. On an update, if the agent's stored multiagent also has type multiagent_20261001, this configuration is merged into the stored one, level by level, instead of replacing it. A key that the update omits keeps its stored value. A key sent as null takes its default, on create as well, so "workflows": null enables workflows. An object sent with a type other than the stored one replaces the stored object, and the keys that it omits take their defaults. A predefined_agents list that is sent replaces the stored list. Every object that is sent needs its type, and an enabled advisor needs its model. Other validation applies to the merged result.

--name: optional string

Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.

maxLength256
--skill: optional array of BetaManagedAgentsSkillParams

Skills. Full replacement. Omit to preserve; send empty array or null to clear.

One of the following:
beta_managed_agents_anthropic_skill_params: object{ type: "anthropic", skill_id, version }

An Anthropic-managed skill.

type: "anthropic"
skill_id: string

Identifier of the Anthropic skill (e.g., "xlsx").

minLength1
maxLength64
version: optional string

Version to pin. Defaults to latest if omitted.

minLength1
maxLength64
beta_managed_agents_custom_skill_params: object{ type: "custom", skill_id, version }

A user-created custom skill.

type: "custom"
skill_id: string

Tagged ID of the custom skill (e.g., "skill_01XJ5...").

minLength1
maxLength64
version: optional string

Version to pin. Defaults to latest if omitted.

minLength1
maxLength64
--system: optional string

System prompt. Omit to preserve; send empty string or null to clear.

maxLength100000

Tool configurations available to the agent. Full replacement. Omit to preserve; send empty array or null to clear. Maximum of 256 tools across all toolsets allowed.

One of the following:
beta_managed_agents_agent_toolset20260401_params: object{ type: "agent_toolset_20260401", configs, default_config }

Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent.

beta_managed_agents_mcp_toolset_params: object{ type: "mcp_toolset", mcp_server_name, configs, default_config }

Configuration for tools from an MCP server defined in mcp_servers.

beta_managed_agents_custom_tool_params: object{ type: "custom", description, input_schema, name }

A custom tool that is executed by the API client rather than the agent. When the agent calls this tool, an agent.custom_tool_use event is emitted and the session goes idle, waiting for the client to provide the result via a user.custom_tool_result event.

type: "custom"
description: string

Description of what the tool does, shown to the agent to help it decide when to use the tool.

minLength1
input_schema: object{ type: "object", properties, required }

JSON Schema defining the expected input parameters for the tool.

type: "object"
properties: optional map[unknown]
required: optional array of string
name: string

Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.

minLength1
maxLength128
pattern^[a-zA-Z0-9_-]{1,128}$
--version: optional number

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.

formatint32
--beta: optional array of AnthropicBeta⁠Header parameter

This endpoint is in beta: requests must send managed-agents-2026-04-01 in this header.

One of the following:
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"output-128k-2025-02-19"
"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"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"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"
"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"
"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"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
"admin-user-sign-out-2026-10-08"
"message-threads-2026-08-12"
"analytics-usage-cost-2026-08-24"
"experimental-claude-tag-2026-10-21"
"user-profiles-billing-2026-10-01"
"message-batches-2024-09-24"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"prompt-caching-2024-07-31"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"pdfs-2024-09-25"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"token-counting-2024-11-01"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"token-efficient-tools-2025-02-19"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"files-api-2025-04-14"⁠Deprecated
Sending this value selects the beta response shapes. Removing it moves you to the current shapes, so follow the migration steps: https://platform.claude.com/docs/en/build-with-claude/files#migrate-from-files-api-2025-04-14
"extended-cache-ttl-2025-04-11"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"skills-2025-10-02"⁠Deprecated
Sending this value selects the beta response shapes. Removing it moves you to the current shapes, so follow the migration steps: https://platform.claude.com/docs/en/build-with-claude/skills-guide#migrate-from-skills-2025-10-02
"cache-diagnosis-2026-04-07"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"ce-user-management-2026-07-13"⁠Deprecated
This value is no longer needed. Remove it from your requests.
--workspace-id: optional 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
beta_managed_agents_agent: object{ type: "agent", id, archived_at, 13 more }

A Managed Agents agent.

Update Agent
ant beta:agents update \
  --agent-id agent_011CZkYpogX7uDKUyvBTophP
Returns Examples
Response 200
{
  "id": "agent_011CZkYpogX7uDKUyvBTophP",
  "archived_at": null,
  "created_at": "2026-03-15T10:00:00Z",
  "description": "A general-purpose starter agent.",
  "execution_identity": {
    "type": "service_account"
  },
  "mcp_servers": [
    {
      "name": "example-mcp",
      "type": "url",
      "url": "https://example-server.modelcontextprotocol.io/sse"
    }
  ],
  "metadata": {
    "foo": "bar"
  },
  "model": {
    "id": "claude-opus-5-5",
    "effort": {
      "type": "low"
    },
    "inference_geo": "inference_geo",
    "speed": "standard"
  },
  "multiagent": null,
  "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": [],
      "default_config": {
        "enabled": true,
        "permission_policy": {
          "type": "always_ask"
        }
      },
      "type": "agent_toolset_20260401"
    }
  ],
  "type": "agent",
  "updated_at": "2026-03-15T10:00:00Z",
  "version": 1
}