API Reference
Interactive Documentation
The API provides interactive Swagger UI docs (Requires running app locally).
👉 Launch Swagger UI
Endpoint Summary
| Endpoint | Method | Security | Resilience | Description |
|---|---|---|---|---|
/health |
GET |
Public | ✅ Rate Limit | Basic health check. Returns service status. |
/ready |
GET |
Public | ✅ Dependency Checks | Dependency-aware readiness for the database, Redis-backed features, and the configured LLM provider. |
/login |
POST |
Public | ✅ Rate Limit | Exchange credentials for an access token and refresh token. |
/token/refresh |
POST |
Public | ✅ Rate Limit | Rotate a refresh token and receive a fresh token pair. |
/logout |
POST |
Bearer | — | Revoke the current access token and optionally revoke the presented refresh token. |
/protected |
GET |
Bearer | — | Example of a secure route requiring a valid token. |
/external-api |
GET |
Public | ✅ Circuit Breaker | Proxy to external service. When open, returns the latest cached upstream payload if fallback caching is configured. |
/debug/summarize-errors |
GET |
Bearer (Admin) | ✅ Rate Limit | Reads the configured log file, returns an AI summary, reports the runtime-selected provider, and records which admin requested it. |
/slo/report |
GET |
Public | ✅ SLO Reporting | Returns SLO targets and, when PROMETHEUS_BASE_URL is configured, the latest Prometheus recording-rule values. |
/slow |
GET |
Public | — | Simulates high-latency request for Tracing demo. |
/force-error |
GET |
Public | — | triggers a 500 error to test Alerting. |