HTTP API
Open a desktop WebRTC signaling session.
GET /v1/desktop/stream/signaling
GET
/v1/desktop/stream/signaling
Upgrades the connection to a WebSocket used for WebRTC signaling between the browser client and the desktop streaming process. Also accepts mouse and keyboard input frames as a fallback transport.
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” access_token
string
Bearer token alternative for WS auth
Responses
Section titled “ Responses ”WebSocket upgraded
Desktop runtime or streaming session is not ready
object
detail
string
instance
string
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties
Desktop stream failed
object
detail
string
instance
string
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties