SPB Git

Repository Public

update.md 28.7 KB 1,115 lines markdown

1---2title: Update Deployment3url: https://platform.claude.com/docs/en/api/beta/deployments/update4---56# Update Deployment78**POST** `/v1/deployments/{deployment_id}`910Update Deployment1112## Path parameters1314- `deployment_id: string`1516## Headers1718- `"anthropic-beta": optional array of AnthropicBeta`1920  Optional header to specify the beta version(s) you want to use.2122  - `string`2324  - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`2526    - `"message-batches-2024-09-24"`2728    - `"prompt-caching-2024-07-31"`2930    - `"computer-use-2024-10-22"`3132    - `"computer-use-2025-01-24"`3334    - `"pdfs-2024-09-25"`3536    - `"token-counting-2024-11-01"`3738    - `"token-efficient-tools-2025-02-19"`3940    - `"output-128k-2025-02-19"`4142    - `"files-api-2025-04-14"`4344    - `"mcp-client-2025-04-04"`4546    - `"mcp-client-2025-11-20"`4748    - `"dev-full-thinking-2025-05-14"`4950    - `"interleaved-thinking-2025-05-14"`5152    - `"code-execution-2025-05-22"`5354    - `"extended-cache-ttl-2025-04-11"`5556    - `"context-1m-2025-08-07"`5758    - `"context-management-2025-06-27"`5960    - `"model-context-window-exceeded-2025-08-26"`6162    - `"skills-2025-10-02"`6364    - `"fast-mode-2026-02-01"`6566    - `"output-300k-2026-03-24"`6768    - `"user-profiles-2026-03-24"`6970    - `"user-profiles-2026-08-18"`7172    - `"user-profiles-2026-09-04"`7374    - `"advisor-tool-2026-03-01"`7576    - `"managed-agents-2026-04-01"`7778    - `"cache-diagnosis-2026-04-07"`7980    - `"dreaming-2026-04-21"`8182    - `"thinking-token-count-2026-05-13"`8384    - `"server-side-fallback-2026-06-01"`8586    - `"server-side-fallback-2026-07-01"`8788    - `"fallback-credit-2026-06-01"`8990    - `"fallback-credit-2026-07-01"`9192    - `"agent-memory-2026-07-22"`9394    - `"mid-conversation-tool-changes-2026-07-01"`9596    - `"compact-2026-01-12"`9798    - `"computer-use-2025-11-24"`99100    - `"mcp-tunnels-2026-06-22"`101102    - `"structured-outputs-2025-11-13"`103104    - `"task-budgets-2026-03-13"`105106    - `"thinking-display-updates-2026-08-18"`107108    - `"ce-user-management-2026-07-13"`109110    - `"mid-conversation-output-config-2026-07-01"`111112    - `"thinking-binding-controls-2026-08-01"`113114    - `"mid-conversation-system-clear-at-2026-08-21"`115116    - `"compact-2026-09-04"`117118- `"anthropic-workspace-id": optional string`119120## Body parameters121122- `agent: optional string or BetaManagedAgentsAgentParams`123124  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.125126  - `string`127128  - `BetaManagedAgentsAgentParams object`129130    Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version131132    - `type: "agent"`133134    - `id: string`135136      The `agent` ID.137138      minLength: 1, maxLength: 128139140    - `version: optional number`141142      The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified.143144      format: int32145146- `budget: optional BetaManagedAgentsBudgetLimit or null`147148  A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.149150  - `type: "limit"`151152  - `max_list_cost: BetaMonetaryAmount`153154    A monetary amount in a specific currency.155156    - `amount: string`157158      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.159160    - `currency: BetaCurrency`161162      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.163164- `description: optional string or null`165166  Description. Omit to preserve; send empty string or null to clear.167168  maxLength: 2048169170- `environment_id: optional string`171172  ID of the `environment` where sessions run. Omit to preserve. Cannot be cleared.173174  maxLength: 128175176- `initial_events: optional array of BetaManagedAgentsDeploymentInitialEventParams`177178  Initial events. Full replacement. Omit to preserve. Cannot be cleared. At least 1, maximum 50.179180  - `BetaManagedAgentsUserMessageEventParams object`181182    Parameters for sending a user message to the session.183184    - `type: "user.message"`185186    - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`187188      Array of content blocks for the user message.189190      - `BetaManagedAgentsTextBlock object`191192        Regular text content.193194        - `type: "text"`195196        - `text: string`197198          The text content.199200          minLength: 1201202      - `BetaManagedAgentsImageBlock object`203204        Image content specified directly as base64 data or as a reference via a URL.205206        - `type: "image"`207208        - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`209210          Union type for image source variants.211212          - `BetaManagedAgentsBase64ImageSource object`213214            Base64-encoded image data.215216            - `type: "base64"`217218            - `data: string`219220              Base64-encoded image data.221222              minLength: 1223224            - `media_type: string`225226              MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").227228              minLength: 1229230          - `BetaManagedAgentsURLImageSource object`231232            Image referenced by URL.233234            - `type: "url"`235236            - `url: string`237238              URL of the image to fetch.239240              minLength: 1241242          - `BetaManagedAgentsFileImageSource object`243244            Image referenced by file ID.245246            - `type: "file"`247248            - `file_id: string`249250              ID of a previously uploaded file.251252              minLength: 1253254      - `BetaManagedAgentsDocumentBlock object`255256        Document content, either specified directly as base64 data, as text, or as a reference via a URL.257258        - `type: "document"`259260        - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`261262          Union type for document source variants.263264          - `BetaManagedAgentsBase64DocumentSource object`265266            Base64-encoded document data.267268            - `type: "base64"`269270            - `data: string`271272              Base64-encoded document data.273274              minLength: 1275276            - `media_type: string`277278              MIME type of the document (e.g., "application/pdf").279280              minLength: 1281282          - `BetaManagedAgentsPlainTextDocumentSource object`283284            Plain text document content.285286            - `type: "text"`287288            - `data: string`289290              The plain text content.291292              minLength: 1293294            - `media_type: "text/plain"`295296              MIME type of the text content. Must be "text/plain".297298          - `BetaManagedAgentsURLDocumentSource object`299300            Document referenced by URL.301302            - `type: "url"`303304            - `url: string`305306              URL of the document to fetch.307308              minLength: 1309310          - `BetaManagedAgentsFileDocumentSource object`311312            Document referenced by file ID.313314            - `type: "file"`315316            - `file_id: string`317318              ID of a previously uploaded file.319320              minLength: 1321322        - `context: optional string or null`323324          Additional context about the document for the model.325326        - `title: optional string or null`327328          The title of the document.329330      - `BetaManagedAgentsRedactedBlock object`331332        Placeholder for content withheld by Anthropic model policy.333334        - `type: "redacted"`335336  - `BetaManagedAgentsUserDefineOutcomeEventParams object`337338    Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.339340    - `type: "user.define_outcome"`341342    - `description: string`343344      What the agent should produce. This is the task specification.345346    - `rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams`347348      Rubric for grading the quality of an outcome.349350      - `BetaManagedAgentsFileRubricParams object`351352        Rubric referenced by a file uploaded via the Files API.353354        - `type: "file"`355356        - `file_id: string`357358          ID of the rubric file.359360      - `BetaManagedAgentsTextRubricParams object`361362        Rubric content provided inline as text.363364        - `type: "text"`365366        - `content: string`367368          Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters.369370          maxLength: 262144371372    - `max_iterations: optional number or null`373374      Eval→revision cycles before giving up. Default 3, max 20.375376      format: int32377378  - `BetaManagedAgentsSystemMessageEventParams object`379380    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.381382    - `type: "system.message"`383384    - `content: array of BetaManagedAgentsSystemContentBlock`385386      System content blocks to append. Text-only.387388      - `type: "text"`389390      - `text: string`391392        The text content.393394        minLength: 1395396- `metadata: optional map[string] or null`397398  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.399400- `name: optional string`401402  Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.403404  maxLength: 256405406- `resources: optional array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam or null`407408  Session resources. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 500.409410  - `BetaManagedAgentsGitHubRepositoryResourceParams object`411412    Mount a GitHub repository into the session's container.413414    - `type: "github_repository"`415416    - `url: string`417418      Github URL of the repository419420      minLength: 1, maxLength: 2048421422    - `authorization_token: optional string`423424      GitHub authorization token used to clone the repository. Required for private repositories; optional for public ones.425426      minLength: 1, maxLength: 4096427428    - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null`429430      Branch or commit to check out. Defaults to the repository's default branch.431432      - `BetaManagedAgentsBranchCheckout object`433434        - `type: "branch"`435436        - `name: string`437438          Branch name to check out.439440          minLength: 1, maxLength: 255441442      - `BetaManagedAgentsCommitCheckout object`443444        - `type: "commit"`445446        - `sha: string`447448          Full commit SHA to check out.449450          minLength: 7, maxLength: 64451452    - `mount_path: optional string or null`453454      Mount path in the container. Defaults to `/workspace/<repo-name>`.455456      minLength: 1, maxLength: 4096457458  - `BetaManagedAgentsFileResourceParams object`459460    Mount a file uploaded via the Files API into the session.461462    - `type: "file"`463464    - `file_id: string`465466      ID of a previously uploaded file.467468      minLength: 1, maxLength: 128469470    - `mount_path: optional string or null`471472      Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.473474      minLength: 1, maxLength: 4096475476  - `BetaManagedAgentsMemoryStoreResourceParam object`477478    Parameters for attaching a memory store to an agent session.479480    - `type: "memory_store"`481482    - `memory_store_id: string`483484      The memory store ID (memstore_...). Must belong to the caller's organization and workspace.485486    - `access: optional "read_write" or "read_only" or null`487488      Access mode for an attached memory store.489490      - `"read_write"`491492      - `"read_only"`493494    - `instructions: optional string or null`495496      Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.497498      maxLength: 4096499500- `schedule: optional BetaManagedAgentsScheduleParams or null`501502  5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.503504  - `type: "cron"`505506  - `expression: string`507508    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).509510    minLength: 1, maxLength: 256511512  - `timezone: string`513514    Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database.515516    minLength: 1517518- `vault_ids: optional array of string or null`519520  Vault IDs. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 50.521522## Returns523524- `BetaManagedAgentsDeployment object`525526  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.527528  - `type: "deployment"`529530  - `id: string`531532    Unique identifier for this deployment.533534  - `agent: BetaManagedAgentsAgentReference`535536    A resolved agent reference with a concrete version.537538    - `type: "agent"`539540    - `id: string`541542    - `version: number`543544      format: int32545546  - `archived_at: string or null`547548    A timestamp in RFC 3339 format549550    format: date-time551552  - `created_at: string`553554    A timestamp in RFC 3339 format555556    format: date-time557558  - `description: string or null`559560    Description of what the deployment does.561562  - `environment_id: string`563564    ID of the `environment` where sessions run.565566  - `initial_events: array of BetaManagedAgentsDeploymentInitialEvent`567568    Events sent to each session immediately after creation.569570    - `BetaManagedAgentsDeploymentUserMessageEvent object`571572      A user message sent to the session.573574      - `type: "user.message"`575576      - `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`577578        Array of content blocks for the user message.579580        - `BetaManagedAgentsTextBlock object`581582          Regular text content.583584          - `type: "text"`585586          - `text: string`587588            The text content.589590            minLength: 1591592        - `BetaManagedAgentsImageBlock object`593594          Image content specified directly as base64 data or as a reference via a URL.595596          - `type: "image"`597598          - `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`599600            Union type for image source variants.601602            - `BetaManagedAgentsBase64ImageSource object`603604              Base64-encoded image data.605606              - `type: "base64"`607608              - `data: string`609610                Base64-encoded image data.611612                minLength: 1613614              - `media_type: string`615616                MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").617618                minLength: 1619620            - `BetaManagedAgentsURLImageSource object`621622              Image referenced by URL.623624              - `type: "url"`625626              - `url: string`627628                URL of the image to fetch.629630                minLength: 1631632            - `BetaManagedAgentsFileImageSource object`633634              Image referenced by file ID.635636              - `type: "file"`637638              - `file_id: string`639640                ID of a previously uploaded file.641642                minLength: 1643644        - `BetaManagedAgentsDocumentBlock object`645646          Document content, either specified directly as base64 data, as text, or as a reference via a URL.647648          - `type: "document"`649650          - `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`651652            Union type for document source variants.653654            - `BetaManagedAgentsBase64DocumentSource object`655656              Base64-encoded document data.657658              - `type: "base64"`659660              - `data: string`661662                Base64-encoded document data.663664                minLength: 1665666              - `media_type: string`667668                MIME type of the document (e.g., "application/pdf").669670                minLength: 1671672            - `BetaManagedAgentsPlainTextDocumentSource object`673674              Plain text document content.675676              - `type: "text"`677678              - `data: string`679680                The plain text content.681682                minLength: 1683684              - `media_type: "text/plain"`685686                MIME type of the text content. Must be "text/plain".687688            - `BetaManagedAgentsURLDocumentSource object`689690              Document referenced by URL.691692              - `type: "url"`693694              - `url: string`695696                URL of the document to fetch.697698                minLength: 1699700            - `BetaManagedAgentsFileDocumentSource object`701702              Document referenced by file ID.703704              - `type: "file"`705706              - `file_id: string`707708                ID of a previously uploaded file.709710                minLength: 1711712          - `context: optional string or null`713714            Additional context about the document for the model.715716          - `title: optional string or null`717718            The title of the document.719720        - `BetaManagedAgentsRedactedBlock object`721722          Placeholder for content withheld by Anthropic model policy.723724          - `type: "redacted"`725726    - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object`727728      An outcome the agent should work toward. The agent begins work on receipt.729730      - `type: "user.define_outcome"`731732      - `description: string`733734        What the agent should produce. This is the task specification.735736      - `rubric: BetaManagedAgentsFileRubric or BetaManagedAgentsTextRubric`737738        Rubric for grading the quality of an outcome.739740        - `BetaManagedAgentsFileRubric object`741742          Rubric referenced by a file uploaded via the Files API.743744          - `type: "file"`745746          - `file_id: string`747748            ID of the rubric file.749750        - `BetaManagedAgentsTextRubric object`751752          Rubric content provided inline as text.753754          - `type: "text"`755756          - `content: string`757758            Rubric content. Plain text or markdown — the grader treats it as freeform text.759760      - `max_iterations: optional number or null`761762        Eval→revision cycles before giving up. Default 3, max 20.763764        format: int32765766    - `BetaManagedAgentsDeploymentSystemMessageEvent object`767768      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.769770      - `type: "system.message"`771772      - `content: array of BetaManagedAgentsSystemContentBlock`773774        System content blocks to append. Text-only.775776        - `type: "text"`777778        - `text: string`779780          The text content.781782          minLength: 1783784  - `metadata: map[string]`785786    Arbitrary key-value metadata. Maximum 16 pairs.787788  - `name: string`789790    Human-readable name.791792  - `paused_reason: BetaManagedAgentsDeploymentPausedReason or null`793794    Why a deployment is paused. Non-null exactly when `status` is `paused`.795796    - `BetaManagedAgentsManualDeploymentPausedReason object`797798      The caller invoked the pause endpoint on the deployment.799800      - `type: "manual"`801802    - `BetaManagedAgentsErrorDeploymentPausedReason object`803804      A scheduled fire recorded a failed run whose error auto-pauses the deployment.805806      - `type: "error"`807808      - `error: BetaManagedAgentsDeploymentPausedReasonError`809810        The error that triggered an auto-pause. Matches the failed run's `error.type`.811812        - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object`813814          The deployment's environment was archived.815816          - `type: "environment_archived_error"`817818        - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object`819820          The deployment's agent was archived.821822          - `type: "agent_archived_error"`823824        - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object`825826          The deployment's environment no longer exists.827828          - `type: "environment_not_found_error"`829830        - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object`831832          A vault referenced by the deployment no longer exists.833834          - `type: "vault_not_found_error"`835836        - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object`837838          A file resource referenced by the deployment no longer exists.839840          - `type: "file_not_found_error"`841842        - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object`843844          A referenced resource no longer exists and its kind was not reported.845846          - `type: "session_resource_not_found_error"`847848        - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object`849850          The deployment's workspace was archived.851852          - `type: "workspace_archived_error"`853854        - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object`855856          The deployment's organization is disabled.857858          - `type: "organization_disabled_error"`859860        - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object`861862          A memory store referenced by the deployment is archived.863864          - `type: "memory_store_archived_error"`865866        - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object`867868          A skill referenced by the deployment's agent no longer exists.869870          - `type: "skill_not_found_error"`871872        - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object`873874          A vault referenced by the deployment is archived.875876          - `type: "vault_archived_error"`877878        - `BetaManagedAgentsUnknownDeploymentPausedReasonError object`879880          An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`.881882          - `type: "unknown_error"`883884        - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object`885886          The deployment configures resources, but its environment is self-hosted and cannot mount them.887888          - `type: "self_hosted_resources_unsupported_error"`889890        - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object`891892          An MCP server host used by the deployment's agent is blocked by the environment's network policy.893894          - `type: "mcp_egress_blocked_error"`895896  - `resources: array of BetaManagedAgentsSessionResourceConfig`897898    Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials.899900    - `BetaManagedAgentsGitHubRepositoryResourceConfig object`901902      A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.903904      - `type: "github_repository"`905906      - `url: string`907908        Github URL of the repository909910      - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null`911912        Branch or commit to check out. Defaults to the repository's default branch.913914        - `BetaManagedAgentsBranchCheckout object`915916          - `type: "branch"`917918          - `name: string`919920            Branch name to check out.921922            minLength: 1, maxLength: 255923924        - `BetaManagedAgentsCommitCheckout object`925926          - `type: "commit"`927928          - `sha: string`929930            Full commit SHA to check out.931932            minLength: 7, maxLength: 64933934      - `mount_path: optional string or null`935936        Mount path in the container. Defaults to `/workspace/<repo-name>`.937938    - `BetaManagedAgentsFileResourceConfig object`939940      A file mounted into each session's container.941942      - `type: "file"`943944      - `file_id: string`945946        ID of a previously uploaded file.947948      - `mount_path: optional string or null`949950        Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`.951952    - `BetaManagedAgentsMemoryStoreResourceConfig object`953954      A memory store attached to each session created from this deployment.955956      - `type: "memory_store"`957958      - `memory_store_id: string`959960        The memory store ID (memstore_...). Must belong to the caller's organization and workspace.961962      - `access: optional "read_write" or "read_only" or null`963964        Access mode for an attached memory store.965966        - `"read_write"`967968        - `"read_only"`969970      - `instructions: optional string or null`971972        Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars.973974  - `schedule: BetaManagedAgentsSchedule or null`975976    5-field POSIX cron schedule with computed runtime timestamps.977978    - `type: "cron"`979980    - `expression: string`981982      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).983984      minLength: 1, maxLength: 256985986    - `timezone: string`987988      IANA timezone identifier (e.g., "America/Los_Angeles", "UTC").989990      minLength: 1991992    - `last_run_at: optional string or null`993994      A timestamp in RFC 3339 format995996      format: date-time997998    - `upcoming_runs_at: optional array of string`9991000      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.10011002  - `status: BetaManagedAgentsDeploymentStatus`10031004    Lifecycle status of a deployment.10051006    - `"active"`10071008    - `"paused"`10091010  - `updated_at: string`10111012    A timestamp in RFC 3339 format10131014    format: date-time10151016  - `vault_ids: array of string`10171018    Vault IDs supplying stored credentials for sessions created from this deployment.10191020  - `budget: optional BetaManagedAgentsBudgetLimit or null`10211022    A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.10231024    - `type: "limit"`10251026    - `max_list_cost: BetaMonetaryAmount`10271028      A monetary amount in a specific currency.10291030      - `amount: string`10311032        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.10331034      - `currency: BetaCurrency`10351036        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.10371038## Example10391040```bash1041curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID \1042    -H 'Content-Type: application/json' \1043    -H 'anthropic-version: 2023-06-01' \1044    -H 'anthropic-beta: managed-agents-2026-04-01' \1045    -H "X-Api-Key: $ANTHROPIC_API_KEY" \1046    -d '{}'1047```10481049### Response (200)10501051```json1052{1053  "id": "depl_011CZkZcDH3vPqd7xnEfwTai",1054  "agent": {1055    "id": "agent_011CZkYpogX7uDKUyvBTophP",1056    "type": "agent",1057    "version": 11058  },1059  "archived_at": null,1060  "created_at": "2026-03-15T10:00:00Z",1061  "description": "Compiles yesterday's orders into a report every weekday morning.",1062  "environment_id": "env_011CZkZ9X2dpNyB7HsEFoRfW",1063  "initial_events": [1064    {1065      "content": [1066        {1067          "text": "Compile yesterday's orders into report.md.",1068          "type": "text"1069        }1070      ],1071      "type": "user.message"1072    }1073  ],1074  "metadata": {},1075  "name": "Daily order report",1076  "paused_reason": {1077    "type": "manual"1078  },1079  "resources": [1080    {1081      "type": "github_repository",1082      "url": "url",1083      "checkout": {1084        "name": "main",1085        "type": "branch"1086      },1087      "mount_path": "mount_path"1088    }1089  ],1090  "schedule": {1091    "expression": "0 9 * * 1-5",1092    "timezone": "America/Los_Angeles",1093    "type": "cron",1094    "last_run_at": "2026-03-16T16:00:09Z",1095    "upcoming_runs_at": [1096      "2026-03-17T16:00:00Z",1097      "2026-03-18T16:00:00Z"1098    ]1099  },1100  "status": "active",1101  "type": "deployment",1102  "updated_at": "2026-03-15T10:00:00Z",1103  "vault_ids": [1104    "vlt_011CZkZDLs7fYzm1hXNPeRjv"1105  ],1106  "budget": {1107    "max_list_cost": {1108      "amount": "2500",1109      "currency": "USD"1110    },1111    "type": "limit"1112  }1113}1114```1115
Files main
Menu

Theme