desktop

Start the sandbox's desktop and share a live view of it.

Starts Xvfb, a window manager, VNC on the sandbox's loopback and noVNC on port 6080, and returns streamUrl: a private preview link that opens the live desktop in a browser. Idempotent.

post/v1/sandboxes/{id}/desktop:start

Request

  • Base URL: https://api.withruntime.com
  • URL: https://api.withruntime.com/v1/sandboxes/{id}/desktop:start
  • Auth: HTTP bearer

Path parameters

idstring required

Resource identifier (UUID).

Headers

Idempotency-Keystring

Replaying the same key with the same request within 24 hours returns the first result and never repeats the effect. A refusal is not kept: a request refused before it ran (no_capacity, busy, a limit) runs afresh when sent again with its key. The SDKs send one automatically; the server makes one when absent and returns it in the idempotency-key response header.

Request body

widthinteger
heightinteger

Response

Success

okboolean required
displaystring
sizestring

WIDTHxHEIGHT.

streamUrlstring required

Opens the live desktop in a browser; carries a private preview token.

previewobject

Changes

No recorded changes to this operation across all 1 revision of this API.