API reference
The complete BeaconCR API contract, served as a self-hosted interactive reference. The underlying OpenAPI document is downloadable below.
Interactive reference
The reference below is generated from beacon-v1.yaml, the OpenAPI 3.1 document that is the single source of truth for the platform's API contract. It is rendered in your browser — no third-party-hosted documentation service is involved.
Download the OpenAPI document
A raw copy ships with the portal for offline viewing, code generation, and contract tests:
The canonical source of the document lives at openapi/beacon-v1.yaml in the repository. The public copy under public/openapi/ is wired to the canonical file at merge time, so the downloadable file and the interactive reference always describe the live contract.
How this reference is built
- The reference component (
components/developers/ApiReference.tsx) is a client component that renders@scalar/api-reference-react, pointed at the static file/openapi/beacon-v1.yaml. - The renderer is self-hosted: the spec file is served from this site and the rendering library is bundled with the app — no third-party documentation host is involved.
- Code samples inside the reference reflect the same base path documented across this portal; start with getting started if you have not requested a token yet.