Claude Platform Docs

Atualizar implantação

client.beta.deployments.update(deploymentID, params, options?): BetaManagedAgentsDeployment
POST/v1/deployments/{deployment_id}

Atualizar implantação

Parameters
deploymentID: string⁠Path parameter

Unique identifier of the deployment to update.

params: DeploymentUpdateParams { agent; budget; description; /* 9 more */ }
agent?: string | BetaManagedAgentsAgentParams

Agent to deploy. Accepts the agent ID string, which re-pins to the latest version, or an agent object with both id and version specified. Omit to preserve. Cannot be cleared.

One of the following:
string
interface BetaManagedAgentsAgentParams { type: "agent"; id; version }

Specification for an Agent. Provide a specific version or use the short-form agent="agent_id" for the most recent version

type: "agent"
id: string

The agent ID.

minLength1
maxLength128
version?: number

The specific agent version to use. Omit to use the latest version. Must be at least 1 if specified.

formatint32
budget?: BetaManagedAgentsBudgetLimit | null

Spend ceiling for future sessions. Full replacement. Omit to preserve; send null to clear (sessions created afterwards are uncapped). The deployment agent's model must have a public list price, or the request is rejected; a multiagent roster is re-validated in full when each fire copies the cap, which fails closed the same way.

type: "limit"
max_list_cost: BetaMonetaryAmount { amount; currency }

Maximum list cost the session may accrue. List price is used regardless of any negotiated discount, so the cap fires at or before the actual charge.

amount: string

Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

currency: BetaCurrency

Uppercase ISO-4217 currency code. USD is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

description?: string | null

Description. Omit to preserve; send empty string or null to clear.

maxLength2048
environment_id?: string

ID of the environment where sessions run. Omit to preserve. Cannot be cleared.

maxLength128
initial_events?: Array<BetaManagedAgentsDeploymentInitialEventParams>

Initial events. Full replacement. Omit to preserve. Cannot be cleared. At least 1, maximum 50.

One of the following:
interface BetaManagedAgentsUserMessageEventParams { type: "user.message"; content }

Parameters for sending a user message to the session.

interface BetaManagedAgentsUserDefineOutcomeEventParams { type: "user.define_outcome"; description; rubric; max_iterations }

Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.

interface BetaManagedAgentsSystemMessageEventParams { 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. At most one per request: it must be the final event and immediately follow the user.message, user.tool_result, or user.custom_tool_result it accompanies. Only supported on models that accept mid-conversation system messages.

type: "system.message"
content: Array<BetaManagedAgentsSystemContentBlock { type: "text"; text }>

System content blocks to append. Text-only.

type: "text"
text: string

The text content.

minLength1
metadata?: Record<string, string | null> | null

Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars.

name?: string

Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.

maxLength256
resources?: Array<BetaManagedAgentsGitHubRepositoryResourceParams | BetaManagedAgentsFileResourceParams | BetaManagedAgentsMemoryStoreResourceParam> | null

Session resources. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 500.

One of the following:
interface BetaManagedAgentsGitHubRepositoryResourceParams { type: "github_repository"; url; authorization_token; /* 2 more */ }

Mount a GitHub repository into the session's container.

interface BetaManagedAgentsFileResourceParams { type: "file"; file_id; mount_path }

Mount a file uploaded via the Files API into the session.

type: "file"
file_id: string

ID of a previously uploaded file.

minLength1
maxLength128
mount_path?: string | null

Mount path in the container. Defaults to /mnt/session/uploads/<file_id>.

minLength1
maxLength4096
interface BetaManagedAgentsMemoryStoreResourceParam { type: "memory_store"; memory_store_id; access; instructions }

Parameters for attaching a memory store to an agent session.

type: "memory_store"
memory_store_id: string

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

access?: "read_write" | "read_only" | null

Access mode for the mounted store. Defaults to read_write. read_only mounts the store as a read-only filesystem.

One of the following:
"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.

maxLength4096
schedule?: BetaManagedAgentsScheduleParams | null

Cron schedule. Full replacement. Omit to preserve; send null to clear (revert to manual-only).

type: "cron"
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).

minLength1
maxLength256
timezone: string

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

minLength1
vault_ids?: Array<string> | null

Vault IDs. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 50.

betas?: Array<AnthropicBeta>⁠Header parameter

Optional header to specify the beta version(s) you want to use.

One of the following:
(string & {})
"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"
"user-profiles-2026-08-18"
"user-profiles-2026-09-04"
"advisor-tool-2026-03-01"
"managed-agents-2026-04-01"
"cache-diagnosis-2026-04-07"
"dreaming-2026-04-21"
"thinking-token-count-2026-05-13"
"server-side-fallback-2026-06-01"
"server-side-fallback-2026-07-01"
"fallback-credit-2026-06-01"
"fallback-credit-2026-07-01"
"agent-memory-2026-07-22"
"mid-conversation-tool-changes-2026-07-01"
"compact-2026-01-12"
"computer-use-2025-11-24"
"mcp-tunnels-2026-06-22"
"structured-outputs-2025-11-13"
"task-budgets-2026-03-13"
"thinking-display-updates-2026-08-18"
"ce-user-management-2026-07-13"
"mid-conversation-output-config-2026-07-01"
"thinking-binding-controls-2026-08-01"
"mid-conversation-system-clear-at-2026-08-21"
"compact-2026-09-04"
"inline-tools-2026-09-15"
"mcp-client-2026-09-15"
"ce-plugins-2026-09-01"
"spend-limit-reads-2026-09-26"
workspace_id?: string⁠Header parameter

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Returns
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.

Atualizar implantação
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.update(
  "depl_011CZkZcDH3vPqd7xnEfwTai"
);

console.log(betaManagedAgentsDeployment.id);
Returns Examples
Response 200
{
  "id": "depl_011CZkZcDH3vPqd7xnEfwTai",
  "agent": {
    "id": "agent_011CZkYpogX7uDKUyvBTophP",
    "type": "agent",
    "version": 1
  },
  "archived_at": null,
  "created_at": "2026-03-15T10:00:00Z",
  "description": "Compiles yesterday's orders into a report every weekday morning.",
  "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
  "initial_events": [
    {
      "content": [
        {
          "text": "Compile yesterday's orders into report.md.",
          "type": "text"
        }
      ],
      "type": "user.message"
    }
  ],
  "metadata": {},
  "name": "Daily order report",
  "paused_reason": {
    "type": "manual"
  },
  "resources": [
    {
      "type": "github_repository",
      "url": "url",
      "checkout": {
        "name": "main",
        "type": "branch"
      },
      "mount_path": "mount_path"
    }
  ],
  "schedule": {
    "expression": "0 9 * * 1-5",
    "timezone": "America/Los_Angeles",
    "type": "cron",
    "last_run_at": "2026-03-16T16:00:09Z",
    "upcoming_runs_at": [
      "2026-03-17T16:00:00Z",
      "2026-03-18T16:00:00Z"
    ]
  },
  "status": "active",
  "type": "deployment",
  "updated_at": "2026-03-15T10:00:00Z",
  "vault_ids": [
    "vlt_011CZkZDLs7fYzm1hXNPeRjv"
  ],
  "budget": {
    "max_list_cost": {
      "amount": "2500",
      "currency": "USD"
    },
    "type": "limit"
  }
}