API surface

API surface

The public control plane is designed around sandboxes, images, checkpoints, ports, and streams.

Status labels matter

This page describes the target public surface. The OpenAPI file in this repo marks each route as live, live-limited, planned, planned-alias, or live-internal; generated clients should preserve those labels.

POST /v1/desktops
GET  /v1/desktops
POST /v1/desktops/:id/connect
POST /v1/desktops/:id/checkpoint
POST /v1/desktops/:id/fork
POST /v1/desktops/:id/reset
GET  /v1/desktops/:id/ports/:port
POST /v1/images/build
POST /v1/images/import
GET  /v1/images

The repository OpenAPI spec marks each route with a Paperplanes status:

• live
• live-limited
• planned
• planned-alias
• live-internal

Generated SDKs should preserve those status labels so planned surfaces do not look production-ready by accident.