Skip to main content
POST
/
v1
/
desktop
/
start
Start the private desktop runtime.
curl --request POST \
  --url http://localhost:2468/v1/desktop/start \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayNum": 123,
  "dpi": 1,
  "height": 1,
  "recordingFps": 1,
  "stateDir": "<string>",
  "streamAudioCodec": "<string>",
  "streamFrameRate": 1,
  "streamVideoCodec": "<string>",
  "webrtcPortRange": "<string>",
  "width": 1
}
'
{
  "state": "inactive",
  "display": "<string>",
  "installCommand": "<string>",
  "missingDependencies": [
    "<string>"
  ],
  "processes": [
    {
      "name": "<string>",
      "running": true,
      "logPath": "<string>",
      "pid": 1
    }
  ],
  "runtimeLogPath": "<string>",
  "startedAt": "<string>",
  "windows": [
    {
      "height": 1,
      "id": "<string>",
      "isActive": true,
      "title": "<string>",
      "width": 1,
      "x": 123,
      "y": 123
    }
  ]
}

Body

application/json
​
displayNum
integer<int32> | null
​
dpi
integer<int32> | null
Required range: x >= 0
​
height
integer<int32> | null
Required range: x >= 0
​
recordingFps
integer<int32> | null
Required range: x >= 0
​
stateDir
string | null
​
streamAudioCodec
string | null
​
streamFrameRate
integer<int32> | null
Required range: x >= 0
​
streamVideoCodec
string | null
​
webrtcPortRange
string | null
​
width
integer<int32> | null
Required range: x >= 0

Response

Desktop runtime status after start

​
state
enum<string>
required
Available options:
inactive,
install_required,
starting,
active,
stopping,
failed
​
display
string | null
​
installCommand
string | null
​
lastError
object
​
missingDependencies
string[]
​
processes
object[]
​
resolution
object
​
runtimeLogPath
string | null
​
startedAt
string | null
​
windows
object[]

Current visible windows (included when the desktop is active).