Claude Platform Docs

Create Session

$ ant beta:sessions create
POST/v1/sessions
Requires anthropic-beta: managed-agents-2026-04-01. Learn how to send beta headers.

Create Session

Parameters

Agent identifier. Accepts the agent ID string, which pins the latest version for the session, or an agent object with both id and version specified.

One of the following:
union_member_0: string
beta_managed_agents_agent_params: object{ 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

type: "agent"
id: string

The agent ID.

minLength1
maxLength128
version: optional number

The specific agent version to use. Omit to use the latest version. Must be at least 1 if specified.

formatint32
beta_managed_agents_agent_with_overrides_params: object{ type: "agent_with_overrides", id, mcp_servers, 5 more }

Reference to an agent plus optional configuration overrides. Each provided field replaces the agent's value for the caller's use; the agent resource is unchanged.

--environment-id: string

ID of the environment defining the container configuration for this session.

minLength1
maxLength128
--budget: optional BetaManagedAgentsBudgetLimit { type: "limit", max_list_cost }

Enforced spend ceiling for the session. Omit to create an uncapped session. Every model the session can run — the agent's model and each callable agent's model — must have a public list price, or the request is rejected with reason model_not_budgetable.

type: "limit"
max_list_cost: object{ amount, currency }

Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.

amount: string

Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

pattern^(0|[1-9]\d*)$
currency: "USD"

Uppercase ISO-4217 currency code. USD is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

Initial events to send to the session at creation, processed in order. Supports user.message and user.define_outcome events. Maximum 50 events.

One of the following:
beta_managed_agents_user_message_event_params: object{ type: "user.message", content }

Parameters for sending a user message to the session.

beta_managed_agents_user_define_outcome_event_params: object{ type: "user.define_outcome", description, rubric, max_iterations }

Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.

--metadata: optional map[string]

Arbitrary key-value metadata attached to the session. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.

Resources (e.g. repositories, files) to mount into the session's container.

One of the following:
beta_managed_agents_github_repository_resource_params: object{ type: "github_repository", url, authorization_token, 2 more }

Mount a GitHub repository into the session's container.

beta_managed_agents_file_resource_params: object{ type: "file", file_id, mount_path }

Mount a file uploaded via the Files API into the session.

type: "file"
file_id: string

ID of a previously uploaded file.

minLength1
maxLength128
mount_path: optional string

Mount path in the container. Defaults to /mnt/session/uploads/<file_id>.

minLength1
maxLength4096
beta_managed_agents_memory_store_resource_param: object{ type: "memory_store", memory_store_id, access, instructions }

Parameters for attaching a memory store to an agent session.

type: "memory_store"
memory_store_id: string

The memory store ID (memstore_...). Must belong to the caller's organization and workspace.

pattern^memstore_[a-zA-Z0-9_]+$
access: optional "read_write" or "read_only"

Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem.

One of the following:
"read_write"
"read_only"
instructions: optional string

Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.

maxLength4096
--title: optional string

Human-readable session title.

maxLength500
--vault-id: optional array of string

Vault IDs for stored credentials the agent can use during the session.

--beta: optional array of AnthropicBeta⁠Header parameter

This endpoint is in beta: requests must send managed-agents-2026-04-01 in this header.

One of the following:
"computer-use-2024-10-22"
"computer-use-2025-01-24"
"output-128k-2025-02-19"
"mcp-client-2025-04-04"
"mcp-client-2025-11-20"
"dev-full-thinking-2025-05-14"
"interleaved-thinking-2025-05-14"
"code-execution-2025-05-22"
"context-1m-2025-08-07"
"context-management-2025-06-27"
"model-context-window-exceeded-2025-08-26"
"fast-mode-2026-02-01"
"output-300k-2026-03-24"
"user-profiles-2026-03-24"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
"telemetry-destinations-2026-08-11"
"webhooks-2026-10-07"
"admin-user-sign-out-2026-10-08"
"message-threads-2026-08-12"
"analytics-usage-cost-2026-08-24"
"experimental-claude-tag-2026-10-21"
"user-profiles-billing-2026-10-01"
"message-batches-2024-09-24"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"prompt-caching-2024-07-31"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"pdfs-2024-09-25"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"token-counting-2024-11-01"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"token-efficient-tools-2025-02-19"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"files-api-2025-04-14"⁠Deprecated
Sending this value selects the beta response shapes. Removing it moves you to the current shapes, so follow the migration steps: https://platform.claude.com/docs/en/build-with-claude/files#migrate-from-files-api-2025-04-14
"extended-cache-ttl-2025-04-11"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"skills-2025-10-02"⁠Deprecated
Sending this value selects the beta response shapes. Removing it moves you to the current shapes, so follow the migration steps: https://platform.claude.com/docs/en/build-with-claude/skills-guide#migrate-from-skills-2025-10-02
"cache-diagnosis-2026-04-07"⁠Deprecated
This value is no longer needed. Remove it from your requests.
"ce-user-management-2026-07-13"⁠Deprecated
This value is no longer needed. Remove it from your requests.
--workspace-id: optional string⁠Header parameter

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Returns
beta_managed_agents_session: object{ type: "session", id, agent, 14 more }

A Managed Agents session.

Create Session
ant beta:sessions create \
  --agent agent_011CZkYpogX7uDKUyvBTophP \
  --environment-id env_011CZkZ9X2dpNyB7HsEFoRfW
Returns Examples
Response 200
{
  "id": "sesn_011CZkZAtmR3yMPDzynEDxu7",
  "agent": {
    "id": "agent_011CZkYpogX7uDKUyvBTophP",
    "description": "A general-purpose starter agent.",
    "execution_identity": {
      "type": "service_account"
    },
    "mcp_servers": [
      {
        "name": "example-mcp",
        "type": "url",
        "url": "https://example-server.modelcontextprotocol.io/sse"
      }
    ],
    "model": {
      "id": "claude-opus-5-5",
      "effort": {
        "type": "low"
      },
      "inference_geo": "inference_geo",
      "speed": "standard"
    },
    "multiagent": null,
    "name": "My First Agent",
    "skills": [
      {
        "skill_id": "xlsx",
        "type": "anthropic",
        "version": "1"
      },
      {
        "skill_id": "skill_011CZkZFNu9hAbo3jZPRgTmx",
        "type": "custom",
        "version": "2"
      }
    ],
    "system": "You are a general-purpose agent that can research, write code, run commands, and use connected tools to complete the user's task end to end.",
    "tools": [
      {
        "configs": [],
        "default_config": {
          "enabled": true,
          "permission_policy": {
            "type": "always_ask"
          }
        },
        "type": "agent_toolset_20260401"
      }
    ],
    "type": "agent",
    "version": 1
  },
  "archived_at": null,
  "budget": null,
  "created_at": "2026-03-15T10:00:00Z",
  "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
  "metadata": {},
  "outcome_evaluations": [
    {
      "completed_at": "2026-03-15T10:02:31Z",
      "description": "Produce a 2-page summary as summary.md",
      "explanation": "All five sections present with inline citations.",
      "iteration": 0,
      "outcome_id": "outc_011CZkZRSw2kEfs6ncTVmjxP",
      "result": "satisfied",
      "type": "outcome_evaluation"
    }
  ],
  "resources": [
    {
      "id": "sesrsc_011CZkZBJq5dWxk9fVLNcPht",
      "created_at": "2026-03-15T10:00:00Z",
      "file_id": "file_011CNha8iCJcU1wXNR6q4V8w",
      "mount_path": "/uploads/receipt.pdf",
      "type": "file",
      "updated_at": "2026-03-15T10:00:00Z"
    },
    {
      "id": "sesrsc_011CZkZCKr6eXym1gWMPdQiu",
      "created_at": "2026-03-15T10:00:00Z",
      "mount_path": "/workspace/example-repo",
      "type": "github_repository",
      "updated_at": "2026-03-15T10:00:00Z",
      "url": "https://github.com/example-org/example-repo",
      "checkout": {
        "name": "main",
        "type": "branch"
      }
    }
  ],
  "stats": {
    "active_seconds": 0,
    "duration_seconds": 0
  },
  "status": "idle",
  "title": "Order #1234 inquiry",
  "type": "session",
  "updated_at": "2026-03-15T10:00:00Z",
  "usage": {
    "active_seconds": 0,
    "cache_creation": {
      "ephemeral_1h_input_tokens": 0,
      "ephemeral_5m_input_tokens": 0
    },
    "cache_read_input_tokens": 0,
    "input_tokens": 0,
    "list_cost": {
      "amount": "2500",
      "currency": "USD"
    },
    "output_tokens": 0,
    "server_tool_use": {
      "web_fetch_requests": 0,
      "web_search_requests": 3
    }
  },
  "vault_ids": [
    "vlt_011CZkZDLs7fYzm1hXNPeRjv"
  ],
  "deployment_id": "deployment_id"
}