Skip to main content
POST
Start a Computer

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version
enum<string>
required
Available options:
2026-08-31
idempotency-key
string
Maximum string length: 255

Path Parameters

id
string
required
Pattern: ^comp_[0-9a-f]{32}$

Response

A persistent, Workspace-owned instance of an Environment that Sessions attach through resources[].

A persistent, Workspace-owned instance of an Environment that Sessions attach through resources[].

type
enum<string>
required
Available options:
computer
id
string
required
Pattern: ^comp_[0-9a-f]{32}$
name
string
required
Required string length: 1 - 256
environment_id
string
required
Pattern: ^env_[0-9a-f]{32}$
status
enum<string>
required

Public Computer lifecycle: provisioning, running, sleeping (disk retained, no compute), stopping, or archived.

Available options:
provisioning,
running,
sleeping,
stopping,
archived
config
object
required

The Computer's immutable machine shape.

idle_policy
object
required

Seconds without an attached Session or viewer before a running Computer sleeps; null never sleeps it automatically.

metadata
object
required

at most 16 correlation pairs with keys of 1 to 64 characters

created_at
string
required
updated_at
string
required
archived_at
string | null
required