API
Endpoints
The full REST endpoint reference.
Audits & runs
All endpoints authenticate with an API key. Paths with {id} take a run id; runs are scoped to you, so another user's run reads as not found.
| Method | Path | Purpose | Cost |
|---|---|---|---|
| POST | /v1/audits | Submit an audit; returns a run_id immediately (async, then poll). | 1 check |
| GET | /v1/runs | List your runs, newest first (limit, offset). | Free |
| GET | /v1/runs/{id}/status | Live status: queued / running / done / failed, and the stage. | Free |
| GET | /v1/runs/{id}/gaps | The gap list: summary + gaps (source, kind, quadrant, score). | Free |
| GET | /v1/runs/{id} | The full stored run, including the graph the gaps came from. | Free |
API keys
Key management uses your signed-in session (the web app), not an API key.
| Method | Path | Purpose | Cost |
|---|---|---|---|
| POST | /api/keys | Create a key; returns the plaintext once. | Free |
| GET | /api/keys | List your keys (metadata only). | Free |
| DELETE | /api/keys/{id} | Revoke a key. | Free |