Better Data

API Reference

OpenAPI bundle

Edit this page

OpenAPI bundle

This documentation site publishes a static OpenAPI 3.0 JSON file for download, codegen, contract tests, and schema inspection:

  • Public URL: /api-reference/openapi.json (served from public/api-reference/openapi.json in the docs repo).
  • In-product explorer (Swagger / Scalar / Redoc) on docs.betterdata.co is optional future work — the JSON artifact is the maintained contract surface for now.

Relation to the SCM web app

The tenant SCM Next.js app may also expose a generated spec at runtime (e.g. /api/openapi.json) for development or in-environment tooling. Whether that document is byte-for-byte identical to the bundle above in every environment is an implementation detail — compare checksums or info.version after deploy when aligning clients.

Narrative overview, auth patterns, and endpoint families live under API overview and Authentication. Day-to-day MDX reference pages are generated from the same API manifest workflow as the bundle; see How we document APIs.