エージェント
エージェントを作成
エージェントの一覧
エージェントを取得
エージェントを更新
エージェントをアーカイブ
Models
BetaManagedAgentsAdvisor object{ model, type }Platform advisor roster entry: a model the session's primary thread may consult mid-turn.
Platform advisor roster entry: a model the session's primary thread may consult mid-turn.
The advisor model id.
BetaManagedAgentsAgent object{ id, archived_at, created_at, 12 more }A Managed Agents agent.
A Managed Agents agent.
BetaManagedAgentsAgentReference object{ id, type, version }A resolved agent reference with a concrete version.
A resolved agent reference with a concrete version.
version: number
BetaManagedAgentsAgentToolConfig = BetaManagedAgentsBashToolConfig { enabled, name, permission_policy, type } or BetaManagedAgentsEditToolConfig { enabled, name, permission_policy, type } or BetaManagedAgentsReadToolConfig { enabled, name, permission_policy, type } or 5 moreConfiguration for a specific agent tool.
Configuration for a specific agent tool.
BetaManagedAgentsAgentToolConfigParams = BetaManagedAgentsBashToolConfigParams { name, enabled, permission_policy, type } or BetaManagedAgentsEditToolConfigParams { name, enabled, permission_policy, type } or BetaManagedAgentsReadToolConfigParams { name, enabled, permission_policy, type } or 5 moreConfiguration override for a specific tool within a toolset.
Configuration override for a specific tool within a toolset.
BetaManagedAgentsAgentToolsetDefaultConfig object{ enabled, permission_policy }Resolved default configuration for agent tools.
Resolved default configuration for agent tools.
permission_policy: BetaManagedAgentsAlwaysAllowPolicy { type } or BetaManagedAgentsAlwaysAskPolicy { type }Permission policy for tool execution.
Permission policy for tool execution.
BetaManagedAgentsAlwaysAllowPolicy object{ type }Tool calls are automatically approved without user confirmation.
Tool calls are automatically approved without user confirmation.
BetaManagedAgentsAlwaysAskPolicy object{ type }Tool calls require user confirmation before execution.
Tool calls require user confirmation before execution.
BetaManagedAgentsAgentToolsetDefaultConfigParams object{ enabled, permission_policy }Default configuration for all tools in a toolset.
Default configuration for all tools in a toolset.
Whether tools are enabled and available to Claude by default. Defaults to true if not specified.
permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy { type } or BetaManagedAgentsAlwaysAskPolicy { type } or nullPermission policy for tool execution.
Permission policy for tool execution.
BetaManagedAgentsAlwaysAllowPolicy object{ type }Tool calls are automatically approved without user confirmation.
Tool calls are automatically approved without user confirmation.
BetaManagedAgentsAlwaysAskPolicy object{ type }Tool calls require user confirmation before execution.
Tool calls require user confirmation before execution.
BetaManagedAgentsAgentToolset20260401 object{ configs, default_config, type }
BetaManagedAgentsAgentToolset20260401BashInput 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.
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.
Shell command to execute. Omit only when restart is true.
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 numberPer-call timeout in milliseconds. Defaults to the
runner-wide tool timeout when omitted or zero.
Per-call timeout in milliseconds. Defaults to the runner-wide tool timeout when omitted or zero.
BetaManagedAgentsAgentToolset20260401EditInput 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.
Input payload for the edit tool. Performs a string
replacement in the named file; by default old_string must
occur exactly once.
Path of the file to edit.
Replacement text.
Substring to find and replace.
When true, replace every occurrence of old_string
instead of requiring a unique match.
BetaManagedAgentsAgentToolset20260401GlobInput object{ pattern, path }Input payload for the glob tool. Returns paths matching a
doublestar glob pattern, newest first.
Input payload for the glob tool. Returns paths matching a
doublestar glob pattern, newest first.
Doublestar glob pattern (e.g. **/*.go). Absolute patterns
are only permitted when the runner is configured to allow
them.
Optional directory root to search under. Defaults to the runner's working directory.
BetaManagedAgentsAgentToolset20260401GrepInput object{ pattern, path }Input payload for the grep tool. Searches file contents for
a regular expression, returning matching lines.
Input payload for the grep tool. Searches file contents for
a regular expression, returning matching lines.
Regular expression to search for.
Optional directory root to search under. Defaults to the runner's working directory.
BetaManagedAgentsAgentToolset20260401Params object{ type, configs, default_config }Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent.
Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent.
BetaManagedAgentsAgentToolset20260401ReadInput 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).
Input payload for the read tool. Reads file contents
relative to the runner's working directory (or absolute when
the runner permits).
Path of the file to read.
view_range: optional array of numberOptional [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".
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".
BetaManagedAgentsAgentToolset20260401WriteInput object{ content, file_path }Input payload for the write tool. Writes (overwriting) the
entire file contents.
Input payload for the write tool. Writes (overwriting) the
entire file contents.
Full file contents to write.
Path of the file to write.
BetaManagedAgentsAlwaysAllowPolicy object{ type }Tool calls are automatically approved without user confirmation.
Tool calls are automatically approved without user confirmation.
BetaManagedAgentsAlwaysAskPolicy object{ type }Tool calls require user confirmation before execution.
Tool calls require user confirmation before execution.
BetaManagedAgentsAnthropicSkill object{ skill_id, type, version }A resolved Anthropic-managed skill.
A resolved Anthropic-managed skill.
BetaManagedAgentsAnthropicSkillParams object{ skill_id, type, version }An Anthropic-managed skill.
An Anthropic-managed skill.
skill_id: stringIdentifier of the Anthropic skill (e.g., "xlsx").
Identifier of the Anthropic skill (e.g., "xlsx").
version: optional string or nullVersion to pin. Defaults to latest if omitted.
Version to pin. Defaults to latest if omitted.
BetaManagedAgentsBashToolConfig object{ enabled, name, permission_policy, type }Configuration for the bash tool.
Configuration for the bash tool.
BetaManagedAgentsBashToolConfigParams object{ name, enabled, permission_policy, type }Configuration override for the bash tool.
Configuration override for the bash tool.
BetaManagedAgentsCustomSkill object{ skill_id, type, version }A resolved user-created custom skill.
A resolved user-created custom skill.
BetaManagedAgentsCustomSkillParams object{ skill_id, type, version }A user-created custom skill.
A user-created custom skill.
skill_id: stringTagged ID of the custom skill (e.g., "skill_01XJ5...").
Tagged ID of the custom skill (e.g., "skill_01XJ5...").
version: optional string or nullVersion to pin. Defaults to latest if omitted.
Version to pin. Defaults to latest if omitted.
BetaManagedAgentsCustomTool object{ description, input_schema, name, type }A custom tool as returned in API responses.
A custom tool as returned in API responses.
input_schema: BetaManagedAgentsCustomToolInputSchema { type, properties, required }JSON Schema for custom tool input parameters.
JSON Schema for custom tool input parameters.
BetaManagedAgentsCustomToolInputSchema object{ type, properties, required }JSON Schema for custom tool input parameters.
JSON Schema for custom tool input parameters.
BetaManagedAgentsCustomToolParams 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.
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: stringDescription of what the tool does, shown to the agent to help it decide when to use the tool.
Description of what the tool does, shown to the agent to help it decide when to use the tool.
input_schema: BetaManagedAgentsCustomToolInputSchema { type, properties, required }JSON Schema for custom tool input parameters.
JSON Schema for custom tool input parameters.
name: stringUnique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.
Unique name for the tool. 1-128 characters; letters, digits, underscores, and hyphens.
BetaManagedAgentsEditToolConfig object{ enabled, name, permission_policy, type }Configuration for the edit tool.
Configuration for the edit tool.
BetaManagedAgentsEditToolConfigParams object{ name, enabled, permission_policy, type }Configuration override for the edit tool.
Configuration override for the edit tool.
BetaManagedAgentsEffortHigh object{ type }High effort. Favors reasoning depth.
High effort. Favors reasoning depth.
BetaManagedAgentsEffortLow object{ type }Low effort. Favors latency over reasoning depth.
Low effort. Favors latency over reasoning depth.
BetaManagedAgentsEffortMax object{ type }Maximum effort. Favors reasoning depth over latency.
Maximum effort. Favors reasoning depth over latency.
BetaManagedAgentsEffortMedium object{ type }Medium effort. Balances latency and reasoning depth.
Medium effort. Balances latency and reasoning depth.
BetaManagedAgentsEffortXhigh object{ type }Extra-high effort. Not all models accept this level.
Extra-high effort. Not all models accept this level.
BetaManagedAgentsGlobToolConfig object{ enabled, name, permission_policy, type }Configuration for the glob tool.
Configuration for the glob tool.
BetaManagedAgentsGlobToolConfigParams object{ name, enabled, permission_policy, type }Configuration override for the glob tool.
Configuration override for the glob tool.
BetaManagedAgentsGrepToolConfig object{ enabled, name, permission_policy, type }Configuration for the grep tool.
Configuration for the grep tool.
BetaManagedAgentsGrepToolConfigParams object{ name, enabled, permission_policy, type }Configuration override for the grep tool.
Configuration override for the grep tool.
BetaManagedAgentsMCPServerURLDefinition object{ name, type, url }URL-based MCP server connection as returned in API responses.
URL-based MCP server connection as returned in API responses.
BetaManagedAgentsMCPToolConfig object{ enabled, name, permission_policy }Resolved configuration for a specific MCP tool.
Resolved configuration for a specific MCP tool.
permission_policy: BetaManagedAgentsAlwaysAllowPolicy { type } or BetaManagedAgentsAlwaysAskPolicy { type }Permission policy for tool execution.
Permission policy for tool execution.
BetaManagedAgentsAlwaysAllowPolicy object{ type }Tool calls are automatically approved without user confirmation.
Tool calls are automatically approved without user confirmation.
BetaManagedAgentsAlwaysAskPolicy object{ type }Tool calls require user confirmation before execution.
Tool calls require user confirmation before execution.
BetaManagedAgentsMCPToolConfigParams object{ name, enabled, permission_policy }Configuration override for a specific MCP tool.
Configuration override for a specific MCP tool.
BetaManagedAgentsMCPToolset object{ configs, default_config, mcp_server_name, type }
BetaManagedAgentsMCPToolsetDefaultConfig object{ enabled, permission_policy }Resolved default configuration for all tools from an MCP server.
Resolved default configuration for all tools from an MCP server.
permission_policy: BetaManagedAgentsAlwaysAllowPolicy { type } or BetaManagedAgentsAlwaysAskPolicy { type }Permission policy for tool execution.
Permission policy for tool execution.
BetaManagedAgentsAlwaysAllowPolicy object{ type }Tool calls are automatically approved without user confirmation.
Tool calls are automatically approved without user confirmation.
BetaManagedAgentsAlwaysAskPolicy object{ type }Tool calls require user confirmation before execution.
Tool calls require user confirmation before execution.
BetaManagedAgentsMCPToolsetDefaultConfigParams object{ enabled, permission_policy }Default configuration for all tools from an MCP server.
Default configuration for all tools from an MCP server.
Whether tools are enabled by default. Defaults to true if not specified.
permission_policy: optional BetaManagedAgentsAlwaysAllowPolicy { type } or BetaManagedAgentsAlwaysAskPolicy { type } or nullPermission policy for tool execution.
Permission policy for tool execution.
BetaManagedAgentsAlwaysAllowPolicy object{ type }Tool calls are automatically approved without user confirmation.
Tool calls are automatically approved without user confirmation.
BetaManagedAgentsAlwaysAskPolicy object{ type }Tool calls require user confirmation before execution.
Tool calls require user confirmation before execution.
BetaManagedAgentsMCPToolsetParams object{ mcp_server_name, type, configs, default_config }Configuration for tools from an MCP server defined in mcp_servers.
Configuration for tools from an MCP server defined in mcp_servers.
BetaManagedAgentsModel = "claude-fable-5-1" or "claude-sonnet-5" or "claude-fable-5" or 11 more or stringThe model that will power your agent.
The model that will power your agent.
See models for additional details and options.
BetaManagedAgentsModelConfig object{ id, effort, inference_geo, speed }Model identifier and configuration.
Model identifier and configuration.
BetaManagedAgentsModelConfigParams object{ id, effort, inference_geo, speed }An object that defines additional configuration control over model use
An object that defines additional configuration control over model use
BetaManagedAgentsMultiagentCoordinator object{ agents, type }Resolved coordinator topology with a concrete agent roster.
Resolved coordinator topology with a concrete agent roster.
BetaManagedAgentsMultiagentCoordinatorParams 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.
A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the agents roster.
BetaManagedAgentsMultiagentSelfParams object{ type }Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference.
Sentinel roster entry meaning "the agent that owns this configuration". Resolved server-side to a concrete agent reference.
BetaManagedAgentsReadToolConfig object{ enabled, name, permission_policy, type }Configuration for the read tool.
Configuration for the read tool.
BetaManagedAgentsReadToolConfigParams object{ name, enabled, permission_policy, type }Configuration override for the read tool.
Configuration override for the read tool.
BetaManagedAgentsSessionThreadAgent 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.
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.
BetaManagedAgentsSkillParams = BetaManagedAgentsAnthropicSkillParams { skill_id, type, version } or BetaManagedAgentsCustomSkillParams { skill_id, type, version }Skill to load in the session container.
Skill to load in the session container.
BetaManagedAgentsURLMCPServerParams object{ name, type, url }URL-based MCP server connection.
URL-based MCP server connection.
name: stringUnique name for this server, referenced by mcp_toolset configurations. 1-255 characters.
Unique name for this server, referenced by mcp_toolset configurations. 1-255 characters.
url: stringEndpoint URL for the MCP server.
Endpoint URL for the MCP server.
BetaManagedAgentsUserLocation object{ type, city, country, 2 more }Approximate user location for search result localization.
Approximate user location for search result localization.
Location precision. Only "approximate" is supported.
city: optional string or nullCity name.
City name.
Two-letter ISO 3166-1 country code, uppercase.
region: optional string or nullRegion or state name.
Region or state name.
timezone: optional string or nullIANA timezone identifier, e.g. "America/Los_Angeles".
IANA timezone identifier, e.g. "America/Los_Angeles".
BetaManagedAgentsWebFetchToolConfig object{ enabled, name, permission_policy, 4 more }Configuration for the web_fetch tool.
Configuration for the web_fetch tool.
BetaManagedAgentsWebFetchToolConfigParams object{ name, allowed_domains, blocked_domains, 4 more }Configuration override for the web_fetch tool.
Configuration override for the web_fetch tool.
BetaManagedAgentsWebSearchToolConfig object{ enabled, name, permission_policy, 4 more }Configuration for the web_search tool.
Configuration for the web_search tool.
BetaManagedAgentsWebSearchToolConfigParams object{ name, allowed_domains, blocked_domains, 4 more }Configuration override for the web_search tool.
Configuration override for the web_search tool.
BetaManagedAgentsWriteToolConfig object{ enabled, name, permission_policy, type }Configuration for the write tool.
Configuration for the write tool.
BetaManagedAgentsWriteToolConfigParams object{ name, enabled, permission_policy, type }Configuration override for the write tool.
Configuration override for the write tool.