OpenAPI

Fetch Miravo's generated admin API contract from the runtime or the repo, then reuse the same schema across tooling.

Miravo generates one OpenAPI document for the admin API. The same contract backs the live /openapi.json route, the checked-in docs/api/openapi.json artifact, and the console's generated admin route map.

Fetch the live document

curl -s http://127.0.0.1:8080/openapi.json | jq .

GET /openapi.json does not require authentication.
Standalone binaries serve an embedded copy of the document.
The default admin server publishes the route on port 8080.

Regenerate from source

bun run gen:openapi

Route metadata lives in packages/shared/src/admin/endpoints.ts.
Schema registration lives in packages/shared/src/admin/openapi-registry.ts.
The generated artifact is written to docs/api/openapi.json.
The same command refreshes packages/console/src/lib/admin-client.generated.ts.

Admin API

Route groups, auth boundary, and runtime behavior.

Docker

Publish the admin port and fetch the spec from a container.

CLI ⭢ miravo start

Admin host, port, detached mode, and runtime flags.

Was this page useful?