Managed Agents is built around four core concepts:
Managed Agents is built around four core concepts:
| Concept | Endpoint | What it is | |---|---|---| | Agent | /v1/agents | A persisted, versioned object defining the agent's capabilities and persona: model, system prompt, tools, MCP servers, skills. Must be created before starting a session. See the Agents section below. | | Session | /v1/sessions | A stateful interaction with an agent. References a pre-created agent by ID + an environment + initial instructions. Produces an event stream. | | Environment | /v1/environments | A template defining the configuration for container provisioning. | | Container | N/A | An isolated compute instance where the agent's tools execute (bash, file ops, code). The agent loop does not run here — it runs on Anthropic's orchestration layer and acts on the container via tool calls. |
┌─────────────────────────────────────┐
│ Anthropic orchestration layer │
Agent (config) ───────▶│ (agent loop: Claude + tool calls) │
└──────────────┬──────────────────────┘
│ tool calls
▼
Environment (template) ──▶ Container (tool execution workspace)
│
Session ─┤
├── Resources (files, repos, memory stores — attached at startup)
├── Vault IDs (MCP credential references)
└── Conversation (event stream in/out)
Agent creation is a prerequisite. Sessions reference a pre-created agent by ID —
model/system/toolslive on the agent object, never on the session. Every flow starts withPOST /v1/agents.
rescheduling → running ↔ idle → terminated
| Status | Description | | -------------- | ------------------------------------------------------------------ | | idle | Agent has finished the current task, and is awaiting input. It's either waiting for input to continue working via a user.message, blocked awaiting a user.custom_tool_result or user.tool_confirmation, or paused because the session budget cap was reached. The stop_reason attached contains more information about why the Agent has stopped working. | | running | Session has starting running, and the Agent is actively doing work. | | rescheduling | Session is (re)scheduling after a retryable error has occurred, ready to be picked up by the orchestration system. | | terminated | Session has ended and is in an irreversible, unusable state — either on completion or because of an unrecoverable error. Terminated does not by itself mean failure; fetch the session to tell the two apart. |
running or idle. Messages are queued and processed in order. Exception: a session paused at its budget (stop_reason: budget_reached) accepts only settle events — events that resolve work already in progress (user.tool_confirmation, user.tool_result, user.custom_tool_result, user.interrupt) rather than starting new work — see § Session budgets.idle → running when it receives a new event, then back to idle when done.session.error events in the stream, not as a status value.Every session has a live trace view in the Anthropic Console at https://platform.claude.com/workspaces/{workspace}/sessions/{session_id}. Print this URL immediately after creating a session so the user can watch tool calls and messages stream in real time. {workspace} is the workspace the API key belongs to — use default only when that's the org's Default workspace. The session response does not include a workspace field and the Console has no workspace-agnostic session route, so for non-default workspaces substitute the workspace's ID (visible in the Console URL bar, or expose it as a config value alongside the API key). A default link to a session that lives in another workspace lands on a "Session not found" page — the Search workspaces button there will locate it, but it is not an automatic redirect.
agent.thinking events signal thinking progress and carry no thinking content| Operation | Notes | |---|---| | List / fetch | Paginated list or single resource by ID | | Update | title, metadata, and the session-local agent.tools/agent.mcp_servers can be overridden (see § Updating the agent configuration mid-session). budget can only be changed or removed (see § Session budgets). vault_ids is create-only — update requests setting it are rejected. | | Archive | Session becomes read-only. Not reversible. | | Delete | Permanently deletes session, event history, container, and checkpoints. |
These are ops/inspection calls — typically made from a terminal, not application code. From the shell (see shared/anthropic-cli.md):
ant beta:sessions list --transform '{id,title,status,created_at}' --format jsonl
ant beta:sessions retrieve --session-id "$SID"
ant beta:sessions:events stream --session-id "$SID" # watch events live
ant beta:sessions archive --session-id "$SID"
ant beta:sessions delete --session-id "$SID"
A session is a running agent instance inside an environment.
Key fields returned by the API:
| Field | Type | Description | | --------------- | -------- | --------------------------------------------------- | | type | string | Always "session" | | id | string | Unique session ID | | title | string | Human-readable title | | status | string | idle, running, rescheduling, terminated | | created_at | string | ISO 8601 timestamp | | updated_at | string | ISO 8601 timestamp | | archived_at | string | ISO 8601 timestamp (nullable) | | environment_id | string | Environment ID | | agent | object | Agent configuration | | resources | array | Attached files, repos, and memory stores | | metadata | object | User-provided key-value pairs (max 8 keys) | | usage | object | Cumulative usage: token counts, server_tool_use (web search/fetch request counts), list_cost (consumption priced at public list rates, as {amount, currency} with the amount an integer string in minor units — cents), and active_seconds (time with ≥1 thread running; concurrent-thread overlap counted once — unlike stats.active_seconds, which sums per-thread time) | | budget | object | The session's spend cap, when one was set at creation — see § Session budgets | | stats | object | Timing statistics — stats.active_seconds sums per-thread time, unlike usage.active_seconds |
A session is meaningless without an agent. Sessions reference a pre-created agent by ID. Create the agent first via agents.create(), then reference it:
// 1. Create the agent (reusable, versioned)
const agent = await client.beta.agents.create(
{
name: "Coding Assistant",
model: "claude-opus-5",
system: "You are a helpful coding agent.",
tools: [{ type: "agent_toolset_20260401"}],
},
);
// 2. Start a session that references it
const session = await client.beta.sessions.create(
{
agent: agent.id, // string shorthand → latest version. Or: { type: "agent", id: agent.id, version: agent.version }
environment_id: environmentId,
title: "Hello World Session",
},
);
💡 Watch it live in Console. While developing, print a link so you can click through to the session UI instead of parsing the event stream:
https://platform.claude.com/workspaces/{workspace}/sessions/{session.id}. Usedefaultfor{workspace}only when the API key belongs to the org's Default workspace; otherwise substitute the workspace's ID (the session response does not carry it — read it from the Console URL bar or make it a config value). Include thisconsole.login code you generate for users who are iterating locally.
Session creation parameters:
| Field | Type | Required | Description | | --------------- | -------- | -------- | ---------------------------------------------- | | agent | string or object | Yes | Three forms: string shorthand "agent_abc123" (latest version); pinned {type: "agent", id, version}; or {type: "agent_with_overrides", id, version?, ...} to override model/system/tools/mcp_servers/skills for this session only — see § Override agent configuration for a session | | environment_id| string | Yes | Environment ID | | title | string | No | Human-readable name (appears in logs/dashboards) | | resources | array | No | Files, GitHub repos, or memory stores, attached to the container at startup. Memory stores are session-create-only (not addable via resources.add()). | | initial_events| array | No | Events to send at creation, processed in order — collapses create + first send into one call. See § Seeding a session with initial_events below. | | vault_ids | array | No | Vault IDs (vlt_*) — MCP credentials with auto-refresh + environment_variable secrets substituted at egress. See shared/managed-agents-tools.md → Vaults. | | budget | object | No | Hard dollar cap on the session's spend: {type: "limit", max_list_cost: {amount, currency}}. Create-only — can be changed or removed later, never added. See § Session budgets. | | metadata | object | No | User-provided key-value pairs |
initial_eventsCreating a session without initial_events registers the session in idle and starts no work; the sandbox is provisioned when the session first needs it. Passing a non-empty initial_events array starts the agent loop in the same call — the session is created directly in running, never passing through idle. A client that waits for an idle → running transition to know work began will wait forever; check status on the create response instead.
session = client.beta.sessions.create(
agent=AGENT_ID,
environment_id=ENVIRONMENT_ID,
initial_events=[
{"type": "user.message", "content": [{"type": "text", "text": "Review the auth module."}]},
],
)
user.message and user.define_outcome are accepted, max 50 events. The tool-result kinds (user.tool_confirmation, user.tool_result, user.custom_tool_result) are rejected because no agent turn exists yet, and user.interrupt because there is no turn to stop. Unlike a scheduled deployment's initial_events, a session's does not accept system.message.sessions.events.list(session.id) if you need their server-assigned IDs.user.define_outcome → 400; a user.define_outcome without a rubric → 400; more than 100 file-sourced document content blocks across the whole list → 400; a request body over 32 MB → 413.An outcome-driven session is therefore a single call — pass one user.define_outcome in initial_events instead of creating the session and then sending the event (see shared/managed-agents-outcomes.md).
Agent configuration fields (passed to agents.create(), not sessions.create()):
| Field | Type | Required | Description | | ------------- | -------- | -------- | ---------------------------------------------- | | name | string | Yes | Human-readable name (1-256 chars) | | model | string or object | Yes | Claude model ID (bare string, or an object taking id, speed, effort, and inference_geo). All Claude 4.5+ models supported. See § Effort on the agent model and § Pinning inference geography below. | | system | string | No | System prompt — defines the agent's behavior (up to 100K chars) | | tools | array | No | Encompasses three kinds: (1) pre-built Claude Agent tools (agent_toolset_20260401), (2) MCP tools (mcp_toolset), and (3) custom client-side tools. Max 128. | | mcp_servers | array | No | MCP server connections — standardized third-party capabilities (e.g. GitHub, Asana). Max 20, unique names. See shared/managed-agents-tools.md → MCP Servers. | | skills | array | No | Customized "best-practices" context with progressive disclosure. Max 20. See shared/managed-agents-tools.md → Skills. | | description | string | No | Description of the agent (up to 2048 chars) | | multiagent | object | No | {type: "coordinator", agents: [...]} — roster this agent may delegate to. See shared/managed-agents-multiagent.md. | | metadata | object | No | Arbitrary key-value pairs (max 16, keys ≤64 chars, values ≤512 chars) |
A session budget is an optional hard spend ceiling set at session creation. The platform continuously prices everything the session consumes at public list rates (the session's list cost) and stops issuing new model requests once that total reaches the cap. A session at its budget pauses and goes idle with stop_reason: budget_reached — it is not terminated; history and sandbox are preserved, and changing or removing the budget resumes the paused work automatically.
session = client.beta.sessions.create(
agent=AGENT_ID,
environment_id=ENVIRONMENT_ID,
budget={
"type": "limit",
"max_list_cost": {"amount": "2500", "currency": "USD"}, # minor units: "2500" = $25.00
},
)
type is always "limit". max_list_cost.amount is the amount in minor units of the currency (cents), as an integer string with no leading zeros, > 0 — "2500" is $25.00, "50" is fifty cents. A string rather than a number so no float rounding is ever applied; decimal forms such as "25.00" are rejected. max_list_cost.currency is uppercase ISO-4217; USD is the only supported currency.list_cost is rounded to the nearest cent while enforcement compares exact amounts — rounding can move the reported figure up to half a cent in either direction from the exact amount, so a session whose reported list_cost equals its cap may not yet be paused. Treat stop_reason: budget_reached (or the 400 on user.message), not the reported figure, as the signal that the cap was reached.budget.max_list_cost must be greater than the session's consumed list cost) or remove (budget: null — the session.updated event carries budget: null rather than a separate flag). Because the consumed cost usually sits a fraction past the old cap when the session pauses, base the new value on the session's reported usage.list_cost, not the old max_list_cost. Removal is one-way: a removed budget can never be re-added; to keep a cap, change it instead.user.tool_confirmation, user.tool_result, user.custom_tool_result, user.interrupt. A user.interrupt sent while the session is paused at its budget (all threads paused at the cap) is accepted and ignored: it does not appear in the event list and changes nothing. Raise or remove the budget to continue. Anything that starts new work (e.g. user.message) is a 400 naming that list. No event resumes the session — only a budget change/removal does.requires_action and another at budget_reached reports requires_action at the session level — answer it as usual (settle events aren't blocked).session.usage event: shared/managed-agents-events.md § Reaching a session budget.shared/managed-agents-scheduled-deployments.md § Deployment budgets.Not the same thing as Messages-API task budgets. Session budgets are hard, dollar-denominated, platform-enforced caps on one session.
task_budgeton the Messages API is an advisory, token-denominated budget the model uses to pace itself within one agentic loop.
This is where every Managed Agents flow begins. The agent object is a persisted, versioned configuration — you create it once, then reference it by ID every time you start a session. No agent → no session.
The API is flat — model, system, tools etc. are top-level fields, not wrapped in an agent:{} sub-object.
| Field | Type | Required | Description | | ------------------ | -------- | -------- | -------------------------------------------------- | | name | string | Yes | Human-readable name | | model | string or object | Yes | Claude model ID — bare string, or {id, speed?, effort?, inference_geo?} | | system | string | No | System prompt | | tools | array | No | Agent toolset / MCP toolset / custom tools | | mcp_servers | array | No | MCP server connections | | skills | array | No | Skill references (max 20) | | description | string | No | Description of the agent | | multiagent | object | No | Coordinator roster — see shared/managed-agents-multiagent.md | | metadata | object | No | Arbitrary key-value pairs |
The agent is a persistent resource, not a per-run parameter. The intended pattern:
┌─ setup (once) ─────────┐ ┌─ runtime (every invocation) ─┐
│ agents.create() │ │ sessions.create( │
│ → store agent_id │ ──→ │ agent={type:..., id: ID} │
│ in config/env/db │ │ ) │
└────────────────────────┘ └──────────────────────────────┘
Anti-pattern: calling agents.create() at the top of every script run. This accumulates orphaned agent objects, pays create latency on every invocation, and defeats the versioning model. If you see agents.create() in a function that's called per-request or per-cron-tick, that's wrong — hoist it to one-time setup and persist the ID.
Recommended — define agents and environments as YAML + apply via the
antCLI. The split is CLI for the control plane, SDK for the data plane: agents and environments are relatively static resources you manage withant(version-controlled YAML, applied from CI); sessions are dynamic and driven by your application through the SDK. Seeshared/anthropic-cli.md→ Version-controlled Managed Agents resources for theant beta:agents create < agent.yaml/update --version Nflow. The SDKagents.create()call shown elsewhere in this doc is the in-code equivalent — use it when you need to provision programmatically, but prefer the YAML flow for anything a human maintains.
Pass model as an object to set the effort level: {"id": "claude-opus-5", "effort": "high"}. effort accepts a level string (low, medium, high, xhigh, max) or an object such as {"type": "high"}. The create/update response echoes it in object form and fills in omitted model fields with their defaults.
⚠️ Effort is agent configuration only. An
effortset inside a per-sessionmodeloverride is not applied — the session runs at the agent's effort. To change effort you must update the agent (or point the session at a different agent). This is the one field where the override form silently does nothing rather than erroring.
The same object form carries speed for fast mode: {"id": "claude-opus-5", "speed": "fast"}.
inference_geo)The model object also takes inference_geo to pin the geography that serves the agent's model requests: {"id": "claude-opus-5", "inference_geo": "us"}. Accepts "us" or "global" — and unlike the Messages API, where inference_geo is a top-level request parameter, here it is always nested inside model, never top-level. When unset, each model request follows the workspace's default inference geo at the time it's served.
allowed_inference_geos when the agent is saved, when a session is created from it, and on every turn the session serves. If the workspace allowlist later narrows so the pin is no longer allowed, new sessions can't be created from the agent and running sessions refuse further turns — pins are never grandfathered (workspaces rely on them for compliance).inference_geo on a model that doesn't support geographic inference pinning returns a 400.model override at session create (see § Override agent configuration for a session).shared/managed-agents-multiagent.md.effort, an inference_geo inside a per-session model override is applied — and because overrides replace the model object in full, an override that omits inference_geo clears the agent's pin for that session.Each POST /v1/agents/{id} (update) creates a new immutable version — a sequential integer, starting at 1 and incrementing on each update. The agent's history is append-only — you can't edit a past version.
version on update is optional. Supply it for optimistic concurrency, or omit it to apply the update unconditionally:
| version | Behavior | Fits | |---|---|---| | Supplied (must be ≥ 1) | 409 if it doesn't match the agent's current version — even when the fields you send already equal the stored values. Re-read and retry. | Interactive callers; the recommended default | | Omitted | Applies unconditionally. The most recent update silently replaces any concurrent one, with no error to either caller. | Declarative apply loops — e.g. a CI job syncing checked-in agent definitions, where the loop owns the agent |
Update semantics. Omitted fields are preserved. Scalar fields (model, system, name, description) are replaced; system and description can be cleared with null, while model and name cannot. Array fields (tools, mcp_servers, skills) are replaced wholesale — null or [] clears them. effort is the sole exception inside a model object you supply: if the model id is unchanged, omitting effort leaves the stored level alone; if you change the id, an omitted effort resets to the new model's default. Other model fields are replaced along with the object — supplying model without inference_geo clears the agent's inference geo pin.
Why version:
{type: "agent", id, version: 3}version is optional. Omit it (or use the string shorthand agent="agent_abc123") to get the latest version at session-creation time. Pass it explicitly ({type: "agent", id, version: N}) to pin for reproducibility.
Getting the version to pin: agents.create() and agents.update() both return version in the response. Store it alongside agent_id. To fetch the current latest for an existing agent: GET /v1/agents/{id} → .version.
When to update vs create new: Update (POST /v1/agents/{id}) when it's conceptually the same agent with tweaked behavior (better prompt, extra tool). Create a new agent when it's a different persona/purpose. Rule of thumb: if you'd give it the same name, update.
| Operation | Method | Path | | ---------------- | -------- | ------------------------------------- | | Create | POST | /v1/agents | | List | GET | /v1/agents | | Get | GET | /v1/agents/{id} | | Update | POST | /v1/agents/{id} | | Archive | POST | /v1/agents/{id}/archive |
⚠️ Archive is permanent. Archiving makes the agent read-only: existing sessions continue to run, but new sessions cannot reference it, and there is no unarchive. Since agents have no
delete, this is the terminal lifecycle state. Never archive a production agent as routine cleanup — confirm with the user first.
Reference the agent by string ID (latest version) or by object with an explicit version:
# String shorthand — uses the agent's latest version
session = client.beta.sessions.create(
agent=agent.id,
environment_id=environment_id,
)
# Or pin to a specific version (int)
session = client.beta.sessions.create(
agent={"type": "agent", "id": agent.id, "version": agent.version},
environment_id=environment_id,
)
The third agent form, agent_with_overrides, replaces parts of the agent's configuration for a single session — try a different model or grant an extra tool without versioning the agent. Pass id (and optionally version; omitted = latest, same default as the other two forms) plus any of model, system, tools, mcp_servers, skills:
session = client.beta.sessions.create(
agent={
"type": "agent_with_overrides",
"id": agent.id,
"model": "claude-opus-5", # replace the agent's model for this session
"system": None, # clear the system prompt for this session
},
environment_id=environment_id,
)
Each overridable field follows tri-state rules:
null (or [] for list fields) → the session runs with that field cleared. Applies in full to system and skills. Three exceptions: model is never clearable (model: null → 400 agent_model_required); clearing tools returns 400 when the session's effective skills is non-empty (skills require the read tool); and clearing mcp_servers returns 400 when the effective tools still contains an mcp_toolset referencing one of the agent's servers — override tools in the same request to drop those entries, then clear mcp_servers.tools override must list every tool the session should have. One exception: an effort level inside a model override is not applied (set it on the agent instead — see § Effort on the agent model). An inference_geo inside a model override is applied — and because the object is replaced in full, an override that omits it clears the agent's pin, so the session follows the workspace's default inference geo. The overridden value is validated against the workspace's allowed_inference_geos at session create.Overrides are session-local: they do not modify the agent resource or create a new agent version. The response's agent object reflects the post-override configuration, while its id and version still identify the base agent — so you can trace a session back to its base. In multiagent sessions, overrides apply to the coordinator and its {type: "self"} copies; roster agents referenced by ID always use their own as-created configuration (see shared/managed-agents-multiagent.md).
sessions.update() can change agent.tools and agent.mcp_servers (including permission policies) on an existing session. This is a session-local override — it does not create a new agent version and does not propagate back to the agent object. The provided arrays are full replacements; to append one tool, GET the session, modify, and POST back. The session must be idle — interrupt first if running. vault_ids is create-only: the update param exists in the SDK but is rejected by the API ("Not yet supported") — attach vaults when you create the session.
Among the agent-configuration fields, only tools and mcp_servers can change after a session is created — to run with a model, system, or skills other than the agent's values, use agent_with_overrides at create time (above). (title, metadata, and budget have their own session-update paths — see § Session operations / § Session budgets.) The agent's model configuration — including its inference_geo pin — and its configured system field are fixed for the session's lifetime; you can still append system-level context between turns by sending a system.message event (see shared/managed-agents-events.md § Adding system context mid-session).
client.beta.sessions.update(
session.id,
agent={
"tools": [
{"type": "agent_toolset_20260401"},
{"type": "mcp_toolset", "mcp_server_name": "linear"},
],
"mcp_servers": [{"type": "url", "name": "linear", "url": "https://mcp.linear.app/sse"}],
},
)