Skip to content
/
List user stream recordin...

Livepush Developers API (1.0.0)

Official REST API reference for Livepush.

The Livepush API allows developers to programmatically manage live streams, multistreaming destinations, video libraries, recordings, scheduling, and media ingestion workflows.

This specification defines the base structure for all Livepush API resources. Some endpoints may be introduced incrementally as additional APIs become available.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://livepush.io/support
Livepush Support
support@livepush.io
License
Proprietary
Terms of Service
Languages
Servers
Mock server
https://api.livepush.io/_mock/openapi
Core Streams & Media APIs
https://octopus.livepush.io
Accounts & Billing APIs
https://squid.livepush.io
Livepush VOD Import API
https://vod-web-import-api.livepush.io

Accounts

Account-level resources and metadata

Operations

Streams

Live stream creation and lifecycle management

Operations

Destinations

Streaming destinations (YouTube, Facebook, RTMP, etc.)

Operations

Videos

Video library and VOD assets

Operations

Video Imports

Import videos from direct URLs (S3, HTTPS)

Operations

Stream Recordings

Recordings generated from live streams

Operations

List user stream recordings

Request

Returns the list of stream recordings owned by the authenticated user.

These recordings are generated from live streams and may include completed, queued, or errored recording entries.

Security
bearerAuth
curl -i -X GET \
  https://api.livepush.io/_mock/openapi/streams/me/recordings \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of user stream recordings

Bodyapplication/jsonArray [
idstring

Public identifier of the recording

Example: "recLuF0EKePs"
_idstring

Internal database identifier

Example: "6956c9137a06c9debc18863e"
userstring

User identifier who owns the recording

Example: "0PoArI-B3"
streamstring

Live stream identifier associated with the recording

Example: "stZ-mQc33cFxfeRH"
streamKeystring

RTMP stream key used during the recording session

timestring(date-time)

Time when the recording session started

updatedAtstring(date-time)

Last update timestamp of the recording

sourceReadyAtstring(date-time)

Time when the recording source became available

durationnumber(float)

Duration of the recording in seconds

Example: 390.465
sizenumber or null

Size of the recording file in bytes

queuedboolean

Indicates whether the recording is queued for processing

unlockedboolean

Indicates whether the recording is unlocked for access

watchableboolean

Indicates whether the recording can be played

exportableboolean

Indicates whether the recording can be exported

cleanableboolean

Indicates whether the recording is eligible for cleanup

cleanedboolean

Indicates whether the recording has been cleaned

recordingTierstring

Recording tier associated with the account

Example: "c_startup"
vendorstring

Backend vendor handling the recording

Example: "flu"
sourceHoststring

Internal source host handling the recording

nsstring

Namespace identifier

preKeystring

Internal object storage key for the recording file

screenshotstring or null

Screenshot URL or identifier for the recording

errorstring or null

Error message if recording processing failed

isRecordingDisabledboolean

Indicates whether recording was disabled for the stream

mediaInfoobject

Technical media metadata of the recording

]
Response
application/json
[
  {
    "id": "recLuF0EKePs",
    "_id": "6956c9137a06c9debc18863e",
    "user": "0PoArI-B3",
    "stream": "stZ-mQc33cFxfeRH",
    "streamKey": "string",
    "time": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "sourceReadyAt": "2019-08-24T14:15:22Z",
    "duration": 390.465,
    "size": 0,
    "queued": true,
    "unlocked": true,
    "watchable": true,
    "exportable": true,
    "cleanable": true,
    "cleaned": true,
    "recordingTier": "c_startup",
    "vendor": "flu",
    "sourceHost": "string",
    "ns": "string",
    "preKey": "string",
    "screenshot": "string",
    "error": "string",
    "isRecordingDisabled": true,
    "mediaInfo": { … }
  }
]

List stream recordings by stream

Request

Returns the list of recordings generated for a specific live stream.

This endpoint is useful for retrieving all historical recordings associated with a single stream.

Security
bearerAuth
Path
stream_idstringrequired

Unique identifier of the live stream

curl -i -X GET \
  'https://api.livepush.io/_mock/openapi/streams/{stream_id}/recordings' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of stream recordings

Bodyapplication/jsonArray [
idstring

Public identifier of the recording

Example: "recLuF0EKePs"
_idstring

Internal database identifier

Example: "6956c9137a06c9debc18863e"
userstring

User identifier who owns the recording

Example: "0PoArI-B3"
streamstring

Live stream identifier associated with the recording

Example: "stZ-mQc33cFxfeRH"
streamKeystring

RTMP stream key used during the recording session

timestring(date-time)

Time when the recording session started

updatedAtstring(date-time)

Last update timestamp of the recording

sourceReadyAtstring(date-time)

Time when the recording source became available

durationnumber(float)

Duration of the recording in seconds

Example: 390.465
sizenumber or null

Size of the recording file in bytes

queuedboolean

Indicates whether the recording is queued for processing

unlockedboolean

Indicates whether the recording is unlocked for access

watchableboolean

Indicates whether the recording can be played

exportableboolean

Indicates whether the recording can be exported

cleanableboolean

Indicates whether the recording is eligible for cleanup

cleanedboolean

Indicates whether the recording has been cleaned

recordingTierstring

Recording tier associated with the account

Example: "c_startup"
vendorstring

Backend vendor handling the recording

Example: "flu"
sourceHoststring

Internal source host handling the recording

nsstring

Namespace identifier

preKeystring

Internal object storage key for the recording file

screenshotstring or null

Screenshot URL or identifier for the recording

errorstring or null

Error message if recording processing failed

isRecordingDisabledboolean

Indicates whether recording was disabled for the stream

mediaInfoobject

Technical media metadata of the recording

]
Response
application/json
[
  {
    "id": "recLuF0EKePs",
    "_id": "6956c9137a06c9debc18863e",
    "user": "0PoArI-B3",
    "stream": "stZ-mQc33cFxfeRH",
    "streamKey": "string",
    "time": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "sourceReadyAt": "2019-08-24T14:15:22Z",
    "duration": 390.465,
    "size": 0,
    "queued": true,
    "unlocked": true,
    "watchable": true,
    "exportable": true,
    "cleanable": true,
    "cleaned": true,
    "recordingTier": "c_startup",
    "vendor": "flu",
    "sourceHost": "string",
    "ns": "string",
    "preKey": "string",
    "screenshot": "string",
    "error": "string",
    "isRecordingDisabled": true,
    "mediaInfo": { … }
  }
]

Stream Zones

Processing and storage regions

Operations

Stream Scheduler

Scheduled and automated streaming

Operations