VOOZH about

URL: https://platform.claude.com/docs/en/managed-agents/agent-setup

⇱ Define your agent - Claude API Docs


Agent setup
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...

An agent is a reusable, versioned configuration that defines persona and capabilities. It bundles the model, system prompt, tools, MCP servers, and skills that shape how Claude behaves during a session.

Create the agent once as a reusable resource and reference it by ID each time you start a session. Agents are versioned and easier to manage across many sessions.

All Managed Agents API requests require the managed-agents-2026-04-01 beta header. The SDK sets the beta header automatically.

Agent configuration fields

FieldDescription
nameRequired. A human-readable name for the agent.
modelRequired. The Claude model that powers the agent. All Claude 4.5-family and later models are supported.
systemA system prompt that defines the agent's behavior and persona. The system prompt is distinct from user messages, which should describe the work to be done.
toolsThe tools available to the agent. Combines pre-built agent tools, MCP tools, and custom tools.
mcp_serversMCP servers that provide standardized third-party capabilities.
skillsSkills that supply domain-specific context with progressive disclosure.
multiagentA coordinator declaration listing the agents this agent can delegate to. See Multiagent sessions.
descriptionA description of what the agent does.
metadataArbitrary key-value pairs for your own tracking.

Create an agent

The following example defines a coding agent that uses Claude Opus 4.8 with access to the pre-built agent toolset. The toolset lets the agent write code, read files, search the web, and more. See the agent tools reference for the full list of supported tools.

To use Claude Opus 4.8, Claude Opus 4.7, or Claude Opus 4.6 with fast mode, pass model as an object, for example: {"id": "claude-opus-4-8", "speed": "fast"}. Fast mode for Claude Opus 4.6 is deprecated as of the Claude Opus 4.8 launch and will be removed approximately 30 days later.

The response echoes your configuration and adds id, type, version, created_at, updated_at, and archived_at fields. The version starts at 1 and increments each time an update changes the agent.

{
 "id": "agent_01HqR2k7vXbZ9mNpL3wYcT8f",
 "type": "agent",
 "name": "Coding Assistant",
 "model": {
 "id": "claude-opus-4-8",
 "speed": "standard"
 },
 "system": "You are a helpful coding agent.",
 "description": null,
 "tools": [
 {
 "type": "agent_toolset_20260401",
 "default_config": {
 "permission_policy": { "type": "always_allow" }
 }
 }
 ],
 "skills": [],
 "mcp_servers": [],
 "metadata": {},
 "version": 1,
 "created_at": "2026-04-03T18:24:10.412Z",
 "updated_at": "2026-04-03T18:24:10.412Z",
 "archived_at": null
}

Update an agent

Updating an agent generates a new version when the configuration changes. Pass the current version to ensure you're updating from a known state.

Update semantics

  • Omitted fields are preserved. You only need to include the fields you want to change.

  • Scalar fields (model, system, name, description) are replaced with the new value. system and description can be cleared by passing null. model and name are mandatory and cannot be cleared.

  • Array fields (tools, mcp_servers, skills) are fully replaced by the new array. To clear an array field entirely, pass null or an empty array.

Agent lifecycle

OperationBehavior
UpdateGenerates a new agent version when the configuration changes.
List versionsReturns the full version history so you can track changes over time.
ArchiveMakes the agent read-only. New sessions cannot reference it, but existing sessions continue to run.

List versions

Fetch the full version history to track how an agent has changed over time.

Archive an agent

Archiving makes the agent read-only. Existing sessions continue to run, but new sessions cannot reference the agent. The response sets archived_at to the archive timestamp.

Next steps

Was this page helpful?

ant beta:agents create \
 --name "Coding Assistant" \
 --model '{id: claude-opus-4-8}' \
 --system "You are a helpful coding agent." \
 --tool '{type: agent_toolset_20260401}'
ant beta:agents update \
 --agent-id "$AGENT_ID" \
 --version "$AGENT_VERSION" \
 --system "You are a helpful coding agent. Always write tests."

multiagent is replaced as a whole, including its agents roster. Pass null to clear it.

  • Metadata is merged at the key level. Keys you provide are added or updated. Keys you omit are preserved. To delete a specific key, set its value to an empty string.

  • No-op detection. If the update produces no change relative to the current version, no new version is created and the existing version is returned.

  • Coordinator rosters are not updated. Coordinators that reference this agent in their multiagent.agents roster keep the version that was pinned when the coordinator was created or last updated, even if the reference omits version. To delegate to the new version, update the coordinator so its roster references it.

  • ant beta:agents:versions list --agent-id "$AGENT_ID"
    ant beta:agents archive --agent-id "$AGENT_ID"