---
title: "Start the sandbox's desktop and share a live view of it."
method: POST
path: "/v1/sandboxes/{id}/desktop:start"
tags: ["desktop"]
---

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

`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

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.

## Path parameters

- `id` string, required: Resource identifier (UUID).

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `width` integer
  - `height` integer

## Response `200`

Success

- object
  - `ok` boolean, required
  - `display` string
  - `size` string: WIDTHxHEIGHT.
  - `streamUrl` string, required: Opens the live desktop in a browser; carries a private preview token.
  - `preview` object

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/withruntime/apis/runtime-cloud-api.md) · [All operations](https://skmtc.dev/withruntime/apis/runtime-cloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/withruntime/apis/runtime-cloud-api/revisions/6f4012286988?raw)