Deployments
Create Deployment
List Deployments
Get Deployment
Update Deployment
Archive Deployment
Run Deployment Now
Pause Deployment
Unpause Deployment
Models
BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object{ type: "agent_archived_error" }The deployment's agent was archived.
The deployment's agent was archived.
BetaManagedAgentsCronSchedule object{ type: "cron", expression, timezone, 2 more }5-field POSIX cron schedule with computed runtime timestamps.
5-field POSIX cron schedule with computed runtime timestamps.
expression: string5-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).
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).
timezone: stringIANA timezone identifier (e.g., "America/Los_Angeles", "UTC").
IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").
last_run_at: optional string or nullA timestamp in RFC 3339 format
A timestamp in RFC 3339 format
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{ type: "cron", expression, timezone }5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
expression: string5-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).
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).
timezone: stringRequired. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database.
Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database.
BetaManagedAgentsDeployment object{ type: "deployment", 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.
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 or BetaManagedAgentsDeploymentUserDefineOutcomeEvent or BetaManagedAgentsDeploymentSystemMessageEventAn event sent to a session immediately after it is created. Supports user.message, user.define_outcome, and system.message.
An event sent to a session immediately after it is created. Supports user.message, user.define_outcome, and system.message.
BetaManagedAgentsDeploymentInitialEventParams = BetaManagedAgentsUserMessageEventParams or BetaManagedAgentsUserDefineOutcomeEventParams or BetaManagedAgentsSystemMessageEventParamsAn event sent to a session immediately after it is created. Supports user.message, user.define_outcome, and system.message.
An event sent to a session immediately after it is created. Supports user.message, user.define_outcome, and system.message.
BetaManagedAgentsDeploymentPausedReason = BetaManagedAgentsManualDeploymentPausedReason or BetaManagedAgentsErrorDeploymentPausedReasonWhy a deployment is paused. Non-null exactly when status is paused.
Why a deployment is paused. Non-null exactly when status is paused.
BetaManagedAgentsManualDeploymentPausedReason object{ type: "manual" }The caller invoked the pause endpoint on the deployment.
The caller invoked the pause endpoint on the deployment.
BetaManagedAgentsErrorDeploymentPausedReason object{ type: "error", error }A scheduled fire recorded a failed run whose error auto-pauses the deployment.
A scheduled fire recorded a failed run whose error auto-pauses the deployment.
The error that triggered an auto-pause. Matches the failed run's error.type.
The error that triggered an auto-pause. Matches the failed run's error.type.
BetaManagedAgentsDeploymentPausedReasonError = BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError or BetaManagedAgentsAgentArchivedDeploymentPausedReasonError or BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError or 11 moreThe error that triggered an auto-pause. Matches the failed run's error.type.
The error that triggered an auto-pause. Matches the failed run's error.type.
BetaManagedAgentsDeploymentStatus = "active" or "paused"Lifecycle status of a deployment.
Lifecycle status of a deployment.
BetaManagedAgentsDeploymentSystemMessageEvent object{ type: "system.message", 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.
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 { type: "text", text }System content blocks to append. Text-only.
System content blocks to append. Text-only.
text: stringThe text content.
The text content.
BetaManagedAgentsDeploymentUserDefineOutcomeEvent object{ type: "user.define_outcome", description, rubric, max_iterations }An outcome the agent should work toward. The agent begins work on receipt.
An outcome the agent should work toward. The agent begins work on receipt.
BetaManagedAgentsDeploymentUserMessageEvent object{ type: "user.message", content }A user message sent to the session.
A user message sent to the session.
BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object{ type: "environment_archived_error" }The deployment's environment was archived.
The deployment's environment was archived.
BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object{ type: "environment_not_found_error" }The deployment's environment no longer exists.
The deployment's environment no longer exists.
BetaManagedAgentsErrorDeploymentPausedReason object{ type: "error", error }A scheduled fire recorded a failed run whose error auto-pauses the deployment.
A scheduled fire recorded a failed run whose error auto-pauses the deployment.
The error that triggered an auto-pause. Matches the failed run's error.type.
The error that triggered an auto-pause. Matches the failed run's error.type.
BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object{ type: "file_not_found_error" }A file resource referenced by the deployment no longer exists.
A file resource referenced by the deployment no longer exists.
BetaManagedAgentsFileResourceConfig object{ type: "file", file_id, mount_path }A file mounted into each session's container.
A file mounted into each session's container.
ID of a previously uploaded file.
Mount path in the container. Defaults to /mnt/session/uploads/<file_id>.
BetaManagedAgentsGitHubRepositoryResourceConfig object{ type: "github_repository", url, checkout, mount_path }A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.
A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.
BetaManagedAgentsManualDeploymentPausedReason object{ type: "manual" }The caller invoked the pause endpoint on the deployment.
The caller invoked the pause endpoint on the deployment.
BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object{ type: "mcp_egress_blocked_error" }An MCP server host used by the deployment's agent is blocked by the environment's network policy.
An MCP server host used by the deployment's agent is blocked by the environment's network policy.
BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object{ type: "memory_store_archived_error" }A memory store referenced by the deployment is archived.
A memory store referenced by the deployment is archived.
BetaManagedAgentsMemoryStoreResourceConfig object{ type: "memory_store", memory_store_id, access, instructions }A memory store attached to each session created from this deployment.
A memory store attached to each session created from this deployment.
The memory store ID (memstore_...). Must belong to the caller's organization and workspace.
access: optional "read_write" or "read_only" or nullAccess mode for an attached memory store.
Access mode for an attached memory store.
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: "organization_disabled_error" }The deployment's organization is disabled.
The deployment's organization is disabled.
BetaManagedAgentsSchedule object{ type: "cron", expression, timezone, 2 more }5-field POSIX cron schedule with computed runtime timestamps.
5-field POSIX cron schedule with computed runtime timestamps.
expression: string5-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).
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).
timezone: stringIANA timezone identifier (e.g., "America/Los_Angeles", "UTC").
IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").
last_run_at: optional string or nullA timestamp in RFC 3339 format
A timestamp in RFC 3339 format
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{ type: "cron", expression, timezone }5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
expression: string5-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).
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).
timezone: stringRequired. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database.
Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database.
BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object{ type: "self_hosted_resources_unsupported_error" }The deployment configures resources, but its environment is self-hosted and cannot mount them.
The deployment configures resources, but its environment is self-hosted and cannot mount them.
BetaManagedAgentsSessionResourceConfig = BetaManagedAgentsGitHubRepositoryResourceConfig or BetaManagedAgentsFileResourceConfig or BetaManagedAgentsMemoryStoreResourceConfigA configured session resource. Echoes the input minus write-only credentials.
A configured session resource. Echoes the input minus write-only credentials.
BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object{ type: "session_resource_not_found_error" }A referenced resource no longer exists and its kind was not reported.
A referenced resource no longer exists and its kind was not reported.
BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object{ type: "skill_not_found_error" }A skill referenced by the deployment's agent no longer exists.
A skill referenced by the deployment's agent no longer exists.
BetaManagedAgentsUnknownDeploymentPausedReasonError object{ type: "unknown_error" }An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose error.type is unknown_error.
An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose error.type is unknown_error.
BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object{ type: "vault_archived_error" }A vault referenced by the deployment is archived.
A vault referenced by the deployment is archived.
BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object{ type: "vault_not_found_error" }A vault referenced by the deployment no longer exists.
A vault referenced by the deployment no longer exists.
BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object{ type: "workspace_archived_error" }The deployment's workspace was archived.
The deployment's workspace was archived.