Start (or reuse) a live `vite dev` preview for this app
POST
/api/workspaces/{workspaceId}/apps/{id}/dev-preview
const url = 'http://localhost:8080/api/workspaces/example/apps/example/dev-preview';const options = { method: 'POST', headers: {cookie: 'auth_session=<auth_session>', 'Content-Type': 'application/json'}, body: '{"restart":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:8080/api/workspaces/example/apps/example/dev-preview \ --header 'Content-Type: application/json' \ --cookie auth_session=<auth_session> \ --data '{ "restart": true }'Live dev preview (apps.md §12.4). Installs dependencies (npm or pnpm, per the app’s lockfile) if needed, starts a persistent vite dev inside the app’s sandbox, and returns the sandbox’s own public origin for the browser to iframe — HMR rides that origin, so edits show up with no rebuild step and nothing of the tenant’s runs on the API host.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”workspaceId
required
string
id
required
string
Request Body
Section titled “Request Body”Media typeapplication/json
object
restart
Stop the running server first and boot a fresh one (new launcher, clean state). Without it a running server is reused.
boolean
Example generated
{ "restart": true}Responses
Section titled “Responses”Successful response
Media typeapplication/json
object
success
Whether the request succeeded.
boolean
data
Endpoint-specific response payload.
message
string
error
string
Example
{ "message": "Operation completed", "error": "Error message"}Invalid request
Media typeapplication/json
object
success
boolean
error
string
Example
{ "error": "Error message"}Internal server error
Media typeapplication/json
object
success
boolean
error
string
Example
{ "error": "Error message"}