Agen
Daftar Agen
client.beta.agents.list(params?, options?): PageCursor<BetaManagedAgentsAgent>Dapatkan Agen
client.beta.agents.retrieve(agentID, params?, options?): BetaManagedAgentsAgentPerbarui Agen
client.beta.agents.update(agentID, params, options?): BetaManagedAgentsAgentArsipkan Agen
client.beta.agents.archive(agentID, params?, options?): BetaManagedAgentsAgentModels
interface BetaManagedAgentsAdvisor { type: "advisor"; model }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.
interface BetaManagedAgentsAgent { type: "agent"; id; archived_at; /* 12 more */ }A Managed Agents agent.
A Managed Agents agent.
interface BetaManagedAgentsAgentReference { type: "agent"; id; version }A resolved agent reference with a concrete version.
A resolved agent reference with a concrete version.
version: number
type BetaManagedAgentsAgentToolConfig = BetaManagedAgentsBashToolConfig | BetaManagedAgentsEditToolConfig | BetaManagedAgentsReadToolConfig | 5 moreConfiguration for a specific agent tool.
Configuration for a specific agent tool.
type BetaManagedAgentsAgentToolConfigParams = BetaManagedAgentsBashToolConfigParams | BetaManagedAgentsEditToolConfigParams | BetaManagedAgentsReadToolConfigParams | 5 moreConfiguration override for a specific tool within a toolset.
Configuration override for a specific tool within a toolset.
interface BetaManagedAgentsAgentToolsetDefaultConfig { enabled; permission_policy }Resolved default configuration for agent tools.
Resolved default configuration for agent tools.
permission_policy: BetaManagedAgentsAlwaysAllowPolicy | BetaManagedAgentsAlwaysAskPolicy | BetaManagedAgentsAutoPolicyPermission policy for tool execution.
Permission policy for tool execution.
interface BetaManagedAgentsAlwaysAllowPolicy { type: "always_allow" }Tool calls are automatically approved without user confirmation.
Tool calls are automatically approved without user confirmation.
interface BetaManagedAgentsAlwaysAskPolicy { type: "always_ask" }Tool calls require user confirmation before execution.
Tool calls require user confirmation before execution.
interface BetaManagedAgentsAutoPolicy { type: "auto" }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.
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.
interface BetaManagedAgentsAgentToolsetDefaultConfigParams { enabled; permission_policy }Default configuration for all tools in a toolset.
Default configuration for all tools in a toolset.
interface BetaManagedAgentsAgentToolset20260401 { type: "agent_toolset_20260401"; configs; default_config }
interface BetaManagedAgentsAgentToolset20260401BashInput { 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?: 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.
interface BetaManagedAgentsAgentToolset20260401EditInput { 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.
interface BetaManagedAgentsAgentToolset20260401GlobInput { 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.
interface BetaManagedAgentsAgentToolset20260401GrepInput { 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.
interface BetaManagedAgentsAgentToolset20260401Params { 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.
Configuration for built-in agent tools. Use this to enable or disable groups of tools available to the agent.
interface BetaManagedAgentsAgentToolset20260401ReadInput { 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?: Array<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".
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".
interface BetaManagedAgentsAgentToolset20260401WriteInput { 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.
interface BetaManagedAgentsAlwaysAllowPolicy { type: "always_allow" }Tool calls are automatically approved without user confirmation.
Tool calls are automatically approved without user confirmation.
interface BetaManagedAgentsAlwaysAskPolicy { type: "always_ask" }Tool calls require user confirmation before execution.
Tool calls require user confirmation before execution.
interface BetaManagedAgentsAnthropicSkill { type: "anthropic"; skill_id; version }A resolved Anthropic-managed skill.
A resolved Anthropic-managed skill.
interface BetaManagedAgentsAnthropicSkillParams { type: "anthropic"; skill_id; 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?: string | nullVersion to pin. Defaults to latest if omitted.
Version to pin. Defaults to latest if omitted.
interface BetaManagedAgentsAutoPolicy { type: "auto" }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.
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.
interface BetaManagedAgentsBashToolConfig { type: "bash"; enabled; name; permission_policy }Configuration for the bash tool.
Configuration for the bash tool.
interface BetaManagedAgentsBashToolConfigParams { type: "bash"; name; enabled; permission_policy }Configuration override for the bash tool.
Configuration override for the bash tool.
interface BetaManagedAgentsCustomSkill { type: "custom"; skill_id; version }A resolved user-created custom skill.
A resolved user-created custom skill.
interface BetaManagedAgentsCustomSkillParams { type: "custom"; skill_id; 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?: string | nullVersion to pin. Defaults to latest if omitted.
Version to pin. Defaults to latest if omitted.
interface BetaManagedAgentsCustomTool { type: "custom"; description; input_schema; name }A custom tool as returned in API responses.
A custom tool as returned in API responses.
input_schema: BetaManagedAgentsCustomToolInputSchema { type: "object"; properties; required }JSON Schema for custom tool input parameters.
JSON Schema for custom tool input parameters.
interface BetaManagedAgentsCustomToolInputSchema { type: "object"; properties; required }JSON Schema for custom tool input parameters.
JSON Schema for custom tool input parameters.
interface BetaManagedAgentsCustomToolParams { 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.
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: "object"; properties; required }JSON Schema defining the expected input parameters for the tool.
JSON Schema defining the expected input parameters for the tool.
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.
interface BetaManagedAgentsEditToolConfig { type: "edit"; enabled; name; permission_policy }Configuration for the edit tool.
Configuration for the edit tool.
interface BetaManagedAgentsEditToolConfigParams { type: "edit"; name; enabled; permission_policy }Configuration override for the edit tool.
Configuration override for the edit tool.
interface BetaManagedAgentsEffortHigh { type: "high" }High effort. Favors reasoning depth.
High effort. Favors reasoning depth.
interface BetaManagedAgentsEffortLow { type: "low" }Low effort. Favors latency over reasoning depth.
Low effort. Favors latency over reasoning depth.
interface BetaManagedAgentsEffortMax { type: "max" }Maximum effort. Favors reasoning depth over latency.
Maximum effort. Favors reasoning depth over latency.
interface BetaManagedAgentsEffortMedium { type: "medium" }Medium effort. Balances latency and reasoning depth.
Medium effort. Balances latency and reasoning depth.
interface BetaManagedAgentsEffortXhigh { type: "xhigh" }Extra-high effort. Not all models accept this level.
Extra-high effort. Not all models accept this level.
interface BetaManagedAgentsGlobToolConfig { type: "glob"; enabled; name; permission_policy }Configuration for the glob tool.
Configuration for the glob tool.
interface BetaManagedAgentsGlobToolConfigParams { type: "glob"; name; enabled; permission_policy }Configuration override for the glob tool.
Configuration override for the glob tool.
interface BetaManagedAgentsGrepToolConfig { type: "grep"; enabled; name; permission_policy }Configuration for the grep tool.
Configuration for the grep tool.
interface BetaManagedAgentsGrepToolConfigParams { type: "grep"; name; enabled; permission_policy }Configuration override for the grep tool.
Configuration override for the grep tool.
interface BetaManagedAgentsMCPServerURLDefinition { type: "url"; name; url }URL-based MCP server connection as returned in API responses.
URL-based MCP server connection as returned in API responses.
interface BetaManagedAgentsMCPToolConfig { enabled; name; permission_policy }Resolved configuration for a specific MCP tool.
Resolved configuration for a specific MCP tool.
interface BetaManagedAgentsMCPToolConfigParams { name; enabled; permission_policy }Configuration override for a specific MCP tool.
Configuration override for a specific MCP tool.
interface BetaManagedAgentsMCPToolset { type: "mcp_toolset"; configs; default_config; mcp_server_name }
interface BetaManagedAgentsMCPToolsetDefaultConfig { 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 | BetaManagedAgentsAlwaysAskPolicy | BetaManagedAgentsAutoPolicyPermission policy for tool execution.
Permission policy for tool execution.
interface BetaManagedAgentsAlwaysAllowPolicy { type: "always_allow" }Tool calls are automatically approved without user confirmation.
Tool calls are automatically approved without user confirmation.
interface BetaManagedAgentsAlwaysAskPolicy { type: "always_ask" }Tool calls require user confirmation before execution.
Tool calls require user confirmation before execution.
interface BetaManagedAgentsAutoPolicy { type: "auto" }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.
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.
interface BetaManagedAgentsMCPToolsetDefaultConfigParams { enabled; permission_policy }Default configuration for all tools from an MCP server.
Default configuration for all tools from an MCP server.
interface BetaManagedAgentsMCPToolsetParams { type: "mcp_toolset"; mcp_server_name; 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.
type BetaManagedAgentsModel = "claude-haiku-5-5" | "claude-sonnet-5-5" | "claude-opus-5-5" | 14 more | (string & {})The model that will power your agent.
The model that will power your agent.
See models for additional details and options.
interface BetaManagedAgentsModelConfig { id; effort; inference_geo; speed }Model identifier and configuration.
Model identifier and configuration.
interface BetaManagedAgentsModelConfigParams { 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
type BetaManagedAgentsMultiagentAdvisor = BetaManagedAgentsMultiagentAdvisorEnabled | BetaManagedAgentsMultiagentAdvisorDisabledWhether the session's primary thread can consult an advisor model.
Whether the session's primary thread can consult an advisor model.
interface BetaManagedAgentsMultiagentAdvisorEnabled { type: "enabled"; model }The session's primary thread can consult model mid-turn.
The session's primary thread can consult model mid-turn.
The advisor model id.
interface BetaManagedAgentsMultiagentAdvisorDisabled { type: "disabled" }The agent has no advisor.
The agent has no advisor.
interface BetaManagedAgentsMultiagentAdvisorDisabled { type: "disabled" }The agent has no advisor.
The agent has no advisor.
interface BetaManagedAgentsMultiagentAdvisorDisabledParams { type: "disabled" }The agent has no advisor.
The agent has no advisor.
interface BetaManagedAgentsMultiagentAdvisorEnabled { type: "enabled"; model }The session's primary thread can consult model mid-turn.
The session's primary thread can consult model mid-turn.
The advisor model id.
interface BetaManagedAgentsMultiagentAdvisorEnabledParams { type: "enabled"; model }The session's primary thread can consult model mid-turn.
The session's primary thread can consult model mid-turn.
model: stringA Claude model id. The model must be permitted as an advisor for this agent's model.
A Claude model id. The model must be permitted as an advisor for this agent's model.
type BetaManagedAgentsMultiagentAdvisorParams = BetaManagedAgentsMultiagentAdvisorEnabledParams | BetaManagedAgentsMultiagentAdvisorDisabledParamsWhether the session's primary thread can consult an advisor model.
Whether the session's primary thread can consult an advisor model.
interface BetaManagedAgentsMultiagentAdvisorEnabledParams { type: "enabled"; model }The session's primary thread can consult model mid-turn.
The session's primary thread can consult model mid-turn.
model: stringA Claude model id. The model must be permitted as an advisor for this agent's model.
A Claude model id. The model must be permitted as an advisor for this agent's model.
interface BetaManagedAgentsMultiagentAdvisorDisabledParams { type: "disabled" }The agent has no advisor.
The agent has no advisor.
interface BetaManagedAgentsMultiagentCoordinator { type: "coordinator"; agents }Resolved coordinator topology with a concrete agent roster.
Resolved coordinator topology with a concrete agent roster.
agents: Array<BetaManagedAgentsAgentReference | BetaManagedAgentsAdvisor>Agents the coordinator may spawn as session threads, each resolved to a specific version.
Agents the coordinator may spawn as session threads, each resolved to a specific version.
interface BetaManagedAgentsAgentReference { type: "agent"; id; version }A resolved agent reference with a concrete version.
A resolved agent reference with a concrete version.
version: number
interface BetaManagedAgentsAdvisor { type: "advisor"; model }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.
interface BetaManagedAgentsMultiagentCoordinatorParams { type: "coordinator"; agents }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.
type BetaManagedAgentsMultiagentInlineAgents = BetaManagedAgentsMultiagentInlineAgentsEnabled | BetaManagedAgentsMultiagentInlineAgentsDisabledWhether the agent can define inline agents. The agent defines an inline agent itself, in a workflow run's plan or when it spawns a session thread, and the inline agent is not saved.
Whether the agent can define inline agents. The agent defines an inline agent itself, in a workflow run's plan or when it spawns a session thread, and the inline agent is not saved.
interface BetaManagedAgentsMultiagentInlineAgentsEnabled { type: "enabled" }The agent can define inline agents.
The agent can define inline agents.
interface BetaManagedAgentsMultiagentInlineAgentsDisabled { type: "disabled" }The agent cannot define inline agents.
The agent cannot define inline agents.
interface BetaManagedAgentsMultiagentInlineAgentsDisabled { type: "disabled" }The agent cannot define inline agents.
The agent cannot define inline agents.
interface BetaManagedAgentsMultiagentInlineAgentsDisabledParams { type: "disabled" }The agent cannot define inline agents.
The agent cannot define inline agents.
interface BetaManagedAgentsMultiagentInlineAgentsEnabled { type: "enabled" }The agent can define inline agents.
The agent can define inline agents.
interface BetaManagedAgentsMultiagentInlineAgentsEnabledParams { type: "enabled" }The agent can define inline agents.
The agent can define inline agents.
type BetaManagedAgentsMultiagentInlineAgentsParams = BetaManagedAgentsMultiagentInlineAgentsEnabledParams | BetaManagedAgentsMultiagentInlineAgentsDisabledParamsWhether the agent can define inline agents. The agent defines an inline agent itself, in a workflow run's plan or when it spawns a session thread, and the inline agent is not saved.
Whether the agent can define inline agents. The agent defines an inline agent itself, in a workflow run's plan or when it spawns a session thread, and the inline agent is not saved.
interface BetaManagedAgentsMultiagentInlineAgentsEnabledParams { type: "enabled" }The agent can define inline agents.
The agent can define inline agents.
interface BetaManagedAgentsMultiagentInlineAgentsDisabledParams { type: "disabled" }The agent cannot define inline agents.
The agent cannot define inline agents.
type BetaManagedAgentsMultiagentPredefinedAgentParams = string | BetaManagedAgentsAgentParams | BetaManagedAgentsMultiagentSelfParamsOne agent in a predefined_agents list. It is an agent ID string, an agent reference with an optional version, or self for the agent that owns this configuration.
One agent in a predefined_agents list. It is an agent ID string, an agent reference with an optional version, or self for the agent that owns this configuration.
interface BetaManagedAgentsAgentParams { type: "agent"; id; version }Specification for an Agent. Provide a specific version or use the short-form agent="agent_id" for the most recent version
Specification for an Agent. Provide a specific version or use the short-form agent="agent_id" for the most recent version
id: stringThe agent ID.
The agent ID.
version?: numberThe specific agent version to use. Omit to use the latest version. Must be at least 1 if specified.
The specific agent version to use. Omit to use the latest version. Must be at least 1 if specified.
interface BetaManagedAgentsMultiagentSelfParams { type: "self" }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.
interface BetaManagedAgentsMultiagentSelfParams { type: "self" }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.
type BetaManagedAgentsMultiagentSubagents = BetaManagedAgentsMultiagentSubagentsEnabled | BetaManagedAgentsMultiagentSubagentsDisabledWhether the agent can spawn session threads.
Whether the agent can spawn session threads.
interface BetaManagedAgentsMultiagentSubagentsEnabled { type: "enabled"; inline_agents; predefined_agents }The agent can spawn session threads.
The agent can spawn session threads.
interface BetaManagedAgentsMultiagentSubagentsDisabled { type: "disabled" }The agent cannot spawn session threads.
The agent cannot spawn session threads.
interface BetaManagedAgentsMultiagentSubagentsDisabled { type: "disabled" }The agent cannot spawn session threads.
The agent cannot spawn session threads.
interface BetaManagedAgentsMultiagentSubagentsDisabledParams { type: "disabled" }The agent cannot spawn session threads.
The agent cannot spawn session threads.
interface BetaManagedAgentsMultiagentSubagentsEnabled { type: "enabled"; inline_agents; predefined_agents }The agent can spawn session threads.
The agent can spawn session threads.
interface BetaManagedAgentsMultiagentSubagentsEnabledParams { type: "enabled"; inline_agents; predefined_agents }The agent can spawn session threads. Each thread runs a predefined agent, which is a saved agent in predefined_agents, or an inline agent, which the agent defines when it spawns the thread and which is not saved. If inline_agents is disabled, predefined_agents must name at least one agent.
The agent can spawn session threads. Each thread runs a predefined agent, which is a saved agent in predefined_agents, or an inline agent, which the agent defines when it spawns the thread and which is not saved. If inline_agents is disabled, predefined_agents must name at least one agent.
type BetaManagedAgentsMultiagentSubagentsParams = BetaManagedAgentsMultiagentSubagentsEnabledParams | BetaManagedAgentsMultiagentSubagentsDisabledParamsWhether the agent can spawn session threads.
Whether the agent can spawn session threads.
interface BetaManagedAgentsMultiagentSubagentsEnabledParams { type: "enabled"; inline_agents; predefined_agents }The agent can spawn session threads. Each thread runs a predefined agent, which is a saved agent in predefined_agents, or an inline agent, which the agent defines when it spawns the thread and which is not saved. If inline_agents is disabled, predefined_agents must name at least one agent.
The agent can spawn session threads. Each thread runs a predefined agent, which is a saved agent in predefined_agents, or an inline agent, which the agent defines when it spawns the thread and which is not saved. If inline_agents is disabled, predefined_agents must name at least one agent.
interface BetaManagedAgentsMultiagentSubagentsDisabledParams { type: "disabled" }The agent cannot spawn session threads.
The agent cannot spawn session threads.
type BetaManagedAgentsMultiagentWorkflows = BetaManagedAgentsMultiagentWorkflowsEnabled | BetaManagedAgentsMultiagentWorkflowsDisabledWhether the agent can start workflow runs.
Whether the agent can start workflow runs.
interface BetaManagedAgentsMultiagentWorkflowsEnabled { type: "enabled"; inline_agents; predefined_agents }The agent can start workflow runs.
The agent can start workflow runs.
interface BetaManagedAgentsMultiagentWorkflowsDisabled { type: "disabled" }The agent cannot start workflow runs.
The agent cannot start workflow runs.
interface BetaManagedAgentsMultiagentWorkflowsDisabled { type: "disabled" }The agent cannot start workflow runs.
The agent cannot start workflow runs.
interface BetaManagedAgentsMultiagentWorkflowsDisabledParams { type: "disabled" }The agent cannot start workflow runs.
The agent cannot start workflow runs.
interface BetaManagedAgentsMultiagentWorkflowsEnabled { type: "enabled"; inline_agents; predefined_agents }The agent can start workflow runs.
The agent can start workflow runs.
interface BetaManagedAgentsMultiagentWorkflowsEnabledParams { type: "enabled"; inline_agents; predefined_agents }The agent can start workflow runs. Each run follows a plan, a program that the agent writes. A plan can use predefined agents, which are the saved agents in predefined_agents, and inline agents, which it defines itself and which are not saved. If inline_agents is disabled, predefined_agents must name at least one agent.
The agent can start workflow runs. Each run follows a plan, a program that the agent writes. A plan can use predefined agents, which are the saved agents in predefined_agents, and inline agents, which it defines itself and which are not saved. If inline_agents is disabled, predefined_agents must name at least one agent.
type BetaManagedAgentsMultiagentWorkflowsParams = BetaManagedAgentsMultiagentWorkflowsEnabledParams | BetaManagedAgentsMultiagentWorkflowsDisabledParamsWhether the agent can start workflow runs.
Whether the agent can start workflow runs.
interface BetaManagedAgentsMultiagentWorkflowsEnabledParams { type: "enabled"; inline_agents; predefined_agents }The agent can start workflow runs. Each run follows a plan, a program that the agent writes. A plan can use predefined agents, which are the saved agents in predefined_agents, and inline agents, which it defines itself and which are not saved. If inline_agents is disabled, predefined_agents must name at least one agent.
The agent can start workflow runs. Each run follows a plan, a program that the agent writes. A plan can use predefined agents, which are the saved agents in predefined_agents, and inline agents, which it defines itself and which are not saved. If inline_agents is disabled, predefined_agents must name at least one agent.
interface BetaManagedAgentsMultiagentWorkflowsDisabledParams { type: "disabled" }The agent cannot start workflow runs.
The agent cannot start workflow runs.
interface BetaManagedAgentsMultiagent20261001 { type: "multiagent_20261001"; advisor; subagents; workflows }Resolved multiagent configuration with three members, each enabled or disabled on its own.
Resolved multiagent configuration with three members, each enabled or disabled on its own.
interface BetaManagedAgentsMultiagent20261001Params { 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.
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.
interface BetaManagedAgentsReadToolConfig { type: "read"; enabled; name; permission_policy }Configuration for the read tool.
Configuration for the read tool.
interface BetaManagedAgentsReadToolConfigParams { type: "read"; name; enabled; permission_policy }Configuration override for the read tool.
Configuration override for the read tool.
interface BetaManagedAgentsSessionThreadAgent { type: "agent"; id; description; /* 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.
type BetaManagedAgentsSkillParams = BetaManagedAgentsAnthropicSkillParams | BetaManagedAgentsCustomSkillParamsSkill to load in the session container.
Skill to load in the session container.
interface BetaManagedAgentsAnthropicSkillParams { type: "anthropic"; skill_id; 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?: string | nullVersion to pin. Defaults to latest if omitted.
Version to pin. Defaults to latest if omitted.
interface BetaManagedAgentsCustomSkillParams { type: "custom"; skill_id; 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?: string | nullVersion to pin. Defaults to latest if omitted.
Version to pin. Defaults to latest if omitted.
interface BetaManagedAgentsURLMCPServerParams { type: "url"; name; 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.
interface BetaManagedAgentsUserLocation { type: "approximate"; 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?: string | nullCity name.
City name.
Two-letter ISO 3166-1 country code, uppercase.
region?: string | nullRegion or state name.
Region or state name.
timezone?: string | nullIANA timezone identifier, e.g. "America/Los_Angeles".
IANA timezone identifier, e.g. "America/Los_Angeles".
interface BetaManagedAgentsWebFetchToolConfig { type: "web_fetch"; enabled; name; /* 5 more */ }Configuration for the web_fetch tool.
Configuration for the web_fetch tool.
interface BetaManagedAgentsWebFetchToolConfigParams { type: "web_fetch"; name; allowed_domains; /* 5 more */ }Configuration override for the web_fetch tool.
Configuration override for the web_fetch tool.
interface BetaManagedAgentsWebFetchURLSourceAll { type: "all" }Every URL from this source may be fetched. This is the default.
Every URL from this source may be fetched. This is the default.
interface BetaManagedAgentsWebFetchURLSourceExcept { type: "except"; tools }Every tool's results contribute URLs that may be fetched, except the named tools' results.
Every tool's results contribute URLs that may be fetched, except the named tools' results.
tools: Array<BetaManagedAgentsWebFetchURLSourceToolReference { type: "tool_reference"; name }>The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results.
The tools whose results do not contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "all" to leave out no tool's results.
Must be "tool_reference".
name: stringName of the tool. Compared exactly, so upper and lower case letters are different.
Name of the tool. Compared exactly, so upper and lower case letters are different.
interface BetaManagedAgentsWebFetchURLSourceNone { type: "none" }This source contributes no URLs that may be fetched.
This source contributes no URLs that may be fetched.
interface BetaManagedAgentsWebFetchURLSourceOnly { type: "only"; tools }Only the named tools' results contribute URLs that may be fetched.
Only the named tools' results contribute URLs that may be fetched.
tools: Array<BetaManagedAgentsWebFetchURLSourceToolReference { type: "tool_reference"; name }>The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results.
The tools whose results contribute. Between 1 and 128 entries, each with a different name. An empty list is rejected; use "none" to allow no tool's results.
Must be "tool_reference".
name: stringName of the tool. Compared exactly, so upper and lower case letters are different.
Name of the tool. Compared exactly, so upper and lower case letters are different.
type BetaManagedAgentsWebFetchURLSourceShorthand = "all" | "none"String form of a url_sources value that has no field other than its type: "all" means {"type": "all"} and "none" means {"type": "none"}.
String form of a url_sources value that has no field other than its type: "all" means {"type": "all"} and "none" means {"type": "none"}.
type BetaManagedAgentsWebFetchURLSourceToolFilter = BetaManagedAgentsWebFetchURLSourceAll | BetaManagedAgentsWebFetchURLSourceNone | BetaManagedAgentsWebFetchURLSourceOnly | BetaManagedAgentsWebFetchURLSourceExceptWhich tools' results contribute URLs that may be fetched.
Which tools' results contribute URLs that may be fetched.
type BetaManagedAgentsWebFetchURLSourceToolFilterParams = BetaManagedAgentsWebFetchURLSourceShorthand | BetaManagedAgentsWebFetchURLSourceToolFilterWhich tools' results contribute URLs that may be fetched. Accepts the string "all" or "none", or an object whose type is "all", "none", "only" or "except". Responses use the object form.
Which tools' results contribute URLs that may be fetched. Accepts the string "all" or "none", or an object whose type is "all", "none", "only" or "except". Responses use the object form.
type BetaManagedAgentsWebFetchURLSourceShorthand = "all" | "none"String form of a url_sources value that has no field other than its type: "all" means {"type": "all"} and "none" means {"type": "none"}.
String form of a url_sources value that has no field other than its type: "all" means {"type": "all"} and "none" means {"type": "none"}.
type BetaManagedAgentsWebFetchURLSourceToolFilter = BetaManagedAgentsWebFetchURLSourceAll | BetaManagedAgentsWebFetchURLSourceNone | BetaManagedAgentsWebFetchURLSourceOnly | BetaManagedAgentsWebFetchURLSourceExceptWhich tools' results contribute URLs that may be fetched.
Which tools' results contribute URLs that may be fetched.
interface BetaManagedAgentsWebFetchURLSourceToolReference { type: "tool_reference"; name }Names one tool in an only or except list.
Names one tool in an only or except list.
Must be "tool_reference".
name: stringName of the tool. Compared exactly, so upper and lower case letters are different.
Name of the tool. Compared exactly, so upper and lower case letters are different.
type BetaManagedAgentsWebFetchURLSourceUserInput = BetaManagedAgentsWebFetchURLSourceAll | BetaManagedAgentsWebFetchURLSourceNoneWhether URLs in the text of user messages may be fetched.
Whether URLs in the text of user messages may be fetched.
interface BetaManagedAgentsWebFetchURLSourceAll { type: "all" }Every URL from this source may be fetched. This is the default.
Every URL from this source may be fetched. This is the default.
interface BetaManagedAgentsWebFetchURLSourceNone { type: "none" }This source contributes no URLs that may be fetched.
This source contributes no URLs that may be fetched.
type BetaManagedAgentsWebFetchURLSourceUserInputParams = BetaManagedAgentsWebFetchURLSourceShorthand | BetaManagedAgentsWebFetchURLSourceUserInputWhether URLs in the text of user messages may be fetched. Accepts the string "all" or "none", or the object {"type": "all"} or {"type": "none"}. Responses use the object form.
Whether URLs in the text of user messages may be fetched. Accepts the string "all" or "none", or the object {"type": "all"} or {"type": "none"}. Responses use the object form.
type BetaManagedAgentsWebFetchURLSourceShorthand = "all" | "none"String form of a url_sources value that has no field other than its type: "all" means {"type": "all"} and "none" means {"type": "none"}.
String form of a url_sources value that has no field other than its type: "all" means {"type": "all"} and "none" means {"type": "none"}.
type BetaManagedAgentsWebFetchURLSourceUserInput = BetaManagedAgentsWebFetchURLSourceAll | BetaManagedAgentsWebFetchURLSourceNoneWhether URLs in the text of user messages may be fetched.
Whether URLs in the text of user messages may be fetched.
interface BetaManagedAgentsWebFetchURLSourceAll { type: "all" }Every URL from this source may be fetched. This is the default.
Every URL from this source may be fetched. This is the default.
interface BetaManagedAgentsWebFetchURLSourceNone { type: "none" }This source contributes no URLs that may be fetched.
This source contributes no URLs that may be fetched.
interface BetaManagedAgentsWebFetchURLSources { client_tool_results; server_tool_results; user_input }Which sources contribute URLs the web_fetch tool may fetch. A key that is null was not set and allows every URL from that source.
Which sources contribute URLs the web_fetch tool may fetch. A key that is null was not set and allows every URL from that source.
interface BetaManagedAgentsWebFetchURLSourcesParams { client_tool_results; server_tool_results; user_input }Which sources contribute URLs the web_fetch tool may fetch. When web_fetch is limited to URLs the conversation has already shown the model (in a user message, a custom tool's result, or an earlier web_search or web_fetch result), each key narrows one of those sources and defaults to "all". Setting all three keys to "none" is rejected.
Which sources contribute URLs the web_fetch tool may fetch. When web_fetch is limited to URLs the conversation has already shown the model (in a user message, a custom tool's result, or an earlier web_search or web_fetch result), each key narrows one of those sources and defaults to "all". Setting all three keys to "none" is rejected.
interface BetaManagedAgentsWebSearchToolConfig { type: "web_search"; enabled; name; /* 4 more */ }Configuration for the web_search tool.
Configuration for the web_search tool.
interface BetaManagedAgentsWebSearchToolConfigParams { type: "web_search"; name; allowed_domains; /* 4 more */ }Configuration override for the web_search tool.
Configuration override for the web_search tool.
interface BetaManagedAgentsWriteToolConfig { type: "write"; enabled; name; permission_policy }Configuration for the write tool.
Configuration for the write tool.
interface BetaManagedAgentsWriteToolConfigParams { type: "write"; name; enabled; permission_policy }Configuration override for the write tool.
Configuration override for the write tool.