One read of Claude Developer Platformapi-20260814T043121Z
565 pages moved out of 565 read.
Pages moved
565
significant first
Pages read
565
in this capture
Captured
04:31 UTC
Corpus hash
764ab7e8e96e
full baseline · corpus-hash
What this read moved
201-225 of 565, page 9 of 23This capture is too large to show at once. Changes 201-225 of 565 are below, significant first; the rest are on the following screens.
api/beta/deployment_runs/list First recorded · 429 lines, first recorded
## List Deployment Runs ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List Deployment Runs
url: https://platform.claude.com/docs/en/api/beta/deployment_runs/list
---
## List Deployment Runs
**get** `/v1/deployment_runs`
List Deployment Runs
### Query Parameters
- `"created_at[gt]": optional string`
Return runs created strictly after this time (exclusive).
- `"created_at[gte]": optional string`
Return runs created at or after this time (inclusive).
- `"created_at[lt]": optional string`
Return runs created strictly before this time (exclusive).
- `"created_at[lte]": optional string`
Return runs created at or before this time (inclusive).
- `deployment_id: optional string`
Filter to a specific deployment. Omit to list across all deployments in the workspace. Filtering by a non-existent deployment_id returns 200 with empty data.
- `has_error: optional boolean`
Filter: true for runs with non-null error, false for runs with non-null session_id. Omit for all.
- `limit: optional number`
Maximum results per page. Default 20, maximum 1000.
- `page: optional string`
Opaque pagination cursor. Pass next_page from the previous response. Invalid or expired cursors return 400.
- `trigger_type: optional BetaManagedAgentsTriggerType`
Filter runs by what triggered them. Omit to return all runs.
- `"schedule"`
- `"manual"`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `data: array of BetaManagedAgentsDeploymentRun`
List of deployment runs.
- `id: string`
Unique identifier for this run (`drun_...`).
- `agent: BetaManagedAgentsAgentReference`
A resolved agent reference with a concrete version.
- `id: string`
- `type: "agent"`
- `"agent"`
- `version: number`
- `created_at: string`
A timestamp in RFC 3339 format
- `deployment_id: string`
ID of the deployment that produced this run.
- `error: BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null`
Why the run failed to create a session. The type identifies the failure; message is human-readable detail.
- `BetaManagedAgentsEnvironmentArchivedRunError object { message, type }`
The deployment's environment was archived.
- `message: string`
Human-readable error description.
- `type: "environment_archived_error"`
- `"environment_archived_error"`
- `BetaManagedAgentsAgentArchivedRunError object { message, type }`
The deployment's agent was archived.
- `message: string`
Human-readable error description.
- `type: "agent_archived_error"`
- `"agent_archived_error"`
- `BetaManagedAgentsEnvironmentNotFoundRunError object { message, type }`
The deployment's environment no longer exists.
- `message: string`
Human-readable error description.
- `type: "environment_not_found_error"`
- `"environment_not_found_error"`
- `BetaManagedAgentsVaultNotFoundRunError object { message, type }`
A vault referenced by the deployment no longer exists.
- `message: string`
Human-readable error description.
- `type: "vault_not_found_error"`
- `"vault_not_found_error"`
- `BetaManagedAgentsVaultArchivedRunError object { message, type }`
A vault referenced by the deployment is archived.
- `message: string`
Human-readable error description.
- `type: "vault_archived_error"`
- `"vault_archived_error"`
- `BetaManagedAgentsFileNotFoundRunError object { message, type }`
A file resource referenced by the deployment no longer exists.
- `message: string`
Human-readable error description.
- `type: "file_not_found_error"`
- `"file_not_found_error"`
- `BetaManagedAgentsMemoryStoreArchivedRunError object { message, type }`
A memory store referenced by the deployment is archived.
- `message: string`
Human-readable error description.
- `type: "memory_store_archived_error"`
- `"memory_store_archived_error"`
- `BetaManagedAgentsSkillNotFoundRunError object { message, type }`
A skill referenced by the deployment's agent no longer exists.
- `message: string`
Human-readable error description.
- `type: "skill_not_found_error"`
- `"skill_not_found_error"`
- `BetaManagedAgentsSessionResourceNotFoundRunError object { message, type }`
A referenced resource no longer exists and its kind was not reported.
- `message: string`
Human-readable error description.
- `type: "session_resource_not_found_error"`
- `"session_resource_not_found_error"`
- `BetaManagedAgentsWorkspaceArchivedRunError object { message, type }`
The deployment's workspace was archived.
- `message: string`
Human-readable error description.
- `type: "workspace_archived_error"`
- `"workspace_archived_error"`
- `BetaManagedAgentsOrganizationDisabledRunError object { message, type }`
The deployment's organization is disabled.
- `message: string`
Human-readable error description.
- `type: "organization_disabled_error"`
- `"organization_disabled_error"`
- `BetaManagedAgentsSessionRateLimitedRunError object { message, type }`
Session creation was rejected due to rate limiting. The schedule keeps firing; subsequent runs may succeed.
- `message: string`
Cut at 300 lines. The page has the rest.
api/beta/deployment_runs/retrieve First recorded · 382 lines, first recorded
## Get Deployment Run ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get Deployment Run
url: https://platform.claude.com/docs/en/api/beta/deployment_runs/retrieve
---
## Get Deployment Run
**get** `/v1/deployment_runs/{deployment_run_id}`
Get Deployment Run
### Path Parameters
- `deployment_run_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaManagedAgentsDeploymentRun object { id, agent, created_at, 5 more }`
A persistent, append-only record of a single deployment execution. Records session creation success or failure — no session lifecycle tracking.
- `id: string`
Unique identifier for this run (`drun_...`).
- `agent: BetaManagedAgentsAgentReference`
A resolved agent reference with a concrete version.
- `id: string`
- `type: "agent"`
- `"agent"`
- `version: number`
- `created_at: string`
A timestamp in RFC 3339 format
- `deployment_id: string`
ID of the deployment that produced this run.
- `error: BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null`
Why the run failed to create a session. The type identifies the failure; message is human-readable detail.
- `BetaManagedAgentsEnvironmentArchivedRunError object { message, type }`
The deployment's environment was archived.
- `message: string`
Human-readable error description.
- `type: "environment_archived_error"`
- `"environment_archived_error"`
- `BetaManagedAgentsAgentArchivedRunError object { message, type }`
The deployment's agent was archived.
- `message: string`
Human-readable error description.
- `type: "agent_archived_error"`
- `"agent_archived_error"`
- `BetaManagedAgentsEnvironmentNotFoundRunError object { message, type }`
The deployment's environment no longer exists.
- `message: string`
Human-readable error description.
- `type: "environment_not_found_error"`
- `"environment_not_found_error"`
- `BetaManagedAgentsVaultNotFoundRunError object { message, type }`
A vault referenced by the deployment no longer exists.
- `message: string`
Human-readable error description.
- `type: "vault_not_found_error"`
- `"vault_not_found_error"`
- `BetaManagedAgentsVaultArchivedRunError object { message, type }`
A vault referenced by the deployment is archived.
- `message: string`
Human-readable error description.
- `type: "vault_archived_error"`
- `"vault_archived_error"`
- `BetaManagedAgentsFileNotFoundRunError object { message, type }`
A file resource referenced by the deployment no longer exists.
- `message: string`
Human-readable error description.
- `type: "file_not_found_error"`
- `"file_not_found_error"`
- `BetaManagedAgentsMemoryStoreArchivedRunError object { message, type }`
A memory store referenced by the deployment is archived.
- `message: string`
Human-readable error description.
- `type: "memory_store_archived_error"`
- `"memory_store_archived_error"`
- `BetaManagedAgentsSkillNotFoundRunError object { message, type }`
A skill referenced by the deployment's agent no longer exists.
- `message: string`
Human-readable error description.
- `type: "skill_not_found_error"`
- `"skill_not_found_error"`
- `BetaManagedAgentsSessionResourceNotFoundRunError object { message, type }`
A referenced resource no longer exists and its kind was not reported.
- `message: string`
Human-readable error description.
- `type: "session_resource_not_found_error"`
- `"session_resource_not_found_error"`
- `BetaManagedAgentsWorkspaceArchivedRunError object { message, type }`
The deployment's workspace was archived.
- `message: string`
Human-readable error description.
- `type: "workspace_archived_error"`
- `"workspace_archived_error"`
- `BetaManagedAgentsOrganizationDisabledRunError object { message, type }`
The deployment's organization is disabled.
- `message: string`
Human-readable error description.
- `type: "organization_disabled_error"`
- `"organization_disabled_error"`
- `BetaManagedAgentsSessionRateLimitedRunError object { message, type }`
Session creation was rejected due to rate limiting. The schedule keeps firing; subsequent runs may succeed.
- `message: string`
Human-readable error description.
- `type: "session_rate_limited_error"`
- `"session_rate_limited_error"`
- `BetaManagedAgentsSessionCreationRejectedRunError object { message, type }`
The session create request was rejected with a non-retryable validation error.
- `message: string`
Human-readable error description.
- `type: "session_creation_rejected_error"`
- `"session_creation_rejected_error"`
- `BetaManagedAgentsUnknownRunError object { message, type }`
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.
- `message: string`
Human-readable error description.
- `type: "unknown_error"`
- `"unknown_error"`
- `BetaManagedAgentsSelfHostedResourcesUnsupportedRunError object { message, type }`
The deployment configures resources, but its environment is self-hosted and cannot mount them.
- `message: string`
Human-readable error description.
Cut at 300 lines. The page has the rest.
api/beta/deployments First recorded · 8372 lines, first recorded
# Deployments ## Create Deployment ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Deployments ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Deployment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Deployment ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Archive Deployment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Run Deployment Now ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Pause Deployment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Unpause Deployment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Managed Agents Agent Archived Deployment Paused Reason Error ### Beta Managed Agents Cron Schedule ### Beta Managed Agents Cron Schedule Params ### Beta Managed Agents Deployment ### Beta Managed Agents Deployment Initial Event ### Beta Managed Agents Deployment Initial Event Params ### Beta Managed Agents Deployment Paused Reason ### Beta Managed Agents Deployment Paused Reason Error ### Beta Managed Agents Deployment Status ### Beta Managed Agents Deployment System Message Event ### Beta Managed Agents Deployment User Define Outcome Event ### Beta Managed Agents Deployment User Message Event ### Beta Managed Agents Environment Archived Deployment Paused Reason Error ### Beta Managed Agents Environment Not Found Deployment Paused Reason Error ### Beta Managed Agents Error Deployment Paused Reason ### Beta Managed Agents File Not Found Deployment Paused Reason Error ### Beta Managed Agents File Resource Config ### Beta Managed Agents GitHub Repository Resource Config ### Beta Managed Agents Manual Deployment Paused Reason ### Beta Managed Agents MCP Egress Blocked Deployment Paused Reason Error ### Beta Managed Agents Memory Store Archived Deployment Paused Reason Error ### Beta Managed Agents Memory Store Resource Config ### Beta Managed Agents Organization Disabled Deployment Paused Reason Error ### Beta Managed Agents Schedule ### Beta Managed Agents Schedule Params ### Beta Managed Agents Self Hosted Resources Unsupported Deployment Paused Reason Error ### Beta Managed Agents Session Resource Config ### Beta Managed Agents Session Resource Not Found Deployment Paused Reason Error ### Beta Managed Agents Skill Not Found Deployment Paused Reason Error ### Beta Managed Agents Unknown Deployment Paused Reason Error ### Beta Managed Agents Vault Archived Deployment Paused Reason Error ### Beta Managed Agents Vault Not Found Deployment Paused Reason Error ### Beta Managed Agents Workspace Archived Deployment Paused Reason Error
The first capture of this source. The page was already there, and this is what it said.
---
title: Deployments
url: https://platform.claude.com/docs/en/api/beta/deployments
---
# Deployments
## Create Deployment
**post** `/v1/deployments`
Create Deployment
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Body Parameters
- `agent: string or BetaManagedAgentsAgentParams`
Agent to deploy. Accepts the `agent` ID string, which pins the latest version, or an `agent` object with both id and version specified. The agent must exist and not be archived.
- `string`
- `BetaManagedAgentsAgentParams object { id, type, version }`
Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version
- `id: string`
The `agent` ID.
- `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.
- `environment_id: string`
ID of the `environment` defining the container configuration for sessions created from this deployment.
- `initial_events: array of BetaManagedAgentsDeploymentInitialEventParams`
Events to send to each session immediately after creation. At least 1, maximum 50.
- `BetaManagedAgentsUserMessageEventParams object { content, type }`
Parameters for sending a user message to the session.
- `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`
Array of content blocks for the user message.
- `BetaManagedAgentsTextBlock object { text, type }`
Regular text content.
- `text: string`
The text content.
- `type: "text"`
- `"text"`
- `BetaManagedAgentsImageBlock object { source, type }`
Image content specified directly as base64 data or as a reference via a URL.
- `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
Union type for image source variants.
- `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`
Base64-encoded image data.
- `data: string`
Base64-encoded image data.
- `media_type: string`
MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsURLImageSource object { type, url }`
Image referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the image to fetch.
- `BetaManagedAgentsFileImageSource object { file_id, type }`
Image referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "image"`
- `"image"`
- `BetaManagedAgentsDocumentBlock object { source, type, context, title }`
Document content, either specified directly as base64 data, as text, or as a reference via a URL.
- `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
Union type for document source variants.
- `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`
Base64-encoded document data.
- `data: string`
Base64-encoded document data.
- `media_type: string`
MIME type of the document (e.g., "application/pdf").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`
Plain text document content.
- `data: string`
The plain text content.
- `media_type: "text/plain"`
MIME type of the text content. Must be "text/plain".
- `"text/plain"`
- `type: "text"`
- `"text"`
- `BetaManagedAgentsURLDocumentSource object { type, url }`
Document referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the document to fetch.
- `BetaManagedAgentsFileDocumentSource object { file_id, type }`
Document referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "document"`
- `"document"`
- `context: optional string or null`
Additional context about the document for the model.
- `title: optional string or null`
The title of the document.
- `BetaManagedAgentsRedactedBlock object { type }`
Placeholder for content withheld by Anthropic model policy.
- `type: "redacted"`
- `"redacted"`
- `type: "user.message"`
- `"user.message"`
- `BetaManagedAgentsUserDefineOutcomeEventParams object { description, rubric, type, max_iterations }`
Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.
- `description: string`
What the agent should produce. This is the task specification.
- `rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams`
Rubric for grading the quality of an outcome.
- `BetaManagedAgentsFileRubricParams object { file_id, type }`
Rubric referenced by a file uploaded via the Files API.
- `file_id: string`
Cut at 300 lines. The page has the rest.
api/beta/deployments/archive First recorded · 729 lines, first recorded
## Archive Deployment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Archive Deployment
url: https://platform.claude.com/docs/en/api/beta/deployments/archive
---
## Archive Deployment
**post** `/v1/deployments/{deployment_id}/archive`
Archive Deployment
### Path Parameters
- `deployment_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }`
A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule.
- `id: string`
Unique identifier for this deployment.
- `agent: BetaManagedAgentsAgentReference`
A resolved agent reference with a concrete version.
- `id: string`
- `type: "agent"`
- `"agent"`
- `version: number`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `description: string or null`
Description of what the deployment does.
- `environment_id: string`
ID of the `environment` where sessions run.
- `initial_events: array of BetaManagedAgentsDeploymentInitialEvent`
Events sent to each session immediately after creation.
- `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`
A user message sent to the session.
- `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`
Array of content blocks for the user message.
- `BetaManagedAgentsTextBlock object { text, type }`
Regular text content.
- `text: string`
The text content.
- `type: "text"`
- `"text"`
- `BetaManagedAgentsImageBlock object { source, type }`
Image content specified directly as base64 data or as a reference via a URL.
- `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
Union type for image source variants.
- `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`
Base64-encoded image data.
- `data: string`
Base64-encoded image data.
- `media_type: string`
MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsURLImageSource object { type, url }`
Image referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the image to fetch.
- `BetaManagedAgentsFileImageSource object { file_id, type }`
Image referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "image"`
- `"image"`
- `BetaManagedAgentsDocumentBlock object { source, type, context, title }`
Document content, either specified directly as base64 data, as text, or as a reference via a URL.
- `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
Union type for document source variants.
- `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`
Base64-encoded document data.
- `data: string`
Base64-encoded document data.
- `media_type: string`
MIME type of the document (e.g., "application/pdf").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`
Plain text document content.
- `data: string`
The plain text content.
- `media_type: "text/plain"`
MIME type of the text content. Must be "text/plain".
- `"text/plain"`
- `type: "text"`
- `"text"`
- `BetaManagedAgentsURLDocumentSource object { type, url }`
Document referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the document to fetch.
- `BetaManagedAgentsFileDocumentSource object { file_id, type }`
Document referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "document"`
- `"document"`
- `context: optional string or null`
Additional context about the document for the model.
- `title: optional string or null`
The title of the document.
- `BetaManagedAgentsRedactedBlock object { type }`
Placeholder for content withheld by Anthropic model policy.
- `type: "redacted"`
- `"redacted"`
- `type: "user.message"`
- `"user.message"`
- `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`
An outcome the agent should work toward. The agent begins work on receipt.
- `description: string`
Cut at 300 lines. The page has the rest.
api/beta/deployments/create First recorded · 1141 lines, first recorded
## Create Deployment ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Create Deployment
url: https://platform.claude.com/docs/en/api/beta/deployments/create
---
## Create Deployment
**post** `/v1/deployments`
Create Deployment
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Body Parameters
- `agent: string or BetaManagedAgentsAgentParams`
Agent to deploy. Accepts the `agent` ID string, which pins the latest version, or an `agent` object with both id and version specified. The agent must exist and not be archived.
- `string`
- `BetaManagedAgentsAgentParams object { id, type, version }`
Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version
- `id: string`
The `agent` ID.
- `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.
- `environment_id: string`
ID of the `environment` defining the container configuration for sessions created from this deployment.
- `initial_events: array of BetaManagedAgentsDeploymentInitialEventParams`
Events to send to each session immediately after creation. At least 1, maximum 50.
- `BetaManagedAgentsUserMessageEventParams object { content, type }`
Parameters for sending a user message to the session.
- `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`
Array of content blocks for the user message.
- `BetaManagedAgentsTextBlock object { text, type }`
Regular text content.
- `text: string`
The text content.
- `type: "text"`
- `"text"`
- `BetaManagedAgentsImageBlock object { source, type }`
Image content specified directly as base64 data or as a reference via a URL.
- `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
Union type for image source variants.
- `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`
Base64-encoded image data.
- `data: string`
Base64-encoded image data.
- `media_type: string`
MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsURLImageSource object { type, url }`
Image referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the image to fetch.
- `BetaManagedAgentsFileImageSource object { file_id, type }`
Image referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "image"`
- `"image"`
- `BetaManagedAgentsDocumentBlock object { source, type, context, title }`
Document content, either specified directly as base64 data, as text, or as a reference via a URL.
- `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
Union type for document source variants.
- `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`
Base64-encoded document data.
- `data: string`
Base64-encoded document data.
- `media_type: string`
MIME type of the document (e.g., "application/pdf").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`
Plain text document content.
- `data: string`
The plain text content.
- `media_type: "text/plain"`
MIME type of the text content. Must be "text/plain".
- `"text/plain"`
- `type: "text"`
- `"text"`
- `BetaManagedAgentsURLDocumentSource object { type, url }`
Document referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the document to fetch.
- `BetaManagedAgentsFileDocumentSource object { file_id, type }`
Document referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "document"`
- `"document"`
- `context: optional string or null`
Additional context about the document for the model.
- `title: optional string or null`
The title of the document.
- `BetaManagedAgentsRedactedBlock object { type }`
Placeholder for content withheld by Anthropic model policy.
- `type: "redacted"`
- `"redacted"`
- `type: "user.message"`
- `"user.message"`
- `BetaManagedAgentsUserDefineOutcomeEventParams object { description, rubric, type, max_iterations }`
Parameters for defining an outcome the agent should work toward. The agent begins work on receipt.
- `description: string`
What the agent should produce. This is the task specification.
- `rubric: BetaManagedAgentsFileRubricParams or BetaManagedAgentsTextRubricParams`
Rubric for grading the quality of an outcome.
- `BetaManagedAgentsFileRubricParams object { file_id, type }`
Rubric referenced by a file uploaded via the Files API.
- `file_id: string`
ID of the rubric file.
Cut at 300 lines. The page has the rest.
api/beta/deployments/list First recorded · 767 lines, first recorded
## List Deployments ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List Deployments
url: https://platform.claude.com/docs/en/api/beta/deployments/list
---
## List Deployments
**get** `/v1/deployments`
List Deployments
### Query Parameters
- `agent_id: optional string`
Filter by agent ID.
- `"created_at[gte]": optional string`
Return deployments created at or after this time (inclusive).
- `"created_at[lte]": optional string`
Return deployments created at or before this time (inclusive).
- `include_archived: optional boolean`
When true, includes archived deployments. Default: false (exclude archived).
- `limit: optional number`
Maximum results per page. Default 20, maximum 100.
- `page: optional string`
Opaque pagination cursor.
- `status: optional BetaManagedAgentsDeploymentStatus`
Filter by status: active or paused. Omit for both. To include archived deployments, use include_archived instead; the two cannot be combined.
- `"active"`
- `"paused"`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `data: array of BetaManagedAgentsDeployment`
List of deployments.
- `id: string`
Unique identifier for this deployment.
- `agent: BetaManagedAgentsAgentReference`
A resolved agent reference with a concrete version.
- `id: string`
- `type: "agent"`
- `"agent"`
- `version: number`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `description: string or null`
Description of what the deployment does.
- `environment_id: string`
ID of the `environment` where sessions run.
- `initial_events: array of BetaManagedAgentsDeploymentInitialEvent`
Events sent to each session immediately after creation.
- `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`
A user message sent to the session.
- `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`
Array of content blocks for the user message.
- `BetaManagedAgentsTextBlock object { text, type }`
Regular text content.
- `text: string`
The text content.
- `type: "text"`
- `"text"`
- `BetaManagedAgentsImageBlock object { source, type }`
Image content specified directly as base64 data or as a reference via a URL.
- `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
Union type for image source variants.
- `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`
Base64-encoded image data.
- `data: string`
Base64-encoded image data.
- `media_type: string`
MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsURLImageSource object { type, url }`
Image referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the image to fetch.
- `BetaManagedAgentsFileImageSource object { file_id, type }`
Image referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "image"`
- `"image"`
- `BetaManagedAgentsDocumentBlock object { source, type, context, title }`
Document content, either specified directly as base64 data, as text, or as a reference via a URL.
- `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
Union type for document source variants.
- `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`
Base64-encoded document data.
- `data: string`
Base64-encoded document data.
- `media_type: string`
MIME type of the document (e.g., "application/pdf").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`
Plain text document content.
- `data: string`
The plain text content.
- `media_type: "text/plain"`
MIME type of the text content. Must be "text/plain".
- `"text/plain"`
- `type: "text"`
- `"text"`
- `BetaManagedAgentsURLDocumentSource object { type, url }`
Document referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the document to fetch.
- `BetaManagedAgentsFileDocumentSource object { file_id, type }`
Document referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
Cut at 300 lines. The page has the rest.
api/beta/deployments/pause First recorded · 729 lines, first recorded
## Pause Deployment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Pause Deployment
url: https://platform.claude.com/docs/en/api/beta/deployments/pause
---
## Pause Deployment
**post** `/v1/deployments/{deployment_id}/pause`
Pause Deployment
### Path Parameters
- `deployment_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }`
A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule.
- `id: string`
Unique identifier for this deployment.
- `agent: BetaManagedAgentsAgentReference`
A resolved agent reference with a concrete version.
- `id: string`
- `type: "agent"`
- `"agent"`
- `version: number`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `description: string or null`
Description of what the deployment does.
- `environment_id: string`
ID of the `environment` where sessions run.
- `initial_events: array of BetaManagedAgentsDeploymentInitialEvent`
Events sent to each session immediately after creation.
- `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`
A user message sent to the session.
- `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`
Array of content blocks for the user message.
- `BetaManagedAgentsTextBlock object { text, type }`
Regular text content.
- `text: string`
The text content.
- `type: "text"`
- `"text"`
- `BetaManagedAgentsImageBlock object { source, type }`
Image content specified directly as base64 data or as a reference via a URL.
- `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
Union type for image source variants.
- `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`
Base64-encoded image data.
- `data: string`
Base64-encoded image data.
- `media_type: string`
MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsURLImageSource object { type, url }`
Image referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the image to fetch.
- `BetaManagedAgentsFileImageSource object { file_id, type }`
Image referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "image"`
- `"image"`
- `BetaManagedAgentsDocumentBlock object { source, type, context, title }`
Document content, either specified directly as base64 data, as text, or as a reference via a URL.
- `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
Union type for document source variants.
- `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`
Base64-encoded document data.
- `data: string`
Base64-encoded document data.
- `media_type: string`
MIME type of the document (e.g., "application/pdf").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`
Plain text document content.
- `data: string`
The plain text content.
- `media_type: "text/plain"`
MIME type of the text content. Must be "text/plain".
- `"text/plain"`
- `type: "text"`
- `"text"`
- `BetaManagedAgentsURLDocumentSource object { type, url }`
Document referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the document to fetch.
- `BetaManagedAgentsFileDocumentSource object { file_id, type }`
Document referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "document"`
- `"document"`
- `context: optional string or null`
Additional context about the document for the model.
- `title: optional string or null`
The title of the document.
- `BetaManagedAgentsRedactedBlock object { type }`
Placeholder for content withheld by Anthropic model policy.
- `type: "redacted"`
- `"redacted"`
- `type: "user.message"`
- `"user.message"`
- `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`
An outcome the agent should work toward. The agent begins work on receipt.
- `description: string`
Cut at 300 lines. The page has the rest.
api/beta/deployments/retrieve First recorded · 728 lines, first recorded
## Get Deployment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get Deployment
url: https://platform.claude.com/docs/en/api/beta/deployments/retrieve
---
## Get Deployment
**get** `/v1/deployments/{deployment_id}`
Get Deployment
### Path Parameters
- `deployment_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }`
A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule.
- `id: string`
Unique identifier for this deployment.
- `agent: BetaManagedAgentsAgentReference`
A resolved agent reference with a concrete version.
- `id: string`
- `type: "agent"`
- `"agent"`
- `version: number`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `description: string or null`
Description of what the deployment does.
- `environment_id: string`
ID of the `environment` where sessions run.
- `initial_events: array of BetaManagedAgentsDeploymentInitialEvent`
Events sent to each session immediately after creation.
- `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`
A user message sent to the session.
- `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`
Array of content blocks for the user message.
- `BetaManagedAgentsTextBlock object { text, type }`
Regular text content.
- `text: string`
The text content.
- `type: "text"`
- `"text"`
- `BetaManagedAgentsImageBlock object { source, type }`
Image content specified directly as base64 data or as a reference via a URL.
- `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
Union type for image source variants.
- `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`
Base64-encoded image data.
- `data: string`
Base64-encoded image data.
- `media_type: string`
MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsURLImageSource object { type, url }`
Image referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the image to fetch.
- `BetaManagedAgentsFileImageSource object { file_id, type }`
Image referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "image"`
- `"image"`
- `BetaManagedAgentsDocumentBlock object { source, type, context, title }`
Document content, either specified directly as base64 data, as text, or as a reference via a URL.
- `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
Union type for document source variants.
- `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`
Base64-encoded document data.
- `data: string`
Base64-encoded document data.
- `media_type: string`
MIME type of the document (e.g., "application/pdf").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`
Plain text document content.
- `data: string`
The plain text content.
- `media_type: "text/plain"`
MIME type of the text content. Must be "text/plain".
- `"text/plain"`
- `type: "text"`
- `"text"`
- `BetaManagedAgentsURLDocumentSource object { type, url }`
Document referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the document to fetch.
- `BetaManagedAgentsFileDocumentSource object { file_id, type }`
Document referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "document"`
- `"document"`
- `context: optional string or null`
Additional context about the document for the model.
- `title: optional string or null`
The title of the document.
- `BetaManagedAgentsRedactedBlock object { type }`
Placeholder for content withheld by Anthropic model policy.
- `type: "redacted"`
- `"redacted"`
- `type: "user.message"`
- `"user.message"`
- `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`
An outcome the agent should work toward. The agent begins work on receipt.
- `description: string`
Cut at 300 lines. The page has the rest.
api/beta/deployments/run First recorded · 383 lines, first recorded
## Run Deployment Now ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Run Deployment Now
url: https://platform.claude.com/docs/en/api/beta/deployments/run
---
## Run Deployment Now
**post** `/v1/deployments/{deployment_id}/run`
Run Deployment Now
### Path Parameters
- `deployment_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaManagedAgentsDeploymentRun object { id, agent, created_at, 5 more }`
A persistent, append-only record of a single deployment execution. Records session creation success or failure — no session lifecycle tracking.
- `id: string`
Unique identifier for this run (`drun_...`).
- `agent: BetaManagedAgentsAgentReference`
A resolved agent reference with a concrete version.
- `id: string`
- `type: "agent"`
- `"agent"`
- `version: number`
- `created_at: string`
A timestamp in RFC 3339 format
- `deployment_id: string`
ID of the deployment that produced this run.
- `error: BetaManagedAgentsEnvironmentArchivedRunError or BetaManagedAgentsAgentArchivedRunError or BetaManagedAgentsEnvironmentNotFoundRunError or 13 more or null`
Why the run failed to create a session. The type identifies the failure; message is human-readable detail.
- `BetaManagedAgentsEnvironmentArchivedRunError object { message, type }`
The deployment's environment was archived.
- `message: string`
Human-readable error description.
- `type: "environment_archived_error"`
- `"environment_archived_error"`
- `BetaManagedAgentsAgentArchivedRunError object { message, type }`
The deployment's agent was archived.
- `message: string`
Human-readable error description.
- `type: "agent_archived_error"`
- `"agent_archived_error"`
- `BetaManagedAgentsEnvironmentNotFoundRunError object { message, type }`
The deployment's environment no longer exists.
- `message: string`
Human-readable error description.
- `type: "environment_not_found_error"`
- `"environment_not_found_error"`
- `BetaManagedAgentsVaultNotFoundRunError object { message, type }`
A vault referenced by the deployment no longer exists.
- `message: string`
Human-readable error description.
- `type: "vault_not_found_error"`
- `"vault_not_found_error"`
- `BetaManagedAgentsVaultArchivedRunError object { message, type }`
A vault referenced by the deployment is archived.
- `message: string`
Human-readable error description.
- `type: "vault_archived_error"`
- `"vault_archived_error"`
- `BetaManagedAgentsFileNotFoundRunError object { message, type }`
A file resource referenced by the deployment no longer exists.
- `message: string`
Human-readable error description.
- `type: "file_not_found_error"`
- `"file_not_found_error"`
- `BetaManagedAgentsMemoryStoreArchivedRunError object { message, type }`
A memory store referenced by the deployment is archived.
- `message: string`
Human-readable error description.
- `type: "memory_store_archived_error"`
- `"memory_store_archived_error"`
- `BetaManagedAgentsSkillNotFoundRunError object { message, type }`
A skill referenced by the deployment's agent no longer exists.
- `message: string`
Human-readable error description.
- `type: "skill_not_found_error"`
- `"skill_not_found_error"`
- `BetaManagedAgentsSessionResourceNotFoundRunError object { message, type }`
A referenced resource no longer exists and its kind was not reported.
- `message: string`
Human-readable error description.
- `type: "session_resource_not_found_error"`
- `"session_resource_not_found_error"`
- `BetaManagedAgentsWorkspaceArchivedRunError object { message, type }`
The deployment's workspace was archived.
- `message: string`
Human-readable error description.
- `type: "workspace_archived_error"`
- `"workspace_archived_error"`
- `BetaManagedAgentsOrganizationDisabledRunError object { message, type }`
The deployment's organization is disabled.
- `message: string`
Human-readable error description.
- `type: "organization_disabled_error"`
- `"organization_disabled_error"`
- `BetaManagedAgentsSessionRateLimitedRunError object { message, type }`
Session creation was rejected due to rate limiting. The schedule keeps firing; subsequent runs may succeed.
- `message: string`
Human-readable error description.
- `type: "session_rate_limited_error"`
- `"session_rate_limited_error"`
- `BetaManagedAgentsSessionCreationRejectedRunError object { message, type }`
The session create request was rejected with a non-retryable validation error.
- `message: string`
Human-readable error description.
- `type: "session_creation_rejected_error"`
- `"session_creation_rejected_error"`
- `BetaManagedAgentsUnknownRunError object { message, type }`
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.
- `message: string`
Human-readable error description.
- `type: "unknown_error"`
- `"unknown_error"`
- `BetaManagedAgentsSelfHostedResourcesUnsupportedRunError object { message, type }`
The deployment configures resources, but its environment is self-hosted and cannot mount them.
- `message: string`
Human-readable error description.
Cut at 300 lines. The page has the rest.
api/beta/deployments/unpause First recorded · 729 lines, first recorded
## Unpause Deployment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Unpause Deployment
url: https://platform.claude.com/docs/en/api/beta/deployments/unpause
---
## Unpause Deployment
**post** `/v1/deployments/{deployment_id}/unpause`
Unpause Deployment
### Path Parameters
- `deployment_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaManagedAgentsDeployment object { id, agent, archived_at, 14 more }`
A deployment is a configured instance of an agent — it binds the agent to everything needed to run it autonomously: an environment, credentials, initial events, and an optional schedule.
- `id: string`
Unique identifier for this deployment.
- `agent: BetaManagedAgentsAgentReference`
A resolved agent reference with a concrete version.
- `id: string`
- `type: "agent"`
- `"agent"`
- `version: number`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `description: string or null`
Description of what the deployment does.
- `environment_id: string`
ID of the `environment` where sessions run.
- `initial_events: array of BetaManagedAgentsDeploymentInitialEvent`
Events sent to each session immediately after creation.
- `BetaManagedAgentsDeploymentUserMessageEvent object { content, type }`
A user message sent to the session.
- `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`
Array of content blocks for the user message.
- `BetaManagedAgentsTextBlock object { text, type }`
Regular text content.
- `text: string`
The text content.
- `type: "text"`
- `"text"`
- `BetaManagedAgentsImageBlock object { source, type }`
Image content specified directly as base64 data or as a reference via a URL.
- `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
Union type for image source variants.
- `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`
Base64-encoded image data.
- `data: string`
Base64-encoded image data.
- `media_type: string`
MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsURLImageSource object { type, url }`
Image referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the image to fetch.
- `BetaManagedAgentsFileImageSource object { file_id, type }`
Image referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "image"`
- `"image"`
- `BetaManagedAgentsDocumentBlock object { source, type, context, title }`
Document content, either specified directly as base64 data, as text, or as a reference via a URL.
- `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
Union type for document source variants.
- `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`
Base64-encoded document data.
- `data: string`
Base64-encoded document data.
- `media_type: string`
MIME type of the document (e.g., "application/pdf").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`
Plain text document content.
- `data: string`
The plain text content.
- `media_type: "text/plain"`
MIME type of the text content. Must be "text/plain".
- `"text/plain"`
- `type: "text"`
- `"text"`
- `BetaManagedAgentsURLDocumentSource object { type, url }`
Document referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the document to fetch.
- `BetaManagedAgentsFileDocumentSource object { file_id, type }`
Document referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "document"`
- `"document"`
- `context: optional string or null`
Additional context about the document for the model.
- `title: optional string or null`
The title of the document.
- `BetaManagedAgentsRedactedBlock object { type }`
Placeholder for content withheld by Anthropic model policy.
- `type: "redacted"`
- `"redacted"`
- `type: "user.message"`
- `"user.message"`
- `BetaManagedAgentsDeploymentUserDefineOutcomeEvent object { description, rubric, type, max_iterations }`
An outcome the agent should work toward. The agent begins work on receipt.
- `description: string`
Cut at 300 lines. The page has the rest.
api/beta/deployments/update First recorded · 1130 lines, first recorded
## Update Deployment ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Update Deployment
url: https://platform.claude.com/docs/en/api/beta/deployments/update
---
## Update Deployment
**post** `/v1/deployments/{deployment_id}`
Update Deployment
### Path Parameters
- `deployment_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Body Parameters
- `agent: optional string or BetaManagedAgentsAgentParams`
Agent to deploy. Accepts the `agent` ID string, which re-pins to the latest version, or an `agent` object with both id and version specified. Omit to preserve. Cannot be cleared.
- `string`
- `BetaManagedAgentsAgentParams object { id, type, version }`
Specification for an Agent. Provide a specific `version` or use the short-form `agent="agent_id"` for the most recent version
- `id: string`
The `agent` ID.
- `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.
- `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`.
- `max_list_cost: BetaMonetaryAmount`
A monetary amount in a specific currency.
- `amount: string`
Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.
- `currency: BetaCurrency`
Uppercase ISO-4217 currency code. `USD` is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.
- `"USD"`
- `type: "limit"`
- `"limit"`
- `description: optional string or null`
Description. Omit to preserve; send empty string or null to clear.
- `environment_id: optional string`
ID of the `environment` where sessions run. Omit to preserve. Cannot be cleared.
- `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 }`
Parameters for sending a user message to the session.
- `content: array of BetaManagedAgentsTextBlock or BetaManagedAgentsImageBlock or BetaManagedAgentsDocumentBlock or BetaManagedAgentsRedactedBlock`
Array of content blocks for the user message.
- `BetaManagedAgentsTextBlock object { text, type }`
Regular text content.
- `text: string`
The text content.
- `type: "text"`
- `"text"`
- `BetaManagedAgentsImageBlock object { source, type }`
Image content specified directly as base64 data or as a reference via a URL.
- `source: BetaManagedAgentsBase64ImageSource or BetaManagedAgentsURLImageSource or BetaManagedAgentsFileImageSource`
Union type for image source variants.
- `BetaManagedAgentsBase64ImageSource object { data, media_type, type }`
Base64-encoded image data.
- `data: string`
Base64-encoded image data.
- `media_type: string`
MIME type of the image (e.g., "image/png", "image/jpeg", "image/gif", "image/webp").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsURLImageSource object { type, url }`
Image referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the image to fetch.
- `BetaManagedAgentsFileImageSource object { file_id, type }`
Image referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "image"`
- `"image"`
- `BetaManagedAgentsDocumentBlock object { source, type, context, title }`
Document content, either specified directly as base64 data, as text, or as a reference via a URL.
- `source: BetaManagedAgentsBase64DocumentSource or BetaManagedAgentsPlainTextDocumentSource or BetaManagedAgentsURLDocumentSource or BetaManagedAgentsFileDocumentSource`
Union type for document source variants.
- `BetaManagedAgentsBase64DocumentSource object { data, media_type, type }`
Base64-encoded document data.
- `data: string`
Base64-encoded document data.
- `media_type: string`
MIME type of the document (e.g., "application/pdf").
- `type: "base64"`
- `"base64"`
- `BetaManagedAgentsPlainTextDocumentSource object { data, media_type, type }`
Plain text document content.
- `data: string`
The plain text content.
- `media_type: "text/plain"`
MIME type of the text content. Must be "text/plain".
- `"text/plain"`
- `type: "text"`
- `"text"`
- `BetaManagedAgentsURLDocumentSource object { type, url }`
Document referenced by URL.
- `type: "url"`
- `"url"`
- `url: string`
URL of the document to fetch.
- `BetaManagedAgentsFileDocumentSource object { file_id, type }`
Document referenced by file ID.
- `file_id: string`
ID of a previously uploaded file.
- `type: "file"`
- `"file"`
- `type: "document"`
- `"document"`
- `context: optional string or null`
Additional context about the document for the model.
- `title: optional string or null`
The title of the document.
- `BetaManagedAgentsRedactedBlock object { type }`
Cut at 300 lines. The page has the rest.
api/beta/dreams First recorded · 1635 lines, first recorded
# Dreams ## Create a Dream ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Dreams ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get a Dream ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Cancel a Dream ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive a Dream ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Dream ### Beta Dream Error ### Beta Dream Input ### Beta Dream Memory Store Input ### Beta Dream Memory Store Output ### Beta Dream Model Config ### Beta Dream Model Config Param ### Beta Dream Output ### Beta Dream Sessions Input ### Beta Dream Status ### Beta Dream Usage
The first capture of this source. The page was already there, and this is what it said.
---
title: Dreams
url: https://platform.claude.com/docs/en/api/beta/dreams
---
# Dreams
## Create a Dream
**post** `/v1/dreams`
Create a Dream
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Body Parameters
- `inputs: array of BetaDreamInput`
- `BetaDreamMemoryStoreInput object { memory_store_id, type }`
An input memory store the dream reads from. The dream never mutates this store.
- `memory_store_id: string`
- `type: "memory_store"`
- `"memory_store"`
- `BetaDreamSessionsInput object { session_ids, type }`
Input session transcripts the dream reads.
- `session_ids: array of string`
- `type: "sessions"`
- `"sessions"`
- `model: string or BetaDreamModelConfigParam`
Model identifier and configuration applied to every pipeline stage.
- `string`
- `BetaDreamModelConfigParam object { id, speed }`
Model identifier and configuration applied to every pipeline stage.
- `id: string`
Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
- `speed: optional "standard" or "fast" or null`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `instructions: optional string or null`
### Returns
- `BetaDream object { id, archived_at, created_at, 10 more }`
An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into a new output memory store. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
- `id: string`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `ended_at: string or null`
A timestamp in RFC 3339 format
- `error: BetaDreamError or null`
Failure detail for a Dream whose `status` is `failed`.
- `message: string`
- `type: string`
- `inputs: array of BetaDreamInput`
- `BetaDreamMemoryStoreInput object { memory_store_id, type }`
An input memory store the dream reads from. The dream never mutates this store.
- `memory_store_id: string`
- `type: "memory_store"`
- `"memory_store"`
- `BetaDreamSessionsInput object { session_ids, type }`
Input session transcripts the dream reads.
- `session_ids: array of string`
- `type: "sessions"`
- `"sessions"`
- `instructions: string or null`
- `model: BetaDreamModelConfig`
Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.
- `id: string`
Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
- `speed: optional "standard" or "fast"`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `outputs: array of BetaDreamOutput`
- `memory_store_id: string`
- `type: "memory_store"`
- `"memory_store"`
- `session_id: string or null`
- `status: BetaDreamStatus`
Lifecycle status of a Dream.
- `"pending"`
- `"running"`
- `"completed"`
- `"failed"`
- `"canceled"`
- `type: "dream"`
- `"dream"`
- `usage: BetaDreamUsage`
Cumulative token usage for the dream across every pipeline stage.
- `cache_creation_input_tokens: number`
Total tokens used to create prompt-cache entries (sum of all TTL tiers).
- `cache_read_input_tokens: number`
Total tokens read from prompt cache.
- `input_tokens: number`
Total uncached input tokens consumed across every pipeline stage.
- `output_tokens: number`
Total output tokens generated across every pipeline stage.
### Example
```http
curl https://api.anthropic.com/v1/dreams \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: dreaming-2026-04-21' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"inputs": [
{
"memory_store_id": "x",
"type": "memory_store"
}
],
"model": "string"
}'
```
#### Response
```json
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"ended_at": "2019-12-27T18:11:19.117Z",
"error": {
"message": "message",
"type": "type"
},
"inputs": [
{
"memory_store_id": "x",
"type": "memory_store"
}
],
"instructions": "instructions",
"model": {
"id": "x",
"speed": "standard"
},
"outputs": [
{
"memory_store_id": "memory_store_id",
"type": "memory_store"
}
Cut at 300 lines. The page has the rest.
api/beta/dreams/archive First recorded · 257 lines, first recorded
## Archive a Dream ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Archive a Dream
url: https://platform.claude.com/docs/en/api/beta/dreams/archive
---
## Archive a Dream
**post** `/v1/dreams/{dream_id}/archive`
Archive a Dream
### Path Parameters
- `dream_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaDream object { id, archived_at, created_at, 10 more }`
An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into a new output memory store. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
- `id: string`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `ended_at: string or null`
A timestamp in RFC 3339 format
- `error: BetaDreamError or null`
Failure detail for a Dream whose `status` is `failed`.
- `message: string`
- `type: string`
- `inputs: array of BetaDreamInput`
- `BetaDreamMemoryStoreInput object { memory_store_id, type }`
An input memory store the dream reads from. The dream never mutates this store.
- `memory_store_id: string`
- `type: "memory_store"`
- `"memory_store"`
- `BetaDreamSessionsInput object { session_ids, type }`
Input session transcripts the dream reads.
- `session_ids: array of string`
- `type: "sessions"`
- `"sessions"`
- `instructions: string or null`
- `model: BetaDreamModelConfig`
Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.
- `id: string`
Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
- `speed: optional "standard" or "fast"`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `outputs: array of BetaDreamOutput`
- `memory_store_id: string`
- `type: "memory_store"`
- `"memory_store"`
- `session_id: string or null`
- `status: BetaDreamStatus`
Lifecycle status of a Dream.
- `"pending"`
- `"running"`
- `"completed"`
- `"failed"`
- `"canceled"`
- `type: "dream"`
- `"dream"`
- `usage: BetaDreamUsage`
Cumulative token usage for the dream across every pipeline stage.
- `cache_creation_input_tokens: number`
Total tokens used to create prompt-cache entries (sum of all TTL tiers).
- `cache_read_input_tokens: number`
Total tokens read from prompt cache.
- `input_tokens: number`
Total uncached input tokens consumed across every pipeline stage.
- `output_tokens: number`
Total output tokens generated across every pipeline stage.
### Example
```http
curl https://api.anthropic.com/v1/dreams/$DREAM_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: dreaming-2026-04-21' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"ended_at": "2019-12-27T18:11:19.117Z",
"error": {
"message": "message",
"type": "type"
},
"inputs": [
{
"memory_store_id": "x",
"type": "memory_store"
}
],
"instructions": "instructions",
"model": {
"id": "x",
"speed": "standard"
},
"outputs": [
{
"memory_store_id": "memory_store_id",
"type": "memory_store"
}
],
"session_id": "session_id",
"status": "pending",
"type": "dream",
"usage": {
"cache_creation_input_tokens": 0,
"cache_read_input_tokens": 0,
"input_tokens": 0,
"output_tokens": 0
}
}
```
api/beta/dreams/cancel First recorded · 257 lines, first recorded
## Cancel a Dream ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Cancel a Dream
url: https://platform.claude.com/docs/en/api/beta/dreams/cancel
---
## Cancel a Dream
**post** `/v1/dreams/{dream_id}/cancel`
Cancel a Dream
### Path Parameters
- `dream_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaDream object { id, archived_at, created_at, 10 more }`
An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into a new output memory store. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
- `id: string`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `ended_at: string or null`
A timestamp in RFC 3339 format
- `error: BetaDreamError or null`
Failure detail for a Dream whose `status` is `failed`.
- `message: string`
- `type: string`
- `inputs: array of BetaDreamInput`
- `BetaDreamMemoryStoreInput object { memory_store_id, type }`
An input memory store the dream reads from. The dream never mutates this store.
- `memory_store_id: string`
- `type: "memory_store"`
- `"memory_store"`
- `BetaDreamSessionsInput object { session_ids, type }`
Input session transcripts the dream reads.
- `session_ids: array of string`
- `type: "sessions"`
- `"sessions"`
- `instructions: string or null`
- `model: BetaDreamModelConfig`
Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.
- `id: string`
Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
- `speed: optional "standard" or "fast"`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `outputs: array of BetaDreamOutput`
- `memory_store_id: string`
- `type: "memory_store"`
- `"memory_store"`
- `session_id: string or null`
- `status: BetaDreamStatus`
Lifecycle status of a Dream.
- `"pending"`
- `"running"`
- `"completed"`
- `"failed"`
- `"canceled"`
- `type: "dream"`
- `"dream"`
- `usage: BetaDreamUsage`
Cumulative token usage for the dream across every pipeline stage.
- `cache_creation_input_tokens: number`
Total tokens used to create prompt-cache entries (sum of all TTL tiers).
- `cache_read_input_tokens: number`
Total tokens read from prompt cache.
- `input_tokens: number`
Total uncached input tokens consumed across every pipeline stage.
- `output_tokens: number`
Total output tokens generated across every pipeline stage.
### Example
```http
curl https://api.anthropic.com/v1/dreams/$DREAM_ID/cancel \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: dreaming-2026-04-21' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"ended_at": "2019-12-27T18:11:19.117Z",
"error": {
"message": "message",
"type": "type"
},
"inputs": [
{
"memory_store_id": "x",
"type": "memory_store"
}
],
"instructions": "instructions",
"model": {
"id": "x",
"speed": "standard"
},
"outputs": [
{
"memory_store_id": "memory_store_id",
"type": "memory_store"
}
],
"session_id": "session_id",
"status": "pending",
"type": "dream",
"usage": {
"cache_creation_input_tokens": 0,
"cache_read_input_tokens": 0,
"input_tokens": 0,
"output_tokens": 0
}
}
```
api/beta/dreams/create First recorded · 310 lines, first recorded
## Create a Dream ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Create a Dream
url: https://platform.claude.com/docs/en/api/beta/dreams/create
---
## Create a Dream
**post** `/v1/dreams`
Create a Dream
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Body Parameters
- `inputs: array of BetaDreamInput`
- `BetaDreamMemoryStoreInput object { memory_store_id, type }`
An input memory store the dream reads from. The dream never mutates this store.
- `memory_store_id: string`
- `type: "memory_store"`
- `"memory_store"`
- `BetaDreamSessionsInput object { session_ids, type }`
Input session transcripts the dream reads.
- `session_ids: array of string`
- `type: "sessions"`
- `"sessions"`
- `model: string or BetaDreamModelConfigParam`
Model identifier and configuration applied to every pipeline stage.
- `string`
- `BetaDreamModelConfigParam object { id, speed }`
Model identifier and configuration applied to every pipeline stage.
- `id: string`
Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
- `speed: optional "standard" or "fast" or null`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `instructions: optional string or null`
### Returns
- `BetaDream object { id, archived_at, created_at, 10 more }`
An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into a new output memory store. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
- `id: string`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `ended_at: string or null`
A timestamp in RFC 3339 format
- `error: BetaDreamError or null`
Failure detail for a Dream whose `status` is `failed`.
- `message: string`
- `type: string`
- `inputs: array of BetaDreamInput`
- `BetaDreamMemoryStoreInput object { memory_store_id, type }`
An input memory store the dream reads from. The dream never mutates this store.
- `memory_store_id: string`
- `type: "memory_store"`
- `"memory_store"`
- `BetaDreamSessionsInput object { session_ids, type }`
Input session transcripts the dream reads.
- `session_ids: array of string`
- `type: "sessions"`
- `"sessions"`
- `instructions: string or null`
- `model: BetaDreamModelConfig`
Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.
- `id: string`
Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
- `speed: optional "standard" or "fast"`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `outputs: array of BetaDreamOutput`
- `memory_store_id: string`
- `type: "memory_store"`
- `"memory_store"`
- `session_id: string or null`
- `status: BetaDreamStatus`
Lifecycle status of a Dream.
- `"pending"`
- `"running"`
- `"completed"`
- `"failed"`
- `"canceled"`
- `type: "dream"`
- `"dream"`
- `usage: BetaDreamUsage`
Cumulative token usage for the dream across every pipeline stage.
- `cache_creation_input_tokens: number`
Total tokens used to create prompt-cache entries (sum of all TTL tiers).
- `cache_read_input_tokens: number`
Total tokens read from prompt cache.
- `input_tokens: number`
Total uncached input tokens consumed across every pipeline stage.
- `output_tokens: number`
Total output tokens generated across every pipeline stage.
### Example
```http
curl https://api.anthropic.com/v1/dreams \
-H 'Content-Type: application/json' \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: dreaming-2026-04-21' \
-H "X-Api-Key: $ANTHROPIC_API_KEY" \
-d '{
"inputs": [
{
"memory_store_id": "x",
"type": "memory_store"
}
],
"model": "string"
}'
```
#### Response
```json
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"ended_at": "2019-12-27T18:11:19.117Z",
"error": {
"message": "message",
"type": "type"
},
"inputs": [
{
"memory_store_id": "x",
"type": "memory_store"
}
],
"instructions": "instructions",
"model": {
"id": "x",
"speed": "standard"
},
"outputs": [
{
"memory_store_id": "memory_store_id",
"type": "memory_store"
}
],
"session_id": "session_id",
Cut at 300 lines. The page has the rest.
api/beta/dreams/list First recorded · 293 lines, first recorded
## List Dreams ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List Dreams
url: https://platform.claude.com/docs/en/api/beta/dreams/list
---
## List Dreams
**get** `/v1/dreams`
List Dreams
### Query Parameters
- `"created_at[gt]": optional string`
Return dreams with `created_at` strictly after this timestamp (exclusive lower bound, RFC 3339). Unset applies no lower bound.
- `"created_at[lt]": optional string`
Return dreams with `created_at` strictly before this timestamp (exclusive upper bound, RFC 3339). Unset applies no upper bound.
- `include_archived: optional boolean`
Query parameter for include_archived
- `limit: optional number`
Query parameter for limit
- `page: optional string`
Query parameter for page
- `statuses: optional array of BetaDreamStatus`
Filter by lifecycle status. Repeat the parameter to match any of multiple statuses. Empty applies no status filter.
- `"pending"`
- `"running"`
- `"completed"`
- `"failed"`
- `"canceled"`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `data: array of BetaDream`
- `id: string`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `ended_at: string or null`
A timestamp in RFC 3339 format
- `error: BetaDreamError or null`
Failure detail for a Dream whose `status` is `failed`.
- `message: string`
- `type: string`
- `inputs: array of BetaDreamInput`
- `BetaDreamMemoryStoreInput object { memory_store_id, type }`
An input memory store the dream reads from. The dream never mutates this store.
- `memory_store_id: string`
- `type: "memory_store"`
- `"memory_store"`
- `BetaDreamSessionsInput object { session_ids, type }`
Input session transcripts the dream reads.
- `session_ids: array of string`
- `type: "sessions"`
- `"sessions"`
- `instructions: string or null`
- `model: BetaDreamModelConfig`
Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.
- `id: string`
Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
- `speed: optional "standard" or "fast"`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `outputs: array of BetaDreamOutput`
- `memory_store_id: string`
- `type: "memory_store"`
- `"memory_store"`
- `session_id: string or null`
- `status: BetaDreamStatus`
Lifecycle status of a Dream.
- `"pending"`
- `"running"`
- `"completed"`
- `"failed"`
- `"canceled"`
- `type: "dream"`
- `"dream"`
- `usage: BetaDreamUsage`
Cumulative token usage for the dream across every pipeline stage.
- `cache_creation_input_tokens: number`
Total tokens used to create prompt-cache entries (sum of all TTL tiers).
- `cache_read_input_tokens: number`
Total tokens read from prompt cache.
- `input_tokens: number`
Total uncached input tokens consumed across every pipeline stage.
- `output_tokens: number`
Total output tokens generated across every pipeline stage.
- `next_page: string or null`
### Example
```http
curl https://api.anthropic.com/v1/dreams \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: dreaming-2026-04-21' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"data": [
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"ended_at": "2019-12-27T18:11:19.117Z",
"error": {
"message": "message",
"type": "type"
},
"inputs": [
{
"memory_store_id": "x",
"type": "memory_store"
}
],
"instructions": "instructions",
"model": {
"id": "x",
"speed": "standard"
},
"outputs": [
{
"memory_store_id": "memory_store_id",
"type": "memory_store"
}
],
"session_id": "session_id",
"status": "pending",
"type": "dream",
"usage": {
"cache_creation_input_tokens": 0,
"cache_read_input_tokens": 0,
"input_tokens": 0,
"output_tokens": 0
}
}
],
"next_page": "next_page"
}
```
api/beta/dreams/retrieve First recorded · 256 lines, first recorded
## Get a Dream ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get a Dream
url: https://platform.claude.com/docs/en/api/beta/dreams/retrieve
---
## Get a Dream
**get** `/v1/dreams/{dream_id}`
Get a Dream
### Path Parameters
- `dream_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaDream object { id, archived_at, created_at, 10 more }`
An asynchronous memory-consolidation job that reads a memory store plus a set of session transcripts and writes consolidated memories into a new output memory store. The Dreams API is in research preview: the request and response shapes are volatile and may change without the deprecation period that applies to generally-available endpoints.
- `id: string`
- `archived_at: string or null`
A timestamp in RFC 3339 format
- `created_at: string`
A timestamp in RFC 3339 format
- `ended_at: string or null`
A timestamp in RFC 3339 format
- `error: BetaDreamError or null`
Failure detail for a Dream whose `status` is `failed`.
- `message: string`
- `type: string`
- `inputs: array of BetaDreamInput`
- `BetaDreamMemoryStoreInput object { memory_store_id, type }`
An input memory store the dream reads from. The dream never mutates this store.
- `memory_store_id: string`
- `type: "memory_store"`
- `"memory_store"`
- `BetaDreamSessionsInput object { session_ids, type }`
Input session transcripts the dream reads.
- `session_ids: array of string`
- `type: "sessions"`
- `"sessions"`
- `instructions: string or null`
- `model: BetaDreamModelConfig`
Model identifier and configuration applied to every pipeline stage. Same wire shape as the Agents API ModelConfig.
- `id: string`
Model identifier, e.g. "claude-opus-4-7". 1-256 characters.
- `speed: optional "standard" or "fast"`
Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time.
- `"standard"`
- `"fast"`
- `outputs: array of BetaDreamOutput`
- `memory_store_id: string`
- `type: "memory_store"`
- `"memory_store"`
- `session_id: string or null`
- `status: BetaDreamStatus`
Lifecycle status of a Dream.
- `"pending"`
- `"running"`
- `"completed"`
- `"failed"`
- `"canceled"`
- `type: "dream"`
- `"dream"`
- `usage: BetaDreamUsage`
Cumulative token usage for the dream across every pipeline stage.
- `cache_creation_input_tokens: number`
Total tokens used to create prompt-cache entries (sum of all TTL tiers).
- `cache_read_input_tokens: number`
Total tokens read from prompt cache.
- `input_tokens: number`
Total uncached input tokens consumed across every pipeline stage.
- `output_tokens: number`
Total output tokens generated across every pipeline stage.
### Example
```http
curl https://api.anthropic.com/v1/dreams/$DREAM_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: dreaming-2026-04-21' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "id",
"archived_at": "2019-12-27T18:11:19.117Z",
"created_at": "2019-12-27T18:11:19.117Z",
"ended_at": "2019-12-27T18:11:19.117Z",
"error": {
"message": "message",
"type": "type"
},
"inputs": [
{
"memory_store_id": "x",
"type": "memory_store"
}
],
"instructions": "instructions",
"model": {
"id": "x",
"speed": "standard"
},
"outputs": [
{
"memory_store_id": "memory_store_id",
"type": "memory_store"
}
],
"session_id": "session_id",
"status": "pending",
"type": "dream",
"usage": {
"cache_creation_input_tokens": 0,
"cache_read_input_tokens": 0,
"input_tokens": 0,
"output_tokens": 0
}
}
```
api/beta/environments First recorded · 4217 lines, first recorded
# Environments ## Create Environment ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Environments ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Get Environment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Environment ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Delete Environment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Archive Environment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Cloud Config ### Beta Cloud Config Params ### Beta Environment ### Beta Environment Delete Response ### Beta Limited Network ### Beta Limited Network Params ### Beta Packages ### Beta Packages Params ### Beta Self Hosted Config ### Beta Self Hosted Config Params ### Beta Unrestricted Network # Work ## Get Work Item ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Poll for Work ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Acknowledge Work ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Record Heartbeat ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Stop Work ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Work Items ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Work Item ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Get Queue Statistics ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Self Hosted Work ### Beta Self Hosted Work Heartbeat Response ### Beta Self Hosted Work List Response ### Beta Self Hosted Work Queue Stats ### Beta Self Hosted Work Stop Request ### Beta Self Hosted Work Update Request ### Beta Session Work Data
The first capture of this source. The page was already there, and this is what it said.
---
title: Environments
url: https://platform.claude.com/docs/en/api/beta/environments
---
# Environments
## Create Environment
**post** `/v1/environments`
Create a new environment with the specified configuration.
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Body Parameters
- `name: string`
Human-readable name for the environment
- `config: optional BetaCloudConfigParams or BetaSelfHostedConfigParams or null`
Environment configuration
- `BetaCloudConfigParams object { type, networking, packages }`
Request params for `cloud` environment configuration.
Fields default to null; on update, omitted fields preserve the
existing value.
- `type: "cloud"`
Environment type
- `"cloud"`
- `networking: optional BetaUnrestrictedNetwork or BetaLimitedNetworkParams or null`
Network configuration policy. Omit on update to preserve the existing value.
- `BetaUnrestrictedNetwork object { type }`
Unrestricted network access.
- `type: "unrestricted"`
Network policy type
- `"unrestricted"`
- `BetaLimitedNetworkParams object { type, allow_mcp_servers, allow_package_managers, allowed_hosts }`
Limited network request params.
Fields default to null; on update, omitted fields preserve the
existing value.
- `type: "limited"`
Network policy type
- `"limited"`
- `allow_mcp_servers: optional boolean or null`
Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`.
- `allow_package_managers: optional boolean or null`
Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`.
- `allowed_hosts: optional array of string or null`
Specifies domains the container can reach.
- `packages: optional BetaPackagesParams or null`
Specify packages (and optionally their versions) available in this environment.
When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest.
- `apt: optional array of string or null`
Ubuntu/Debian packages to install
- `cargo: optional array of string or null`
Rust packages to install
- `gem: optional array of string or null`
Ruby packages to install
- `go: optional array of string or null`
Go packages to install
- `npm: optional array of string or null`
Node.js packages to install
- `pip: optional array of string or null`
Python packages to install
- `type: optional "packages"`
Package configuration type
- `"packages"`
- `BetaSelfHostedConfigParams object { type }`
Request params for `self_hosted` environment configuration.
- `type: "self_hosted"`
Environment type
- `"self_hosted"`
- `description: optional string or null`
Optional description of the environment
- `metadata: optional map[string]`
User-provided metadata key-value pairs
- `scope: optional "organization" or "account" or null`
The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. Only applicable for self-hosted environments. If not specified, defaults based on organization type.
- `"organization"`
- `"account"`
### Returns
- `BetaEnvironment object { id, archived_at, config, 7 more }`
Unified Environment resource for both cloud and self-hosted environments.
- `id: string`
Environment identifier (e.g., 'env_...')
- `archived_at: string or null`
RFC 3339 timestamp when environment was archived, or null if not archived
- `config: BetaCloudConfig or BetaSelfHostedConfig`
Environment configuration (either Anthropic Cloud or self-hosted)
- `BetaCloudConfig object { networking, packages, type }`
`cloud` environment configuration.
- `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork`
Network configuration policy.
- `BetaUnrestrictedNetwork object { type }`
Unrestricted network access.
- `type: "unrestricted"`
Network policy type
- `"unrestricted"`
- `BetaLimitedNetwork object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }`
Limited network access.
- `allow_mcp_servers: boolean`
Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array.
- `allow_package_managers: boolean`
Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array.
- `allowed_hosts: array of string`
Specifies domains the container can reach.
- `type: "limited"`
Network policy type
- `"limited"`
- `packages: BetaPackages`
Package manager configuration.
- `apt: array of string`
Ubuntu/Debian packages to install
- `cargo: array of string`
Rust packages to install
- `gem: array of string`
Ruby packages to install
- `go: array of string`
Go packages to install
- `npm: array of string`
Node.js packages to install
- `pip: array of string`
Python packages to install
- `type: optional "packages"`
Cut at 300 lines. The page has the rest.
api/beta/environments/archive First recorded · 291 lines, first recorded
## Archive Environment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Archive Environment
url: https://platform.claude.com/docs/en/api/beta/environments/archive
---
## Archive Environment
**post** `/v1/environments/{environment_id}/archive`
Archive an environment by ID. Archived environments cannot be used to create new sessions.
### Path Parameters
- `environment_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaEnvironment object { id, archived_at, config, 7 more }`
Unified Environment resource for both cloud and self-hosted environments.
- `id: string`
Environment identifier (e.g., 'env_...')
- `archived_at: string or null`
RFC 3339 timestamp when environment was archived, or null if not archived
- `config: BetaCloudConfig or BetaSelfHostedConfig`
Environment configuration (either Anthropic Cloud or self-hosted)
- `BetaCloudConfig object { networking, packages, type }`
`cloud` environment configuration.
- `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork`
Network configuration policy.
- `BetaUnrestrictedNetwork object { type }`
Unrestricted network access.
- `type: "unrestricted"`
Network policy type
- `"unrestricted"`
- `BetaLimitedNetwork object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }`
Limited network access.
- `allow_mcp_servers: boolean`
Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array.
- `allow_package_managers: boolean`
Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array.
- `allowed_hosts: array of string`
Specifies domains the container can reach.
- `type: "limited"`
Network policy type
- `"limited"`
- `packages: BetaPackages`
Package manager configuration.
- `apt: array of string`
Ubuntu/Debian packages to install
- `cargo: array of string`
Rust packages to install
- `gem: array of string`
Ruby packages to install
- `go: array of string`
Go packages to install
- `npm: array of string`
Node.js packages to install
- `pip: array of string`
Python packages to install
- `type: optional "packages"`
Package configuration type
- `"packages"`
- `type: "cloud"`
Environment type
- `"cloud"`
- `BetaSelfHostedConfig object { type }`
Configuration for self-hosted environments.
- `type: "self_hosted"`
Environment type
- `"self_hosted"`
- `created_at: string`
RFC 3339 timestamp when environment was created
- `description: string`
User-provided description for the environment
- `metadata: map[string]`
User-provided metadata key-value pairs
- `name: string`
Human-readable name for the environment
- `type: "environment"`
The type of object (always 'environment')
- `"environment"`
- `updated_at: string`
RFC 3339 timestamp when environment was last updated
- `scope: optional "organization" or "account"`
The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account.
- `"organization"`
- `"account"`
### Example
```http
curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/archive \
-X POST \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: managed-agents-2026-04-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
"archived_at": null,
"config": {
"networking": {
"allow_mcp_servers": false,
"allow_package_managers": true,
"allowed_hosts": [
"api.example.com"
],
"type": "limited"
},
"packages": {
"apt": [
"string"
],
"cargo": [
"string"
],
"gem": [
"string"
],
"go": [
"string"
],
"npm": [
"string"
],
"pip": [
"pandas",
"numpy"
],
"type": "packages"
},
"type": "cloud"
},
"created_at": "2026-03-15T10:00:00Z",
"description": "Python environment with data-analysis packages.",
"metadata": {},
"name": "python-data-analysis",
"type": "environment",
"updated_at": "2026-03-15T10:00:00Z",
"scope": "organization"
}
```
api/beta/environments/create First recorded · 431 lines, first recorded
## Create Environment ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Create Environment
url: https://platform.claude.com/docs/en/api/beta/environments/create
---
## Create Environment
**post** `/v1/environments`
Create a new environment with the specified configuration.
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Body Parameters
- `name: string`
Human-readable name for the environment
- `config: optional BetaCloudConfigParams or BetaSelfHostedConfigParams or null`
Environment configuration
- `BetaCloudConfigParams object { type, networking, packages }`
Request params for `cloud` environment configuration.
Fields default to null; on update, omitted fields preserve the
existing value.
- `type: "cloud"`
Environment type
- `"cloud"`
- `networking: optional BetaUnrestrictedNetwork or BetaLimitedNetworkParams or null`
Network configuration policy. Omit on update to preserve the existing value.
- `BetaUnrestrictedNetwork object { type }`
Unrestricted network access.
- `type: "unrestricted"`
Network policy type
- `"unrestricted"`
- `BetaLimitedNetworkParams object { type, allow_mcp_servers, allow_package_managers, allowed_hosts }`
Limited network request params.
Fields default to null; on update, omitted fields preserve the
existing value.
- `type: "limited"`
Network policy type
- `"limited"`
- `allow_mcp_servers: optional boolean or null`
Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`.
- `allow_package_managers: optional boolean or null`
Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`.
- `allowed_hosts: optional array of string or null`
Specifies domains the container can reach.
- `packages: optional BetaPackagesParams or null`
Specify packages (and optionally their versions) available in this environment.
When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest.
- `apt: optional array of string or null`
Ubuntu/Debian packages to install
- `cargo: optional array of string or null`
Rust packages to install
- `gem: optional array of string or null`
Ruby packages to install
- `go: optional array of string or null`
Go packages to install
- `npm: optional array of string or null`
Node.js packages to install
- `pip: optional array of string or null`
Python packages to install
- `type: optional "packages"`
Package configuration type
- `"packages"`
- `BetaSelfHostedConfigParams object { type }`
Request params for `self_hosted` environment configuration.
- `type: "self_hosted"`
Environment type
- `"self_hosted"`
- `description: optional string or null`
Optional description of the environment
- `metadata: optional map[string]`
User-provided metadata key-value pairs
- `scope: optional "organization" or "account" or null`
The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only. Only applicable for self-hosted environments. If not specified, defaults based on organization type.
- `"organization"`
- `"account"`
### Returns
- `BetaEnvironment object { id, archived_at, config, 7 more }`
Unified Environment resource for both cloud and self-hosted environments.
- `id: string`
Environment identifier (e.g., 'env_...')
- `archived_at: string or null`
RFC 3339 timestamp when environment was archived, or null if not archived
- `config: BetaCloudConfig or BetaSelfHostedConfig`
Environment configuration (either Anthropic Cloud or self-hosted)
- `BetaCloudConfig object { networking, packages, type }`
`cloud` environment configuration.
- `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork`
Network configuration policy.
- `BetaUnrestrictedNetwork object { type }`
Unrestricted network access.
- `type: "unrestricted"`
Network policy type
- `"unrestricted"`
- `BetaLimitedNetwork object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }`
Limited network access.
- `allow_mcp_servers: boolean`
Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array.
- `allow_package_managers: boolean`
Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array.
- `allowed_hosts: array of string`
Specifies domains the container can reach.
- `type: "limited"`
Network policy type
- `"limited"`
- `packages: BetaPackages`
Package manager configuration.
- `apt: array of string`
Ubuntu/Debian packages to install
- `cargo: array of string`
Rust packages to install
- `gem: array of string`
Ruby packages to install
- `go: array of string`
Go packages to install
- `npm: array of string`
Node.js packages to install
- `pip: array of string`
Python packages to install
- `type: optional "packages"`
Package configuration type
Cut at 300 lines. The page has the rest.
api/beta/environments/delete First recorded · 125 lines, first recorded
## Delete Environment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Delete Environment
url: https://platform.claude.com/docs/en/api/beta/environments/delete
---
## Delete Environment
**delete** `/v1/environments/{environment_id}`
Delete an environment by ID. Returns a confirmation of the deletion.
### Path Parameters
- `environment_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaEnvironmentDeleteResponse object { id, type }`
Response after deleting an environment.
- `id: string`
Environment identifier
- `type: "environment_deleted"`
The type of response
- `"environment_deleted"`
### Example
```http
curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID \
-X DELETE \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: managed-agents-2026-04-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
"type": "environment_deleted"
}
```
api/beta/environments/list First recorded · 309 lines, first recorded
## List Environments ### Query Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: List Environments
url: https://platform.claude.com/docs/en/api/beta/environments/list
---
## List Environments
**get** `/v1/environments`
List environments with pagination support.
### Query Parameters
- `include_archived: optional boolean`
Include archived environments in the response
- `limit: optional number`
Maximum number of environments to return
- `page: optional string`
Opaque cursor from previous response for pagination. Pass the `next_page` value from the previous response.
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `data: array of BetaEnvironment`
List of environments.
- `id: string`
Environment identifier (e.g., 'env_...')
- `archived_at: string or null`
RFC 3339 timestamp when environment was archived, or null if not archived
- `config: BetaCloudConfig or BetaSelfHostedConfig`
Environment configuration (either Anthropic Cloud or self-hosted)
- `BetaCloudConfig object { networking, packages, type }`
`cloud` environment configuration.
- `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork`
Network configuration policy.
- `BetaUnrestrictedNetwork object { type }`
Unrestricted network access.
- `type: "unrestricted"`
Network policy type
- `"unrestricted"`
- `BetaLimitedNetwork object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }`
Limited network access.
- `allow_mcp_servers: boolean`
Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array.
- `allow_package_managers: boolean`
Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array.
- `allowed_hosts: array of string`
Specifies domains the container can reach.
- `type: "limited"`
Network policy type
- `"limited"`
- `packages: BetaPackages`
Package manager configuration.
- `apt: array of string`
Ubuntu/Debian packages to install
- `cargo: array of string`
Rust packages to install
- `gem: array of string`
Ruby packages to install
- `go: array of string`
Go packages to install
- `npm: array of string`
Node.js packages to install
- `pip: array of string`
Python packages to install
- `type: optional "packages"`
Package configuration type
- `"packages"`
- `type: "cloud"`
Environment type
- `"cloud"`
- `BetaSelfHostedConfig object { type }`
Configuration for self-hosted environments.
- `type: "self_hosted"`
Environment type
- `"self_hosted"`
- `created_at: string`
RFC 3339 timestamp when environment was created
- `description: string`
User-provided description for the environment
- `metadata: map[string]`
User-provided metadata key-value pairs
- `name: string`
Human-readable name for the environment
- `type: "environment"`
The type of object (always 'environment')
- `"environment"`
- `updated_at: string`
RFC 3339 timestamp when environment was last updated
- `scope: optional "organization" or "account"`
The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account.
- `"organization"`
- `"account"`
- `next_page: string or null`
Token for fetching the next page of results. If `null`, there are no more results available. Pass this value to the `page` parameter in the next request.
### Example
```http
curl https://api.anthropic.com/v1/environments \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: managed-agents-2026-04-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"data": [
{
"id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
"archived_at": null,
"config": {
"networking": {
"allow_mcp_servers": false,
"allow_package_managers": true,
"allowed_hosts": [
"api.example.com"
],
"type": "limited"
},
"packages": {
"apt": [
"string"
],
"cargo": [
"string"
],
"gem": [
"string"
],
"go": [
"string"
],
"npm": [
"string"
],
"pip": [
"pandas",
"numpy"
],
"type": "packages"
},
"type": "cloud"
},
"created_at": "2026-03-15T10:00:00Z",
"description": "Python environment with data-analysis packages.",
"metadata": {},
Cut at 300 lines. The page has the rest.
api/beta/environments/retrieve First recorded · 290 lines, first recorded
## Get Environment ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Get Environment
url: https://platform.claude.com/docs/en/api/beta/environments/retrieve
---
## Get Environment
**get** `/v1/environments/{environment_id}`
Retrieve a specific environment by ID.
### Path Parameters
- `environment_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaEnvironment object { id, archived_at, config, 7 more }`
Unified Environment resource for both cloud and self-hosted environments.
- `id: string`
Environment identifier (e.g., 'env_...')
- `archived_at: string or null`
RFC 3339 timestamp when environment was archived, or null if not archived
- `config: BetaCloudConfig or BetaSelfHostedConfig`
Environment configuration (either Anthropic Cloud or self-hosted)
- `BetaCloudConfig object { networking, packages, type }`
`cloud` environment configuration.
- `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork`
Network configuration policy.
- `BetaUnrestrictedNetwork object { type }`
Unrestricted network access.
- `type: "unrestricted"`
Network policy type
- `"unrestricted"`
- `BetaLimitedNetwork object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }`
Limited network access.
- `allow_mcp_servers: boolean`
Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array.
- `allow_package_managers: boolean`
Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array.
- `allowed_hosts: array of string`
Specifies domains the container can reach.
- `type: "limited"`
Network policy type
- `"limited"`
- `packages: BetaPackages`
Package manager configuration.
- `apt: array of string`
Ubuntu/Debian packages to install
- `cargo: array of string`
Rust packages to install
- `gem: array of string`
Ruby packages to install
- `go: array of string`
Go packages to install
- `npm: array of string`
Node.js packages to install
- `pip: array of string`
Python packages to install
- `type: optional "packages"`
Package configuration type
- `"packages"`
- `type: "cloud"`
Environment type
- `"cloud"`
- `BetaSelfHostedConfig object { type }`
Configuration for self-hosted environments.
- `type: "self_hosted"`
Environment type
- `"self_hosted"`
- `created_at: string`
RFC 3339 timestamp when environment was created
- `description: string`
User-provided description for the environment
- `metadata: map[string]`
User-provided metadata key-value pairs
- `name: string`
Human-readable name for the environment
- `type: "environment"`
The type of object (always 'environment')
- `"environment"`
- `updated_at: string`
RFC 3339 timestamp when environment was last updated
- `scope: optional "organization" or "account"`
The visibility scope for this environment. 'organization' means visible to all accounts. 'account' means visible only to the owning account.
- `"organization"`
- `"account"`
### Example
```http
curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: managed-agents-2026-04-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "env_011CZkZ9X2dpNyB7HsEFoRfW",
"archived_at": null,
"config": {
"networking": {
"allow_mcp_servers": false,
"allow_package_managers": true,
"allowed_hosts": [
"api.example.com"
],
"type": "limited"
},
"packages": {
"apt": [
"string"
],
"cargo": [
"string"
],
"gem": [
"string"
],
"go": [
"string"
],
"npm": [
"string"
],
"pip": [
"pandas",
"numpy"
],
"type": "packages"
},
"type": "cloud"
},
"created_at": "2026-03-15T10:00:00Z",
"description": "Python environment with data-analysis packages.",
"metadata": {},
"name": "python-data-analysis",
"type": "environment",
"updated_at": "2026-03-15T10:00:00Z",
"scope": "organization"
}
```
api/beta/environments/update First recorded · 418 lines, first recorded
## Update Environment ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The first capture of this source. The page was already there, and this is what it said.
---
title: Update Environment
url: https://platform.claude.com/docs/en/api/beta/environments/update
---
## Update Environment
**post** `/v1/environments/{environment_id}`
Update an existing environment's configuration.
### Path Parameters
- `environment_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Body Parameters
- `config: optional BetaCloudConfigParams or BetaSelfHostedConfigParams or null`
Updated environment configuration
- `BetaCloudConfigParams object { type, networking, packages }`
Request params for `cloud` environment configuration.
Fields default to null; on update, omitted fields preserve the
existing value.
- `type: "cloud"`
Environment type
- `"cloud"`
- `networking: optional BetaUnrestrictedNetwork or BetaLimitedNetworkParams or null`
Network configuration policy. Omit on update to preserve the existing value.
- `BetaUnrestrictedNetwork object { type }`
Unrestricted network access.
- `type: "unrestricted"`
Network policy type
- `"unrestricted"`
- `BetaLimitedNetworkParams object { type, allow_mcp_servers, allow_package_managers, allowed_hosts }`
Limited network request params.
Fields default to null; on update, omitted fields preserve the
existing value.
- `type: "limited"`
Network policy type
- `"limited"`
- `allow_mcp_servers: optional boolean or null`
Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array. Defaults to `false`.
- `allow_package_managers: optional boolean or null`
Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array. Defaults to `false`.
- `allowed_hosts: optional array of string or null`
Specifies domains the container can reach.
- `packages: optional BetaPackagesParams or null`
Specify packages (and optionally their versions) available in this environment.
When versioning, use the version semantics relevant for the package manager, e.g. for `pip` use `package==1.0.0`. You are responsible for validating the package and version exist. Unversioned installs the latest.
- `apt: optional array of string or null`
Ubuntu/Debian packages to install
- `cargo: optional array of string or null`
Rust packages to install
- `gem: optional array of string or null`
Ruby packages to install
- `go: optional array of string or null`
Go packages to install
- `npm: optional array of string or null`
Node.js packages to install
- `pip: optional array of string or null`
Python packages to install
- `type: optional "packages"`
Package configuration type
- `"packages"`
- `BetaSelfHostedConfigParams object { type }`
Request params for `self_hosted` environment configuration.
- `type: "self_hosted"`
Environment type
- `"self_hosted"`
- `description: optional string or null`
Updated description of the environment
- `metadata: optional map[string]`
User-provided metadata key-value pairs. Set a value to null or empty string to delete the key.
- `name: optional string or null`
Updated name for the environment
- `scope: optional "organization" or "account" or null`
The visibility scope for this environment. 'organization' makes the environment visible to all accounts. 'account' restricts visibility to the owning account only.
- `"organization"`
- `"account"`
### Returns
- `BetaEnvironment object { id, archived_at, config, 7 more }`
Unified Environment resource for both cloud and self-hosted environments.
- `id: string`
Environment identifier (e.g., 'env_...')
- `archived_at: string or null`
RFC 3339 timestamp when environment was archived, or null if not archived
- `config: BetaCloudConfig or BetaSelfHostedConfig`
Environment configuration (either Anthropic Cloud or self-hosted)
- `BetaCloudConfig object { networking, packages, type }`
`cloud` environment configuration.
- `networking: BetaUnrestrictedNetwork or BetaLimitedNetwork`
Network configuration policy.
- `BetaUnrestrictedNetwork object { type }`
Unrestricted network access.
- `type: "unrestricted"`
Network policy type
- `"unrestricted"`
- `BetaLimitedNetwork object { allow_mcp_servers, allow_package_managers, allowed_hosts, type }`
Limited network access.
- `allow_mcp_servers: boolean`
Permits outbound access to MCP server endpoints configured on the agent, beyond those listed in the `allowed_hosts` array.
- `allow_package_managers: boolean`
Permits outbound access to public package registries (PyPI, npm, etc.) beyond those listed in the `allowed_hosts` array.
- `allowed_hosts: array of string`
Specifies domains the container can reach.
- `type: "limited"`
Network policy type
- `"limited"`
- `packages: BetaPackages`
Package manager configuration.
- `apt: array of string`
Ubuntu/Debian packages to install
- `cargo: array of string`
Rust packages to install
- `gem: array of string`
Ruby packages to install
- `go: array of string`
Go packages to install
- `npm: array of string`
Node.js packages to install
- `pip: array of string`
Python packages to install
Cut at 300 lines. The page has the rest.
api/beta/environments/work First recorded · 1882 lines, first recorded
# Work ## Get Work Item ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Poll for Work ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Acknowledge Work ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Record Heartbeat ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Stop Work ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## List Work Items ### Path Parameters ### Query Parameters ### Header Parameters ### Returns ### Example #### Response ## Update Work Item ### Path Parameters ### Header Parameters ### Body Parameters ### Returns ### Example #### Response ## Get Queue Statistics ### Path Parameters ### Header Parameters ### Returns ### Example #### Response ## Domain Types ### Beta Self Hosted Work ### Beta Self Hosted Work Heartbeat Response ### Beta Self Hosted Work List Response ### Beta Self Hosted Work Queue Stats ### Beta Self Hosted Work Stop Request ### Beta Self Hosted Work Update Request ### Beta Session Work Data
The first capture of this source. The page was already there, and this is what it said.
---
title: Work
url: https://platform.claude.com/docs/en/api/beta/environments/work
---
# Work
## Get Work Item
**get** `/v1/environments/{environment_id}/work/{work_id}`
Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly.
Retrieve detailed information about a specific work item.
### Path Parameters
- `environment_id: string`
- `work_id: string`
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
- `"server-side-fallback-2026-06-01"`
- `"server-side-fallback-2026-07-01"`
- `"fallback-credit-2026-06-01"`
- `"fallback-credit-2026-07-01"`
- `"agent-memory-2026-07-22"`
- `"mid-conversation-tool-changes-2026-07-01"`
### Returns
- `BetaSelfHostedWork object { id, acknowledged_at, created_at, 10 more }`
Work resource representing a unit of work in a self-hosted environment.
Work items are queued when sessions are created or when long-dormant sessions
receive new messages. The environment worker polls for work to execute in a
self-hosted sandbox.
- `id: string`
Work identifier (e.g., 'work_...')
- `acknowledged_at: string or null`
RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox
- `created_at: string`
RFC 3339 timestamp when work was created
- `data: BetaSessionWorkData`
The actual work to be performed
- `id: string`
Session identifier (e.g., 'session_...')
- `type: "session"`
Type of work data
- `"session"`
- `environment_id: string`
Environment identifier this work belongs to (e.g., `env_...`)
- `latest_heartbeat_at: string or null`
RFC 3339 timestamp of the most recent heartbeat
- `metadata: map[string]`
User-provided metadata key-value pairs associated with this work item
- `secret: string or null`
Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths.
- `started_at: string or null`
RFC 3339 timestamp when work execution started
- `state: "queued" or "starting" or "active" or 2 more`
Current state of the work item
- `"queued"`
- `"starting"`
- `"active"`
- `"stopping"`
- `"stopped"`
- `stop_requested_at: string or null`
RFC 3339 timestamp when stop was requested
- `stopped_at: string or null`
RFC 3339 timestamp when work execution stopped
- `type: "work"`
The type of object (always 'work')
- `"work"`
### Example
```http
curl https://api.anthropic.com/v1/environments/$ENVIRONMENT_ID/work/$WORK_ID \
-H 'anthropic-version: 2023-06-01' \
-H 'anthropic-beta: managed-agents-2026-04-01' \
-H "X-Api-Key: $ANTHROPIC_API_KEY"
```
#### Response
```json
{
"id": "id",
"acknowledged_at": "acknowledged_at",
"created_at": "created_at",
"data": {
"id": "id",
"type": "session"
},
"environment_id": "environment_id",
"latest_heartbeat_at": "latest_heartbeat_at",
"metadata": {
"foo": "string"
},
"secret": "secret",
"started_at": "started_at",
"state": "queued",
"stop_requested_at": "stop_requested_at",
"stopped_at": "stopped_at",
"type": "work"
}
```
## Poll for Work
**get** `/v1/environments/{environment_id}/work/poll`
Note: these endpoints are called automatically by the pre-built environment worker provided in the SDKs and CLI, for orchestrating sessions with self-hosted sandbox environments. They are included here as a reference; you do not need to invoke them directly.
Long poll for work items in the queue.
### Path Parameters
- `environment_id: string`
### Query Parameters
- `block_ms: optional number`
How long to wait for work to arrive before returning. Must be 1-999 in milliseconds. Defaults to non-blocking (returns immediately if no work is available).
- `reclaim_older_than_ms: optional number`
Reclaim unacknowledged work items older than this many milliseconds. If omitted, uses the default (5000ms).
### Header Parameters
- `"anthropic-beta": optional array of AnthropicBeta`
Optional header to specify the beta version(s) you want to use.
- `string`
- `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 30 more`
- `"message-batches-2024-09-24"`
- `"prompt-caching-2024-07-31"`
- `"computer-use-2024-10-22"`
- `"computer-use-2025-01-24"`
- `"pdfs-2024-09-25"`
- `"token-counting-2024-11-01"`
- `"token-efficient-tools-2025-02-19"`
- `"output-128k-2025-02-19"`
- `"files-api-2025-04-14"`
- `"mcp-client-2025-04-04"`
- `"mcp-client-2025-11-20"`
- `"dev-full-thinking-2025-05-14"`
- `"interleaved-thinking-2025-05-14"`
- `"code-execution-2025-05-22"`
- `"extended-cache-ttl-2025-04-11"`
- `"context-1m-2025-08-07"`
- `"context-management-2025-06-27"`
- `"model-context-window-exceeded-2025-08-26"`
- `"skills-2025-10-02"`
- `"fast-mode-2026-02-01"`
- `"output-300k-2026-03-24"`
- `"user-profiles-2026-03-24"`
- `"advisor-tool-2026-03-01"`
- `"managed-agents-2026-04-01"`
- `"cache-diagnosis-2026-04-07"`
- `"dreaming-2026-04-21"`
- `"thinking-token-count-2026-05-13"`
Cut at 300 lines. The page has the rest.