Sign in

v1

latestOpenAPI 3.1.02026-07-175096.6 KB
Desktop

Create a new virtual desktop instance

Creates a new virtual desktop instance and returns its ID and stream URL

post/v1/desktop

Headers

x-api-keystring required

API key for authentication

Example:api_12345

Request body

timeout_msinteger

Timeout in milliseconds for the desktop session

Example request

{
  "timeout_ms": 3600000
}

Response

Desktop creation initiated successfully

idstring required

Unique identifier for the desktop instance

status'pending' | 'running' | 'terminated' | 'error' required

Initial status of the desktop instance after creation request

Example response

{
  "id": "desktop_12345",
  "status": "pending"
}