Skip to main content
Version: 0.9.12

API reference

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.

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​