Skip to content
/
Get user details

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

Get user details

Request

Retrieves details of the currently authenticated user account. The response includes profile information, preferences, and basic billing metadata.

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

Responses

Current user account details

Bodyapplication/json
idstring
Example: "RDHe2BXVP6d89"
usernamestring
Example: "congresstv24_xxxxx"
namestring
Example: "CONGRESS TV"
emailstring(email)
Example: "user@example.com"
avatarstring(uri)
Example: "https://example.com/avatar.jpg"
nsstring
Example: "nsL2BzkdFKgIYv"
isDisabledboolean
Example: false
createdAtstring(date-time)
preferencesobject
billingInfoobject
Response
application/json
{
  "id": "RDHe2BXVP6d89",
  "username": "congresstv24_xxxxx",
  "name": "CONGRESS TV",
  "email": "user@example.com",
  "avatar": "https://example.com/avatar.jpg",
  "ns": "nsL2BzkdFKgIYv",
  "isDisabled": false,
  "createdAt": "2019-08-24T14:15:22Z",
  "preferences": {},
  "billingInfo": {
    "email": "billing@example.com",
    "name": "John Doe"
  }
}

Get user subscriptions

Request

Returns a list of active and historical subscriptions associated with the authenticated user account.

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

Responses

List of account subscriptions

Bodyapplication/jsonArray [
idstring
Example: "AzyzaQV4rbNdSXKQ"
categorystring
Example: "simulcast"
startTimestring(date-time)
endTimestring(date-time)
updatedAtstring(date-time)
planobject
]
Response
application/json
[
  {
    "id": "AzyzaQV4rbNdSXKQ",
    "category": "simulcast",
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "plan": { … }
  }
]

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

Stream Zones

Processing and storage regions

Operations

Stream Scheduler

Scheduled and automated streaming

Operations