Skip to main content

GET /api

Returns service metadata plus the current caller (if authenticated).
  • Auth – optional session cookie or API key.
  • Response
Use this endpoint as a health check before attempting privileged operations.

GET /:project/api

Project-scoped equivalent of the root endpoint.
  • Path paramproject accepts a slug or UUID; it is resolved via database.projects.resolve.
  • Auth – optional, but the response only includes the project payload when you have the projects.read permission for that slug.
  • Response

Error shape

Validation errors and rejected permission checks use the same JSON envelope:
Unexpected failures fall back to HTTP 500 with the same structure. Always check the status property before trusting other fields.