Skip to main content
POST
Create a new workspace.
The workspace starts in provisioned status. Pass template_id to create it from a template; requested RAM, vCPU, and disk values below the template/catalog floor are raised before the workspace is stored. Call Start Workspace to boot it.

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
catalog_ids
string[] | null
disk_size_mb
integer<int32> | null
Required range: x >= 0
image
string | null
ram_mb
integer<int32> | null
Required range: x >= 0
service_spec_ids
string[] | null
setup_script_ids
string[] | null
template_id
string | null
vcpu_count
integer<int32> | null
Required range: x >= 0

Response

201 - application/json

Workspace created

vm
object
required
failure
null | object

Structured failure info when vm.status == Failed. None otherwise. Computed from the workspace's failure_code, failure_reason, and creation_attempts fields plus the retryable allowlist policy.