One change
Get Agent
api/beta/agents/retrieve
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/beta/agents/retrieve Changed · +75 / -130 lines
# Get Agent ## Path parameters ## Query parameters ## Headers ## Returns ## Example ### Response (200) ## Get Agent ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
---- -title: Get Agent -url: https://platform.claude.com/docs/en/api/beta/agents/retrieve ---- +# Get Agent -## Get Agent +**GET** `/v1/agents/{agent_id}` -**get** `/v1/agents/{agent_id}` - Get Agent -### Path Parameters +## Path parameters - `agent_id: string` -### Query Parameters +## Query parameters - `version: optional number` Agent version. Omit for the most recent version. Must be at least 1 if specified. -### Header Parameters + format: int32 +## Headers + - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use.
from line 94
- `"mid-conversation-tool-changes-2026-07-01"` -### Returns +## Returns -- `BetaManagedAgentsAgent object { id, archived_at, created_at, 12 more }` +- `BetaManagedAgentsAgent object` A Managed Agents `agent`.
from line 106
A timestamp in RFC 3339 format + format: date-time + - `created_at: string` A timestamp in RFC 3339 format + format: date-time + - `description: string or null` - `mcp_servers: array of BetaManagedAgentsMCPServerURLDefinition`
from line 122
- `type: "url"` - - `"url"` - - `url: string` - `metadata: map[string]`
from line 200
How hard Claude works on each turn. Sets `output_config.effort` on every Messages call the session makes. - - `BetaManagedAgentsEffortLow object { type }` + - `BetaManagedAgentsEffortLow object` Low effort. Favors latency over reasoning depth. - `type: "low"` - - `"low"` + - `BetaManagedAgentsEffortMedium object` - - `BetaManagedAgentsEffortMedium object { type }` - Medium effort. Balances latency and reasoning depth. - `type: "medium"` - - `"medium"` + - `BetaManagedAgentsEffortHigh object` - - `BetaManagedAgentsEffortHigh object { type }` - High effort. Favors reasoning depth. - `type: "high"` - - `"high"` + - `BetaManagedAgentsEffortXhigh object` - - `BetaManagedAgentsEffortXhigh object { type }` - Extra-high effort. Not all models accept this level. - `type: "xhigh"` - - `"xhigh"` + - `BetaManagedAgentsEffortMax object` - - `BetaManagedAgentsEffortMax object { type }` - Maximum effort. Favors reasoning depth over latency. - `type: "max"` - - `"max"` - - `inference_geo: optional string` Geographic region for model inference. When unset, requests fall through to the workspace's default_inference_geo.
from line 250
Agents the coordinator may spawn as session threads, each resolved to a specific version. - - `BetaManagedAgentsAgentReference object { id, type, version }` + - `BetaManagedAgentsAgentReference object` A resolved agent reference with a concrete version.
from line 258
- `type: "agent"` - - `"agent"` - - `version: number` - - `BetaManagedAgentsAdvisor object { model, type }` + format: int32 + - `BetaManagedAgentsAdvisor object` + Platform advisor roster entry: a model the session's primary thread may consult mid-turn. - `model: string`
from line 272
- `type: "advisor"` - - `"advisor"` - - `type: "coordinator"` - - `"coordinator"` - - `name: string` - `skills: array of BetaManagedAgentsAnthropicSkill or BetaManagedAgentsCustomSkill` - - `BetaManagedAgentsAnthropicSkill object { skill_id, type, version }` + - `BetaManagedAgentsAnthropicSkill object` A resolved Anthropic-managed skill.
from line 286
- `type: "anthropic"` - - `"anthropic"` - - `version: string` - - `BetaManagedAgentsCustomSkill object { skill_id, type, version }` + - `BetaManagedAgentsCustomSkill object` A resolved user-created custom skill.
from line 296
- `type: "custom"` - - `"custom"` - - `version: string` - `system: string or null`
from line 302
- `tools: array of BetaManagedAgentsAgentToolset20260401 or BetaManagedAgentsMCPToolset or BetaManagedAgentsCustomTool` - - `BetaManagedAgentsAgentToolset20260401 object { configs, default_config, type }` + - `BetaManagedAgentsAgentToolset20260401 object` - `configs: array of BetaManagedAgentsAgentToolConfig` - - `BetaManagedAgentsBashToolConfig object { enabled, name, permission_policy, type }` + - `BetaManagedAgentsBashToolConfig object` Configuration for the bash tool.
from line 314
- `name: "bash"` - - `"bash"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - `type: "always_allow"` - - `"always_allow"` + - `BetaManagedAgentsAlwaysAskPolicy object` - - `BetaManagedAgentsAlwaysAskPolicy object { type }` - Tool calls require user confirmation before execution. - `type: "always_ask"` - - `"always_ask"` - - `type: "bash"` - - `"bash"` + - `BetaManagedAgentsEditToolConfig object` - - `BetaManagedAgentsEditToolConfig object { enabled, name, permission_policy, type }` - Configuration for the edit tool. - `enabled: boolean`
from line 340
- `name: "edit"` - - `"edit"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "edit"` - - `"edit"` + - `BetaManagedAgentsReadToolConfig object` - - `BetaManagedAgentsReadToolConfig object { enabled, name, permission_policy, type }` - Configuration for the read tool. - `enabled: boolean`
from line 362
- `name: "read"` - - `"read"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "read"` - - `"read"` + - `BetaManagedAgentsWriteToolConfig object` - - `BetaManagedAgentsWriteToolConfig object { enabled, name, permission_policy, type }` - Configuration for the write tool. - `enabled: boolean`
from line 384
- `name: "write"` - - `"write"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "write"` - - `"write"` + - `BetaManagedAgentsGlobToolConfig object` - - `BetaManagedAgentsGlobToolConfig object { enabled, name, permission_policy, type }` - Configuration for the glob tool. - `enabled: boolean`
from line 406
- `name: "glob"` - - `"glob"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "glob"` - - `"glob"` + - `BetaManagedAgentsGrepToolConfig object` - - `BetaManagedAgentsGrepToolConfig object { enabled, name, permission_policy, type }` - Configuration for the grep tool. - `enabled: boolean`
from line 428
- `name: "grep"` - - `"grep"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "grep"` - - `"grep"` + - `BetaManagedAgentsWebFetchToolConfig object` - - `BetaManagedAgentsWebFetchToolConfig object { enabled, name, permission_policy, 4 more }` - Configuration for the web_fetch tool. - `enabled: boolean`
from line 450
- `name: "web_fetch"` - - `"web_fetch"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "web_fetch"` - - `"web_fetch"` - - `allowed_domains: optional array of string` - `blocked_domains: optional array of string`
from line 470
- `max_content_tokens: optional number or null` - - `BetaManagedAgentsWebSearchToolConfig object { enabled, name, permission_policy, 4 more }` + format: int32 + - `BetaManagedAgentsWebSearchToolConfig object` + Configuration for the web_search tool. - `enabled: boolean`
from line 480
- `name: "web_search"` - - `"web_search"` - - `permission_policy: BetaManagedAgentsAlwaysAllowPolicy or BetaManagedAgentsAlwaysAskPolicy` Permission policy for tool execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "web_search"` - - `"web_search"` - - `allowed_domains: optional array of string` - `blocked_domains: optional array of string`
from line 506
Location precision. Only "approximate" is supported. - - `"approximate"` - - `city: optional string or null` City name. + minLength: 1, maxLength: 255 + - `country: optional string or null` Two-letter ISO 3166-1 country code, uppercase.
from line 520
Region or state name. + minLength: 1, maxLength: 255 + - `timezone: optional string or null` IANA timezone identifier, e.g. "America/Los_Angeles". + minLength: 1, maxLength: 255 + - `default_config: BetaManagedAgentsAgentToolsetDefaultConfig` Resolved default configuration for agent tools.
from line 538
Permission policy for tool execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution. - `type: "agent_toolset_20260401"` - - `"agent_toolset_20260401"` + - `BetaManagedAgentsMCPToolset object` - - `BetaManagedAgentsMCPToolset object { configs, default_config, mcp_server_name, type }` - - `configs: array of BetaManagedAgentsMCPToolConfig` - `enabled: boolean`
from line 560
Permission policy for tool execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution.
from line 578
Permission policy for tool execution. - - `BetaManagedAgentsAlwaysAllowPolicy object { type }` + - `BetaManagedAgentsAlwaysAllowPolicy object` Tool calls are automatically approved without user confirmation. - - `BetaManagedAgentsAlwaysAskPolicy object { type }` + - `BetaManagedAgentsAlwaysAskPolicy object` Tool calls require user confirmation before execution.
from line 590
- `type: "mcp_toolset"` - - `"mcp_toolset"` + - `BetaManagedAgentsCustomTool object` - - `BetaManagedAgentsCustomTool object { description, input_schema, name, type }` - A custom tool as returned in API responses. - `description: string`
from line 602
- `type: "object"` - - `"object"` - - `properties: optional map[unknown] or null` - `required: optional array of string or null`
from line 610
- `type: "custom"` - - `"custom"` - - `type: "agent"` - - `"agent"` - - `updated_at: string` A timestamp in RFC 3339 format + format: date-time + - `version: number` The agent's current version. Starts at 1 and increments when the agent is modified. -### Example + format: int32 -```http +## Example + +```bash curl https://api.anthropic.com/v1/agents/$AGENT_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \
from line 633
-H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +### Response (200) ```json {