Skip to main content

API reference

platform v0.9.11verified 2026-05-14

The interactive TelAPI reference is generated from an OpenAPI snapshot exported from TelAPI at a platform release tag and rendered as a self-contained Redoc HTML page hosted at /openapi/telapi.html. When the snapshot is present in this repo, the banner below links to it.

How the export works (at release time)​

  1. The release manager builds TelAPI from the release tag.

  2. A monorepo script exports the OpenAPI document and writes it to a known path.

  3. From this docs repo, run:

    pnpm openapi:sync --from /path/to/openapi.json --tag 0.9.11

    The script validates the spec, writes the canonical static/openapi/telapi.json, an archive copy static/openapi/telapi-0.9.11.json, and produces a self-contained Redoc HTML view at static/openapi/telapi.html via @redocly/cli.

  4. Commit all three files and run pnpm build to confirm the banner above links to the rendered view.

  5. Open a docs PR with the snapshot bump alongside the version cut.

The export procedure and the surrounding docs-version cut are maintained internally by the docs team and are not part of the public site.

Why this isn't the live /documentation​

TelAPI's /documentation route is excellent for the platform you happen to be hitting. It's not stable for versioned docs because:

  • It updates the moment the platform updates.
  • It isn't searchable or cross-linked with the concept pages in this section.
  • It isn't reachable from outside the deployment.

The release-time export makes the same schema reachable, searchable, and pinned to the docs version users selected in the version switcher.

See also​