OpenAPI /api/v3 Reference

Control plane for live TV.

The public contract for auth, sessions, health, playback decisions, and live HLS delivery. Published from the repo so the API docs stay close to the code that serves them.

Download OpenAPI Browse Reference View Source

contract snapshot

POST

/api/v3/auth/session Browser-safe session bootstrap.

GET

/api/v3/system/healthz Runtime health and readiness signal.

POST

/api/v3/sessions Start live playback with server-side policy.

HLS

/api/v3/sessions/{id}/stream.m3u8 Token-gated media delivery.

v3 stable API surface

HLS browser playback path

YAML source contract

Public Contract

/api/v3 is the integration surface.

Use it for WebUI clients, automation, playback orchestration, and operator tooling.

Spec YAML

Repo Driven

One checked-in source feeds the published page.

The Pages workflow mirrors backend/api/openapi.yaml, so endpoint copy and schema details do not live in a second CMS.

Open source file

Start Here

Need a running service first?

Use the repo quickstart for deployment, then return here when wiring clients against the API.

Quickstart Docs

Full OpenAPI Reference Rendered by ReDoc from ./openapi.yaml