GET
/
stream
/
{id}
Authorization
Path
curl --request GET \
  --url https://livepeer.studio/api/stream/{id} \
  --header 'Authorization: <authorization>'
{
  "createdAt": 1587667174725,
  "createdByTokenName": "staging key",
  "creatorId": {
    "type": "unverified",
    "value": "<string>"
  },
  "id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
  "ingestRate": 1,
  "isActive": true,
  "isHealthy": true,
  "issues": [
    "Buffer underflow",
    "Network congestion"
  ],
  "lastSeen": 1587667174725,
  "multistream": {
    "targets": [
      {
        "id": "PUSH123",
        "profile": "720p"
      }
    ]
  },
  "name": "test_stream",
  "outgoingRate": 2,
  "parentId": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
  "playbackId": "eaw4nk06ts2d0mzb",
  "playbackPolicy": {
    "type": "public",
    "webhookContext": {
      "foo": "bar"
    },
    "webhookId": "3e02c844-d364-4d48-b401-24b2773b5d6c"
  },
  "profiles": [
    {
      "bitrate": 3000,
      "fps": 30,
      "height": 720,
      "name": "720p",
      "width": 1280
    }
  ],
  "record": true,
  "sourceBytes": 1,
  "sourceSegments": 1,
  "sourceSegmentsDuration": 1,
  "streamKey": "hgebdhhigq",
  "suspended": true,
  "transcodedBytes": 2,
  "transcodedSegments": 2,
  "transcodedSegmentsDuration": 2
}

Authorizations

Authorization
string
headerrequired

Bearer api-key

Path Parameters

id
string
required

ID of the stream

Response

200 - application/json
createdAt
number

Timestamp (in milliseconds) at which the stream object was created

createdByTokenName
string

Name of the token used to create this object

creatorId
object
id
string
ingestRate
number

Rate at which sourceBytes increases (bytes/second)

isActive
boolean

If currently active

isHealthy
boolean

Indicates whether the stream is healthy or not.

issues
string[]

A string array of human-readable errors describing issues affecting the stream, if any.

lastSeen
number
multistream
object
name
string
required
outgoingRate
number

Rate at which transcodedBytes increases (bytes/second)

parentId
string

Points to the parent stream object

playbackId
string

Used to form playback URL

playbackPolicy
object

Whether the playback policy for a asset or stream is public or signed

profiles
object[]
record
boolean

Should this stream be recorded? Uses default settings. For more customization, create and configure an object store.

sourceBytes
number
sourceSegments
number
sourceSegmentsDuration
number

Duration of all the source segments, sec

streamKey
string

Used to form the RTMP ingest URL

suspended
boolean

If currently suspended

transcodedBytes
number
transcodedSegments
number
transcodedSegmentsDuration
number

Duration of all the transcoded segments, sec

Was this page helpful?

Create a streamUpdate a stream