Claude Platform Docs

Deployments

Deployment erstellen
BetaManagedAgentsDeployment Beta.Deployments.Create(parameters, cancellationToken = default)
POST/v1/deployments
Deployments auflisten
DeploymentListPage Beta.Deployments.List(parameters, cancellationToken = default)
GET/v1/deployments
Deployment abrufen
BetaManagedAgentsDeployment Beta.Deployments.Retrieve(parameters, cancellationToken = default)
GET/v1/deployments/{deployment_id}
Deployment aktualisieren
BetaManagedAgentsDeployment Beta.Deployments.Update(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}
Deployment archivieren
BetaManagedAgentsDeployment Beta.Deployments.Archive(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/archive
Deployment jetzt ausführen
BetaManagedAgentsDeploymentRun Beta.Deployments.Run(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/run
Deployment pausieren
BetaManagedAgentsDeployment Beta.Deployments.Pause(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/pause
Deployment fortsetzen
BetaManagedAgentsDeployment Beta.Deployments.Unpause(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/unpause
Models
class BetaManagedAgentsAgentArchivedDeploymentPausedReasonError { Type; }

The deployment's agent was archived.

required Type Type
class BetaManagedAgentsCronSchedule { Type; Expression; Timezone; /* 2 more */ }

5-field POSIX cron schedule with computed runtime timestamps.

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

minLength1
maxLength256
required string Timezone

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

minLength1
DateTimeOffset? LastRunAt

A timestamp in RFC 3339 format

formatdate-time
IReadOnlyList<DateTimeOffset> 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; }

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

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

minLength1
maxLength256
required string Timezone

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

minLength1
class BetaManagedAgentsDeployment { Type; ID; Agent; /* 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.

class BetaManagedAgentsDeploymentInitialEvent: union

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

class BetaManagedAgentsDeploymentInitialEventParams: union

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

class BetaManagedAgentsDeploymentPausedReason: union

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

class BetaManagedAgentsManualDeploymentPausedReason { Type; }

The caller invoked the pause endpoint on the deployment.

required Type Type
class BetaManagedAgentsErrorDeploymentPausedReason { Type; Error; }

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

required Type Type
required BetaManagedAgentsDeploymentPausedReasonError Error

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

One of the following:
class BetaManagedAgentsDeploymentPausedReasonError: union

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

enum BetaManagedAgentsDeploymentStatus

Lifecycle status of a deployment.

Active("active")
Paused("paused")
class BetaManagedAgentsDeploymentSystemMessageEvent { Type; Content; }

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.

required Type Type
required IReadOnlyList<BetaManagedAgentsSystemContentBlock> Content

System content blocks to append. Text-only.

required Type Type
required string Text

The text content.

minLength1
class BetaManagedAgentsDeploymentUserDefineOutcomeEvent { Type; Description; Rubric; MaxIterations; }

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

required Type Type
required string Description

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

required Rubric Rubric

Rubric for grading the quality of an outcome.

One of the following:
class BetaManagedAgentsFileRubric { Type; FileID; }

Rubric referenced by a file uploaded via the Files API.

required Type Type
required string FileID

ID of the rubric file.

class BetaManagedAgentsTextRubric { Type; Content; }

Rubric content provided inline as text.

required Type Type
required string Content

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

int? MaxIterations

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

formatint32
class BetaManagedAgentsDeploymentUserMessageEvent { Type; Content; }

A user message sent to the session.

class BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError { Type; }

The deployment's environment was archived.

required Type Type
class BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError { Type; }

The deployment's environment no longer exists.

required Type Type
class BetaManagedAgentsErrorDeploymentPausedReason { Type; Error; }

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

required Type Type
required BetaManagedAgentsDeploymentPausedReasonError Error

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

One of the following:
class BetaManagedAgentsFileNotFoundDeploymentPausedReasonError { Type; }

A file resource referenced by the deployment no longer exists.

required Type Type
class BetaManagedAgentsFileResourceConfig { Type; FileID; MountPath; }

A file mounted into each session's container.

required Type Type
required 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; }

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

required Type Type
required string Url

Github URL of the repository

Checkout? Checkout

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

One of the following:
class BetaManagedAgentsBranchCheckout { Type; Name; }
required Type Type
required string Name

Branch name to check out.

minLength1
maxLength255
class BetaManagedAgentsCommitCheckout { Type; Sha; }
required Type Type
required string Sha

Full commit SHA to check out.

minLength7
maxLength64
string? MountPath

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

class BetaManagedAgentsManualDeploymentPausedReason { Type; }

The caller invoked the pause endpoint on the deployment.

required Type Type
class BetaManagedAgentsMcpEgressBlockedDeploymentPausedReasonError { Type; }

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

required Type Type
class BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError { Type; }

A memory store referenced by the deployment is archived.

required Type Type
class BetaManagedAgentsMemoryStoreResourceConfig { Type; MemoryStoreID; Access; Instructions; }

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

required Type Type
required 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.

One of the following:
ReadWrite("read_write")
ReadOnly("read_only")
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; }

The deployment's organization is disabled.

required Type Type
class BetaManagedAgentsSchedule { Type; Expression; Timezone; /* 2 more */ }

5-field POSIX cron schedule with computed runtime timestamps.

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

minLength1
maxLength256
required string Timezone

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

minLength1
DateTimeOffset? LastRunAt

A timestamp in RFC 3339 format

formatdate-time
IReadOnlyList<DateTimeOffset> 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; }

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

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

minLength1
maxLength256
required string Timezone

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

minLength1
class BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError { Type; }

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

required Type Type
class BetaManagedAgentsSessionResourceConfig: union

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

class BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError { Type; }

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

required Type Type
class BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError { Type; }

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

required Type Type
class BetaManagedAgentsUnknownDeploymentPausedReasonError { Type; }

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

required Type Type
class BetaManagedAgentsVaultArchivedDeploymentPausedReasonError { Type; }

A vault referenced by the deployment is archived.

required Type Type
class BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError { Type; }

A vault referenced by the deployment no longer exists.

required Type Type
class BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError { Type; }

The deployment's workspace was archived.

required Type Type