API Reference

This reference is generated from the backend’s route definitions (catalyst-backend/scripts/export-openapi.ts → api/openapi.json), so it tracks the code instead of drifting from it. Every operation also carries an x-catalyst block with the source file and line, the permissionGuards it enforces, and the errorCodes it can return.

Note

The contract also lists the long-lived SSE endpoints (console, server events, metrics, admin events, node agent logs) with their status codes. The event names and payloads they push are in Realtime events.

Note

The viewer loads from a CDN with JavaScript enabled. Offline or script-blocked readers can use the raw openapi.json with any OpenAPI tool.