API Reference
The authoritative API reference is generated by APID and served live. Every endpoint, schema, and error shape documented there comes straight from the running server.
Interactive referenceScalar API reference, served live by APID.
OpenAPI JSON (live)Raw OpenAPI 3 spec served by APID — pipe it into your tool of choice.
OpenAPI JSON (this site)Build-time copy served at /openapi.json — matches the docs you are reading.
Spec copies
Section titled “Spec copies”Two copies of the spec are available:
| Source | URL | Freshness |
|---|---|---|
| DUST API (live) | https://apid.dustid.io/api/openapi.json |
Always matches the deployed API. |
| This docs site | /openapi.json |
Generated when this site is built, from the same source as the API. |
Prefer the live copy when generating clients or validating requests — it always matches the deployed API. The site copy is regenerated with every docs release and is convenient when you are already browsing here.
Where to start
Section titled “Where to start”- Quickstart — first authenticated request in minutes.
- Authentication — API keys, token exchange, and context headers.
- Conventions — pagination, errors, and request context shared by every endpoint.