Skip to main content
GET
Get Machine

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Path Parameters

machine
string
required

Query Parameters

wait
number
default:0

Wait up to N seconds for it to become ready.

Required range: 0 <= x <= 60

Response

Successful Response

id
string
required

The machine id (mch_…). Every route also takes the machine's name.

name
string
required

The name.

status
enum<string>
required

The state (see the enum).

Available options:
starting,
ready,
paused,
released,
failed
gpu
string
required

The GPU model, e.g. RTX-PRO-6000.

image
string
required

The machine image (GET /v1/machines/images).

preset
string | null
required

The preset it matches (render, render-lite, compute), if any.

created_at
string | null
required

When it was created (ISO 8601).

ready_at
string | null
required

When it became ready.

idle_timeout
integer | null
required

Seconds without a command or file transfer before it pauses.

cost
MachineCost · object
required

What it has cost so far.

next
string
required

What to do next, for agents.

error
MachineFailure · object | null

Why it failed, when it failed.