Livepush Developers

Streams

Get stream by ID

GET https://octopus.livepush.io/streams/{stream_id}

Base URL https://octopus.livepush.io — Core Streams & Media APIs

Retrieves details of a specific live stream owned by the authenticated user. The response includes stream metadata, configuration, zone assignment, and destinations.

Authorization

Send a valid access token in the Authorization header.

  • bearerAuth — Bearer token (JWT)
headers.txt 
Authorization: Bearer YOUR_API_TOKEN

Try it

GET https://octopus.livepush.io/streams/{stream_id} — This call only reads data.

Parameters

Path parameters

  • stream_id string required
    Unique identifier of the stream.
    example: st_xxxxxxxxxxxxx

Code samples

request.sh 
curl -X GET 'https://octopus.livepush.io/streams/st_xxxxxxxxxxxxx' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'
const response = await fetch('https://octopus.livepush.io/streams/st_xxxxxxxxxxxxx', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
  },
});

if (!response.ok) {
  throw new Error(`Livepush API error ${response.status}`);
}

const data = await response.json();
import requests

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
}

response = requests.get('https://octopus.livepush.io/streams/st_xxxxxxxxxxxxx', headers=headers, timeout=30)
response.raise_for_status()
data = response.json()

Responses

Stream details

application/json

  • id string
  • chatId string
  • embedId string
  • createdAt string<date-time>
  • metadata object
    • name string
    • category string
      Stream category
      simulcastschedule
  • config object
    • pullUrlMaxRetry integer
    • recordingTier string
  • destinations object[]
    • id string
    • label string
    • appName string
    • rtmpBase string
    • isDisabled boolean
    • updatedAt string<date-time>
  • zone object
    • id string
    • name string
    • category string
    • host string
    • isPublic boolean
    • isDefault boolean
  • unsafeContent boolean
  • hasValidated boolean
Example 200 response response.json 
{
  "id": "st_xxxxxxxxxxxxx",
  "chatId": "mc_xxxxxxxxxxxx",
  "embedId": "em_xxxxxxxxxxxx",
  "createdAt": "2026-01-31T09:00:00.000Z",
  "metadata": {
    "name": "OUTPUT 1",
    "category": "simulcast"
  },
  "config": {
    "pullUrlMaxRetry": 5,
    "recordingTier": "rise"
  },
  "destinations": [
    {
      "id": "pb_xxxxxxxxxxxx",
      "label": "YouTube",
      "appName": "youtube",
      "rtmpBase": "rtmp://a.rtmp.youtube.com/live2",
      "isDisabled": true,
      "updatedAt": "2026-01-31T09:00:00.000Z"
    }
  ],
  "zone": {
    "id": "zn_xxxxxxxxx",
    "name": "Livepush Global",
    "category": "simulcast",
    "host": "stream.livepush.io",
    "isPublic": true,
    "isDefault": true
  },
  "unsafeContent": true,
  "hasValidated": true
}

Unauthorized

Stream not found