API reference

TelAPI emits two OpenAPI documents depending on the webrtc feature flag. At each platform release we check in both snapshots as self-contained Redoc HTML pages plus raw JSON:

Profile	FEATURE_WEBRTC	Typical paths
WebRTC enabled	true	/api/v1/sessions/*, /api/v1/runtime/*, /api/v1/endpoints, /api/v1/webhooks/*, /health
WebRTC disabled	false	/api/v1/webhooks/*, /health only

Reference ready

Two release snapshots are checked in — pick the profile that matches your deployment's FEATURE_WEBRTC setting.

WebRTC enabled

Browser SDK REST routes, /ws/session, provider webhooks, and health — FEATURE_WEBRTC=true.

TelAPI 0.9.14-patch1 · 7 paths · captured 2026-07-01 · 198.8 KB

• Open interactive reference →
• Download telapi-webrtc.json

WebRTC disabled

Provider webhooks and health only — FEATURE_WEBRTC=false (SIP-only deployments).

TelAPI 0.9.14 · 2 paths · captured 2026-07-01 · 109.5 KB

• Open interactive reference →
• Download telapi-webhooks.json

Export each profile from a TelAPI instance running with the matching flag (GET /documentation/json), then sync with:

pnpm openapi:sync --from https://<api-host>/documentation/json --profile webhooks --tag 0.9.13
pnpm openapi:sync --from https://<api-host>/documentation/json --profile webrtc --tag 0.9.13

Add --insecure when exporting from a local stack with self-signed TLS (e.g. api.delphi.local).

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

• Authentication · Scopes · Call tokens · Errors
• Version sources — how to confirm what your platform is running.