2026-07-28 · The API reference is now object-first
docs/api is a written reference now, not a raw spec render — 16 object pages, 23 error pages, and 21 event pages, each with an agent-facing markdown twin.
The API reference is now object-first
/docs/api is no longer a raw render of the OpenAPI spec. It is a written reference. A generator fills in what a machine can know. A person wrote everything else.
Added — object, error, and event pages
- 16 object pages, one per resource plus one for account and provisioning calls. Each has a decision list (“which call do I want?”), prose per operation, generated field tables, and real examples.
- 23 error pages, one per error type. Each states what happened, why, and how to fix it.
- 21 event pages, one per webhook event. Each states when it fires — and the part that matters most, when it does not.
- An
.mdtwin for every page. An agent reads the same content a person does.
Changed — the explorer moved
The interactive try-it page is now at /docs/api/explorer. Use it to send a real call against your sandbox key.
GET /errors/{slug} now redirects (302) to its matching error page. Every error URL QuotaStack has ever sent resolves to a real page.
Coverage
Every product operation, event, and error is documented: 81 of 81 operations, 21 of 21 events, 23 of 23 errors.
Why
One integrating team stalled on the old reference. They could not tell which endpoint to call. Payloads and errors read as opaque. This rewrite closes exactly that gap.
See the API reference, or jump straight to an object page.
Loading…