Skip to content

API Reference

The Multiverse Echoes API surface as an interactive OpenAPI 3.1 reference. Two surfaces ship the same spec:

  • Runtime / live — GET /api/docs serves the spec produced by the deployed binary; /api/docs/ui is the Swagger UI rendering. Always reflects the running deployment, including any deployed-but-undocumented changes.
  • Static / snapshot — the rendering below is the spec captured at the last MkDocs build. Driven by Redoc for differentiation from the runtime Swagger UI surface; both render identical OpenAPI but Redoc is friendlier for read-only browsing.

The static spec is regenerated on every push to main that touches crates/api/src/routes/**, crates/api/src/openapi_schemas.rs, or this developer-portal directory — see .github/workflows/deploy-developer-portal.yml.

Authentication

Authenticated endpoints accept two schemes:

  • Authorization: Bearer <jwt>;
  • Authorization: ApiKey <token>, with a key created by POST /account/me/api-keys.

An endpoint can require a scope. An API key without that scope gets 403 with the error code API_KEY_SCOPE_REQUIRED. A JWT is not checked for scopes.

An admin account can authenticate only with a JWT. WebSocket routes also take only a JWT, passed as ?token=<jwt>.

The security label on each endpoint below lists only the JWT. The labels are being corrected to show the API key as well. Until then, the rules above apply.