Claude Platform Docs

デプロイメントを作成

$ ant beta:deployments create
POST/v1/deployments

デプロイメントを作成

Parameters
--agent: string or BetaManagedAgentsAgentParams { id, type, version }

Body param: Agent to deploy. Accepts the agent ID string, which pins the latest version, or an agent object with both id and version specified. The agent must exist and not be archived.

--environment-id: string

Body param: ID of the environment defining the container configuration for sessions created from this deployment.

minLength1
maxLength128
--initial-event: array of BetaManagedAgentsDeploymentInitialEventParams

Body param: Events to send to each session immediately after creation. At least 1, maximum 50.

--name: string

Body param: Human-readable name for the deployment.

minLength1
maxLength256
--budget: optional object{ max_list_cost, type }

Body param: A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches max_list_cost.

--description: optional string

Body param: Description of what the deployment does.

maxLength2048
--metadata: optional map[string]

Body param: Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.

--resource: optional array of BetaManagedAgentsGitHubRepositoryResourceParams { authorization_token, type, url, 2 more } or BetaManagedAgentsFileResourceParams { file_id, type, mount_path } or BetaManagedAgentsMemoryStoreResourceParam { memory_store_id, type, access, instructions }

Body param: Resources (e.g. repositories, files) to mount into each session's container. Maximum 500.

--schedule: optional object{ expression, timezone, type }

Body param: 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.

--vault-id: optional array of string

Body param: Vault IDs for stored credentials the agent can use during sessions created from this deployment. Maximum 50.

--beta: optional array of AnthropicBeta

Header param: Optional header to specify the beta version(s) you want to use.

Returns
beta_managed_agents_deployment: object{ id, agent, archived_at, 14 more }

A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule.

id: string

Unique identifier for this deployment.

agent: object{ id, type, version }

A resolved agent reference with a concrete version.

id: string
type: "agent"
version: number
formatint32
archived_at: string

A timestamp in RFC 3339 format

formatdate-time
created_at: string

A timestamp in RFC 3339 format

formatdate-time
description: string

Description of what the deployment does.

environment_id: string

ID of the environment where sessions run.

initial_events: array of BetaManagedAgentsDeploymentInitialEvent

Events sent to each session immediately after creation.

One of the following:
beta_managed_agents_deployment_user_message_event: object{ content, type }

A user message sent to the session.

content: array of BetaManagedAgentsTextBlock { text, type } or BetaManagedAgentsImageBlock { source, type } or BetaManagedAgentsDocumentBlock { source, type, context, title } or BetaManagedAgentsRedactedBlock { type }

Array of content blocks for the user message.

One of the following:
beta_managed_agents_text_block: object{ text, type }

Regular text content.

text: string

The text content.

minLength1
type: "text"
beta_managed_agents_image_block: object{ source, type }

Image content specified directly as base64 data or as a reference via a URL.

beta_managed_agents_document_block: object{ source, type, context, title }

Document content, either specified directly as base64 data, as text, or as a reference via a URL.

beta_managed_agents_redacted_block: object{ type }

Placeholder for content withheld by Anthropic model policy.

type: "redacted"
type: "user.message"
beta_managed_agents_deployment_user_define_outcome_event: object{ description, rubric, type, max_iterations }

An outcome the agent should work toward. The agent begins work on receipt.

description: string

What the agent should produce. This is the task specification.

rubric: BetaManagedAgentsFileRubric { file_id, type } or BetaManagedAgentsTextRubric { content, type }

Rubric for grading the quality of an outcome.

One of the following:
beta_managed_agents_file_rubric: object{ file_id, type }

Rubric referenced by a file uploaded via the Files API.

file_id: string

ID of the rubric file.

type: "file"
beta_managed_agents_text_rubric: object{ content, type }

Rubric content provided inline as text.

content: string

Rubric content. Plain text or markdown — the grader treats it as freeform text.

type: "text"
type: "user.define_outcome"
max_iterations: optional number

Eval→revision cycles before giving up. Default 3, max 20.

formatint32
beta_managed_agents_deployment_system_message_event: object{ content, type }

Privileged context for the accompanying turn and all subsequent turns, appended to the session's system context as a role: "system" turn rather than replacing the top-level system prompt.

content: array of BetaManagedAgentsSystemContentBlock { text, type }

System content blocks to append. Text-only.

text: string

The text content.

minLength1
type: "text"
type: "system.message"
metadata: map[string]

Arbitrary key-value metadata. Maximum 16 pairs.

name: string

Human-readable name.

paused_reason: BetaManagedAgentsManualDeploymentPausedReason { type } or BetaManagedAgentsErrorDeploymentPausedReason { error, type }

Why a deployment is paused. Non-null exactly when status is paused.

One of the following:
beta_managed_agents_manual_deployment_paused_reason: object{ type }

The caller invoked the pause endpoint on the deployment.

type: "manual"
beta_managed_agents_error_deployment_paused_reason: object{ error, type }

A scheduled fire recorded a failed run whose error auto-pauses the deployment.

error: BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError { type } or BetaManagedAgentsAgentArchivedDeploymentPausedReasonError { type } or BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError { type } or 11 more

The error that triggered an auto-pause. Matches the failed run's error.type.

One of the following:
beta_managed_agents_environment_archived_deployment_paused_reason_error: object{ type }

The deployment's environment was archived.

type: "environment_archived_error"
beta_managed_agents_agent_archived_deployment_paused_reason_error: object{ type }

The deployment's agent was archived.

type: "agent_archived_error"
beta_managed_agents_environment_not_found_deployment_paused_reason_error: object{ type }

The deployment's environment no longer exists.

type: "environment_not_found_error"
beta_managed_agents_vault_not_found_deployment_paused_reason_error: object{ type }

A vault referenced by the deployment no longer exists.

type: "vault_not_found_error"
beta_managed_agents_file_not_found_deployment_paused_reason_error: object{ type }

A file resource referenced by the deployment no longer exists.

type: "file_not_found_error"
beta_managed_agents_session_resource_not_found_deployment_paused_reason_error: object{ type }

A referenced resource no longer exists and its kind was not reported.

type: "session_resource_not_found_error"
beta_managed_agents_workspace_archived_deployment_paused_reason_error: object{ type }

The deployment's workspace was archived.

type: "workspace_archived_error"
beta_managed_agents_organization_disabled_deployment_paused_reason_error: object{ type }

The deployment's organization is disabled.

type: "organization_disabled_error"
beta_managed_agents_memory_store_archived_deployment_paused_reason_error: object{ type }

A memory store referenced by the deployment is archived.

type: "memory_store_archived_error"
beta_managed_agents_skill_not_found_deployment_paused_reason_error: object{ type }

A skill referenced by the deployment's agent no longer exists.

type: "skill_not_found_error"
beta_managed_agents_vault_archived_deployment_paused_reason_error: object{ type }

A vault referenced by the deployment is archived.

type: "vault_archived_error"
beta_managed_agents_unknown_deployment_paused_reason_error: object{ type }

An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose error.type is unknown_error.

type: "unknown_error"
beta_managed_agents_self_hosted_resources_unsupported_deployment_paused_reason_error: object{ type }

The deployment configures resources, but its environment is self-hosted and cannot mount them.

type: "self_hosted_resources_unsupported_error"
beta_managed_agents_mcp_egress_blocked_deployment_paused_reason_error: object{ type }

An MCP server host used by the deployment's agent is blocked by the environment's network policy.

type: "mcp_egress_blocked_error"
type: "error"
resources: array of BetaManagedAgentsSessionResourceConfig

Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.

One of the following:
beta_managed_agents_github_repository_resource_config: object{ type, url, checkout, mount_path }

A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.

type: "github_repository"
url: string

Github URL of the repository

checkout: optional BetaManagedAgentsBranchCheckout { name, type } or BetaManagedAgentsCommitCheckout { sha, type }

Branch or commit to check out. Defaults to the repository's default branch.

One of the following:
beta_managed_agents_branch_checkout: object{ name, type }
name: string

Branch name to check out.

minLength1
maxLength255
type: "branch"
beta_managed_agents_commit_checkout: object{ sha, type }
sha: string

Full commit SHA to check out.

minLength7
maxLength64
type: "commit"
mount_path: optional string

Mount path in the container. Defaults to /workspace/<repo-name>.

beta_managed_agents_file_resource_config: object{ file_id, type, mount_path }

A file mounted into each session's container.

file_id: string

ID of a previously uploaded file.

type: "file"
mount_path: optional string

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

beta_managed_agents_memory_store_resource_config: object{ memory_store_id, type, access, instructions }

A memory store attached to each session created from this deployment.

memory_store_id: string

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

type: "memory_store"
access: optional "read_write" or "read_only"

Access mode for an attached memory store.

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.

schedule: object{ expression, timezone, type, 2 more }

5-field POSIX cron schedule with computed runtime timestamps.

expression: string

5-field POSIX cron expression: minute hour day-of-month month day-of-week (e.g., "0 9 * * 1-5" for weekdays at 9am). Day-of-week is 0-7 where 0 and 7 both mean Sunday. Extended cron syntax - seconds or year fields, and the special characters L, W, #, and ? - is not supported, nor are predefined shortcuts (@daily).

minLength1
maxLength256
timezone: string

IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").

minLength1
type: "cron"
last_run_at: optional string

A timestamp in RFC 3339 format

formatdate-time
upcoming_runs_at: optional array of string

Up to 5 timestamps of upcoming cron occurrences. Non-empty for active and paused deployments (reflects what the schedule would do if unpaused); empty once the deployment is archived (archived_at set). Each fire is offset by a small per-schedule jitter, so a run will actually start at or shortly after its listed time.

status: "active" or "paused"

Lifecycle status of a deployment.

One of the following:
"active"
"paused"
type: "deployment"
updated_at: string

A timestamp in RFC 3339 format

formatdate-time
vault_ids: array of string

Vault IDs supplying stored credentials for sessions created from this deployment.

budget: optional object{ max_list_cost, type }

A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches max_list_cost.

max_list_cost: object{ amount, currency }

A monetary amount in a specific currency.

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.

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.

type: "limit"
デプロイメントを作成
ant beta:deployments create \
  --api-key my-anthropic-api-key \
  --agent string \
  --environment-id x \
  --initial-event '{content: [{text: '\''Where is my order #1234?'\'', type: text}], type: user.message}' \
  --name x
Returns Examples
Response 200
{
  "id": "depl_011CZkZcDH3vPqd7xnEfwTai",
  "agent": {
    "id": "agent_011CZkYpogX7uDKUyvBTophP",
    "type": "agent",
    "version": 1
  },
  "archived_at": null,
  "created_at": "2026-03-15T10:00:00Z",
  "description": "Compiles yesterday's orders into a report every weekday morning.",
  "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
  "initial_events": [
    {
      "content": [
        {
          "text": "Compile yesterday's orders into report.md.",
          "type": "text"
        }
      ],
      "type": "user.message"
    }
  ],
  "metadata": {},
  "name": "Daily order report",
  "paused_reason": {
    "type": "manual"
  },
  "resources": [
    {
      "type": "github_repository",
      "url": "url",
      "checkout": {
        "name": "main",
        "type": "branch"
      },
      "mount_path": "mount_path"
    }
  ],
  "schedule": {
    "expression": "0 9 * * 1-5",
    "timezone": "America/Los_Angeles",
    "type": "cron",
    "last_run_at": "2026-03-16T16:00:09Z",
    "upcoming_runs_at": [
      "2026-03-17T16:00:00Z",
      "2026-03-18T16:00:00Z"
    ]
  },
  "status": "active",
  "type": "deployment",
  "updated_at": "2026-03-15T10:00:00Z",
  "vault_ids": [
    "vlt_011CZkZDLs7fYzm1hXNPeRjv"
  ],
  "budget": {
    "max_list_cost": {
      "amount": "2500",
      "currency": "USD"
    },
    "type": "limit"
  }
}