API reference overview
The API Reference section is generated from the OpenAPI document shipped with this repository (openapi.json), which mirrors GET /openapi.json on a running API instance.
- Use Try it flows in Mintlify with your Bearer token (
Authorization: Bearer <key_id>:<secret>). - Base URL in examples defaults to
https://api.example.com; substitute your deployment host. - Health endpoints (
/health/*) are unauthenticated; all/v1/*routes require a valid API key.