HTTP API

Build & test environments with hard TTLs, typed failure causes, export-that-survives-teardown, and per-second metering. Everything non-preemptible. Version 0.1.0. Generated from the OpenAPI spec. Machine-readable at /openapi.json, also served live by the control plane at GET /openapi.json. Auth is a bearer key: Authorization: Bearer nk_.... Errors carry typed causes: {"detail": {"cause", "message"}}.

templates

POST/v1/templates

Create Template

Request body

name*string
source*TemplateSource
GET/v1/templates

List Templates

GET/v1/templates/{tpl_id}

Get Template

roms

POST/v1/roms

Create Rom

Request body

name*string
files*objectpath -> utf-8 content. Bundled into a read-only, content-addressed tar mounted at /rom.

capacity

GET/v1/capacity

Get Capacity

POST/v1/reservations

Create Reservation

Request body

vcpu*integer
mem_gib*number
count*integer
duration_minutesinteger
labelsobject

sandboxes

POST/v1/sandboxes

Create Sandbox

Request body

template_idobject
imageobject
rom_idobject
vcpuinteger
mem_gibnumber
ttl_secondsinteger0 = platform default; enforced server-side, absolute
launch_tokenobjectidempotency key
labelsobject
networkNetworkPolicy
envobject
exportobject
GET/v1/sandboxes

List Sandboxes

GET/v1/sandboxes/{sb_id}

Get Sandbox

DELETE/v1/sandboxes/{sb_id}

Destroy Sandbox

GET/v1/sandboxes/{sb_id}/events

Sandbox Events

POST/v1/sandboxes/{sb_id}/exec

Exec In Sandbox

Request body

command*string
timeout_secnumber
cwdobject
envobject
userobject
GET/v1/sandboxes/{sb_id}/logs

Sandbox Logs

POST/v1/sandboxes/{sb_id}/suspend

Suspend Sandbox

POST/v1/sandboxes/{sb_id}/resume

Resume Sandbox

POST/v1/sandboxes/{sb_id}/export

Export From Sandbox

Export a path from the sandbox — including after it terminated. This is the primitive that kills the reaped-mid-upload failure class.

Request body

path*string
toobjects3://bucket/prefix or blank for the hosted artifact store
PUT/v1/sandboxes/{sb_id}/files

Put File

Request body

path*string
content_b64*string
GET/v1/sandboxes/{sb_id}/files

Get File

usage

GET/v1/usage

Get Usage

GET/v1/pricing

Get Pricing

meta

GET/v1/healthz

Healthz