API Reference
Live Streams
List and monitor live streams via the Client API
Get Active Live Streams
GET /live-streams/activeReturns streams that are live right now. Active ones include a manifest object with playback URLs.
Example request
curl "https://your-domain.com/api/client/v1/live-streams/active" \
-H "Authorization: Bearer YOUR_API_KEY"Response
If streams are active, returns an array of LiveStream objects with status: "active" and a manifest object.
{
"data": [
{
"id": "stream-uuid",
"title": "Live Event",
"status": "active",
"stream_key": "abc123",
"manifest": {
"hls": "https://your-domain.com/live/abc123/master.m3u8"
}
}
]
}Errors
| Status | Description |
|---|---|
| 503 | Media server unavailable |
Get All Live Streams
GET /live-streamsPaginated list of all live streams. Status is pulled from the media server in real time.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
per_page | integer | No | Results per page (default 15) |
Example request
curl "https://your-domain.com/api/client/v1/live-streams?per_page=20" \
-H "Authorization: Bearer YOUR_API_KEY"Streams not currently broadcasting have status: "inactive".
Get Live Stream
GET /live-streams/{streamId}One stream, with live status from the media server.
Example request
curl "https://your-domain.com/api/client/v1/live-streams/{streamId}" \
-H "Authorization: Bearer YOUR_API_KEY"If the stream is live, status is "active" and manifest contains playback URLs. If offline, status is "inactive".
Errors
| Status | Description |
|---|---|
| 404 | Stream not found |
| 503 | Could not retrieve live stream status |