The environment object

⚠️

Preview — this feature is being built; the design below is the spec.

The environment object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "env_01JC5B2D4F6H8K0M2P4R",
  "type": "environment",
  "name": "data-analysis",
  "base_image": "syntic/python:3.12",
  "packages": {
    "apt": [
      "git"
    ],
    "pip": [
      "pandas==2.2.3",
      "matplotlib"
    ],
    "npm": []
  },
  "setup_script": "mkdir -p /workspace/out",
  "files": [],
  "network": {
    "mode": "none",
    "allowed_hosts": []
  },
  "resources": {
    "cpu": 2,
    "memory_mb": 4096,
    "disk_mb": 10240
  },
  "timeouts": {
    "command_seconds": 300,
    "idle_minutes": 15,
    "max_lifetime_minutes": 240
  },
  "env_vars": {
    "TZ": "UTC"
  },
  "vault_secrets": [],
  "build": {
    "status": "ready",
    "image_digest": "sha256:9f2c...",
    "finished_at": "2026-11-04T08:12:40Z",
    "error": null
  },
  "created_at": "2026-11-04T08:10:02Z",
  "updated_at": "2026-11-04T08:10:02Z"
}

Fields

Field	Type	Description
`id`	string	Unique id of this object.
`type`	string	The object type, always `environment`.
`name`	string	Name shown in the Console and in reports.
`base_image`	string	See the endpoint pages below.
`packages`	object	Nested detail; see the endpoint pages below.
`setup_script`	string	See the endpoint pages below.
`files`	array	Nested detail; see the endpoint pages below.
`network`	object	Nested detail; see the endpoint pages below.
`resources`	object	Nested detail; see the endpoint pages below.
`timeouts`	object	Nested detail; see the endpoint pages below.
`env_vars`	object	Nested detail; see the endpoint pages below.
`vault_secrets`	array	Nested detail; see the endpoint pages below.
`build`	object	Nested detail; see the endpoint pages below.
`created_at`	string	When it was created, RFC 3339 UTC (some older objects use Unix seconds).
`updated_at`	string	When it last changed.

Returned by

encryption_key eval_dataset

Was this page helpful?