## Get Deployment `client.beta.deployments.retrieve(stringdeploymentID, DeploymentRetrieveParamsparams?, RequestOptionsoptions?): BetaManagedAgentsDeployment` **get** `/v1/deployments/{deployment_id}` Get Deployment ### Parameters - `deploymentID: string` - `params: DeploymentRetrieveParams` - `betas?: Array` Optional header to specify the beta version(s) you want to use. - `(string & {})` - `"message-batches-2024-09-24" | "prompt-caching-2024-07-31" | "computer-use-2024-10-22" | 25 more` - `"message-batches-2024-09-24"` - `"prompt-caching-2024-07-31"` - `"computer-use-2024-10-22"` - `"computer-use-2025-01-24"` - `"pdfs-2024-09-25"` - `"token-counting-2024-11-01"` - `"token-efficient-tools-2025-02-19"` - `"output-128k-2025-02-19"` - `"files-api-2025-04-14"` - `"mcp-client-2025-04-04"` - `"mcp-client-2025-11-20"` - `"dev-full-thinking-2025-05-14"` - `"interleaved-thinking-2025-05-14"` - `"code-execution-2025-05-22"` - `"extended-cache-ttl-2025-04-11"` - `"context-1m-2025-08-07"` - `"context-management-2025-06-27"` - `"model-context-window-exceeded-2025-08-26"` - `"skills-2025-10-02"` - `"fast-mode-2026-02-01"` - `"output-300k-2026-03-24"` - `"user-profiles-2026-03-24"` - `"advisor-tool-2026-03-01"` - `"managed-agents-2026-04-01"` - `"cache-diagnosis-2026-04-07"` - `"thinking-token-count-2026-05-13"` - `"server-side-fallback-2026-06-01"` - `"fallback-credit-2026-06-01"` ### Returns - `BetaManagedAgentsDeployment` 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. - `id: string` Unique identifier for this deployment. - `agent: BetaManagedAgentsAgentReference` A resolved agent reference with a concrete version. - `id: string` - `type: "agent"` - `"agent"` - `version: number` - `archived_at: string | null` A timestamp in RFC 3339 format - `created_at: string` A timestamp in RFC 3339 format - `description: string | null` Description of what the deployment does. - `environment_id: string` ID of the `environment` where sessions run. - `initial_events: Array` Events sent to each session immediately after creation. - `BetaManagedAgentsDeploymentUserMessageEvent` A user message sent to the session. - `content: Array` Array of content blocks for the user message. - `BetaManagedAgentsTextBlock` Regular text content. - `text: string` The text content. - `type: "text"` - `"text"` - `BetaManagedAgentsImageBlock` Image content specified directly as base64 data or as a reference via a URL. - `source: BetaManagedAgentsBase64ImageSource | BetaManagedAgentsURLImageSource | BetaManagedAgentsFileImageSource` Union type for image source variants. - `BetaManagedAgentsBase64ImageSource` Base64-encoded image data. - `data: string` Base64-encoded image data. - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). - `type: "base64"` - `"base64"` - `BetaManagedAgentsURLImageSource` Image referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the image to fetch. - `BetaManagedAgentsFileImageSource` Image referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "image"` - `"image"` - `BetaManagedAgentsDocumentBlock` Document content, either specified directly as base64 data, as text, or as a reference via a URL. - `source: BetaManagedAgentsBase64DocumentSource | BetaManagedAgentsPlainTextDocumentSource | BetaManagedAgentsURLDocumentSource | BetaManagedAgentsFileDocumentSource` Union type for document source variants. - `BetaManagedAgentsBase64DocumentSource` Base64-encoded document data. - `data: string` Base64-encoded document data. - `media_type: string` MIME type of the document (e.g., "application/pdf"). - `type: "base64"` - `"base64"` - `BetaManagedAgentsPlainTextDocumentSource` Plain text document content. - `data: string` The plain text content. - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - `"text/plain"` - `type: "text"` - `"text"` - `BetaManagedAgentsURLDocumentSource` Document referenced by URL. - `type: "url"` - `"url"` - `url: string` URL of the document to fetch. - `BetaManagedAgentsFileDocumentSource` Document referenced by file ID. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `type: "document"` - `"document"` - `context?: string | null` Additional context about the document for the model. - `title?: string | null` The title of the document. - `type: "user.message"` - `"user.message"` - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent` An outcome the agent should work toward. The agent begins work on receipt. - `description: string` What the agent should produce. This is the task specification. - `rubric: BetaManagedAgentsFileRubric | BetaManagedAgentsTextRubric` Rubric for grading the quality of an outcome. - `BetaManagedAgentsFileRubric` Rubric referenced by a file uploaded via the Files API. - `file_id: string` ID of the rubric file. - `type: "file"` - `"file"` - `BetaManagedAgentsTextRubric` Rubric content provided inline as text. - `content: string` Rubric content. Plain text or markdown — the grader treats it as freeform text. - `type: "text"` - `"text"` - `type: "user.define_outcome"` - `"user.define_outcome"` - `max_iterations?: number | null` Eval→revision cycles before giving up. Default 3, max 20. - `BetaManagedAgentsDeploymentSystemMessageEvent` 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` System content blocks to append. Text-only. - `text: string` The text content. - `type: "text"` - `"text"` - `type: "system.message"` - `"system.message"` - `metadata: Record` Arbitrary key-value metadata. Maximum 16 pairs. - `name: string` Human-readable name. - `paused_reason: BetaManagedAgentsDeploymentPausedReason | null` Why a deployment is paused. Non-null exactly when `status` is `paused`. - `BetaManagedAgentsManualDeploymentPausedReason` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - `"manual"` - `BetaManagedAgentsErrorDeploymentPausedReason` A scheduled fire recorded a failed run whose error auto-pauses the deployment. - `error: BetaManagedAgentsDeploymentPausedReasonError` The error that triggered an auto-pause. Matches the failed run's `error.type`. - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError` The deployment's environment was archived. - `type: "environment_archived_error"` - `"environment_archived_error"` - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError` The deployment's agent was archived. - `type: "agent_archived_error"` - `"agent_archived_error"` - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - `"environment_not_found_error"` - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - `"vault_not_found_error"` - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - `"file_not_found_error"` - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - `"session_resource_not_found_error"` - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError` The deployment's workspace was archived. - `type: "workspace_archived_error"` - `"workspace_archived_error"` - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError` The deployment's organization is disabled. - `type: "organization_disabled_error"` - `"organization_disabled_error"` - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - `"memory_store_archived_error"` - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - `"skill_not_found_error"` - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - `"vault_archived_error"` - `BetaManagedAgentsUnknownDeploymentPausedReasonError` An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`. - `type: "unknown_error"` - `"unknown_error"` - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError` The deployment configures resources, but its environment is self-hosted and cannot mount them. - `type: "self_hosted_resources_unsupported_error"` - `"self_hosted_resources_unsupported_error"` - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError` An MCP server host used by the deployment's agent is blocked by the environment's network policy. - `type: "mcp_egress_blocked_error"` - `"mcp_egress_blocked_error"` - `type: "error"` - `"error"` - `resources: Array` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - `BetaManagedAgentsGitHubRepositoryResourceConfig` A GitHub repository mounted into each session's container. The authorization token is write-only and never returned. - `type: "github_repository"` - `"github_repository"` - `url: string` Github URL of the repository - `checkout?: BetaManagedAgentsBranchCheckout | BetaManagedAgentsCommitCheckout | null` Branch or commit to check out. Defaults to the repository's default branch. - `BetaManagedAgentsBranchCheckout` - `name: string` Branch name to check out. - `type: "branch"` - `"branch"` - `BetaManagedAgentsCommitCheckout` - `sha: string` Full commit SHA to check out. - `type: "commit"` - `"commit"` - `mount_path?: string | null` Mount path in the container. Defaults to `/workspace/`. - `BetaManagedAgentsFileResourceConfig` A file mounted into each session's container. - `file_id: string` ID of a previously uploaded file. - `type: "file"` - `"file"` - `mount_path?: string | null` Mount path in the container. Defaults to `/mnt/session/uploads/`. - `BetaManagedAgentsMemoryStoreResourceConfig` A memory store attached to each session created from this deployment. - `memory_store_id: string` The memory store ID (memstore_...). Must belong to the caller's organization and workspace. - `type: "memory_store"` - `"memory_store"` - `access?: "read_write" | "read_only" | null` Access mode for an attached memory store. - `"read_write"` - `"read_only"` - `instructions?: string | null` Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. - `schedule: BetaManagedAgentsSchedule | null` 5-field POSIX cron schedule with computed runtime timestamps. - `expression: string` 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: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). - `type: "cron"` - `"cron"` - `last_run_at?: string | null` A timestamp in RFC 3339 format - `upcoming_runs_at?: Array` 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. - `status: BetaManagedAgentsDeploymentStatus` Lifecycle status of a deployment. - `"active"` - `"paused"` - `type: "deployment"` - `"deployment"` - `updated_at: string` A timestamp in RFC 3339 format - `vault_ids: Array` Vault IDs supplying stored credentials for sessions created from this deployment. ### Example ```typescript import Anthropic from '@anthropic-ai/sdk'; const client = new Anthropic({ apiKey: process.env['ANTHROPIC_API_KEY'], // This is the default and can be omitted }); const betaManagedAgentsDeployment = await client.beta.deployments.retrieve('deployment_id'); console.log(betaManagedAgentsDeployment.id); ``` #### Response ```json { "id": "id", "agent": { "id": "agent_011CZkYqphY8vELVzwCUpqiQ", "type": "agent", "version": 1 }, "archived_at": "2019-12-27T18:11:19.117Z", "created_at": "2019-12-27T18:11:19.117Z", "description": "description", "environment_id": "environment_id", "initial_events": [ { "content": [ { "text": "Where is my order #1234?", "type": "text" } ], "type": "user.message" } ], "metadata": { "foo": "string" }, "name": "name", "paused_reason": { "type": "manual" }, "resources": [ { "type": "github_repository", "url": "url", "checkout": { "name": "main", "type": "branch" }, "mount_path": "mount_path" } ], "schedule": { "expression": "x", "timezone": "x", "type": "cron", "last_run_at": "2019-12-27T18:11:19.117Z", "upcoming_runs_at": [ "2019-12-27T18:11:19.117Z" ] }, "status": "active", "type": "deployment", "updated_at": "2019-12-27T18:11:19.117Z", "vault_ids": [ "string" ] } ```