Where to open the live desktop

Returns the WebSocket address of the gateway. The stream is RFB over WebSocket straight to the gateway, authenticated with a view or control token in the query string. This endpoint only tells you the address; it needs COMPUTER_GATEWAY_PUBLIC_URL to be configured.

GET/v1/computers/{id}/stream

Authorization

AuthorizationBearer token (JWT) · headerrequired

Bearer API key issued for your account. Send Authorization: Bearer <key>.

Path parameters

idstringrequired

Computer id returned by POST /v1/computers.

Responses

200

Gateway response, passed through as JSON.

object

400

Bad request

string

401

Missing or invalid bearer token

string

403

Billing or plan entitlement blocked the request

string

404

No such computer for this account.

502

Upstream service (arXiv, YouTube, web page) failed

string

503

The backing service is not configured or is busy

string

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

idpath*Computer id returned by `POST /v1/computers`.

Request

curl -X GET 'https://api.webfold.ai/v1/computers/string/stream' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

import requests

response = requests.get(
    "https://api.webfold.ai/v1/computers/string/stream",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

const response = await fetch("https://api.webfold.ai/v1/computers/string/stream", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

Response

{}

"string"

"string"

"string"

"string"

"string"