Claude Platform Docs

Agents

Create Agent
BetaManagedAgentsAgent Beta.Agents.Create(parameters, cancellationToken = default)
POST/v1/agents
List Agents
AgentListPage Beta.Agents.List(parameters, cancellationToken = default)
GET/v1/agents
Get Agent
BetaManagedAgentsAgent Beta.Agents.Retrieve(parameters, cancellationToken = default)
GET/v1/agents/{agent_id}
Update Agent
BetaManagedAgentsAgent Beta.Agents.Update(parameters, cancellationToken = default)
POST/v1/agents/{agent_id}
Archive Agent
BetaManagedAgentsAgent Beta.Agents.Archive(parameters, cancellationToken = default)
POST/v1/agents/{agent_id}/archive
Models
class BetaManagedAgentsAdvisor:

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

required string Model

The advisor model id.

required Type Type
class BetaManagedAgentsAgent:

A Managed Agents agent.

class BetaManagedAgentsAgentReference:

A resolved agent reference with a concrete version.

required string ID
required Type Type
required int Version
formatint32
class BetaManagedAgentsAgentToolConfig: union

Configuration for a specific agent tool.

class BetaManagedAgentsAgentToolConfigParams: union

Configuration override for a specific tool within a toolset.

class BetaManagedAgentsAgentToolsetDefaultConfig:

Resolved default configuration for agent tools.

required bool Enabled
required PermissionPolicy PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
class BetaManagedAgentsAgentToolsetDefaultConfigParams:

Default configuration for all tools in a toolset.

bool? Enabled

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

PermissionPolicy? PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
class BetaManagedAgentsAgentToolset20260401:
class BetaManagedAgentsAgentToolset20260401BashInput:

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.

string Command

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

bool Restart

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

long TimeoutMs

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

minimum0
class BetaManagedAgentsAgentToolset20260401EditInput:

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

required string FilePath

Path of the file to edit.

required string NewString

Replacement text.

required string OldString

Substring to find and replace.

bool ReplaceAll

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

class BetaManagedAgentsAgentToolset20260401GlobInput:

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

required string Pattern

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

string Path

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

class BetaManagedAgentsAgentToolset20260401GrepInput:

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

required string Pattern

Regular expression to search for.

string Path

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

class BetaManagedAgentsAgentToolset20260401Params:

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

class BetaManagedAgentsAgentToolset20260401ReadInput:

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

required string FilePath

Path of the file to read.

IReadOnlyList<long> ViewRange

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
class BetaManagedAgentsAgentToolset20260401WriteInput:

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

required string Content

Full file contents to write.

required string FilePath

Path of the file to write.

class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
class BetaManagedAgentsAnthropicSkill:

A resolved Anthropic-managed skill.

required string SkillID
required Type Type
required string Version
class BetaManagedAgentsAnthropicSkillParams:

An Anthropic-managed skill.

required string SkillID

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

minLength1
maxLength64
required Type Type
string? Version

Version to pin. Defaults to latest if omitted.

minLength1
maxLength64
class BetaManagedAgentsBashToolConfig:

Configuration for the bash tool.

required bool Enabled
JsonElement Name = "bash"
required PermissionPolicy PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
JsonElement Type = "bash"
class BetaManagedAgentsBashToolConfigParams:

Configuration override for the bash tool.

JsonElement Name = "bash"

Must be "bash".

bool? Enabled

Whether this tool is enabled and available to Claude. Overrides the default_config setting.

PermissionPolicy? PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
Type Type
class BetaManagedAgentsCustomSkill:

A resolved user-created custom skill.

required string SkillID
required Type Type
required string Version
class BetaManagedAgentsCustomSkillParams:

A user-created custom skill.

required string SkillID

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

minLength1
maxLength64
required Type Type
string? Version

Version to pin. Defaults to latest if omitted.

minLength1
maxLength64
class BetaManagedAgentsCustomTool:

A custom tool as returned in API responses.

required string Description
required BetaManagedAgentsCustomToolInputSchema InputSchema

JSON Schema for custom tool input parameters.

JsonElement Type = "object"
IReadOnlyDictionary<string, JsonElement>? Properties
IReadOnlyList<string>? Required
required string Name
required Type Type
class BetaManagedAgentsCustomToolInputSchema:

JSON Schema for custom tool input parameters.

JsonElement Type = "object"
IReadOnlyDictionary<string, JsonElement>? Properties
IReadOnlyList<string>? Required
class BetaManagedAgentsCustomToolParams:

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.

required string Description

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

minLength1
required BetaManagedAgentsCustomToolInputSchema InputSchema

JSON Schema for custom tool input parameters.

JsonElement Type = "object"
IReadOnlyDictionary<string, JsonElement>? Properties
IReadOnlyList<string>? Required
required string Name

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

minLength1
maxLength128
required Type Type
class BetaManagedAgentsEditToolConfig:

Configuration for the edit tool.

required bool Enabled
JsonElement Name = "edit"
required PermissionPolicy PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
JsonElement Type = "edit"
class BetaManagedAgentsEditToolConfigParams:

Configuration override for the edit tool.

JsonElement Name = "edit"

Must be "edit".

bool? Enabled

Whether this tool is enabled and available to Claude. Overrides the default_config setting.

PermissionPolicy? PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
Type Type
class BetaManagedAgentsEffortHigh:

High effort. Favors reasoning depth.

required Type Type
class BetaManagedAgentsEffortLow:

Low effort. Favors latency over reasoning depth.

required Type Type
class BetaManagedAgentsEffortMax:

Maximum effort. Favors reasoning depth over latency.

required Type Type
class BetaManagedAgentsEffortMedium:

Medium effort. Balances latency and reasoning depth.

required Type Type
class BetaManagedAgentsEffortXhigh:

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

required Type Type
class BetaManagedAgentsGlobToolConfig:

Configuration for the glob tool.

required bool Enabled
JsonElement Name = "glob"
required PermissionPolicy PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
JsonElement Type = "glob"
class BetaManagedAgentsGlobToolConfigParams:

Configuration override for the glob tool.

JsonElement Name = "glob"

Must be "glob".

bool? Enabled

Whether this tool is enabled and available to Claude. Overrides the default_config setting.

PermissionPolicy? PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
Type Type
class BetaManagedAgentsGrepToolConfig:

Configuration for the grep tool.

required bool Enabled
JsonElement Name = "grep"
required PermissionPolicy PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
JsonElement Type = "grep"
class BetaManagedAgentsGrepToolConfigParams:

Configuration override for the grep tool.

JsonElement Name = "grep"

Must be "grep".

bool? Enabled

Whether this tool is enabled and available to Claude. Overrides the default_config setting.

PermissionPolicy? PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
Type Type
class BetaManagedAgentsMcpServerUrlDefinition:

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

required string Name
required Type Type
required string Url
class BetaManagedAgentsMcpToolConfig:

Resolved configuration for a specific MCP tool.

required bool Enabled
required string Name
required PermissionPolicy PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
class BetaManagedAgentsMcpToolConfigParams:

Configuration override for a specific MCP tool.

required string Name

Name of the MCP tool to configure. 1-128 characters.

minLength1
maxLength128
bool? Enabled

Whether this tool is enabled. Overrides the default_config setting.

PermissionPolicy? PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
class BetaManagedAgentsMcpToolset:
class BetaManagedAgentsMcpToolsetDefaultConfig:

Resolved default configuration for all tools from an MCP server.

required bool Enabled
required PermissionPolicy PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
class BetaManagedAgentsMcpToolsetDefaultConfigParams:

Default configuration for all tools from an MCP server.

bool? Enabled

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

PermissionPolicy? PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
class BetaManagedAgentsMcpToolsetParams:

Configuration for tools from an MCP server defined in mcp_servers.

class BetaManagedAgentsModelConfig:

Model identifier and configuration.

class BetaManagedAgentsModelConfigParams:

An object that defines additional configuration control over model use

class BetaManagedAgentsMultiagentCoordinator:

Resolved coordinator topology with a concrete agent roster.

required IReadOnlyList<Agent> Agents

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

One of the following:
class BetaManagedAgentsAgentReference:

A resolved agent reference with a concrete version.

required string ID
required Type Type
required int Version
formatint32
class BetaManagedAgentsAdvisor:

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

required string Model

The advisor model id.

required Type Type
required Type Type
class BetaManagedAgentsMultiagentCoordinatorParams:

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

required IReadOnlyList<BetaManagedAgentsMultiagentRosterEntryParams> Agents

Agents the coordinator may spawn as session threads. 1–20 entries. Each entry is an agent ID string, a versioned {"type":"agent","id","version"} reference, or {"type":"self"} to allow recursive self-invocation. Entries must reference distinct agents (after resolving self and string forms); at most one self. Referenced agents must exist, must not be archived, and must not themselves have multiagent set (depth limit 1).

One of the following:
string
class BetaManagedAgentsAgentParams:

Specification for an Agent. Provide a specific version or use the short-form agent="agent_id" for the most recent version

required string ID

The agent ID.

minLength1
maxLength128
required Type Type
int Version

The specific agent version to use. Omit to use the latest version. Must be at least 1 if specified.

formatint32
class BetaManagedAgentsMultiagentSelfParams:

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

required Type Type
class BetaManagedAgentsAdvisorParams:

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.

required string Model

A Claude model id. The model must be permitted as an advisor for this agent's model — see the sessions/threads/advisor spec.

minLength1
maxLength256
required Type Type
required Type Type
class BetaManagedAgentsMultiagentSelfParams:

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

required Type Type
class BetaManagedAgentsReadToolConfig:

Configuration for the read tool.

required bool Enabled
JsonElement Name = "read"
required PermissionPolicy PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
JsonElement Type = "read"
class BetaManagedAgentsReadToolConfigParams:

Configuration override for the read tool.

JsonElement Name = "read"

Must be "read".

bool? Enabled

Whether this tool is enabled and available to Claude. Overrides the default_config setting.

PermissionPolicy? PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
Type Type
class BetaManagedAgentsSessionThreadAgent:

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.

class BetaManagedAgentsSkillParams: union

Skill to load in the session container.

class BetaManagedAgentsAnthropicSkillParams:

An Anthropic-managed skill.

required string SkillID

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

minLength1
maxLength64
required Type Type
string? Version

Version to pin. Defaults to latest if omitted.

minLength1
maxLength64
class BetaManagedAgentsCustomSkillParams:

A user-created custom skill.

required string SkillID

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

minLength1
maxLength64
required Type Type
string? Version

Version to pin. Defaults to latest if omitted.

minLength1
maxLength64
class BetaManagedAgentsUrlMcpServerParams:

URL-based MCP server connection.

required string Name

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

minLength1
maxLength255
required Type Type
required string Url

Endpoint URL for the MCP server.

maxLength2048
class BetaManagedAgentsUserLocation:

Approximate user location for search result localization.

JsonElement Type = "approximate"

Location precision. Only "approximate" is supported.

string? City

City name.

minLength1
maxLength255
string? Country

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

string? Region

Region or state name.

minLength1
maxLength255
string? Timezone

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

minLength1
maxLength255
class BetaManagedAgentsWebFetchToolConfig:

Configuration for the web_fetch tool.

required bool Enabled
JsonElement Name = "web_fetch"
required PermissionPolicy PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
JsonElement Type = "web_fetch"
IReadOnlyList<string> AllowedDomains
IReadOnlyList<string> BlockedDomains
int? MaxContentTokens
formatint32
class BetaManagedAgentsWebFetchToolConfigParams:

Configuration override for the web_fetch tool.

JsonElement Name = "web_fetch"

Must be "web_fetch".

IReadOnlyList<string> AllowedDomains

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.

IReadOnlyList<string> BlockedDomains

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.

bool? Enabled

Whether this tool is enabled and available to Claude. Overrides the default_config setting.

int? MaxContentTokens

Maximum number of tokens of fetched text content to include in context per call. Does not apply to binary content such as PDFs.

formatint32
PermissionPolicy? PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
Type Type
class BetaManagedAgentsWebSearchToolConfig:

Configuration for the web_search tool.

class BetaManagedAgentsWebSearchToolConfigParams:

Configuration override for the web_search tool.

class BetaManagedAgentsWriteToolConfig:

Configuration for the write tool.

required bool Enabled
JsonElement Name = "write"
required PermissionPolicy PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
JsonElement Type = "write"
class BetaManagedAgentsWriteToolConfigParams:

Configuration override for the write tool.

JsonElement Name = "write"

Must be "write".

bool? Enabled

Whether this tool is enabled and available to Claude. Overrides the default_config setting.

PermissionPolicy? PermissionPolicy

Permission policy for tool execution.

One of the following:
class BetaManagedAgentsAlwaysAllowPolicy:

Tool calls are automatically approved without user confirmation.

required Type Type
class BetaManagedAgentsAlwaysAskPolicy:

Tool calls require user confirmation before execution.

required Type Type
Type Type

AgentsVersions

List Agent Versions
VersionListPage Beta.Agents.Versions.List(parameters, cancellationToken = default)
GET/v1/agents/{agent_id}/versions