Claude Platform Docs

Deployments

Create Deployment
$client->beta->deployments->create(Agent agent, string environmentID, list<BetaManagedAgentsDeploymentInitialEventParams> initialEvents, string name, ?BetaManagedAgentsBudgetLimit budget, ?string description, ?array<string,string> metadata, ?list<Resource> resources, ?BetaManagedAgentsScheduleParams schedule, ?list<string> vaultIDs, ?list<AnthropicBeta> betas, ?string workspaceID): BetaManagedAgentsDeployment
POST/v1/deployments
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
List Deployments
$client->beta->deployments->list(?string agentID, ?\Datetime createdAtGte, ?\Datetime createdAtLte, ?bool includeArchived, ?int limit, ?string page, ?BetaManagedAgentsDeploymentStatus status, ?list<AnthropicBeta> betas, ?string workspaceID): PageCursor<BetaManagedAgentsDeployment>
GET/v1/deployments
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Get Deployment
$client->beta->deployments->retrieve(string deploymentID, ?list<AnthropicBeta> betas, ?string workspaceID): BetaManagedAgentsDeployment
GET/v1/deployments/{deployment_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Update Deployment
$client->beta->deployments->update(string deploymentID, ?Agent agent, ?BetaManagedAgentsBudgetLimit budget, ?string description, ?string environmentID, ?list<BetaManagedAgentsDeploymentInitialEventParams> initialEvents, ?array<string,string> metadata, ?string name, ?list<Resource> resources, ?BetaManagedAgentsScheduleParams schedule, ?list<string> vaultIDs, ?list<AnthropicBeta> betas, ?string workspaceID): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Archive Deployment
$client->beta->deployments->archive(string deploymentID, ?list<AnthropicBeta> betas, ?string workspaceID): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/archive
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Run Deployment Now
$client->beta->deployments->run(string deploymentID, ?list<AnthropicBeta> betas, ?string workspaceID): BetaManagedAgentsDeploymentRun
POST/v1/deployments/{deployment_id}/run
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Pause Deployment
$client->beta->deployments->pause(string deploymentID, ?list<AnthropicBeta> betas, ?string workspaceID): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/pause
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Unpause Deployment
$client->beta->deployments->unpause(string deploymentID, ?list<AnthropicBeta> betas, ?string workspaceID): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/unpause
Requires anthropic-beta: managed-agents-2026-04-01. How to send beta headers
Models
class BetaManagedAgentsAgentArchivedDeploymentPausedReasonError { $type = 'agent_archived_error'; }
"agent_archived_error" type
class BetaManagedAgentsCronSchedule { $type = 'cron'; $expression; $timezone; /* 2 more */ }
"cron" type
string expression

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).

string timezone

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

?\Datetime lastRunAt

Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.

?list<\Datetime> upcomingRunsAt

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.

class BetaManagedAgentsCronScheduleParams { $type = 'cron'; $expression; $timezone; }
"cron" type
string expression

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).

string timezone

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

class BetaManagedAgentsDeployment { $type = 'deployment'; $id; $agent; /* 14 more */ }
class BetaManagedAgentsDeploymentInitialEvent
One of the following:
class BetaManagedAgentsDeploymentInitialEventParams
One of the following:
class BetaManagedAgentsDeploymentPausedReason
One of the following:
class BetaManagedAgentsManualDeploymentPausedReason { $type = 'manual'; }
"manual" type
class BetaManagedAgentsErrorDeploymentPausedReason { $type = 'error'; $error; }
"error" type
BetaManagedAgentsDeploymentPausedReasonError error

The failed run's error.

class BetaManagedAgentsDeploymentPausedReasonError
One of the following:
enum BetaManagedAgentsDeploymentStatus
One of the following:
"active"

The deployment is active and can run sessions. Archived deployments also report this status; check archived_at to distinguish them.

"paused"

The deployment is paused. Autonomous triggers are suppressed; manual runs are still permitted.

class BetaManagedAgentsDeploymentSystemMessageEvent { $type = 'system.message'; $content; }
"system.message" type
list<BetaManagedAgentsSystemContentBlock> content

System content blocks to append. Text-only.

class BetaManagedAgentsDeploymentUserDefineOutcomeEvent { $type = 'user.define_outcome'; $description; $rubric; $maxIterations; }
"user.define_outcome" type
string description

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

Rubric rubric

How to grade the outcome. Text or file reference.

?int maxIterations

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

class BetaManagedAgentsDeploymentUserMessageEvent { $type = 'user.message'; $content; }
"user.message" type
list<Content> content

Array of content blocks for the user message.

class BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError { $type = 'environment_archived_error'; }
"environment_archived_error" type
class BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError { $type = 'environment_not_found_error'; }
"environment_not_found_error" type
class BetaManagedAgentsErrorDeploymentPausedReason { $type = 'error'; $error; }
"error" type
BetaManagedAgentsDeploymentPausedReasonError error

The failed run's error.

class BetaManagedAgentsFileNotFoundDeploymentPausedReasonError { $type = 'file_not_found_error'; }
"file_not_found_error" type
class BetaManagedAgentsFileResourceConfig { $type = 'file'; $fileID; $mountPath; }
"file" type
string fileID

ID of a previously uploaded file.

?string mountPath

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

class BetaManagedAgentsGitHubRepositoryResourceConfig { $type = 'github_repository'; $url; $checkout; $mountPath; }
"github_repository" type
string url

Github URL of the repository

?Checkout checkout

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

?string mountPath

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

class BetaManagedAgentsManualDeploymentPausedReason { $type = 'manual'; }
"manual" type
class BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError { $type = 'mcp_egress_blocked_error'; }
"mcp_egress_blocked_error" type
class BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError { $type = 'memory_store_archived_error'; }
"memory_store_archived_error" type
class BetaManagedAgentsMemoryStoreResourceConfig { $type = 'memory_store'; $memoryStoreID; $access; $instructions; }
"memory_store" type
string memoryStoreID

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

?Access access

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

?string instructions

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

class BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError { $type = 'organization_disabled_error'; }
"organization_disabled_error" type
class BetaManagedAgentsSchedule { $type = 'cron'; $expression; $timezone; /* 2 more */ }
"cron" type
string expression

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).

string timezone

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

?\Datetime lastRunAt

Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.

?list<\Datetime> upcomingRunsAt

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.

class BetaManagedAgentsScheduleParams { $type = 'cron'; $expression; $timezone; }
"cron" type
string expression

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).

string timezone

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

class BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError { $type = 'self_hosted_resources_unsupported_error'; }
"self_hosted_resources_unsupported_error" type
class BetaManagedAgentsSessionResourceConfig
One of the following:
class BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError { $type = 'session_resource_not_found_error'; }
"session_resource_not_found_error" type
class BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError { $type = 'skill_not_found_error'; }
"skill_not_found_error" type
class BetaManagedAgentsUnknownDeploymentPausedReasonError { $type = 'unknown_error'; }
"unknown_error" type
class BetaManagedAgentsVaultArchivedDeploymentPausedReasonError { $type = 'vault_archived_error'; }
"vault_archived_error" type
class BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError { $type = 'vault_not_found_error'; }
"vault_not_found_error" type
class BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError { $type = 'workspace_archived_error'; }
"workspace_archived_error" type