One change
Deployments
api/beta/deployments
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/beta/deployments Changed · +1092 / -1643 lines
### Headers ### Body parameters #### Response (200) ### Query parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ### Path parameters ### Headers ### Body parameters #### Response (200) ### Path parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ## Domain types ### Header Parameters ### Body Parameters #### Response ### Query Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters ### Body Parameters #### Response ### Path Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ## Domain Types
The two sides of this change are too far apart to line up, so this is the differ's own diff of it.
from line 1
---- -title: Deployments -url: https://platform.claude.com/docs/en/api/beta/deployments ---- - # Deployments ## Create Deployment -**post** `/v1/deployments` +**POST** `/v1/deployments` Create Deployment -### Header Parameters +### Headers - `"anthropic-beta": optional array of AnthropicBeta`
from line 84
- `"mid-conversation-tool-changes-2026-07-01"` -### Body Parameters +### Body parameters - `agent: string or BetaManagedAgentsAgentParams`
from line 92
- `string` - - `BetaManagedAgentsAgentParams object { id, type, version }` + - `BetaManagedAgentsAgentParams object` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version
from line 100
The `agent` ID. + minLength: 1, maxLength: 128 + - `type: "agent"` - - `"agent"` - - `version: optional number` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. + format: int32 + - `environment_id: string` ID of the `environment` defining the container configuration for sessions created from this deployment. + minLength: 1, maxLength: 128 + - `initial_events: array of BetaManagedAgentsDeploymentInitialEventParams` Events to send to each session immediately after creation. At least 1, maximum 50. - - `BetaManagedAgentsUserMessageEventParams object { content, type }` + - `BetaManagedAgentsUserMessageEventParams object` Parameters for sending a user message to the session.
from line 128
Array of content blocks for the user message. - - `BetaManagedAgentsTextBlock object { text, type }` + - `BetaManagedAgentsTextBlock object` Regular text content.
from line 136
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - - `BetaManagedAgentsImageBlock object { source, type }` + - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL.
from line 148
Union type for image source variants. - - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }` + - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data.
from line 156
Base64-encoded image data. + minLength: 1 + - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsURLImageSource object { type, url }` + - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the image to fetch. - - `BetaManagedAgentsFileImageSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileImageSource object` Image referenced by file ID.
from line 186
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` - - - `BetaManagedAgentsDocumentBlock object { source, type, context, title }` + - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL.
from line 200
Union type for document source variants. - - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }` + - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data.
from line 208
Base64-encoded document data. + minLength: 1 + - `media_type: string` MIME type of the document (e.g., "application/pdf"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }` + - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content.
from line 226
The plain text content. + minLength: 1 + - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - - `"text/plain"` - - `type: "text"` - - `"text"` - - - `BetaManagedAgentsURLDocumentSource object { type, url }` + - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the document to fetch. - - `BetaManagedAgentsFileDocumentSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID.
from line 254
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `context: optional string or null` Additional context about the document for the model.
from line 268
The title of the document. - - `BetaManagedAgentsRedactedBlock object { type }` + - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - - `"redacted"` - - `type: "user.message"` - - `"user.message"` - - - `BetaManagedAgentsUserDefineOutcomeEventParams object { description, rubric, type, max_iterations }` + - `BetaManagedAgentsUserDefineOutcomeEventParams object` Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.
from line 288
Rubric for grading the quality of an outcome. - - `BetaManagedAgentsFileRubricParams object { file_id, type }` + - `BetaManagedAgentsFileRubricParams object` Rubric referenced by a file uploaded via the Files API.
from line 298
- `type: "file"` - - `"file"` - - - `BetaManagedAgentsTextRubricParams object { content, type }` + - `BetaManagedAgentsTextRubricParams object` Rubric content provided inline as text.
from line 306
Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. + maxLength: 262144 + - `type: "text"` - - `"text"` - - `type: "user.define_outcome"` - - `"user.define_outcome"` - - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. - - `BetaManagedAgentsSystemMessageEventParams object { content, type }` + format: int32 + + - `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 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.
from line 330
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - `type: "system.message"` - - `"system.message"` - - `name: string` Human-readable name for the deployment. + minLength: 1, maxLength: 256 + - `budget: optional BetaManagedAgentsBudgetLimit or null` A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
from line 358
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. - - `"USD"` - - `type: "limit"` - - `"limit"` - - `description: optional string or null` Description of what the deployment does. + maxLength: 2048 + - `metadata: optional map[string]` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
from line 374
Resources (e.g. repositories, files) to mount into each session's container. Maximum 500. - - `BetaManagedAgentsGitHubRepositoryResourceParams object { authorization_token, type, url, 2 more }` + - `BetaManagedAgentsGitHubRepositoryResourceParams object` Mount a GitHub repository into the session's container.
from line 382
GitHub authorization token used to clone the repository. + minLength: 1, maxLength: 4096 + - `type: "github_repository"` - - `"github_repository"` - - `url: string` Github URL of the repository + minLength: 1, maxLength: 2048 + - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` Branch or commit to check out. Defaults to the repository's default branch. - - `BetaManagedAgentsBranchCheckout object { name, type }` + - `BetaManagedAgentsBranchCheckout object` - `name: string` Branch name to check out. + minLength: 1, maxLength: 255 + - `type: "branch"` - - `"branch"` - - - `BetaManagedAgentsCommitCheckout object { sha, type }` + - `BetaManagedAgentsCommitCheckout object` - `sha: string` Full commit SHA to check out. + minLength: 7, maxLength: 64 + - `type: "commit"` - - `"commit"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/<repo-name>`. - - `BetaManagedAgentsFileResourceParams object { file_id, type, mount_path }` + minLength: 1, maxLength: 4096 + + - `BetaManagedAgentsFileResourceParams object` Mount a file uploaded via the Files API into the session.
from line 430
ID of a previously uploaded file. + minLength: 1, maxLength: 128 + - `type: "file"` - - `"file"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. - - `BetaManagedAgentsMemoryStoreResourceParam object { memory_store_id, type, access, instructions }` + minLength: 1, maxLength: 4096 + + - `BetaManagedAgentsMemoryStoreResourceParam object` Parameters for attaching a memory store to an agent session.
from line 450
- `type: "memory_store"` - - `"memory_store"` - - `access: optional "read_write" or "read_only" or null` Access mode for an attached memory store.
from line 462
Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. + maxLength: 4096 + - `schedule: optional BetaManagedAgentsScheduleParams or null` 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
from line 472
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). + minLength: 1, maxLength: 256 + - `timezone: string` Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database. + minLength: 1 + - `type: "cron"` - - `"cron"` - - `vault_ids: optional array of string` Vault IDs for stored credentials the agent can use during sessions created from this deployment. Maximum 50. ### Returns -- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }` +- `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, and an optional schedule.
from line 504
- `type: "agent"` - - `"agent"` - - `version: number` + format: int32 + - `archived_at: string or null` A timestamp in RFC 3339 format + format: date-time + - `created_at: string` A timestamp in RFC 3339 format + format: date-time + - `description: string or null` Description of what the deployment does.
from line 532
Events sent to each session immediately after creation. - - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }` + - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session.
from line 540
Array of content blocks for the user message. - - `BetaManagedAgentsTextBlock object { text, type }` + - `BetaManagedAgentsTextBlock object` Regular text content.
from line 548
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - - `BetaManagedAgentsImageBlock object { source, type }` + - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL.
from line 560
Union type for image source variants. - - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }` + - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data.
from line 568
Base64-encoded image data. + minLength: 1 + - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsURLImageSource object { type, url }` + - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the image to fetch. - - `BetaManagedAgentsFileImageSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileImageSource object` Image referenced by file ID.
from line 598
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` - - - `BetaManagedAgentsDocumentBlock object { source, type, context, title }` + - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL.
from line 612
Union type for document source variants. - - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }` + - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data.
from line 620
Base64-encoded document data. + minLength: 1 + - `media_type: string` MIME type of the document (e.g., "application/pdf"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }` + - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content.
from line 638
The plain text content. + minLength: 1 + - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - - `"text/plain"` - - `type: "text"` - - `"text"` - - - `BetaManagedAgentsURLDocumentSource object { type, url }` + - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the document to fetch. - - `BetaManagedAgentsFileDocumentSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID.
from line 666
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `context: optional string or null` Additional context about the document for the model.
from line 680
The title of the document. - - `BetaManagedAgentsRedactedBlock object { type }` + - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - - `"redacted"` - - `type: "user.message"` - - `"user.message"` - - - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }` + - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt.
from line 700
Rubric for grading the quality of an outcome. - - `BetaManagedAgentsFileRubric object { file_id, type }` + - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API.
from line 710
- `type: "file"` - - `"file"` - - - `BetaManagedAgentsTextRubric object { content, type }` + - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text.
from line 720
- `type: "text"` - - `"text"` - - `type: "user.define_outcome"` - - `"user.define_outcome"` - - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. - - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }` + format: int32 + + - `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 the top-level system prompt.
from line 740
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - `type: "system.message"` - - `"system.message"` - - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs.
from line 758
Why a deployment is paused. Non-null exactly when `status` is `paused`. - - `BetaManagedAgentsManualDeploymentPausedReason object { type }` + - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - - `"manual"` - - - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }` + - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment.
from line 772
The error that triggered an auto-pause. Matches the failed run's `error.type`. - - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - - `"environment_archived_error"` - - - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - - `"agent_archived_error"` - - - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - - `"environment_not_found_error"` - - - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - - `"vault_not_found_error"` - - - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - - `"file_not_found_error"` - - - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` - - - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - - `"workspace_archived_error"` - - - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - - `"organization_disabled_error"` - - - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` - - - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - - `"skill_not_found_error"` - - - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - - `"vault_archived_error"` - - - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` 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 of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }` + - `BetaManagedAgentsGitHubRepositoryResourceConfig object` 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
from line 876
Branch or commit to check out. Defaults to the repository's default branch. - - `BetaManagedAgentsBranchCheckout object { name, type }` + - `BetaManagedAgentsBranchCheckout object` - `name: string` Branch name to check out. + minLength: 1, maxLength: 255 + - `type: "branch"` - - `"branch"` - - - `BetaManagedAgentsCommitCheckout object { sha, type }` + - `BetaManagedAgentsCommitCheckout object` - `sha: string` Full commit SHA to check out. + minLength: 7, maxLength: 64 + - `type: "commit"` - - `"commit"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/<repo-name>`. - - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }` + - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container.
from line 910
- `type: "file"` - - `"file"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. - - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }` + - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment.
from line 924
- `type: "memory_store"` - - `"memory_store"` - - `access: optional "read_write" or "read_only" or null` Access mode for an attached memory store.
from line 944
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). + minLength: 1, maxLength: 256 + - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). + minLength: 1 + - `type: "cron"` - - `"cron"` - - `last_run_at: optional string or null` A timestamp in RFC 3339 format + format: date-time + - `upcoming_runs_at: optional array of string` 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.
from line 974
- `type: "deployment"` - - `"deployment"` - - `updated_at: string` A timestamp in RFC 3339 format + format: date-time + - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment.
from line 1000
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. - - `"USD"` - - `type: "limit"` - - `"limit"` - ### Example -```http +```bash curl https://api.anthropic.com/v1/deployments \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \
from line 1028
}' ``` -#### Response +#### Response (200) ```json {
from line 1097
## List Deployments -**get** `/v1/deployments` +**GET** `/v1/deployments` List Deployments -### Query Parameters +### Query parameters - `agent_id: optional string`
from line 1111
Return deployments created at or after this time (inclusive). + format: date-time + - `"created_at[lte]": optional string` Return deployments created at or before this time (inclusive). + format: date-time + - `include_archived: optional boolean` When true, includes archived deployments. Default: false (exclude archived).
from line 1127
Maximum results per page. Default 20, maximum 100. + format: int32 + - `page: optional string` Opaque pagination cursor.
from line 1141
- `"paused"` -### Header Parameters +### Headers - `"anthropic-beta": optional array of AnthropicBeta`
from line 1237
- `type: "agent"` - - `"agent"` - - `version: number` + format: int32 + - `archived_at: string or null` A timestamp in RFC 3339 format + format: date-time + - `created_at: string` A timestamp in RFC 3339 format + format: date-time + - `description: string or null` Description of what the deployment does.
from line 1265
Events sent to each session immediately after creation. - - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }` + - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session.
from line 1273
Array of content blocks for the user message. - - `BetaManagedAgentsTextBlock object { text, type }` + - `BetaManagedAgentsTextBlock object` Regular text content.
from line 1281
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - - `BetaManagedAgentsImageBlock object { source, type }` + - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL.
from line 1293
Union type for image source variants. - - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }` + - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data.
from line 1301
Base64-encoded image data. + minLength: 1 + - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsURLImageSource object { type, url }` + - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the image to fetch. - - `BetaManagedAgentsFileImageSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileImageSource object` Image referenced by file ID.
from line 1331
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` - - - `BetaManagedAgentsDocumentBlock object { source, type, context, title }` + - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL.
from line 1345
Union type for document source variants. - - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }` + - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data.
from line 1353
Base64-encoded document data. + minLength: 1 + - `media_type: string` MIME type of the document (e.g., "application/pdf"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }` + - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content.
from line 1371
The plain text content. + minLength: 1 + - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - - `"text/plain"` - - `type: "text"` - - `"text"` - - - `BetaManagedAgentsURLDocumentSource object { type, url }` + - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the document to fetch. - - `BetaManagedAgentsFileDocumentSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID.
from line 1399
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `context: optional string or null` Additional context about the document for the model.
from line 1413
The title of the document. - - `BetaManagedAgentsRedactedBlock object { type }` + - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - - `"redacted"` - - `type: "user.message"` - - `"user.message"` - - - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }` + - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt.
from line 1433
Rubric for grading the quality of an outcome. - - `BetaManagedAgentsFileRubric object { file_id, type }` + - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API.
from line 1443
- `type: "file"` - - `"file"` - - - `BetaManagedAgentsTextRubric object { content, type }` + - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text.
from line 1453
- `type: "text"` - - `"text"` - - `type: "user.define_outcome"` - - `"user.define_outcome"` - - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. - - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }` + format: int32 + + - `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 the top-level system prompt.
from line 1473
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - `type: "system.message"` - - `"system.message"` - - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs.
from line 1491
Why a deployment is paused. Non-null exactly when `status` is `paused`. - - `BetaManagedAgentsManualDeploymentPausedReason object { type }` + - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - - `"manual"` - - - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }` + - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment.
from line 1505
The error that triggered an auto-pause. Matches the failed run's `error.type`. - - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - - `"environment_archived_error"` - - - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - - `"agent_archived_error"` - - - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - - `"environment_not_found_error"` - - - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - - `"vault_not_found_error"` - - - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - - `"file_not_found_error"` - - - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` - - - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - - `"workspace_archived_error"` - - - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - - `"organization_disabled_error"` - - - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` - - - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - - `"skill_not_found_error"` - - - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - - `"vault_archived_error"` - - - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` 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 of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }` + - `BetaManagedAgentsGitHubRepositoryResourceConfig object` 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
from line 1609
Branch or commit to check out. Defaults to the repository's default branch. - - `BetaManagedAgentsBranchCheckout object { name, type }` + - `BetaManagedAgentsBranchCheckout object` - `name: string` Branch name to check out. + minLength: 1, maxLength: 255 + - `type: "branch"` - - `"branch"` - - - `BetaManagedAgentsCommitCheckout object { sha, type }` + - `BetaManagedAgentsCommitCheckout object` - `sha: string` Full commit SHA to check out. + minLength: 7, maxLength: 64 + - `type: "commit"` - - `"commit"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/<repo-name>`. - - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }` + - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container.
from line 1643
- `type: "file"` - - `"file"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. - - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }` + - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment.
from line 1657
- `type: "memory_store"` - - `"memory_store"` - - `access: optional "read_write" or "read_only" or null` Access mode for an attached memory store.
from line 1677
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). + minLength: 1, maxLength: 256 + - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). + minLength: 1 + - `type: "cron"` - - `"cron"` - - `last_run_at: optional string or null` A timestamp in RFC 3339 format + format: date-time + - `upcoming_runs_at: optional array of string` 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.
from line 1707
- `type: "deployment"` - - `"deployment"` - - `updated_at: string` A timestamp in RFC 3339 format + format: date-time + - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment.
from line 1733
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. - - `"USD"` - - `type: "limit"` - - `"limit"` - - `next_page: optional string or null` Opaque cursor for the next page. Null when no more results. ### Example -```http +```bash curl https://api.anthropic.com/v1/deployments \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +#### Response (200) ```json {
from line 1822
## Get Deployment -**get** `/v1/deployments/{deployment_id}` +**GET** `/v1/deployments/{deployment_id}` Get Deployment -### Path Parameters +### Path parameters - `deployment_id: string` -### Header Parameters +### Headers - `"anthropic-beta": optional array of AnthropicBeta`
from line 1910
### Returns -- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }` +- `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, and an optional schedule.
from line 1926
- `type: "agent"` - - `"agent"` - - `version: number` + format: int32 + - `archived_at: string or null` A timestamp in RFC 3339 format + format: date-time + - `created_at: string` A timestamp in RFC 3339 format + format: date-time + - `description: string or null` Description of what the deployment does.
from line 1954
Events sent to each session immediately after creation. - - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }` + - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session.
from line 1962
Array of content blocks for the user message. - - `BetaManagedAgentsTextBlock object { text, type }` + - `BetaManagedAgentsTextBlock object` Regular text content.
from line 1970
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - - `BetaManagedAgentsImageBlock object { source, type }` + - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL.
from line 1982
Union type for image source variants. - - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }` + - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data.
from line 1990
Base64-encoded image data. + minLength: 1 + - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsURLImageSource object { type, url }` + - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the image to fetch. - - `BetaManagedAgentsFileImageSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileImageSource object` Image referenced by file ID.
from line 2020
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` - - - `BetaManagedAgentsDocumentBlock object { source, type, context, title }` + - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL.
from line 2034
Union type for document source variants. - - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }` + - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data.
from line 2042
Base64-encoded document data. + minLength: 1 + - `media_type: string` MIME type of the document (e.g., "application/pdf"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }` + - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content.
from line 2060
The plain text content. + minLength: 1 + - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - - `"text/plain"` - - `type: "text"` - - `"text"` - - - `BetaManagedAgentsURLDocumentSource object { type, url }` + - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the document to fetch. - - `BetaManagedAgentsFileDocumentSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID.
from line 2088
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `context: optional string or null` Additional context about the document for the model.
from line 2102
The title of the document. - - `BetaManagedAgentsRedactedBlock object { type }` + - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - - `"redacted"` - - `type: "user.message"` - - `"user.message"` - - - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }` + - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt.
from line 2122
Rubric for grading the quality of an outcome. - - `BetaManagedAgentsFileRubric object { file_id, type }` + - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API.
from line 2132
- `type: "file"` - - `"file"` - - - `BetaManagedAgentsTextRubric object { content, type }` + - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text.
from line 2142
- `type: "text"` - - `"text"` - - `type: "user.define_outcome"` - - `"user.define_outcome"` - - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. - - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }` + format: int32 + + - `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 the top-level system prompt.
from line 2162
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - `type: "system.message"` - - `"system.message"` - - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs.
from line 2180
Why a deployment is paused. Non-null exactly when `status` is `paused`. - - `BetaManagedAgentsManualDeploymentPausedReason object { type }` + - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - - `"manual"` - - - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }` + - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment.
from line 2194
The error that triggered an auto-pause. Matches the failed run's `error.type`. - - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - - `"environment_archived_error"` - - - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - - `"agent_archived_error"` - - - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - - `"environment_not_found_error"` - - - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - - `"vault_not_found_error"` - - - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - - `"file_not_found_error"` - - - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` - - - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - - `"workspace_archived_error"` - - - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - - `"organization_disabled_error"` - - - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` - - - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - - `"skill_not_found_error"` - - - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - - `"vault_archived_error"` - - - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` 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 of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }` + - `BetaManagedAgentsGitHubRepositoryResourceConfig object` 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
from line 2298
Branch or commit to check out. Defaults to the repository's default branch. - - `BetaManagedAgentsBranchCheckout object { name, type }` + - `BetaManagedAgentsBranchCheckout object` - `name: string` Branch name to check out. + minLength: 1, maxLength: 255 + - `type: "branch"` - - `"branch"` - - - `BetaManagedAgentsCommitCheckout object { sha, type }` + - `BetaManagedAgentsCommitCheckout object` - `sha: string` Full commit SHA to check out. + minLength: 7, maxLength: 64 + - `type: "commit"` - - `"commit"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/<repo-name>`. - - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }` + - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container.
from line 2332
- `type: "file"` - - `"file"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. - - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }` + - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment.
from line 2346
- `type: "memory_store"` - - `"memory_store"` - - `access: optional "read_write" or "read_only" or null` Access mode for an attached memory store.
from line 2366
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). + minLength: 1, maxLength: 256 + - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). + minLength: 1 + - `type: "cron"` - - `"cron"` - - `last_run_at: optional string or null` A timestamp in RFC 3339 format + format: date-time + - `upcoming_runs_at: optional array of string` 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.
from line 2396
- `type: "deployment"` - - `"deployment"` - - `updated_at: string` A timestamp in RFC 3339 format + format: date-time + - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment.
from line 2422
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. - - `"USD"` - - `type: "limit"` - - `"limit"` - ### Example -```http +```bash curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID \ -H 'anthropic-version: 2023-06-01' \ -H 'anthropic-beta: managed-agents-2026-04-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +#### Response (200) ```json {
from line 2502
## Update Deployment -**post** `/v1/deployments/{deployment_id}` +**POST** `/v1/deployments/{deployment_id}` Update Deployment -### Path Parameters +### Path parameters - `deployment_id: string` -### Header Parameters +### Headers - `"anthropic-beta": optional array of AnthropicBeta`
from line 2588
- `"mid-conversation-tool-changes-2026-07-01"` -### Body Parameters +### Body parameters - `agent: optional string or BetaManagedAgentsAgentParams`
from line 2596
- `string` - - `BetaManagedAgentsAgentParams object { id, type, version }` + - `BetaManagedAgentsAgentParams object` Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version
from line 2604
The `agent` ID. + minLength: 1, maxLength: 128 + - `type: "agent"` - - `"agent"` - - `version: optional number` The specific `agent` version to use. Omit to use the latest version. Must be at least 1 if specified. + format: int32 + - `budget: optional BetaManagedAgentsBudgetLimit or null` A hard spend ceiling. The session stops issuing new model requests once the tracked list cost reaches `max_list_cost`.
from line 2630
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. - - `"USD"` - - `type: "limit"` - - `"limit"` - - `description: optional string or null` Description. Omit to preserve; send empty string or null to clear. + maxLength: 2048 + - `environment_id: optional string` ID of the `environment` where sessions run. Omit to preserve. Cannot be cleared. + maxLength: 128 + - `initial_events: optional array of BetaManagedAgentsDeploymentInitialEventParams` Initial events. Full replacement. Omit to preserve. Cannot be cleared. At least 1, maximum 50. - - `BetaManagedAgentsUserMessageEventParams object { content, type }` + - `BetaManagedAgentsUserMessageEventParams object` Parameters for sending a user message to the session.
from line 2656
Array of content blocks for the user message. - - `BetaManagedAgentsTextBlock object { text, type }` + - `BetaManagedAgentsTextBlock object` Regular text content.
from line 2664
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - - `BetaManagedAgentsImageBlock object { source, type }` + - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL.
from line 2676
Union type for image source variants. - - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }` + - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data.
from line 2684
Base64-encoded image data. + minLength: 1 + - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsURLImageSource object { type, url }` + - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the image to fetch. - - `BetaManagedAgentsFileImageSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileImageSource object` Image referenced by file ID.
from line 2714
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` - - - `BetaManagedAgentsDocumentBlock object { source, type, context, title }` + - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL.
from line 2728
Union type for document source variants. - - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }` + - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data.
from line 2736
Base64-encoded document data. + minLength: 1 + - `media_type: string` MIME type of the document (e.g., "application/pdf"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }` + - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content.
from line 2754
The plain text content. + minLength: 1 + - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - - `"text/plain"` - - `type: "text"` - - `"text"` - - - `BetaManagedAgentsURLDocumentSource object { type, url }` + - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the document to fetch. - - `BetaManagedAgentsFileDocumentSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID.
from line 2782
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `context: optional string or null` Additional context about the document for the model.
from line 2796
The title of the document. - - `BetaManagedAgentsRedactedBlock object { type }` + - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - - `"redacted"` - - `type: "user.message"` - - `"user.message"` - - - `BetaManagedAgentsUserDefineOutcomeEventParams object { description, rubric, type, max_iterations }` + - `BetaManagedAgentsUserDefineOutcomeEventParams object` Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.
from line 2816
Rubric for grading the quality of an outcome. - - `BetaManagedAgentsFileRubricParams object { file_id, type }` + - `BetaManagedAgentsFileRubricParams object` Rubric referenced by a file uploaded via the Files API.
from line 2826
- `type: "file"` - - `"file"` - - - `BetaManagedAgentsTextRubricParams object { content, type }` + - `BetaManagedAgentsTextRubricParams object` Rubric content provided inline as text.
from line 2834
Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. + maxLength: 262144 + - `type: "text"` - - `"text"` - - `type: "user.define_outcome"` - - `"user.define_outcome"` - - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. - - `BetaManagedAgentsSystemMessageEventParams object { content, type }` + format: int32 + + - `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 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.
from line 2858
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - `type: "system.message"` - - `"system.message"` - - `metadata: optional map[string] or 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.
from line 2872
Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared. + maxLength: 256 + - `resources: optional array of BetaManagedAgentsGitHubRepositoryResourceParams or BetaManagedAgentsFileResourceParams or BetaManagedAgentsMemoryStoreResourceParam or null` Session resources. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 500. - - `BetaManagedAgentsGitHubRepositoryResourceParams object { authorization_token, type, url, 2 more }` + - `BetaManagedAgentsGitHubRepositoryResourceParams object` Mount a GitHub repository into the session's container.
from line 2886
GitHub authorization token used to clone the repository. + minLength: 1, maxLength: 4096 + - `type: "github_repository"` - - `"github_repository"` - - `url: string` Github URL of the repository + minLength: 1, maxLength: 2048 + - `checkout: optional BetaManagedAgentsBranchCheckout or BetaManagedAgentsCommitCheckout or null` Branch or commit to check out. Defaults to the repository's default branch. - - `BetaManagedAgentsBranchCheckout object { name, type }` + - `BetaManagedAgentsBranchCheckout object` - `name: string` Branch name to check out. + minLength: 1, maxLength: 255 + - `type: "branch"` - - `"branch"` - - - `BetaManagedAgentsCommitCheckout object { sha, type }` + - `BetaManagedAgentsCommitCheckout object` - `sha: string` Full commit SHA to check out. + minLength: 7, maxLength: 64 + - `type: "commit"` - - `"commit"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/<repo-name>`. - - `BetaManagedAgentsFileResourceParams object { file_id, type, mount_path }` + minLength: 1, maxLength: 4096 + + - `BetaManagedAgentsFileResourceParams object` Mount a file uploaded via the Files API into the session.
from line 2934
ID of a previously uploaded file. + minLength: 1, maxLength: 128 + - `type: "file"` - - `"file"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. - - `BetaManagedAgentsMemoryStoreResourceParam object { memory_store_id, type, access, instructions }` + minLength: 1, maxLength: 4096 + + - `BetaManagedAgentsMemoryStoreResourceParam object` Parameters for attaching a memory store to an agent session.
from line 2954
- `type: "memory_store"` - - `"memory_store"` - - `access: optional "read_write" or "read_only" or null` Access mode for an attached memory store.
from line 2966
Per-attachment guidance for the agent on how to use this store. Rendered into the memory section of the system prompt. Max 4096 chars. + maxLength: 4096 + - `schedule: optional BetaManagedAgentsScheduleParams or null` 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
from line 2976
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). + minLength: 1, maxLength: 256 + - `timezone: string` Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database. + minLength: 1 + - `type: "cron"` - - `"cron"` - - `vault_ids: optional array of string or null` Vault IDs. Full replacement. Omit to preserve; send empty array or null to clear. Maximum 50. ### Returns -- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }` +- `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, and an optional schedule.
from line 3008
- `type: "agent"` - - `"agent"` - - `version: number` + format: int32 + - `archived_at: string or null` A timestamp in RFC 3339 format + format: date-time + - `created_at: string` A timestamp in RFC 3339 format + format: date-time + - `description: string or null` Description of what the deployment does.
from line 3036
Events sent to each session immediately after creation. - - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }` + - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session.
from line 3044
Array of content blocks for the user message. - - `BetaManagedAgentsTextBlock object { text, type }` + - `BetaManagedAgentsTextBlock object` Regular text content.
from line 3052
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - - `BetaManagedAgentsImageBlock object { source, type }` + - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL.
from line 3064
Union type for image source variants. - - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }` + - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data.
from line 3072
Base64-encoded image data. + minLength: 1 + - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsURLImageSource object { type, url }` + - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the image to fetch. - - `BetaManagedAgentsFileImageSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileImageSource object` Image referenced by file ID.
from line 3102
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` - - - `BetaManagedAgentsDocumentBlock object { source, type, context, title }` + - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL.
from line 3116
Union type for document source variants. - - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }` + - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data.
from line 3124
Base64-encoded document data. + minLength: 1 + - `media_type: string` MIME type of the document (e.g., "application/pdf"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }` + - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content.
from line 3142
The plain text content. + minLength: 1 + - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - - `"text/plain"` - - `type: "text"` - - `"text"` - - - `BetaManagedAgentsURLDocumentSource object { type, url }` + - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the document to fetch. - - `BetaManagedAgentsFileDocumentSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID.
from line 3170
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `context: optional string or null` Additional context about the document for the model.
from line 3184
The title of the document. - - `BetaManagedAgentsRedactedBlock object { type }` + - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - - `"redacted"` - - `type: "user.message"` - - `"user.message"` - - - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }` + - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt.
from line 3204
Rubric for grading the quality of an outcome. - - `BetaManagedAgentsFileRubric object { file_id, type }` + - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API.
from line 3214
- `type: "file"` - - `"file"` - - - `BetaManagedAgentsTextRubric object { content, type }` + - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text.
from line 3224
- `type: "text"` - - `"text"` - - `type: "user.define_outcome"` - - `"user.define_outcome"` - - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. - - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }` + format: int32 + + - `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 the top-level system prompt.
from line 3244
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - `type: "system.message"` - - `"system.message"` - - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs.
from line 3262
Why a deployment is paused. Non-null exactly when `status` is `paused`. - - `BetaManagedAgentsManualDeploymentPausedReason object { type }` + - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - - `"manual"` - - - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }` + - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment.
from line 3276
The error that triggered an auto-pause. Matches the failed run's `error.type`. - - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - - `"environment_archived_error"` - - - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - - `"agent_archived_error"` - - - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - - `"environment_not_found_error"` - - - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - - `"vault_not_found_error"` - - - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - - `"file_not_found_error"` - - - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` - - - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - - `"workspace_archived_error"` - - - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - - `"organization_disabled_error"` - - - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` - - - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - - `"skill_not_found_error"` - - - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - - `"vault_archived_error"` - - - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` 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 of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }` + - `BetaManagedAgentsGitHubRepositoryResourceConfig object` 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
from line 3380
Branch or commit to check out. Defaults to the repository's default branch. - - `BetaManagedAgentsBranchCheckout object { name, type }` + - `BetaManagedAgentsBranchCheckout object` - `name: string` Branch name to check out. + minLength: 1, maxLength: 255 + - `type: "branch"` - - `"branch"` - - - `BetaManagedAgentsCommitCheckout object { sha, type }` + - `BetaManagedAgentsCommitCheckout object` - `sha: string` Full commit SHA to check out. + minLength: 7, maxLength: 64 + - `type: "commit"` - - `"commit"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/<repo-name>`. - - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }` + - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container.
from line 3414
- `type: "file"` - - `"file"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. - - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }` + - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment.
from line 3428
- `type: "memory_store"` - - `"memory_store"` - - `access: optional "read_write" or "read_only" or null` Access mode for an attached memory store.
from line 3448
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). + minLength: 1, maxLength: 256 + - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). + minLength: 1 + - `type: "cron"` - - `"cron"` - - `last_run_at: optional string or null` A timestamp in RFC 3339 format + format: date-time + - `upcoming_runs_at: optional array of string` 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.
from line 3478
- `type: "deployment"` - - `"deployment"` - - `updated_at: string` A timestamp in RFC 3339 format + format: date-time + - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment.
from line 3504
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. - - `"USD"` - - `type: "limit"` - - `"limit"` - ### Example -```http +```bash curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \
from line 3517
-d '{}' ``` -#### Response +#### Response (200) ```json {
from line 3586
## Archive Deployment -**post** `/v1/deployments/{deployment_id}/archive` +**POST** `/v1/deployments/{deployment_id}/archive` Archive Deployment -### Path Parameters +### Path parameters - `deployment_id: string` -### Header Parameters +### Headers - `"anthropic-beta": optional array of AnthropicBeta`
from line 3674
### Returns -- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }` +- `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, and an optional schedule.
from line 3690
- `type: "agent"` - - `"agent"` - - `version: number` + format: int32 + - `archived_at: string or null` A timestamp in RFC 3339 format + format: date-time + - `created_at: string` A timestamp in RFC 3339 format + format: date-time + - `description: string or null` Description of what the deployment does.
from line 3718
Events sent to each session immediately after creation. - - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }` + - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session.
from line 3726
Array of content blocks for the user message. - - `BetaManagedAgentsTextBlock object { text, type }` + - `BetaManagedAgentsTextBlock object` Regular text content.
from line 3734
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - - `BetaManagedAgentsImageBlock object { source, type }` + - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL.
from line 3746
Union type for image source variants. - - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }` + - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data.
from line 3754
Base64-encoded image data. + minLength: 1 + - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsURLImageSource object { type, url }` + - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the image to fetch. - - `BetaManagedAgentsFileImageSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileImageSource object` Image referenced by file ID.
from line 3784
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` - - - `BetaManagedAgentsDocumentBlock object { source, type, context, title }` + - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL.
from line 3798
Union type for document source variants. - - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }` + - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data.
from line 3806
Base64-encoded document data. + minLength: 1 + - `media_type: string` MIME type of the document (e.g., "application/pdf"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }` + - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content.
from line 3824
The plain text content. + minLength: 1 + - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - - `"text/plain"` - - `type: "text"` - - `"text"` - - - `BetaManagedAgentsURLDocumentSource object { type, url }` + - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the document to fetch. - - `BetaManagedAgentsFileDocumentSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID.
from line 3852
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `context: optional string or null` Additional context about the document for the model.
from line 3866
The title of the document. - - `BetaManagedAgentsRedactedBlock object { type }` + - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - - `"redacted"` - - `type: "user.message"` - - `"user.message"` - - - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }` + - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt.
from line 3886
Rubric for grading the quality of an outcome. - - `BetaManagedAgentsFileRubric object { file_id, type }` + - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API.
from line 3896
- `type: "file"` - - `"file"` - - - `BetaManagedAgentsTextRubric object { content, type }` + - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text.
from line 3906
- `type: "text"` - - `"text"` - - `type: "user.define_outcome"` - - `"user.define_outcome"` - - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. - - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }` + format: int32 + + - `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 the top-level system prompt.
from line 3926
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - `type: "system.message"` - - `"system.message"` - - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs.
from line 3944
Why a deployment is paused. Non-null exactly when `status` is `paused`. - - `BetaManagedAgentsManualDeploymentPausedReason object { type }` + - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - - `"manual"` - - - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }` + - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment.
from line 3958
The error that triggered an auto-pause. Matches the failed run's `error.type`. - - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - - `"environment_archived_error"` - - - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - - `"agent_archived_error"` - - - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - - `"environment_not_found_error"` - - - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - - `"vault_not_found_error"` - - - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - - `"file_not_found_error"` - - - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` - - - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - - `"workspace_archived_error"` - - - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - - `"organization_disabled_error"` - - - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` - - - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - - `"skill_not_found_error"` - - - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - - `"vault_archived_error"` - - - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` 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 of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }` + - `BetaManagedAgentsGitHubRepositoryResourceConfig object` 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
from line 4062
Branch or commit to check out. Defaults to the repository's default branch. - - `BetaManagedAgentsBranchCheckout object { name, type }` + - `BetaManagedAgentsBranchCheckout object` - `name: string` Branch name to check out. + minLength: 1, maxLength: 255 + - `type: "branch"` - - `"branch"` - - - `BetaManagedAgentsCommitCheckout object { sha, type }` + - `BetaManagedAgentsCommitCheckout object` - `sha: string` Full commit SHA to check out. + minLength: 7, maxLength: 64 + - `type: "commit"` - - `"commit"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/<repo-name>`. - - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }` + - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container.
from line 4096
- `type: "file"` - - `"file"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. - - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }` + - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment.
from line 4110
- `type: "memory_store"` - - `"memory_store"` - - `access: optional "read_write" or "read_only" or null` Access mode for an attached memory store.
from line 4130
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). + minLength: 1, maxLength: 256 + - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). + minLength: 1 + - `type: "cron"` - - `"cron"` - - `last_run_at: optional string or null` A timestamp in RFC 3339 format + format: date-time + - `upcoming_runs_at: optional array of string` 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.
from line 4160
- `type: "deployment"` - - `"deployment"` - - `updated_at: string` A timestamp in RFC 3339 format + format: date-time + - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment.
from line 4186
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. - - `"USD"` - - `type: "limit"` - - `"limit"` - ### Example -```http +```bash curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \
from line 4198
-H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +#### Response (200) ```json {
from line 4267
## Run Deployment Now -**post** `/v1/deployments/{deployment_id}/run` +**POST** `/v1/deployments/{deployment_id}/run` Run Deployment Now -### Path Parameters +### Path parameters - `deployment_id: string` -### Header Parameters +### Headers - `"anthropic-beta": optional array of AnthropicBeta`
from line 4355
### Returns -- `BetaManagedAgentsDeploymentRun object { id, agent, created_at, 5 more }` +- `BetaManagedAgentsDeploymentRun object` A persistent, append-only record of a single deployment execution. Records session creation success or failure — no session lifecycle tracking.
from line 4371
- `type: "agent"` - - `"agent"` - - `version: number` + format: int32 + - `created_at: string` A timestamp in RFC 3339 format + format: date-time + - `deployment_id: string` ID of the deployment that produced this run.
from line 4389
Why the run failed to create a session. The type identifies the failure; message is human-readable detail. - - `BetaManagedAgentsEnvironmentArchivedRunError object { message, type }` + - `BetaManagedAgentsEnvironmentArchivedRunError object` The deployment's environment was archived.
from line 4399
- `type: "environment_archived_error"` - - `"environment_archived_error"` - - - `BetaManagedAgentsAgentArchivedRunError object { message, type }` + - `BetaManagedAgentsAgentArchivedRunError object` The deployment's agent was archived.
from line 4409
- `type: "agent_archived_error"` - - `"agent_archived_error"` - - - `BetaManagedAgentsEnvironmentNotFoundRunError object { message, type }` + - `BetaManagedAgentsEnvironmentNotFoundRunError object` The deployment's environment no longer exists.
from line 4419
- `type: "environment_not_found_error"` - - `"environment_not_found_error"` - - - `BetaManagedAgentsVaultNotFoundRunError object { message, type }` + - `BetaManagedAgentsVaultNotFoundRunError object` A vault referenced by the deployment no longer exists.
from line 4429
- `type: "vault_not_found_error"` - - `"vault_not_found_error"` - - - `BetaManagedAgentsVaultArchivedRunError object { message, type }` + - `BetaManagedAgentsVaultArchivedRunError object` A vault referenced by the deployment is archived.
from line 4439
- `type: "vault_archived_error"` - - `"vault_archived_error"` - - - `BetaManagedAgentsFileNotFoundRunError object { message, type }` + - `BetaManagedAgentsFileNotFoundRunError object` A file resource referenced by the deployment no longer exists.
from line 4449
- `type: "file_not_found_error"` - - `"file_not_found_error"` - - - `BetaManagedAgentsMemoryStoreArchivedRunError object { message, type }` + - `BetaManagedAgentsMemoryStoreArchivedRunError object` A memory store referenced by the deployment is archived.
from line 4459
- `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` - - - `BetaManagedAgentsSkillNotFoundRunError object { message, type }` + - `BetaManagedAgentsSkillNotFoundRunError object` A skill referenced by the deployment's agent no longer exists.
from line 4469
- `type: "skill_not_found_error"` - - `"skill_not_found_error"` - - - `BetaManagedAgentsSessionResourceNotFoundRunError object { message, type }` + - `BetaManagedAgentsSessionResourceNotFoundRunError object` A referenced resource no longer exists and its kind was not reported.
from line 4479
- `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` - - - `BetaManagedAgentsWorkspaceArchivedRunError object { message, type }` + - `BetaManagedAgentsWorkspaceArchivedRunError object` The deployment's workspace was archived.
from line 4489
- `type: "workspace_archived_error"` - - `"workspace_archived_error"` - - - `BetaManagedAgentsOrganizationDisabledRunError object { message, type }` + - `BetaManagedAgentsOrganizationDisabledRunError object` The deployment's organization is disabled.
from line 4499
- `type: "organization_disabled_error"` - - `"organization_disabled_error"` - - - `BetaManagedAgentsSessionRateLimitedRunError object { message, type }` + - `BetaManagedAgentsSessionRateLimitedRunError object` Session creation was rejected due to rate limiting. The schedule keeps firing; subsequent runs may succeed.
from line 4509
- `type: "session_rate_limited_error"` - - `"session_rate_limited_error"` - - - `BetaManagedAgentsSessionCreationRejectedRunError object { message, type }` + - `BetaManagedAgentsSessionCreationRejectedRunError object` The session create request was rejected with a non-retryable validation error.
from line 4519
- `type: "session_creation_rejected_error"` - - `"session_creation_rejected_error"` - - - `BetaManagedAgentsUnknownRunError object { message, type }` + - `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.
from line 4529
- `type: "unknown_error"` - - `"unknown_error"` - - - `BetaManagedAgentsSelfHostedResourcesUnsupportedRunError object { message, type }` + - `BetaManagedAgentsSelfHostedResourcesUnsupportedRunError object` The deployment configures resources, but its environment is self-hosted and cannot mount them.
from line 4539
- `type: "self_hosted_resources_unsupported_error"` - - `"self_hosted_resources_unsupported_error"` - - - `BetaManagedAgentsMCPEgressBlockedRunError object { message, type }` + - `BetaManagedAgentsMCPEgressBlockedRunError object` An MCP server host used by the deployment's agent is blocked by the environment's network policy.
from line 4549
- `type: "mcp_egress_blocked_error"` - - `"mcp_egress_blocked_error"` - - `session_id: string or null` Populated on success. Null on creation failure. Exactly one of session_id or error is non-null.
from line 4557
Describes what triggered a deployment run, with trigger-specific metadata. - - `BetaManagedAgentsScheduleTriggerContext object { scheduled_at, type }` + - `BetaManagedAgentsScheduleTriggerContext object` The run was fired by the deployment's cron schedule.
from line 4565
A timestamp in RFC 3339 format + format: date-time + - `type: "schedule"` - - `"schedule"` - - - `BetaManagedAgentsManualTriggerContext object { type }` + - `BetaManagedAgentsManualTriggerContext object` The run was started manually by creating a session directly against the deployment. - `type: "manual"` - - `"manual"` - - `type: "deployment_run"` - - `"deployment_run"` - ### Example -```http +```bash curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/run \ -X POST \ -H 'anthropic-version: 2023-06-01' \
from line 4587
-H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +#### Response (200) ```json {
from line 4614
## Pause Deployment -**post** `/v1/deployments/{deployment_id}/pause` +**POST** `/v1/deployments/{deployment_id}/pause` Pause Deployment -### Path Parameters +### Path parameters - `deployment_id: string` -### Header Parameters +### Headers - `"anthropic-beta": optional array of AnthropicBeta`
from line 4702
### Returns -- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }` +- `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, and an optional schedule.
from line 4718
- `type: "agent"` - - `"agent"` - - `version: number` + format: int32 + - `archived_at: string or null` A timestamp in RFC 3339 format + format: date-time + - `created_at: string` A timestamp in RFC 3339 format + format: date-time + - `description: string or null` Description of what the deployment does.
from line 4746
Events sent to each session immediately after creation. - - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }` + - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session.
from line 4754
Array of content blocks for the user message. - - `BetaManagedAgentsTextBlock object { text, type }` + - `BetaManagedAgentsTextBlock object` Regular text content.
from line 4762
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - - `BetaManagedAgentsImageBlock object { source, type }` + - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL.
from line 4774
Union type for image source variants. - - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }` + - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data.
from line 4782
Base64-encoded image data. + minLength: 1 + - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsURLImageSource object { type, url }` + - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the image to fetch. - - `BetaManagedAgentsFileImageSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileImageSource object` Image referenced by file ID.
from line 4812
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` - - - `BetaManagedAgentsDocumentBlock object { source, type, context, title }` + - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL.
from line 4826
Union type for document source variants. - - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }` + - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data.
from line 4834
Base64-encoded document data. + minLength: 1 + - `media_type: string` MIME type of the document (e.g., "application/pdf"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }` + - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content.
from line 4852
The plain text content. + minLength: 1 + - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - - `"text/plain"` - - `type: "text"` - - `"text"` - - - `BetaManagedAgentsURLDocumentSource object { type, url }` + - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the document to fetch. - - `BetaManagedAgentsFileDocumentSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID.
from line 4880
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `context: optional string or null` Additional context about the document for the model.
from line 4894
The title of the document. - - `BetaManagedAgentsRedactedBlock object { type }` + - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - - `"redacted"` - - `type: "user.message"` - - `"user.message"` - - - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }` + - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt.
from line 4914
Rubric for grading the quality of an outcome. - - `BetaManagedAgentsFileRubric object { file_id, type }` + - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API.
from line 4924
- `type: "file"` - - `"file"` - - - `BetaManagedAgentsTextRubric object { content, type }` + - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text.
from line 4934
- `type: "text"` - - `"text"` - - `type: "user.define_outcome"` - - `"user.define_outcome"` - - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. - - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }` + format: int32 + + - `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 the top-level system prompt.
from line 4954
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - `type: "system.message"` - - `"system.message"` - - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs.
from line 4972
Why a deployment is paused. Non-null exactly when `status` is `paused`. - - `BetaManagedAgentsManualDeploymentPausedReason object { type }` + - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - - `"manual"` - - - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }` + - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment.
from line 4986
The error that triggered an auto-pause. Matches the failed run's `error.type`. - - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - - `"environment_archived_error"` - - - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - - `"agent_archived_error"` - - - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - - `"environment_not_found_error"` - - - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - - `"vault_not_found_error"` - - - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - - `"file_not_found_error"` - - - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` - - - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - - `"workspace_archived_error"` - - - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - - `"organization_disabled_error"` - - - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` - - - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - - `"skill_not_found_error"` - - - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - - `"vault_archived_error"` - - - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` 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 of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }` + - `BetaManagedAgentsGitHubRepositoryResourceConfig object` 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
from line 5090
Branch or commit to check out. Defaults to the repository's default branch. - - `BetaManagedAgentsBranchCheckout object { name, type }` + - `BetaManagedAgentsBranchCheckout object` - `name: string` Branch name to check out. + minLength: 1, maxLength: 255 + - `type: "branch"` - - `"branch"` - - - `BetaManagedAgentsCommitCheckout object { sha, type }` + - `BetaManagedAgentsCommitCheckout object` - `sha: string` Full commit SHA to check out. + minLength: 7, maxLength: 64 + - `type: "commit"` - - `"commit"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/<repo-name>`. - - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }` + - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container.
from line 5124
- `type: "file"` - - `"file"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. - - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }` + - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment.
from line 5138
- `type: "memory_store"` - - `"memory_store"` - - `access: optional "read_write" or "read_only" or null` Access mode for an attached memory store.
from line 5158
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). + minLength: 1, maxLength: 256 + - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). + minLength: 1 + - `type: "cron"` - - `"cron"` - - `last_run_at: optional string or null` A timestamp in RFC 3339 format + format: date-time + - `upcoming_runs_at: optional array of string` 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.
from line 5188
- `type: "deployment"` - - `"deployment"` - - `updated_at: string` A timestamp in RFC 3339 format + format: date-time + - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment.
from line 5214
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. - - `"USD"` - - `type: "limit"` - - `"limit"` - ### Example -```http +```bash curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/pause \ -X POST \ -H 'anthropic-version: 2023-06-01' \
from line 5226
-H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +#### Response (200) ```json {
from line 5295
## Unpause Deployment -**post** `/v1/deployments/{deployment_id}/unpause` +**POST** `/v1/deployments/{deployment_id}/unpause` Unpause Deployment -### Path Parameters +### Path parameters - `deployment_id: string` -### Header Parameters +### Headers - `"anthropic-beta": optional array of AnthropicBeta`
from line 5383
### Returns -- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }` +- `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, and an optional schedule.
from line 5399
- `type: "agent"` - - `"agent"` - - `version: number` + format: int32 + - `archived_at: string or null` A timestamp in RFC 3339 format + format: date-time + - `created_at: string` A timestamp in RFC 3339 format + format: date-time + - `description: string or null` Description of what the deployment does.
from line 5427
Events sent to each session immediately after creation. - - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }` + - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session.
from line 5435
Array of content blocks for the user message. - - `BetaManagedAgentsTextBlock object { text, type }` + - `BetaManagedAgentsTextBlock object` Regular text content.
from line 5443
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - - `BetaManagedAgentsImageBlock object { source, type }` + - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL.
from line 5455
Union type for image source variants. - - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }` + - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data.
from line 5463
Base64-encoded image data. + minLength: 1 + - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsURLImageSource object { type, url }` + - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the image to fetch. - - `BetaManagedAgentsFileImageSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileImageSource object` Image referenced by file ID.
from line 5493
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` - - - `BetaManagedAgentsDocumentBlock object { source, type, context, title }` + - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL.
from line 5507
Union type for document source variants. - - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }` + - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data.
from line 5515
Base64-encoded document data. + minLength: 1 + - `media_type: string` MIME type of the document (e.g., "application/pdf"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }` + - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content.
from line 5533
The plain text content. + minLength: 1 + - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - - `"text/plain"` - - `type: "text"` - - `"text"` - - - `BetaManagedAgentsURLDocumentSource object { type, url }` + - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the document to fetch. - - `BetaManagedAgentsFileDocumentSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID.
from line 5561
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `context: optional string or null` Additional context about the document for the model.
from line 5575
The title of the document. - - `BetaManagedAgentsRedactedBlock object { type }` + - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - - `"redacted"` - - `type: "user.message"` - - `"user.message"` - - - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }` + - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt.
from line 5595
Rubric for grading the quality of an outcome. - - `BetaManagedAgentsFileRubric object { file_id, type }` + - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API.
from line 5605
- `type: "file"` - - `"file"` - - - `BetaManagedAgentsTextRubric object { content, type }` + - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text.
from line 5615
- `type: "text"` - - `"text"` - - `type: "user.define_outcome"` - - `"user.define_outcome"` - - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. - - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }` + format: int32 + + - `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 the top-level system prompt.
from line 5635
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - `type: "system.message"` - - `"system.message"` - - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs.
from line 5653
Why a deployment is paused. Non-null exactly when `status` is `paused`. - - `BetaManagedAgentsManualDeploymentPausedReason object { type }` + - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - - `"manual"` - - - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }` + - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment.
from line 5667
The error that triggered an auto-pause. Matches the failed run's `error.type`. - - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - - `"environment_archived_error"` - - - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - - `"agent_archived_error"` - - - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - - `"environment_not_found_error"` - - - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - - `"vault_not_found_error"` - - - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - - `"file_not_found_error"` - - - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` - - - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - - `"workspace_archived_error"` - - - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - - `"organization_disabled_error"` - - - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` - - - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - - `"skill_not_found_error"` - - - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - - `"vault_archived_error"` - - - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` 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 of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }` + - `BetaManagedAgentsGitHubRepositoryResourceConfig object` 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
from line 5771
Branch or commit to check out. Defaults to the repository's default branch. - - `BetaManagedAgentsBranchCheckout object { name, type }` + - `BetaManagedAgentsBranchCheckout object` - `name: string` Branch name to check out. + minLength: 1, maxLength: 255 + - `type: "branch"` - - `"branch"` - - - `BetaManagedAgentsCommitCheckout object { sha, type }` + - `BetaManagedAgentsCommitCheckout object` - `sha: string` Full commit SHA to check out. + minLength: 7, maxLength: 64 + - `type: "commit"` - - `"commit"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/<repo-name>`. - - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }` + - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container.
from line 5805
- `type: "file"` - - `"file"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. - - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }` + - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment.
from line 5819
- `type: "memory_store"` - - `"memory_store"` - - `access: optional "read_write" or "read_only" or null` Access mode for an attached memory store.
from line 5839
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). + minLength: 1, maxLength: 256 + - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). + minLength: 1 + - `type: "cron"` - - `"cron"` - - `last_run_at: optional string or null` A timestamp in RFC 3339 format + format: date-time + - `upcoming_runs_at: optional array of string` 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.
from line 5869
- `type: "deployment"` - - `"deployment"` - - `updated_at: string` A timestamp in RFC 3339 format + format: date-time + - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment.
from line 5895
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. - - `"USD"` - - `type: "limit"` - - `"limit"` - ### Example -```http +```bash curl https://api.anthropic.com/v1/deployments/$DEPLOYMENT_ID/unpause \ -X POST \ -H 'anthropic-version: 2023-06-01' \
from line 5907
-H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +#### Response (200) ```json {
from line 5974
} ``` -## Domain Types +## Domain types ### Beta Managed Agents Agent Archived Deployment Paused Reason Error -- `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }` +- `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - - `"agent_archived_error"` - ### Beta Managed Agents Cron Schedule -- `BetaManagedAgentsCronSchedule object { expression, timezone, type, 2 more }` +- `BetaManagedAgentsCronSchedule object` 5-field POSIX cron schedule with computed runtime timestamps.
from line 5994
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). + minLength: 1, maxLength: 256 + - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). + minLength: 1 + - `type: "cron"` - - `"cron"` - - `last_run_at: optional string or null` A timestamp in RFC 3339 format + format: date-time + - `upcoming_runs_at: optional array of string` 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. ### Beta Managed Agents Cron Schedule Params -- `BetaManagedAgentsCronScheduleParams object { expression, timezone, type }` +- `BetaManagedAgentsCronScheduleParams object` 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
from line 6024
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). + minLength: 1, maxLength: 256 + - `timezone: string` Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database. + minLength: 1 + - `type: "cron"` - - `"cron"` - ### Beta Managed Agents Deployment -- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }` +- `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, and an optional schedule.
from line 6052
- `type: "agent"` - - `"agent"` - - `version: number` + format: int32 + - `archived_at: string or null` A timestamp in RFC 3339 format + format: date-time + - `created_at: string` A timestamp in RFC 3339 format + format: date-time + - `description: string or null` Description of what the deployment does.
from line 6080
Events sent to each session immediately after creation. - - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }` + - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session.
from line 6088
Array of content blocks for the user message. - - `BetaManagedAgentsTextBlock object { text, type }` + - `BetaManagedAgentsTextBlock object` Regular text content.
from line 6096
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - - `BetaManagedAgentsImageBlock object { source, type }` + - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL.
from line 6108
Union type for image source variants. - - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }` + - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data.
from line 6116
Base64-encoded image data. + minLength: 1 + - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsURLImageSource object { type, url }` + - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the image to fetch. - - `BetaManagedAgentsFileImageSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileImageSource object` Image referenced by file ID.
from line 6146
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` - - - `BetaManagedAgentsDocumentBlock object { source, type, context, title }` + - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL.
from line 6160
Union type for document source variants. - - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }` + - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data.
from line 6168
Base64-encoded document data. + minLength: 1 + - `media_type: string` MIME type of the document (e.g., "application/pdf"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }` + - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content.
from line 6186
The plain text content. + minLength: 1 + - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - - `"text/plain"` - - `type: "text"` - - `"text"` - - - `BetaManagedAgentsURLDocumentSource object { type, url }` + - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the document to fetch. - - `BetaManagedAgentsFileDocumentSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID.
from line 6214
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `context: optional string or null` Additional context about the document for the model.
from line 6228
The title of the document. - - `BetaManagedAgentsRedactedBlock object { type }` + - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - - `"redacted"` - - `type: "user.message"` - - `"user.message"` - - - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }` + - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt.
from line 6248
Rubric for grading the quality of an outcome. - - `BetaManagedAgentsFileRubric object { file_id, type }` + - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API.
from line 6258
- `type: "file"` - - `"file"` - - - `BetaManagedAgentsTextRubric object { content, type }` + - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text.
from line 6268
- `type: "text"` - - `"text"` - - `type: "user.define_outcome"` - - `"user.define_outcome"` - - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. - - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }` + format: int32 + + - `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 the top-level system prompt.
from line 6288
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - `type: "system.message"` - - `"system.message"` - - `metadata: map[string]` Arbitrary key-value metadata. Maximum 16 pairs.
from line 6306
Why a deployment is paused. Non-null exactly when `status` is `paused`. - - `BetaManagedAgentsManualDeploymentPausedReason object { type }` + - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - - `"manual"` - - - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }` + - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment.
from line 6320
The error that triggered an auto-pause. Matches the failed run's `error.type`. - - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - - `"environment_archived_error"` - - - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - - `"agent_archived_error"` - - - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - - `"environment_not_found_error"` - - - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - - `"vault_not_found_error"` - - - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - - `"file_not_found_error"` - - - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` - - - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - - `"workspace_archived_error"` - - - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - - `"organization_disabled_error"` - - - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` - - - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - - `"skill_not_found_error"` - - - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - - `"vault_archived_error"` - - - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` 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 of BetaManagedAgentsSessionResourceConfig` Resources attached to sessions created from this deployment. Echoes the input minus write-only credentials. - - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }` + - `BetaManagedAgentsGitHubRepositoryResourceConfig object` 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
from line 6424
Branch or commit to check out. Defaults to the repository's default branch. - - `BetaManagedAgentsBranchCheckout object { name, type }` + - `BetaManagedAgentsBranchCheckout object` - `name: string` Branch name to check out. + minLength: 1, maxLength: 255 + - `type: "branch"` - - `"branch"` - - - `BetaManagedAgentsCommitCheckout object { sha, type }` + - `BetaManagedAgentsCommitCheckout object` - `sha: string` Full commit SHA to check out. + minLength: 7, maxLength: 64 + - `type: "commit"` - - `"commit"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/<repo-name>`. - - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }` + - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container.
from line 6458
- `type: "file"` - - `"file"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. - - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }` + - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment.
from line 6472
- `type: "memory_store"` - - `"memory_store"` - - `access: optional "read_write" or "read_only" or null` Access mode for an attached memory store.
from line 6492
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). + minLength: 1, maxLength: 256 + - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). + minLength: 1 + - `type: "cron"` - - `"cron"` - - `last_run_at: optional string or null` A timestamp in RFC 3339 format + format: date-time + - `upcoming_runs_at: optional array of string` 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.
from line 6522
- `type: "deployment"` - - `"deployment"` - - `updated_at: string` A timestamp in RFC 3339 format + format: date-time + - `vault_ids: array of string` Vault IDs supplying stored credentials for sessions created from this deployment.
from line 6548
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. - - `"USD"` - - `type: "limit"` - - `"limit"` - ### Beta Managed Agents Deployment Initial Event - `BetaManagedAgentsDeploymentInitialEvent = BetaManagedAgentsDeploymentUserMessageEvent or BetaManagedAgentsDeploymentUserDefineOutcomeEvent or BetaManagedAgentsDeploymentSystemMessageEvent` An event sent to a session immediately after it is created. Supports `user.message`, `user.define_outcome`, and `system.message`. - - `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }` + - `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session.
from line 6564
Array of content blocks for the user message. - - `BetaManagedAgentsTextBlock object { text, type }` + - `BetaManagedAgentsTextBlock object` Regular text content.
from line 6572
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - - `BetaManagedAgentsImageBlock object { source, type }` + - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL.
from line 6584
Union type for image source variants. - - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }` + - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data.
from line 6592
Base64-encoded image data. + minLength: 1 + - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsURLImageSource object { type, url }` + - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the image to fetch. - - `BetaManagedAgentsFileImageSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileImageSource object` Image referenced by file ID.
from line 6622
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` - - - `BetaManagedAgentsDocumentBlock object { source, type, context, title }` + - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL.
from line 6636
Union type for document source variants. - - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }` + - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data.
from line 6644
Base64-encoded document data. + minLength: 1 + - `media_type: string` MIME type of the document (e.g., "application/pdf"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }` + - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content.
from line 6662
The plain text content. + minLength: 1 + - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - - `"text/plain"` - - `type: "text"` - - `"text"` - - - `BetaManagedAgentsURLDocumentSource object { type, url }` + - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the document to fetch. - - `BetaManagedAgentsFileDocumentSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID.
from line 6690
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `context: optional string or null` Additional context about the document for the model.
from line 6704
The title of the document. - - `BetaManagedAgentsRedactedBlock object { type }` + - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - - `"redacted"` - - `type: "user.message"` - - `"user.message"` - - - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }` + - `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt.
from line 6724
Rubric for grading the quality of an outcome. - - `BetaManagedAgentsFileRubric object { file_id, type }` + - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API.
from line 6734
- `type: "file"` - - `"file"` - - - `BetaManagedAgentsTextRubric object { content, type }` + - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text.
from line 6744
- `type: "text"` - - `"text"` - - `type: "user.define_outcome"` - - `"user.define_outcome"` - - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. - - `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }` + format: int32 + + - `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 the top-level system prompt.
from line 6764
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - `type: "system.message"` - - `"system.message"` - ### Beta Managed Agents Deployment Initial Event Params - `BetaManagedAgentsDeploymentInitialEventParams = BetaManagedAgentsUserMessageEventParams or BetaManagedAgentsUserDefineOutcomeEventParams or BetaManagedAgentsSystemMessageEventParams` An event sent to a session immediately after it is created. Supports `user.message`, `user.define_outcome`, and `system.message`. - - `BetaManagedAgentsUserMessageEventParams object { content, type }` + - `BetaManagedAgentsUserMessageEventParams object` Parameters for sending a user message to the session.
from line 6784
Array of content blocks for the user message. - - `BetaManagedAgentsTextBlock object { text, type }` + - `BetaManagedAgentsTextBlock object` Regular text content.
from line 6792
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - - `BetaManagedAgentsImageBlock object { source, type }` + - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL.
from line 6804
Union type for image source variants. - - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }` + - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data.
from line 6812
Base64-encoded image data. + minLength: 1 + - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsURLImageSource object { type, url }` + - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the image to fetch. - - `BetaManagedAgentsFileImageSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileImageSource object` Image referenced by file ID.
from line 6842
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` - - - `BetaManagedAgentsDocumentBlock object { source, type, context, title }` + - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL.
from line 6856
Union type for document source variants. - - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }` + - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data.
from line 6864
Base64-encoded document data. + minLength: 1 + - `media_type: string` MIME type of the document (e.g., "application/pdf"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }` + - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content.
from line 6882
The plain text content. + minLength: 1 + - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - - `"text/plain"` - - `type: "text"` - - `"text"` - - - `BetaManagedAgentsURLDocumentSource object { type, url }` + - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the document to fetch. - - `BetaManagedAgentsFileDocumentSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID.
from line 6910
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `context: optional string or null` Additional context about the document for the model.
from line 6924
The title of the document. - - `BetaManagedAgentsRedactedBlock object { type }` + - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - - `"redacted"` - - `type: "user.message"` - - `"user.message"` - - - `BetaManagedAgentsUserDefineOutcomeEventParams object { description, rubric, type, max_iterations }` + - `BetaManagedAgentsUserDefineOutcomeEventParams object` Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.
from line 6944
Rubric for grading the quality of an outcome. - - `BetaManagedAgentsFileRubricParams object { file_id, type }` + - `BetaManagedAgentsFileRubricParams object` Rubric referenced by a file uploaded via the Files API.
from line 6954
- `type: "file"` - - `"file"` - - - `BetaManagedAgentsTextRubricParams object { content, type }` + - `BetaManagedAgentsTextRubricParams object` Rubric content provided inline as text.
from line 6962
Rubric content. Plain text or markdown — the grader treats it as freeform text. Maximum 262144 characters. + maxLength: 262144 + - `type: "text"` - - `"text"` - - `type: "user.define_outcome"` - - `"user.define_outcome"` - - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. - - `BetaManagedAgentsSystemMessageEventParams object { content, type }` + format: int32 + + - `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 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.
from line 6986
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - `type: "system.message"` - - `"system.message"` - ### Beta Managed Agents Deployment Paused Reason - `BetaManagedAgentsDeploymentPausedReason = BetaManagedAgentsManualDeploymentPausedReason or BetaManagedAgentsErrorDeploymentPausedReason` Why a deployment is paused. Non-null exactly when `status` is `paused`. - - `BetaManagedAgentsManualDeploymentPausedReason object { type }` + - `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - - `"manual"` - - - `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }` + - `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment.
from line 7012
The error that triggered an auto-pause. Matches the failed run's `error.type`. - - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - - `"environment_archived_error"` - - - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - - `"agent_archived_error"` - - - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - - `"environment_not_found_error"` - - - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - - `"vault_not_found_error"` - - - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - - `"file_not_found_error"` - - - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` - - - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - - `"workspace_archived_error"` - - - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - - `"organization_disabled_error"` - - - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` - - - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - - `"skill_not_found_error"` - - - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - - `"vault_archived_error"` - - - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` 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"` - ### Beta Managed Agents Deployment Paused Reason Error - `BetaManagedAgentsDeploymentPausedReasonError = BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError or BetaManagedAgentsAgentArchivedDeploymentPausedReasonError or BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError or 11 more` The error that triggered an auto-pause. Matches the failed run's `error.type`. - - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - - `"environment_archived_error"` - - - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - - `"agent_archived_error"` - - - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - - `"environment_not_found_error"` - - - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - - `"vault_not_found_error"` - - - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - - `"file_not_found_error"` - - - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` - - - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - - `"workspace_archived_error"` - - - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - - `"organization_disabled_error"` - - - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` - - - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - - `"skill_not_found_error"` - - - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - - `"vault_archived_error"` - - - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` 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"` - ### Beta Managed Agents Deployment Status - `BetaManagedAgentsDeploymentStatus = "active" or "paused"`
from line 7200
### Beta Managed Agents Deployment System Message Event -- `BetaManagedAgentsDeploymentSystemMessageEvent object { content, type }` +- `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 the top-level system prompt.
from line 7212
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - `type: "system.message"` - - `"system.message"` - ### Beta Managed Agents Deployment User Define Outcome Event -- `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }` +- `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object` An outcome the agent should work toward. The agent begins work on receipt.
from line 7232
Rubric for grading the quality of an outcome. - - `BetaManagedAgentsFileRubric object { file_id, type }` + - `BetaManagedAgentsFileRubric object` Rubric referenced by a file uploaded via the Files API.
from line 7242
- `type: "file"` - - `"file"` - - - `BetaManagedAgentsTextRubric object { content, type }` + - `BetaManagedAgentsTextRubric object` Rubric content provided inline as text.
from line 7252
- `type: "text"` - - `"text"` - - `type: "user.define_outcome"` - - `"user.define_outcome"` - - `max_iterations: optional number or null` Eval→revision cycles before giving up. Default 3, max 20. + format: int32 + ### Beta Managed Agents Deployment User Message Event -- `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }` +- `BetaManagedAgentsDeploymentUserMessageEvent object` A user message sent to the session.
from line 7270
Array of content blocks for the user message. - - `BetaManagedAgentsTextBlock object { text, type }` + - `BetaManagedAgentsTextBlock object` Regular text content.
from line 7278
The text content. + minLength: 1 + - `type: "text"` - - `"text"` - - - `BetaManagedAgentsImageBlock object { source, type }` + - `BetaManagedAgentsImageBlock object` Image content specified directly as base64 data or as a reference via a URL.
from line 7290
Union type for image source variants. - - `BetaManagedAgentsBase64ImageSource object { data, media_type, type }` + - `BetaManagedAgentsBase64ImageSource object` Base64-encoded image data.
from line 7298
Base64-encoded image data. + minLength: 1 + - `media_type: string` MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsURLImageSource object { type, url }` + - `BetaManagedAgentsURLImageSource object` Image referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the image to fetch. - - `BetaManagedAgentsFileImageSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileImageSource object` Image referenced by file ID.
from line 7328
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` - - - `BetaManagedAgentsDocumentBlock object { source, type, context, title }` + - `BetaManagedAgentsDocumentBlock object` Document content, either specified directly as base64 data, as text, or as a reference via a URL.
from line 7342
Union type for document source variants. - - `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }` + - `BetaManagedAgentsBase64DocumentSource object` Base64-encoded document data.
from line 7350
Base64-encoded document data. + minLength: 1 + - `media_type: string` MIME type of the document (e.g., "application/pdf"). + minLength: 1 + - `type: "base64"` - - `"base64"` - - - `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }` + - `BetaManagedAgentsPlainTextDocumentSource object` Plain text document content.
from line 7368
The plain text content. + minLength: 1 + - `media_type: "text/plain"` MIME type of the text content. Must be "text/plain". - - `"text/plain"` - - `type: "text"` - - `"text"` - - - `BetaManagedAgentsURLDocumentSource object { type, url }` + - `BetaManagedAgentsURLDocumentSource object` Document referenced by URL. - `type: "url"` - - `"url"` - - `url: string` URL of the document to fetch. - - `BetaManagedAgentsFileDocumentSource object { file_id, type }` + minLength: 1 + + - `BetaManagedAgentsFileDocumentSource object` Document referenced by file ID.
from line 7396
ID of a previously uploaded file. + minLength: 1 + - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `context: optional string or null` Additional context about the document for the model.
from line 7410
The title of the document. - - `BetaManagedAgentsRedactedBlock object { type }` + - `BetaManagedAgentsRedactedBlock object` Placeholder for content withheld by Anthropic model policy. - `type: "redacted"` - - `"redacted"` - - `type: "user.message"` - - `"user.message"` - ### Beta Managed Agents Environment Archived Deployment Paused Reason Error -- `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }` +- `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - - `"environment_archived_error"` - ### Beta Managed Agents Environment Not Found Deployment Paused Reason Error -- `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }` +- `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - - `"environment_not_found_error"` - ### Beta Managed Agents Error Deployment Paused Reason -- `BetaManagedAgentsErrorDeploymentPausedReason object { error, type }` +- `BetaManagedAgentsErrorDeploymentPausedReason object` A scheduled fire recorded a failed run whose error auto-pauses the deployment.
from line 7444
The error that triggered an auto-pause. Matches the failed run's `error.type`. - - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentArchivedDeploymentPausedReasonError object` The deployment's environment was archived. - `type: "environment_archived_error"` - - `"environment_archived_error"` - - - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsAgentArchivedDeploymentPausedReasonError object` The deployment's agent was archived. - `type: "agent_archived_error"` - - `"agent_archived_error"` - - - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsEnvironmentNotFoundDeploymentPausedReasonError object` The deployment's environment no longer exists. - `type: "environment_not_found_error"` - - `"environment_not_found_error"` - - - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - - `"vault_not_found_error"` - - - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - - `"file_not_found_error"` - - - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` - - - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - - `"workspace_archived_error"` - - - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - - `"organization_disabled_error"` - - - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` - - - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - - `"skill_not_found_error"` - - - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - - `"vault_archived_error"` - - - `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }` + - `BetaManagedAgentsUnknownDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` 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 object { type }` + - `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` 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"` - ### Beta Managed Agents File Not Found Deployment Paused Reason Error -- `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object { type }` +- `BetaManagedAgentsFileNotFoundDeploymentPausedReasonError object` A file resource referenced by the deployment no longer exists. - `type: "file_not_found_error"` - - `"file_not_found_error"` - ### Beta Managed Agents File Resource Config -- `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }` +- `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container.
from line 7550
- `type: "file"` - - `"file"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. ### Beta Managed Agents GitHub Repository Resource Config -- `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }` +- `BetaManagedAgentsGitHubRepositoryResourceConfig object` 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
from line 7570
Branch or commit to check out. Defaults to the repository's default branch. - - `BetaManagedAgentsBranchCheckout object { name, type }` + - `BetaManagedAgentsBranchCheckout object` - `name: string` Branch name to check out. + minLength: 1, maxLength: 255 + - `type: "branch"` - - `"branch"` - - - `BetaManagedAgentsCommitCheckout object { sha, type }` + - `BetaManagedAgentsCommitCheckout object` - `sha: string` Full commit SHA to check out. + minLength: 7, maxLength: 64 + - `type: "commit"` - - `"commit"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/<repo-name>`. ### Beta Managed Agents Manual Deployment Paused Reason -- `BetaManagedAgentsManualDeploymentPausedReason object { type }` +- `BetaManagedAgentsManualDeploymentPausedReason object` The caller invoked the pause endpoint on the deployment. - `type: "manual"` - - `"manual"` - ### Beta Managed Agents MCP Egress Blocked Deployment Paused Reason Error -- `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object { type }` +- `BetaManagedAgentsMCPEgressBlockedDeploymentPausedReasonError object` 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"` - ### Beta Managed Agents Memory Store Archived Deployment Paused Reason Error -- `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object { type }` +- `BetaManagedAgentsMemoryStoreArchivedDeploymentPausedReasonError object` A memory store referenced by the deployment is archived. - `type: "memory_store_archived_error"` - - `"memory_store_archived_error"` - ### Beta Managed Agents Memory Store Resource Config -- `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }` +- `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment.
from line 7630
- `type: "memory_store"` - - `"memory_store"` - - `access: optional "read_write" or "read_only" or null` Access mode for an attached memory store.
from line 7644
### Beta Managed Agents Organization Disabled Deployment Paused Reason Error -- `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object { type }` +- `BetaManagedAgentsOrganizationDisabledDeploymentPausedReasonError object` The deployment's organization is disabled. - `type: "organization_disabled_error"` - - `"organization_disabled_error"` - ### Beta Managed Agents Schedule -- `BetaManagedAgentsSchedule object { expression, timezone, type, 2 more }` +- `BetaManagedAgentsSchedule object` 5-field POSIX cron schedule with computed runtime timestamps.
from line 7660
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). + minLength: 1, maxLength: 256 + - `timezone: string` IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). + minLength: 1 + - `type: "cron"` - - `"cron"` - - `last_run_at: optional string or null` A timestamp in RFC 3339 format + format: date-time + - `upcoming_runs_at: optional array of string` 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. ### Beta Managed Agents Schedule Params -- `BetaManagedAgentsScheduleParams object { expression, timezone, type }` +- `BetaManagedAgentsScheduleParams object` 5-field POSIX cron schedule. Literal wall-clock matching in the configured timezone.
from line 7690
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). + minLength: 1, maxLength: 256 + - `timezone: string` Required. IANA timezone identifier (e.g., "America/Los_Angeles", "UTC"). Validated against the IANA timezone database. + minLength: 1 + - `type: "cron"` - - `"cron"` - ### Beta Managed Agents Self Hosted Resources Unsupported Deployment Paused Reason Error -- `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object { type }` +- `BetaManagedAgentsSelfHostedResourcesUnsupportedDeploymentPausedReasonError object` 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"` - ### Beta Managed Agents Session Resource Config - `BetaManagedAgentsSessionResourceConfig = BetaManagedAgentsGitHubRepositoryResourceConfig or BetaManagedAgentsFileResourceConfig or BetaManagedAgentsMemoryStoreResourceConfig` A configured session resource. Echoes the input minus write-only credentials. - - `BetaManagedAgentsGitHubRepositoryResourceConfig object { type, url, checkout, mount_path }` + - `BetaManagedAgentsGitHubRepositoryResourceConfig object` 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
from line 7728
Branch or commit to check out. Defaults to the repository's default branch. - - `BetaManagedAgentsBranchCheckout object { name, type }` + - `BetaManagedAgentsBranchCheckout object` - `name: string` Branch name to check out. + minLength: 1, maxLength: 255 + - `type: "branch"` - - `"branch"` - - - `BetaManagedAgentsCommitCheckout object { sha, type }` + - `BetaManagedAgentsCommitCheckout object` - `sha: string` Full commit SHA to check out. + minLength: 7, maxLength: 64 + - `type: "commit"` - - `"commit"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/workspace/<repo-name>`. - - `BetaManagedAgentsFileResourceConfig object { file_id, type, mount_path }` + - `BetaManagedAgentsFileResourceConfig object` A file mounted into each session's container.
from line 7762
- `type: "file"` - - `"file"` - - `mount_path: optional string or null` Mount path in the container. Defaults to `/mnt/session/uploads/<file_id>`. - - `BetaManagedAgentsMemoryStoreResourceConfig object { memory_store_id, type, access, instructions }` + - `BetaManagedAgentsMemoryStoreResourceConfig object` A memory store attached to each session created from this deployment.
from line 7776
- `type: "memory_store"` - - `"memory_store"` - - `access: optional "read_write" or "read_only" or null` Access mode for an attached memory store.
from line 7790
### Beta Managed Agents Session Resource Not Found Deployment Paused Reason Error -- `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object { type }` +- `BetaManagedAgentsSessionResourceNotFoundDeploymentPausedReasonError object` A referenced resource no longer exists and its kind was not reported. - `type: "session_resource_not_found_error"` - - `"session_resource_not_found_error"` - ### Beta Managed Agents Skill Not Found Deployment Paused Reason Error -- `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object { type }` +- `BetaManagedAgentsSkillNotFoundDeploymentPausedReasonError object` A skill referenced by the deployment's agent no longer exists. - `type: "skill_not_found_error"` - - `"skill_not_found_error"` - ### Beta Managed Agents Unknown Deployment Paused Reason Error -- `BetaManagedAgentsUnknownDeploymentPausedReasonError object { type }` +- `BetaManagedAgentsUnknownDeploymentPausedReasonError object` An unrecognized error auto-paused the deployment. A fallback variant; matches a run whose `error.type` is `unknown_error`. - `type: "unknown_error"` - - `"unknown_error"` - ### Beta Managed Agents Vault Archived Deployment Paused Reason Error -- `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object { type }` +- `BetaManagedAgentsVaultArchivedDeploymentPausedReasonError object` A vault referenced by the deployment is archived. - `type: "vault_archived_error"` - - `"vault_archived_error"` - ### Beta Managed Agents Vault Not Found Deployment Paused Reason Error -- `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object { type }` +- `BetaManagedAgentsVaultNotFoundDeploymentPausedReasonError object` A vault referenced by the deployment no longer exists. - `type: "vault_not_found_error"` - - `"vault_not_found_error"` - ### Beta Managed Agents Workspace Archived Deployment Paused Reason Error -- `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object { type }` +- `BetaManagedAgentsWorkspaceArchivedDeploymentPausedReasonError object` The deployment's workspace was archived. - `type: "workspace_archived_error"` - - - `"workspace_archived_error"`