Skip to main content

Reference

Reference pages are lookup material: configuration keys, environment variables, data model fields - content you consult for a specific fact rather than read start to end.

The interactive API reference (OpenAPI/Swagger UI) is generated directly from the running service, not maintained here - see /docs and /openapi.json on a running core-api instance (http://localhost:8000/docs by default; see Getting started). This section is for reference material that doesn't fit in the OpenAPI schema itself, such as environment variable descriptions and configuration semantics. Nothing has been added yet: the authoritative list of settings and defaults is the Settings class in app/core/config.py (see also .env.example and deployment/.env.local).