Claude Platform Docs

Agents

Create Agent
$ ant beta:agents create
POST/v1/agents
List Agents
$ ant beta:agents list
GET/v1/agents
Get Agent
$ ant beta:agents retrieve
GET/v1/agents/{agent_id}
Update Agent
$ ant beta:agents update
POST/v1/agents/{agent_id}
Archive Agent
$ ant beta:agents archive
POST/v1/agents/{agent_id}/archive
Models
beta_managed_agents_advisor: object{ model, type }

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

model: string

The advisor model id.

type: "advisor"
beta_managed_agents_agent: object{ id, archived_at, created_at, 12 more }

A Managed Agents agent.

beta_managed_agents_agent_reference: object{ id, type, version }

A resolved agent reference with a concrete version.

id: string
type: "agent"
version: number
formatint32
beta_managed_agents_agent_tool_config: BetaManagedAgentsBashToolConfig { enabled, name, permission_policy, type } or BetaManagedAgentsEditToolConfig { enabled, name, permission_policy, type } or BetaManagedAgentsReadToolConfig { enabled, name, permission_policy, type } or 5 more

Configuration for a specific agent tool.

beta_managed_agents_agent_tool_config_params: BetaManagedAgentsBashToolConfigParams { name, enabled, permission_policy, type } or BetaManagedAgentsEditToolConfigParams { name, enabled, permission_policy, type } or BetaManagedAgentsReadToolConfigParams { name, enabled, permission_policy, type } or 5 more

Configuration override for a specific tool within a toolset.

beta_managed_agents_agent_toolset_default_config: object{ enabled, permission_policy }

Resolved default configuration for agent tools.

enabled: boolean

Permission policy for tool execution.

One of the following:
beta_managed_agents_always_allow_policy: object{ type }

Tool calls are automatically approved without user confirmation.

type: "always_allow"
beta_managed_agents_always_ask_policy: object{ type }

Tool calls require user confirmation before execution.

type: "always_ask"
beta_managed_agents_agent_toolset_default_config_params: object{ enabled, permission_policy }

Default configuration for all tools in a toolset.

enabled: optional boolean

Whether tools are enabled and available to Claude by default. Defaults to true if not specified.

permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy { type } or BetaManagedAgentsAlwaysAskPolicy { type }

Permission policy for tool execution.

One of the following:
beta_managed_agents_always_allow_policy: object{ type }

Tool calls are automatically approved without user confirmation.

type: "always_allow"
beta_managed_agents_always_ask_policy: object{ type }

Tool calls require user confirmation before execution.

type: "always_ask"
beta_managed_agents_agent_toolset20260401: object{ configs, default_config, type }
beta_managed_agents_agent_toolset20260401_bash_input: object{ command, restart, timeout_ms }

Input payload for the bash tool of the agent_toolset_20260401 toolset. All fields are optional; a normal invocation supplies command, while restart=true (with no command) reboots the runner-side bash session.

command: optional string

Shell command to execute. Omit only when restart is true.

restart: optional boolean

When true, restart the persistent bash session instead of running a command. Subsequent calls without restart will run against the fresh session.

timeout_ms: optional number

Per-call timeout in milliseconds. Defaults to the runner-wide tool timeout when omitted or zero.

minimum0
beta_managed_agents_agent_toolset20260401_edit_input: object{ file_path, new_string, old_string, replace_all }

Input payload for the edit tool. Performs a string replacement in the named file; by default old_string must occur exactly once.

file_path: string

Path of the file to edit.

new_string: string

Replacement text.

old_string: string

Substring to find and replace.

replace_all: optional boolean

When true, replace every occurrence of old_string instead of requiring a unique match.

beta_managed_agents_agent_toolset20260401_glob_input: object{ pattern, path }

Input payload for the glob tool. Returns paths matching a doublestar glob pattern, newest first.

pattern: string

Doublestar glob pattern (e.g. **/*.go). Absolute patterns are only permitted when the runner is configured to allow them.

path: optional string

Optional directory root to search under. Defaults to the runner's working directory.

beta_managed_agents_agent_toolset20260401_grep_input: object{ pattern, path }

Input payload for the grep tool. Searches file contents for a regular expression, returning matching lines.

pattern: string

Regular expression to search for.

path: optional string

Optional directory root to search under. Defaults to the runner's working directory.

beta_managed_agents_agent_toolset20260401_params: object{ type, 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_agent_toolset20260401_read_input: object{ file_path, view_range }

Input payload for the read tool. Reads file contents relative to the runner's working directory (or absolute when the runner permits).

file_path: string

Path of the file to read.

view_range: optional array of number

Optional [start_line, end_line] 1-indexed inclusive range. When omitted the entire file is returned. end_line of 0 or negative means "to end of file".

minItems2
maxItems2
beta_managed_agents_agent_toolset20260401_write_input: object{ content, file_path }

Input payload for the write tool. Writes (overwriting) the entire file contents.

content: string

Full file contents to write.

file_path: string

Path of the file to write.

beta_managed_agents_always_allow_policy: object{ type }

Tool calls are automatically approved without user confirmation.

type: "always_allow"
beta_managed_agents_always_ask_policy: object{ type }

Tool calls require user confirmation before execution.

type: "always_ask"
beta_managed_agents_anthropic_skill: object{ skill_id, type, version }

A resolved Anthropic-managed skill.

skill_id: string
type: "anthropic"
version: string
beta_managed_agents_anthropic_skill_params: object{ skill_id, type, version }

An Anthropic-managed skill.

skill_id: string

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

minLength1
maxLength64
type: "anthropic"
version: optional string

Version to pin. Defaults to latest if omitted.

minLength1
maxLength64
beta_managed_agents_bash_tool_config: object{ enabled, name, permission_policy, type }

Configuration for the bash tool.

beta_managed_agents_bash_tool_config_params: object{ name, enabled, permission_policy, type }

Configuration override for the bash tool.

beta_managed_agents_custom_skill: object{ skill_id, type, version }

A resolved user-created custom skill.

skill_id: string
type: "custom"
version: string
beta_managed_agents_custom_skill_params: object{ skill_id, type, version }

A user-created custom skill.

skill_id: string

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

minLength1
maxLength64
type: "custom"
version: optional string

Version to pin. Defaults to latest if omitted.

minLength1
maxLength64
beta_managed_agents_custom_tool: object{ description, input_schema, name, type }

A custom tool as returned in API responses.

description: string
input_schema: object{ type, properties, required }

JSON Schema for custom tool input parameters.

type: "object"
properties: optional map[unknown]
required: optional array of string
name: string
type: "custom"
beta_managed_agents_custom_tool_input_schema: object{ type, properties, required }

JSON Schema for custom tool input parameters.

type: "object"
properties: optional map[unknown]
required: optional array of string
beta_managed_agents_custom_tool_params: object{ description, input_schema, name, type }

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

description: string

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

minLength1
input_schema: object{ type, properties, required }

JSON Schema for custom tool input parameters.

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
type: "custom"
beta_managed_agents_edit_tool_config: object{ enabled, name, permission_policy, type }

Configuration for the edit tool.

beta_managed_agents_edit_tool_config_params: object{ name, enabled, permission_policy, type }

Configuration override for the edit tool.

beta_managed_agents_effort_high: object{ type }

High effort. Favors reasoning depth.

type: "high"
beta_managed_agents_effort_low: object{ type }

Low effort. Favors latency over reasoning depth.

type: "low"
beta_managed_agents_effort_max: object{ type }

Maximum effort. Favors reasoning depth over latency.

type: "max"
beta_managed_agents_effort_medium: object{ type }

Medium effort. Balances latency and reasoning depth.

type: "medium"
beta_managed_agents_effort_xhigh: object{ type }

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

type: "xhigh"
beta_managed_agents_glob_tool_config: object{ enabled, name, permission_policy, type }

Configuration for the glob tool.

beta_managed_agents_glob_tool_config_params: object{ name, enabled, permission_policy, type }

Configuration override for the glob tool.

beta_managed_agents_grep_tool_config: object{ enabled, name, permission_policy, type }

Configuration for the grep tool.

beta_managed_agents_grep_tool_config_params: object{ name, enabled, permission_policy, type }

Configuration override for the grep tool.

beta_managed_agents_mcp_server_url_definition: object{ name, type, url }

URL-based MCP server connection as returned in API responses.

name: string
type: "url"
url: string
beta_managed_agents_mcp_tool_config: object{ enabled, name, permission_policy }

Resolved configuration for a specific MCP tool.

enabled: boolean
name: string

Permission policy for tool execution.

One of the following:
beta_managed_agents_always_allow_policy: object{ type }

Tool calls are automatically approved without user confirmation.

type: "always_allow"
beta_managed_agents_always_ask_policy: object{ type }

Tool calls require user confirmation before execution.

type: "always_ask"
beta_managed_agents_mcp_tool_config_params: object{ name, enabled, permission_policy }

Configuration override for a specific MCP tool.

beta_managed_agents_mcp_toolset: object{ configs, default_config, mcp_server_name, type }
beta_managed_agents_mcp_toolset_default_config: object{ enabled, permission_policy }

Resolved default configuration for all tools from an MCP server.

enabled: boolean

Permission policy for tool execution.

One of the following:
beta_managed_agents_always_allow_policy: object{ type }

Tool calls are automatically approved without user confirmation.

type: "always_allow"
beta_managed_agents_always_ask_policy: object{ type }

Tool calls require user confirmation before execution.

type: "always_ask"
beta_managed_agents_mcp_toolset_default_config_params: object{ enabled, permission_policy }

Default configuration for all tools from an MCP server.

enabled: optional boolean

Whether tools are enabled by default. Defaults to true if not specified.

permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy { type } or BetaManagedAgentsAlwaysAskPolicy { type }

Permission policy for tool execution.

One of the following:
beta_managed_agents_always_allow_policy: object{ type }

Tool calls are automatically approved without user confirmation.

type: "always_allow"
beta_managed_agents_always_ask_policy: object{ type }

Tool calls require user confirmation before execution.

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

Configuration for tools from an MCP server defined in mcp_servers.

beta_managed_agents_model_config: object{ id, effort, inference_geo, speed }

Model identifier and configuration.

beta_managed_agents_model_config_params: object{ id, effort, inference_geo, speed }

An object that defines additional configuration control over model use

beta_managed_agents_multiagent_coordinator: object{ agents, type }

Resolved coordinator topology with a concrete agent roster.

beta_managed_agents_multiagent_coordinator_params: object{ agents, type }

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_multiagent_self_params: object{ type }

Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference.

type: "self"
beta_managed_agents_read_tool_config: object{ enabled, name, permission_policy, type }

Configuration for the read tool.

beta_managed_agents_read_tool_config_params: object{ name, enabled, permission_policy, type }

Configuration override for the read tool.

beta_managed_agents_session_thread_agent: object{ id, description, mcp_servers, 7 more }

Resolved agent definition for a single session_thread. Snapshot of the agent at thread creation time. The multiagent roster is not repeated here; read it from Session.agent.

beta_managed_agents_skill_params: BetaManagedAgentsAnthropicSkillParams { skill_id, type, version } or BetaManagedAgentsCustomSkillParams { skill_id, type, version }

Skill to load in the session container.

beta_managed_agents_url_mcp_server_params: object{ name, type, url }

URL-based MCP server connection.

name: string

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

minLength1
maxLength255
type: "url"
url: string

Endpoint URL for the MCP server.

maxLength2048
beta_managed_agents_user_location: object{ type, city, country, 2 more }

Approximate user location for search result localization.

type: "approximate"

Location precision. Only "approximate" is supported.

city: optional string

City name.

minLength1
maxLength255
country: optional string

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

region: optional string

Region or state name.

minLength1
maxLength255
timezone: optional string

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

minLength1
maxLength255
beta_managed_agents_web_fetch_tool_config: object{ enabled, name, permission_policy, 4 more }

Configuration for the web_fetch tool.

beta_managed_agents_web_fetch_tool_config_params: object{ name, allowed_domains, blocked_domains, 4 more }

Configuration override for the web_fetch tool.

beta_managed_agents_web_search_tool_config: object{ enabled, name, permission_policy, 4 more }

Configuration for the web_search tool.

beta_managed_agents_web_search_tool_config_params: object{ name, allowed_domains, blocked_domains, 4 more }

Configuration override for the web_search tool.

beta_managed_agents_write_tool_config: object{ enabled, name, permission_policy, type }

Configuration for the write tool.

beta_managed_agents_write_tool_config_params: object{ name, enabled, permission_policy, type }

Configuration override for the write tool.

AgentsVersions

List Agent Versions
$ ant beta:agents:versions list
GET/v1/agents/{agent_id}/versions