Skip to content

OpenAPI Specification

The interactive reference below is rendered from the openapi.json asset attached to the latest GitHub release, baked into this site when the docs were built. It describes every endpoint under /api/v1 and is generated directly from the Rust API source, so it stays in sync without committing a large generated file to the repository.

Download the raw openapi.json for the latest release

Versioning and offline use

This page reflects the latest released version, not unreleased changes on main. The authoritative contract for your deployment is always the running API itself: GET /api/v1/openapi.json with interactive Swagger UI at /api/docs. In air-gapped environments, fetch the spec from your own server instead of the release download link above:

curl -s http://localhost:8000/api/v1/openapi.json -o openapi.json