REST APIAPI reference
Setup
Instance status, signup and plans
6 operations, generated from apps/api/openapi.yaml (OpenAPI 3.2). Each page has the parameters, request body, responses and code samples, and a Send button to try the request against your cloud instance.
- GET
/healthLiveness and database check - GET
/openapi.yamlThis OpenAPI document - GET
/v1/setupWhether the workspace has been created - POST
/v1/workspacesCreate a cloud workspaceCreate a cloud workspace (with billing it has no plan until a subscription starts; without billing the server-side trial) - GET
/v1/plansCloud plans and their limitsCloud plans and their limits (-1 = unlimited) - POST
/mcpMCP Streamable HTTP endpointMCP Streamable HTTP endpoint (stateless; bearer access token in the Community Edition, bearer API key in cloud mode)