Skip to content
Workloom
Menu

Registry API

Workspaces

Create and update workspaces, and preview a render plan on the server.

A workspace is stored as numbered workspace revisions. `wl bind` and `wl pull` read these routes.

The render-preview route computes the same render plan the CLI prints, without writing anything.

Operations

Workspaces operations
RequestWhat it does
GET /api/workspacesList workspaces
POST /api/workspacesCreate a workspace
GET /api/workspaces/{id}Get a workspace
PUT /api/workspaces/{id}Update a workspace
GET /api/workspaces/{id}/render-previewPreview the workspace’s render plan

Operations are exactly those in the committed OpenAPI document (packages/workloom-api/openapi.json), which matches the route definitions; this site checks its list against both. Paths are under the API host. Public, approved packages and profiles can be read without a token; everything else needs one.