How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Anthropic Environments API

Container configuration for agent sessions

Anthropic Environments API is one of 29 APIs that Anthropic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Environment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

This API exposes 19 operations across 13 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.anthropic.com.

19 operations 13 paths 35 schemas 2 DELETE8 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.anthropic.com/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Anthropic Environments API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth).

Paths & Operations 19

Across 13 paths, the API surfaces 19 operations — 2 DELETE, 8 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Environments 19
POST
/v1/environments/{environment_id}/archive?beta=true
Archive Environment
beta_archive_environment_v1_environments__environment_id__archive_post 3 params → 2004XX
GET
/v1/environments/{environment_id}/work/poll?beta=true
Poll for Work
beta_poll_work_v1_environments__environment_id__work_poll_get 7 params → 2004XX
GET
/v1/environments/{environment_id}/work/stats?beta=true
Get Queue Statistics
beta_get_environment_stats_v1_environments__environment_id__work_stats_get 5 params → 2004XX
POST
/v1/environments/{environment_id}/work/{work_id}/ack?beta=true
Acknowledge Work
beta_acknowledge_work_v1_environments__environment_id__work__work_id__ack_post 5 params → 2004XX
POST
/v1/environments/{environment_id}/work/{work_id}/heartbeat?beta=true
Record Heartbeat
beta_record_heartbeat_v1_environments__environment_id__work__work_id__heartbeat_post 7 params → 2004XX
POST
/v1/environments/{environment_id}/work/{work_id}/stop?beta=true
Stop Work
beta_stop_work_v1_environments__environment_id__work__work_id__stop_post 5 params body → 2004XX
GET
/v1/environments/{environment_id}/work/{work_id}?beta=true
Get Work Item
beta_get_work_v1_environments__environment_id__work__work_id__get 5 params → 2004XX
POST
/v1/environments/{environment_id}/work/{work_id}?beta=true
Update Work Item
beta_update_work_v1_environments__environment_id__work__work_id__post 4 params body → 2004XX
GET
/v1/environments/{environment_id}/work?beta=true
List Work Items
beta_list_work_v1_environments__environment_id__work_get 6 params → 2004XX
GET
/v1/environments/{environment_id}?beta=true
Get Environment
beta_get_environment_v1_environments__environment_id__get 4 params → 2004XX
POST
/v1/environments/{environment_id}?beta=true
Update Environment
beta_update_environment_v1_environments__environment_id__post 3 params body → 2004XX
DELETE
/v1/environments/{environment_id}?beta=true
Delete Environment
beta_delete_environment_v1_environments__environment_id__delete 4 params → 2004XX
POST
/v1/environments?beta=true
Create Environment
beta_create_environment_v1_environments_post 2 params body → 2004XX
GET
/v1/environments?beta=true
List Environments
beta_list_environments_v1_environments_get 6 params → 2004XX
POST
/v1/environments
Anthropic Create Environment
createEnvironment 2 params body → 200
GET
/v1/environments
Anthropic List Environments
listEnvironments 2 params → 200
GET
/v1/environments/{environment_id}
Anthropic Get Environment
getEnvironment 3 params → 200
DELETE
/v1/environments/{environment_id}
Anthropic Delete Environment
deleteEnvironment 3 params → 200
POST
/v1/environments/{environment_id}/archive
Anthropic Archive Environment
archiveEnvironment 3 params → 200

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are BetaSelfHostedWork (13 properties), BetaEnvironment (10 properties), BetaPackagesParams (7 properties), BetaPackages (7 properties). Each schema is shown below with its type and property counts.

BetaSelfHostedConfig
object
Configuration for self-hosted environments.
1 property 1 required
BetaSelfHostedWorkStopRequest
object
Request to stop a work item.
1 property
BetaInvalidRequestError
object
2 properties 2 required
BetaPermissionError
object
2 properties 2 required
BetaSelfHostedWorkListResponse
object
Response when listing work items with cursor-based pagination.
2 properties 2 required
BetaUnrestrictedNetwork
object
Unrestricted network access.
1 property 1 required
BetaRateLimitError
object
2 properties 2 required
BetaSelfHostedWorkUpdateRequest
object
Request to update work item metadata.
1 property 1 required
BetaCloudConfigParams
object
Request params for cloud environment configuration. Fields default to null; on update, omitted fields preserve the existing value.
3 properties 1 required
BetaNotFoundError
object
2 properties 2 required
BetaEnvironment
object
Unified Environment resource for both cloud and self-hosted environments.
10 properties 9 required
BetaCloudConfig
object
cloud environment configuration.
3 properties 3 required
BetaOverloadedError
object
2 properties 2 required
BetaPublicEnvironmentUpdateRequest
object
Public API request to update an environment (without org/account fields).
5 properties
BetaSessionWorkData
object
Work data for session work items. This resource type is used when work represents a session that needs to be executed in a self-hosted environment.
2 properties 2 required
BetaAuthenticationError
object
2 properties 2 required
BetaSelfHostedWork
object
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 n…
13 properties 13 required
BetaEnvironmentListResponse
object
Response when listing environments. This response model uses opaque cursor-based pagination. Use the page query parameter with the value from nextpage to fetch…
2 properties 2 required
BetaBillingError
object
2 properties 2 required
BetaSelfHostedWorkHeartbeatResponse
object
Response after recording a heartbeat for a work item.
5 properties 5 required
BetaEnvironmentDeleteResponse
object
Response after deleting an environment.
2 properties 2 required
BetaGatewayTimeoutError
object
2 properties 2 required
BetaSelfHostedWorkQueueStats
object
Statistics about the work queue for an environment. Uses Redis Stream consumer group metrics for O(1) queries.
5 properties 5 required
BetaAPIError
object
2 properties 2 required
BetaLimitedNetworkParams
object
Limited network request params. Fields default to null; on update, omitted fields preserve the existing value.
4 properties 1 required
BetaPackagesParams
object
Specify packages (and optionally their versions) available in this environment. When versioning, use the version semantics relevant for the package manager, e.…
7 properties
BetaPublicEnvironmentCreateRequest
object
Public API request to create a new environment (without org/account fields).
5 properties 1 required
BetaPackages
object
Packages (and their versions) available in this environment.
7 properties 6 required
AnthropicBeta
BetaSelfHostedConfigParams
object
Request params for selfhosted environment configuration.
1 property 1 required
BetaErrorResponse
object
3 properties 3 required
BetaLimitedNetwork
object
Limited network access.
4 properties 4 required
Environment
object
6 properties
CreateEnvironmentRequest
object
2 properties 2 required
EnvironmentList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

anthropic-environments-api-openapi.yml Raw ↑

Other APIs Anthropic publishes across the network.

Anthropic Messages API
Anthropic Models API
Anthropic Files API
Anthropic Skills API
Anthropic Agents API
Anthropic Api Keys API
Anthropic Cost API
Anthropic Events API
Anthropic Organization API
Anthropic Organization Invites API
Anthropic Organization Members API
Anthropic Prompt Generation API
Where this information came from

This is an independent, third-party profile of Anthropic Environments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.