Control Plane
Create Desktop
Provision a new VM environment
POST
Creates and initializes a new desktop environment. Runs as a background task and returns immediately with a task ID for status polling. Supports multiple VMs simultaneously (max 16).
Returns
429 Too Many Requests if the maximum number of concurrent environments is reached.
Request Body
string
default:"docker"
VM provider
string
default:"Ubuntu"
Operating system (
Ubuntu, Windows, macOS)string
Remote server IP (for remote VMs)
integer
Remote server port
boolean
default:"false"
Enable accessibility tree
boolean
default:"false"
Enable terminal access
integer
default:"3600"
Session timeout in seconds
Response
string
Request status (
accepted)string
Status message
string
Unique identifier for the VM
string
Background task ID for status polling
string
URL to check task status