ErsatzTV Legacy ships a REST API that lets you inspect and control every major subsystem — channels, transcoding profiles, media libraries, smart collections, HLS sessions, and scripted playout builds — from any HTTP client. All endpoints accept and returnDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/ErsatzTV/legacy/llms.txt
Use this file to discover all available pages before exploring further.
application/json and are documented with an OpenAPI 3.1 specification served directly from the running instance.
Base URL
All endpoints are served on port 8409:OpenAPI Specifications
ErsatzTV Legacy ships two separate OpenAPI documents:| Document | URL | Coverage |
|---|---|---|
| General API | http://<host>:8409/openapi/v1.json | Channels, FFmpeg profiles, libraries, collections, sessions, maintenance, version |
| Scripted Schedule API | http://<host>:8409/openapi/scripted-schedule.json | Playout building for scripted schedules |
Authentication
Authentication is optional and controlled by the ErsatzTV authentication settings. When enabled, all API requests must include a Bearer token in theAuthorization header.
Refer to the streaming authentication documentation for instructions on obtaining a token and configuring authentication.
Content Type
All request bodies must be sent withContent-Type: application/json. All responses are returned as JSON.
Version Endpoint
The simplest endpoint to verify connectivity isGET /api/version. It returns the API protocol version alongside the running application version string.
Integer protocol version of the ErsatzTV REST API.
Full application version string, including the git commit hash suffix.
Endpoint Groups
Channels
List all channels and reset channel playouts.
FFmpeg Profiles
Create, list, update, and delete FFmpeg transcoding profiles.
Libraries
Trigger full library scans or targeted per-show scans.
Collections
Manage smart collections built from search queries.
Sessions
View active HLS streaming sessions and stop them on demand.
Maintenance
Garbage collection, empty trash, and artwork cache cleanup.
Scripted Schedule
Programmatic playout building for scripted schedules.