Claude Platform Docs

Deployments

Create Deployment
POST/v1/deployments
List Deployments
GET/v1/deployments
Get Deployment
GET/v1/deployments/{deployment_id}
Update Deployment
POST/v1/deployments/{deployment_id}
Archive Deployment
POST/v1/deployments/{deployment_id}/archive
Run Deployment Now
POST/v1/deployments/{deployment_id}/run
Pause Deployment
POST/v1/deployments/{deployment_id}/pause
Unpause Deployment
POST/v1/deployments/{deployment_id}/unpause
Models
BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object{ type }

The deployment's agent was archived.

type: "agent_archived_error"
BetaManagedAgentsCronSchedule 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 or null

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.

BetaManagedAgentsCronScheduleParams object{ expression, timezone, type }

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

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

Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database.

minLength1
type: "cron"
BetaManagedAgentsDeployment 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.

BetaManagedAgentsDeploymentInitialEvent = BetaManagedAgentsDeploymentUserMessageEvent { content, type } or BetaManagedAgentsDeploymentUserDefineOutcomeEvent { description, rubric, type, max_iterations } or BetaManagedAgentsDeploymentSystemMessageEvent { content, type }

An event sent to a session immediately after it is created. Supports user.message, user.define_outcome, and system.message.

One of the following:
BetaManagedAgentsDeploymentInitialEventParams = BetaManagedAgentsUserMessageEventParams { content, type } or BetaManagedAgentsUserDefineOutcomeEventParams { description, rubric, type, max_iterations } or BetaManagedAgentsSystemMessageEventParams { content, type }

An event sent to a session immediately after it is created. Supports user.message, user.define_outcome, and system.message.

One of the following:
BetaManagedAgentsDeploymentPausedReason = BetaManagedAgentsManualDeploymentPausedReason { type } or BetaManagedAgentsErrorDeploymentPausedReason { error, type }

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

One of the following:
BetaManagedAgentsManualDeploymentPausedReason object{ type }

The caller invoked the pause endpoint on the deployment.

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

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

error: BetaManagedAgentsDeploymentPausedReasonError

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

One of the following:
type: "error"
BetaManagedAgentsDeploymentPausedReasonError = 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:
BetaManagedAgentsDeploymentStatus = "active" or "paused"

Lifecycle status of a deployment.

One of the following:
"active"
"paused"
BetaManagedAgentsDeploymentSystemMessageEvent 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"
BetaManagedAgentsDeploymentUserDefineOutcomeEvent object{ description, rubric, type, max_iterations }

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

BetaManagedAgentsDeploymentUserMessageEvent object{ content, type }

A user message sent to the session.

BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object{ type }

The deployment's environment was archived.

type: "environment_archived_error"
BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object{ type }

The deployment's environment no longer exists.

type: "environment_not_found_error"
BetaManagedAgentsErrorDeploymentPausedReason object{ error, type }

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

error: BetaManagedAgentsDeploymentPausedReasonError

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

One of the following:
type: "error"
BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object{ type }

A file resource referenced by the deployment no longer exists.

type: "file_not_found_error"
BetaManagedAgentsFileResourceConfig 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 or null

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

BetaManagedAgentsGitHubRepositoryResourceConfig object{ type, url, checkout, mount_path }

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

BetaManagedAgentsManualDeploymentPausedReason object{ type }

The caller invoked the pause endpoint on the deployment.

type: "manual"
BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError 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"
BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object{ type }

A memory store referenced by the deployment is archived.

type: "memory_store_archived_error"
BetaManagedAgentsMemoryStoreResourceConfig 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" or null

Access mode for an attached memory store.

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

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

BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object{ type }

The deployment's organization is disabled.

type: "organization_disabled_error"
BetaManagedAgentsSchedule 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 or null

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.

BetaManagedAgentsScheduleParams object{ expression, timezone, type }

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

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

Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database.

minLength1
type: "cron"
BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object{ type }

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

type: "self_hosted_resources_unsupported_error"
BetaManagedAgentsSessionResourceConfig = BetaManagedAgentsGitHubRepositoryResourceConfig { type, url, checkout, mount_path } or BetaManagedAgentsFileResourceConfig { file_id, type, mount_path } or BetaManagedAgentsMemoryStoreResourceConfig { memory_store_id, type, access, instructions }

A configured session resource. Echoes the input minus write-only credentials.

One of the following:
BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object{ type }

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

type: "session_resource_not_found_error"
BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object{ type }

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

type: "skill_not_found_error"
BetaManagedAgentsUnknownDeploymentPausedReasonError object{ type }

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

type: "unknown_error"
BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object{ type }

A vault referenced by the deployment is archived.

type: "vault_archived_error"
BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object{ type }

A vault referenced by the deployment no longer exists.

type: "vault_not_found_error"
BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object{ type }

The deployment's workspace was archived.

type: "workspace_archived_error"