OpenAPI & interactive docs

The API service in this monorepo exposes standard FastAPI documentation. Treat the OpenAPI document as the contract for what your deployment actually serves—paths and schemas can differ by version and configuration.

Where to look

Interactive UI: GET /docs on the API host (Swagger UI).
Machine-readable spec: GET /openapi.json
Automation surface: /api/v1/autonomy/… (see the spec for exact operation IDs and bodies).

Tip

If you only expose the API through the Next.js host, you typically configure a reverse proxy or use server-side calls. The browser-facing rewrites in this repo point /api/backend/* at /api/v1/* on the API—they do not automatically expose /docs on the same origin unless you add a route or proxy for it.

Download the spec with curl

bash

curl -sS http://localhost:8000/openapi.json -o openapi.json
# List path keys (requires jq)
jq -r '.paths | keys[]' openapi.json | head

Generating clients

You can feed openapi.json to code generators (OpenAPI Generator, openapi-typescript, etc.) for typed clients. Prefer generating from the spec that matches your running deployment, not a stale copy checked into docs.

Authentication in the explorer

Secured operations may require headers or cookies as defined in the spec and your auth setup. See Authentication and API overview.

API overview · Web app & API proxies · SDK and client libraries