Environment object
Returned by create, get, list, update, and archive endpoints.| Field | Type | Description |
|---|---|---|
id | string | Environment ID with the env_ prefix |
type | string | Always "environment" |
name | string | Environment name |
description | string | Environment description |
config | Environment config | Environment configuration |
metadata | object | Metadata object. Defaults to {} |
status | string | Environment status. Valid values: ready, archived |
archived | boolean | Whether the Environment is archived |
archived_at | string | null | Archive time in UTC, or null when not archived |
created_at | string | Creation time in UTC |
updated_at | string | Last update time in UTC |
Environment config
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Must be "cloud" |
networking | Environment networking | No | Network access configuration |
packages | Environment packages | No | Dependencies to install when a session sandbox is prepared |
Environment packages
packages maps supported package managers to arrays of package spec strings. Supported keys are apt, pip, and npm; other keys are not installed by the current environment preparation flow.
| Key | Type | Description | Example |
|---|---|---|---|
apt | array of string | Debian/Ubuntu system packages installed with apt-get install -y | ["git", "curl", "build-essential"] |
pip | array of string | Python packages installed with pip install | ["pandas", "PyYAML==6.0.1"] |
npm | array of string | Node.js packages installed globally with npm install -g | ["typescript@5.0.0", "eslint"] |
Environment networking
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Valid values: limited, unrestricted |
Related
Cloud environment setup
Choose the container, network, and dependencies your agent runs in.