Exact backend contracts live in the API reference.

Entry points

Reference surfaces

Use the interactive backend reference for exact schemas. Use this page for orientation.

Interactive API docs

Use the backend Scalar route for exact request and response contracts.

OpenAPI JSON

Download the backend OpenAPI document for generated clients or inspection.

Mock runtime

Generated mock endpoints live under /mock/{projectId}/{path}.

Authenticated project APIs

Project, schema, settings, member, and log routes require an authenticated GhostAPI session.

Route map

Backend families

The application API is grouped by product capability rather than raw database tables.

Auth

Register, login, refresh, logout, CSRF, password reset, verification, and invitation acceptance.

Projects

Create, read, update, delete, configure, and list project-owned resources.

Schemas

Upload, validate, replace, version, and inspect OpenAPI schemas.

Members

Invite users, preview recipients, accept invitations, and manage project roles.

Mock runtime

Serve generated routes, saved responses, generated responses, request logs, and runtime behavior.

Example

Mock runtime URL

Project mock routes are normal HTTP URLs and can be called by frontend code or cURL.