Skip to main content
POST
Create a machine

Authorizations

Authorization
string
header
required

Agent token (alt_…) or OAuth access token; bound to one agent

Body

application/json
agent_id
string

Owning agent; required for organization keys, implied for agent tokens

Minimum string length: 1
name
string

Display name; defaults to ' machine'

Maximum string length: 80
size
enum<string>

small = 2 vCPU/4 GB (0.5× rate), default = 4 vCPU/8 GB (1×), large = 8 vCPU/16 GB (2×). Plans limit the sizes

Available options:
small,
default,
large
ttl_seconds
integer

Auto-stop after this many seconds of wall-clock time (default 3600). Every machine stops itself; plans cap the window

Required range: 60 <= x <= 9007199254740991
env
object

Environment variables for the machine (at most 40, 32 KB in total)

inject_credential_ids
string[]

Vault credentials to inject as _USERNAME/_PASSWORD or _API_KEY variables; the values never pass through the caller

Maximum array length: 10
Minimum string length: 1
agent_token_capabilities
string[]

Mint an agent token with these capabilities and place it in AGENT_LOADOUT_TOKEN inside the machine. An agent connection can delegate only its granted permissions; reconnect and obtain explicit consent before requesting additional capabilities.

Maximum array length: 10
Maximum string length: 40
setup_script
string

Shell script run once after the machine is ready

Maximum string length: 65536
from_machine_id
string

Fork this machine's latest snapshot instead of starting from a fresh Ubuntu

Minimum string length: 1
idempotency_key
string

Repeat a request with the same key to get the same machine instead of a second one

Maximum string length: 200

Response

Provisioning

machine
object
required