Skip to main content

API Reference

The REST API reference is generated from the platform's OpenAPI (springdoc) so it always matches the code — it is not hand-written.

Until the generated reference is wired into this site (via redocusaurus, fed by an openapi.json dumped in CI — see docs/README.md), use the running application's built-in reference:

  • Swagger UI: /swagger-ui.html
  • OpenAPI JSON: /v3/api-docs

Each feature's how-it-works page links here and lists its endpoint groups under its /api/v1/<engine> prefix.