Déploiements
Créer un déploiement
client.beta.deployments.create(params, options?): BetaManagedAgentsDeploymentLister les déploiements
client.beta.deployments.list(params?, options?): PageCursor<BetaManagedAgentsDeployment>Obtenir un déploiement
client.beta.deployments.retrieve(deploymentID, params?, options?): BetaManagedAgentsDeploymentMettre à jour un déploiement
client.beta.deployments.update(deploymentID, params, options?): BetaManagedAgentsDeploymentArchiver un déploiement
client.beta.deployments.archive(deploymentID, params?, options?): BetaManagedAgentsDeploymentExécuter un déploiement maintenant
client.beta.deployments.run(deploymentID, params?, options?): BetaManagedAgentsDeploymentRunMettre en pause un déploiement
client.beta.deployments.pause(deploymentID, params?, options?): BetaManagedAgentsDeploymentReprendre un déploiement
client.beta.deployments.unpause(deploymentID, params?, options?): BetaManagedAgentsDeploymentModels
interface BetaManagedAgentsAgentArchivedDeploymentPausedReasonError { type: "agent_archived_error" }The deployment's agent was archived.
The deployment's agent was archived.
interface BetaManagedAgentsCronSchedule { 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?: string | nullTime the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
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.
interface BetaManagedAgentsCronScheduleParams { 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.
interface BetaManagedAgentsDeployment { 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.
type BetaManagedAgentsDeploymentInitialEvent = BetaManagedAgentsDeploymentUserMessageEvent | BetaManagedAgentsDeploymentUserDefineOutcomeEvent | 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.
type BetaManagedAgentsDeploymentInitialEventParams = BetaManagedAgentsUserMessageEventParams | BetaManagedAgentsUserDefineOutcomeEventParams | 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.
type BetaManagedAgentsDeploymentPausedReason = BetaManagedAgentsManualDeploymentPausedReason | BetaManagedAgentsErrorDeploymentPausedReasonWhy a deployment is paused. Non-null exactly when status is paused.
Why a deployment is paused. Non-null exactly when status is paused.
interface BetaManagedAgentsManualDeploymentPausedReason { type: "manual" }The caller invoked the pause endpoint on the deployment.
The caller invoked the pause endpoint on the deployment.
interface BetaManagedAgentsErrorDeploymentPausedReason { 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 failed run's error.
The failed run's error.
type BetaManagedAgentsDeploymentPausedReasonError = BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError | BetaManagedAgentsAgentArchivedDeploymentPausedReasonError | BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError | 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.
type BetaManagedAgentsDeploymentStatus = "active" | "paused"Lifecycle status of a deployment.
Lifecycle status of a deployment.
The deployment is active and can run sessions. Archived deployments also report this status; check archived_at to distinguish them.
The deployment is paused. Autonomous triggers are suppressed; manual runs are still permitted.
interface BetaManagedAgentsDeploymentSystemMessageEvent { 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<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.
interface BetaManagedAgentsDeploymentUserDefineOutcomeEvent { 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.
interface BetaManagedAgentsDeploymentUserMessageEvent { type: "user.message"; content }A user message sent to the session.
A user message sent to the session.
interface BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError { type: "environment_archived_error" }The deployment's environment was archived.
The deployment's environment was archived.
interface BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError { type: "environment_not_found_error" }The deployment's environment no longer exists.
The deployment's environment no longer exists.
interface BetaManagedAgentsErrorDeploymentPausedReason { 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 failed run's error.
The failed run's error.
interface BetaManagedAgentsFileNotFoundDeploymentPausedReasonError { 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.
interface BetaManagedAgentsFileResourceConfig { 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>.
interface BetaManagedAgentsGitHubRepositoryResourceConfig { 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.
interface BetaManagedAgentsManualDeploymentPausedReason { type: "manual" }The caller invoked the pause endpoint on the deployment.
The caller invoked the pause endpoint on the deployment.
interface BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError { 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.
interface BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError { type: "memory_store_archived_error" }A memory store referenced by the deployment is archived.
A memory store referenced by the deployment is archived.
interface BetaManagedAgentsMemoryStoreResourceConfig { 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?: "read_write" | "read_only" | nullAccess mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem.
Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem.
Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.
interface BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError { type: "organization_disabled_error" }The deployment's organization is disabled.
The deployment's organization is disabled.
interface BetaManagedAgentsSchedule { type: "cron"; expression; timezone; /* 2 more */ }A recurring schedule with computed runtime timestamps. Discriminated union — only cron is supported currently.
A recurring schedule with computed runtime timestamps. Discriminated union — only cron is supported currently.
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?: string | nullTime the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
Time the most recent scheduled run actually started. Null until one completes; preserved after the deployment is archived. Manual runs do not update this.
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.
interface BetaManagedAgentsScheduleParams { type: "cron"; expression; timezone }A recurring schedule. Discriminated union — only cron is supported currently.
A recurring schedule. Discriminated union — only cron is supported currently.
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.
interface BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError { 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.
type BetaManagedAgentsSessionResourceConfig = BetaManagedAgentsGitHubRepositoryResourceConfig | BetaManagedAgentsFileResourceConfig | BetaManagedAgentsMemoryStoreResourceConfigA configured session resource. Echoes the input minus write-only credentials.
A configured session resource. Echoes the input minus write-only credentials.
interface BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError { 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.
interface BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError { 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.
interface BetaManagedAgentsUnknownDeploymentPausedReasonError { 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.
interface BetaManagedAgentsVaultArchivedDeploymentPausedReasonError { type: "vault_archived_error" }A vault referenced by the deployment is archived.
A vault referenced by the deployment is archived.
interface BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError { type: "vault_not_found_error" }A vault referenced by the deployment no longer exists.
A vault referenced by the deployment no longer exists.
interface BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError { type: "workspace_archived_error" }The deployment's workspace was archived.
The deployment's workspace was archived.