Anthropic Deployments API
The Deployments API from Anthropic — 5 operation(s) for deployments.
Anthropic Deployments API is one of 43 APIs that Anthropic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 6 operations across 5 paths, and defines 106 schemas. It is described by OpenAPI 3.2.0.
Requests are made against a single base URL, https://api.anthropic.com.
6 operations
5 paths
106 schemas
1 GET5 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 6
Across 5 paths, the API surfaces 6 operations — 1 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.
Deployments 6
POST
/v1/deployments/{deployment_id}/archive?beta=true
Archive Deployment
POST
/v1/deployments/{deployment_id}/pause?beta=true
Pause Deployment
POST
/v1/deployments/{deployment_id}/run?beta=true
Run Deployment Now
POST
/v1/deployments/{deployment_id}/unpause?beta=true
Unpause Deployment
GET
/v1/deployments/{deployment_id}?beta=true
Get Deployment
POST
/v1/deployments/{deployment_id}?beta=true
Update Deployment
Schemas 106
The contract defines 106 schemas that model the data the API accepts and returns. The most detailed are BetaManagedAgentsDeployment (17 properties), BetaManagedAgentsUpdateDeploymentParams (10 properties), BetaManagedAgentsDeploymentRun (8 properties), BetaManagedAgentsCronSchedule (5 properties). Each schema is shown below with its type and property counts.
BetaManagedAgentsScheduleParams
object
A recurring schedule. Discriminated union — only cron is supported currently.
BetaManagedAgentsOrganizationDisabledRunError
object
The deployment's organization is disabled.
2 properties
2 required
BetaManagedAgentsDeploymentPausedReason
object
Why a deployment is paused. Non-null exactly when status is paused.
BetaManagedAgentsSessionResourceConfig
object
A configured session resource. Echoes the input minus write-only credentials.
BetaManagedAgentsErrorDeploymentPausedReason
object
A scheduled fire recorded a failed run whose error auto-pauses the deployment.
2 properties
2 required
BetaManagedAgentsDeploymentPausedReasonError
object
The error that triggered an auto-pause. Matches the failed run's error.type.
BetaManagedAgentsAgentReference
object
A resolved agent reference with a concrete version.
3 properties
3 required
BetaManagedAgentsRubric
Rubric for grading the quality of an outcome.
BetaManagedAgentsUserMessageEventParams
object
Parameters for sending a user message to the session.
2 properties
2 required
BetaManagedAgentsDocumentBlock
object
Document content, either specified directly as base64 data, as text, or as a reference via a URL.
4 properties
2 required
BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError
object
The deployment's environment was archived.
1 property
1 required
BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError
object
The deployment configures resources, but its environment is self-hosted and cannot mount them.
1 property
1 required
BetaManagedAgentsURLImageSource
object
Image referenced by URL.
2 properties
2 required
BetaManagedAgentsBudget
object
An enforced spend ceiling on a session. Discriminated on type; limit is the only kind currently supported.
BetaManagedAgentsManualDeploymentPausedReason
object
The caller invoked the pause endpoint on the deployment.
1 property
1 required
BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError
object
A vault referenced by the deployment no longer exists.
1 property
1 required
BetaManagedAgentsEnvironmentArchivedRunError
object
The deployment's environment was archived.
2 properties
2 required
BetaManagedAgentsAgentArchivedDeploymentPausedReasonError
object
The deployment's agent was archived.
1 property
1 required
BetaManagedAgentsCronSchedule
object
5-field POSIX cron schedule with computed runtime timestamps.
5 properties
3 required
BetaManagedAgentsDeploymentInitialEvent
object
An event sent to a session immediately after it is created. Supports user.message, user.defineoutcome, and system.message.
BetaManagedAgentsFileNotFoundDeploymentPausedReasonError
object
A file resource referenced by the deployment no longer exists.
1 property
1 required
BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError
object
The deployment's organization is disabled.
1 property
1 required
BetaManagedAgentsAgentArchivedRunError
object
The deployment's agent was archived.
2 properties
2 required
BetaManagedAgentsFileDocumentSource
object
Document referenced by file ID.
2 properties
2 required
BetaManagedAgentsFileRubricParams
object
Rubric referenced by a file uploaded via the Files API.
2 properties
2 required
BetaManagedAgentsCronScheduleParams
object
5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
3 properties
3 required
BetaManagedAgentsUserContentBlock
object
Content block in a user message. Can be text, image, or document.
BetaManagedAgentsMemoryStoreArchivedRunError
object
A memory store referenced by the deployment is archived.
2 properties
2 required
BetaGatewayTimeoutError
object
2 properties
2 required
BetaManagedAgentsSkillNotFoundRunError
object
A skill referenced by the deployment's agent no longer exists.
2 properties
2 required
BetaManagedAgentsFileResourceConfig
object
A file mounted into each session's container.
3 properties
2 required
BetaManagedAgentsVaultArchivedDeploymentPausedReasonError
object
A vault referenced by the deployment is archived.
1 property
1 required
BetaManagedAgentsDeploymentUserMessageEvent
object
A user message sent to the session.
2 properties
2 required
BetaManagedAgentsSelfHostedResourcesUnsupportedRunError
object
The deployment configures resources, but its environment is self-hosted and cannot mount them.
2 properties
2 required
BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError
object
A memory store referenced by the deployment is archived.
1 property
1 required
BetaManagedAgentsBranchCheckout
object
2 properties
2 required
BetaManagedAgentsBase64DocumentSource
object
Base64-encoded document data.
3 properties
3 required
BetaManagedAgentsTriggerContext
object
Describes what triggered a deployment run, with trigger-specific metadata.
BetaManagedAgentsGitHubRepositoryResourceParams
object
Mount a GitHub repository into the session's container.
5 properties
3 required
BetaManagedAgentsManualTriggerContext
object
The run was started manually by creating a session directly against the deployment.
1 property
1 required
BetaManagedAgentsDeploymentUserDefineOutcomeEvent
object
An outcome the agent should work toward. The agent begins work on receipt.
4 properties
3 required
BetaManagedAgentsAgentParams
object
Specification for an Agent. Provide a specific version or use the short-form agent="agentid" for the most recent version
3 properties
2 required
BetaManagedAgentsMemoryStoreResourceConfig
object
A memory store attached to each session created from this deployment.
4 properties
2 required
BetaManagedAgentsFileResourceParams
object
Mount a file uploaded via the Files API into the session.
3 properties
2 required
BetaAPIError
object
2 properties
2 required
BetaManagedAgentsDeployment
object
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…
17 properties
16 required
BetaManagedAgentsRunError
object
Why the run failed to create a session. The type identifies the failure; message is human-readable detail.
BetaManagedAgentsSessionResourceParams
object
Union of resources that can be mounted into a session.
BetaRateLimitError
object
2 properties
2 required
BetaManagedAgentsMcpEgressBlockedRunError
object
An MCP server host used by the deployment's agent is blocked by the environment's network policy.
2 properties
2 required
BetaManagedAgentsEnvironmentNotFoundRunError
object
The deployment's environment no longer exists.
2 properties
2 required
BetaManagedAgentsUnknownRunError
object
An unknown or unexpected error caused the run to fail. A fallback variant; clients that do not recognize a new error type can match on message alone.
2 properties
2 required
BetaManagedAgentsSessionCreationRejectedRunError
object
The session create request was rejected with a non-retryable validation error.
2 properties
2 required
BetaManagedAgentsURLDocumentSource
object
Document referenced by URL.
2 properties
2 required
BetaManagedAgentsSystemMessageEventParams
object
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…
2 properties
2 required
BetaManagedAgentsCommitCheckout
object
2 properties
2 required
BetaManagedAgentsPlainTextDocumentSource
object
Plain text document content.
3 properties
3 required
BetaManagedAgentsFileNotFoundRunError
object
A file resource referenced by the deployment no longer exists.
2 properties
2 required
BetaManagedAgentsSessionResourceNotFoundRunError
object
A referenced resource no longer exists and its kind was not reported.
2 properties
2 required
BetaInvalidRequestError
object
2 properties
2 required
BetaManagedAgentsRubricParams
Rubric for grading the quality of an outcome.
BetaManagedAgentsSessionRateLimitedRunError
object
Session creation was rejected due to rate limiting. The schedule keeps firing; subsequent runs may succeed.
2 properties
2 required
BetaManagedAgentsGitHubRepositoryResourceConfig
object
A GitHub repository mounted into each session's container. The authorization token is write-only and never returned.
4 properties
2 required
BetaManagedAgentsSchedule
object
A recurring schedule with computed runtime timestamps. Discriminated union — only cron is supported currently.
BetaManagedAgentsTextRubricParams
object
Rubric content provided inline as text.
2 properties
2 required
BetaManagedAgentsRedactedBlock
object
Placeholder for content withheld by Anthropic model policy.
1 property
1 required
BetaManagedAgentsScheduleTriggerContext
object
The run was fired by the deployment's cron schedule.
2 properties
2 required
BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError
object
A skill referenced by the deployment's agent no longer exists.
1 property
1 required
BetaManagedAgentsUserDefineOutcomeEventParams
object
Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.
4 properties
3 required
BetaCurrency
string
BetaManagedAgentsBudgetLimit
object
A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches maxlistcost.
2 properties
2 required
BetaManagedAgentsVaultNotFoundRunError
object
A vault referenced by the deployment no longer exists.
2 properties
2 required
BetaManagedAgentsWorkspaceArchivedRunError
object
The deployment's workspace was archived.
2 properties
2 required
BetaManagedAgentsImageBlock
object
Image content specified directly as base64 data or as a reference via a URL.
2 properties
2 required
BetaTimestamp
string
A timestamp in RFC 3339 format
BetaOverloadedError
object
2 properties
2 required
BetaBillingError
object
2 properties
2 required
BetaManagedAgentsUnknownDeploymentPausedReasonError
object
An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose error.type is unknownerror.
1 property
1 required
BetaManagedAgentsUpdateDeploymentParams
object
Request parameters for updating a deployment. Omit a field to preserve its current value.
10 properties
BetaManagedAgentsSystemContentBlock
object
Content block in a mid-conversation system message. Text-only.
BetaManagedAgentsMemoryStoreResourceParam
object
Parameters for attaching a memory store to an agent session.
4 properties
2 required
BetaManagedAgentsVaultArchivedRunError
object
A vault referenced by the deployment is archived.
2 properties
2 required
BetaManagedAgentsRepositoryCheckout
object
BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError
object
The deployment's workspace was archived.
1 property
1 required
BetaManagedAgentsFileRubric
object
Rubric referenced by a file uploaded via the Files API.
2 properties
2 required
BetaAuthenticationError
object
2 properties
2 required
BetaManagedAgentsTextBlock
object
Regular text content.
2 properties
2 required
BetaNotFoundError
object
2 properties
2 required
BetaManagedAgentsDeploymentInitialEventParams
object
An event sent to a session immediately after it is created. Supports user.message, user.defineoutcome, and system.message.
BetaManagedAgentsDeploymentStatus
string
Lifecycle status of a deployment.
BetaPermissionError
object
2 properties
2 required
BetaManagedAgentsTextRubric
object
Rubric content provided inline as text.
2 properties
2 required
BetaMonetaryAmount
object
A monetary amount in a specific currency.
2 properties
2 required
BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError
object
The deployment's environment no longer exists.
1 property
1 required
BetaManagedAgentsAgentUnionParams
BetaManagedAgentsFileImageSource
object
Image referenced by file ID.
2 properties
2 required
BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError
object
A referenced resource no longer exists and its kind was not reported.
1 property
1 required
BetaManagedAgentsMountMode
string
Access mode for an attached memory store.
BetaManagedAgentsImageSource
object
Union type for image source variants.
BetaManagedAgentsDocumentSource
object
Union type for document source variants.
BetaManagedAgentsMcpEgressBlockedDeploymentPausedReasonError
object
An MCP server host used by the deployment's agent is blocked by the environment's network policy.
1 property
1 required
BetaErrorResponse
object
3 properties
3 required
BetaManagedAgentsDeploymentRun
object
A persistent, append-only record of a single deployment execution. Records session creation success or failure — no session lifecycle tracking.
8 properties
8 required
BetaManagedAgentsBase64ImageSource
object
Base64-encoded image data.
3 properties
3 required
AnthropicBeta
BetaManagedAgentsDeploymentSystemMessageEvent
object
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…
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Anthropic 12
Other APIs Anthropic publishes across the network.
Anthropic Messages API
Anthropic Models API
Anthropic Files API
Anthropic Skills API
Anthropic Agents API
Anthropic Api Keys API
Anthropic Cost API
Anthropic Environments API
Anthropic Events API
Anthropic Organization API
Anthropic Organization Invites API
Anthropic Organization Members API
#Deployment
Where this information came from
This is an independent, third-party profile of Anthropic Deployments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.