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
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
Get Deployment
$client->beta->deployments->retrieve(string deploymentID, ?list<AnthropicBeta> betas, ?string workspaceID): BetaManagedAgentsDeployment
GET/v1/deployments/{deployment_id}
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}
Archive Deployment
$client->beta->deployments->archive(string deploymentID, ?list<AnthropicBeta> betas, ?string workspaceID): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/archive
Run Deployment Now
$client->beta->deployments->run(string deploymentID, ?list<AnthropicBeta> betas, ?string workspaceID): BetaManagedAgentsDeploymentRun
POST/v1/deployments/{deployment_id}/run
Pause Deployment
$client->beta->deployments->pause(string deploymentID, ?list<AnthropicBeta> betas, ?string workspaceID): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/pause
Unpause Deployment
$client->beta->deployments->unpause(string deploymentID, ?list<AnthropicBeta> betas, ?string workspaceID): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}/unpause
Models
class BetaManagedAgentsCronSchedule { $type; $expression; $timezone; /* 2 more */ }
Type 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

A timestamp in RFC 3339 format

?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; $expression; $timezone; }
Type 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; $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; }
Type type
class BetaManagedAgentsErrorDeploymentPausedReason { $type; $error; }
Type type
BetaManagedAgentsDeploymentPausedReasonError error

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

class BetaManagedAgentsDeploymentPausedReasonError
One of the following:
enum BetaManagedAgentsDeploymentStatus
One of the following:
"active"
"paused"
class BetaManagedAgentsDeploymentSystemMessageEvent { $type; $content; }
Type type
list<BetaManagedAgentsSystemContentBlock> content

System content blocks to append. Text-only.

class BetaManagedAgentsDeploymentUserDefineOutcomeEvent { $type; $description; $rubric; $maxIterations; }
Type type
string description

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

Rubric rubric

Rubric for grading the quality of an outcome.

?int maxIterations

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

class BetaManagedAgentsDeploymentUserMessageEvent { $type; $content; }
Type type
list<Content> content

Array of content blocks for the user message.

class BetaManagedAgentsErrorDeploymentPausedReason { $type; $error; }
Type type
BetaManagedAgentsDeploymentPausedReasonError error

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

class BetaManagedAgentsFileResourceConfig { $type; $fileID; $mountPath; }
Type 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; $url; $checkout; $mountPath; }
Type 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; }
Type type
class BetaManagedAgentsMemoryStoreResourceConfig { $type; $memoryStoreID; $access; $instructions; }
Type type
string memoryStoreID

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

?Access access

Access mode for an attached memory store.

?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 BetaManagedAgentsSchedule { $type; $expression; $timezone; /* 2 more */ }
Type 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

A timestamp in RFC 3339 format

?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; $expression; $timezone; }
Type 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 BetaManagedAgentsSessionResourceConfig
One of the following:
class BetaManagedAgentsUnknownDeploymentPausedReasonError { $type; }
Type type