GET
/docs/
Help docs
This page. Lists all available routes, environment variables, and links to detailed docs for each area.
Core routes
GET /healthGET /db/healthGET /tenant/*
Payment routes
POST /paymentPOST /payment/webhookGET /docs/payments
Space routes
GET /spacePOST /spaceGET /space/:idPATCH /space/:idDELETE /space/:idGET /space/:id/meGET /space/:id/usersGET /space/:id/users/:userIdPATCH /space/:id/users/:userIdDELETE /space/:id/users/:userIdGET /space/:id/invitesPOST /space/:id/inviteDELETE /space/:id/invite/:inviteIdPOST /space/:id/invite/acceptGET /docs/spaces
Model routes
GET /modelsGET /models/:idPOST /modelsPUT /models/:idDELETE /models/:idPOST /models/:id/validatePOST /models/:id/validate-changeGET /models/:id/contentGET /docs/models
Content routes
GET /contentGET /content/:idPOST /contentPUT /content/:idDELETE /content/:idGET /content/:id/resolvedGET /content/:id/referencesGET /docs/content
API key routes
POST /space/:id/keysGET /space/:id/keysDELETE /space/:id/keys/:keyIdGET /docs/keys
MCP routes
POST /mcpGET /docs/mcp
GET
/health
Service health
Returns the service status and deployment timestamp. No authentication required.
Request
Nothing required. No headers, body, or query parameters.
Response
{
"service": "sample",
"status": "ok",
"deployed_at": "unknown"
}
GET
/db/health
Database health
Verifies the API can acquire a connection from the MySQL pool and execute a query. Returns 503 if the connection fails.
Request
Nothing required. No headers, body, or query parameters.
Response
{
"service": "sample",
"status": "ok",
"deployed_at": null,
"message": "Database connection successful",
"database": "your_db"
}
Returns 503 with "status": "error" when the connection fails.