Stream the environment's desktop live

Upgrades the connection to fuse-vnc/1 and relays a raw RFB (VNC) byte stream between the caller and the vnc server inside the guest, both directions, until either end closes. This is the live view of the desktop, and — because RFB carries input — human takeover of a session an agent is driving.

Handshake. The request must carry Upgrade: fuse-vnc/1 (and, per HTTP, Connection: Upgrade). On success the server answers 101 Switching Protocols; the first byte after the response head is the first byte of the vnc server’s RFB greeting. There is no frame protocol on top: the stream is RFB verbatim, so any VNC client can speak it once the upgrade and bearer auth are handled (the fuse desktop CLI command wraps this in a browser viewer).

The vnc server inside the guest binds localhost only; this authed route is the only way to reach it. Unlike exec and attach this accepts API keys, for the same reason the computer action route does: the stream views and drives the same display an API key can already drive click by click.

An open stream counts as environment activity for as long as it is open, so a watched-but-idle desktop is not reaped.

While a human holds a takeover (or an ask stall waits to be acked) the stream answers 423 locked, like the agent’s computer actions: input sent on it would get past the lock. A takeover holder’s view is GET /v1/interventions/{interventionId}/desktop.

curl -X GET "http://localhost:8080/v1/environments/string/computer/stream" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("http://localhost:8080/v1/environments/string/computer/stream", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8080/v1/environments/string/computer/stream",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

{
  "error": {
    "code": "not_found",
    "message": "string",
    "details": {}
  }
}

{
  "error": {
    "code": "not_found",
    "message": "string",
    "details": {}
  }
}

{
  "error": {
    "code": "not_found",
    "message": "string",
    "details": {}
  }
}

{
  "error": {
    "code": "not_found",
    "message": "string",
    "details": {}
  }
}

{
  "error": {
    "code": "not_found",
    "message": "string",
    "details": {}
  }
}

{
  "error": {
    "code": "not_found",
    "message": "string",
    "details": {}
  }
}

{
  "error": {
    "code": "not_found",
    "message": "string",
    "details": {}
  }
}