Skip to content
IndexDesign corpus

API documentation

Help & Support · 9 checks · 20 resources

The developer reference that has to get someone from zero to a successful first call.

Before you ship9 checks
  1. 01Quickstart that produces a working call in under five minutes — including how to obtain a key
  2. 02Authentication explained once, concretely — header name, token format, and a copy-pasteable example
  3. 03Per-endpoint reference — method, path, every parameter with type and requirement, and every response field
  4. 04Runnable request examples in multiple languages — curl plus the officially supported SDKs, generated from the same spec
  5. 05Complete error catalogue — every status code and error string, with the cause and the fix
  6. 06Rate limits, pagination and idempotency documented as first-class topics, not footnotes
  7. 07Versioning and deprecation policy — how versions are pinned, how long old ones live, and what changes without notice
  8. 08Machine-readable spec published — OpenAPI or equivalent, downloadable and matching the rendered docs
  9. 09Changelog for the API itself, separate from the product changelog
Resources that help you build this20