Skip to main content
POST
Create an environment

Authorizations

Authorization
string
header
required

API key with the vk_ prefix. Create one from the dashboard.

Body

application/json

The environment spec as submitted. Also the body of POST /v1/environments/{id}/versions.

name
string
required

[a-z0-9][a-z0-9_-]{0,63}, unique per workspace.

harness
string | null

claude-code (the only harness today).

model
object

Where the harness sends model calls.

size
string | null

small | standard (default) | large.

egress
string | null

restricted (default) | unrestricted.

allowed_hosts
string[]

Extra hostnames a restricted session may reach.

env
object

Plain environment variables for the harness.

secrets
string[]

Secret names injected as environment variables named after them (or attached per host when the secret has a scope_host).

mcp_servers
object[]
skills
string[]

Skill names, optionally pinned: name (latest) or name@3.

permissions
object
idle_timeout_s
integer<int64> | null

Seconds without input before the session snapshots and pauses (60 .. 21600, default 900).

description
string | null

Response

The environment with version 1

object
string
required
id
string
required
name
string
required
latest_version
integer<int32>
required
created_by
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
version
object
required

The latest version unless ?version= asked for another.

description
string | null