Retrieve a stream
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
Bearer api-key
Path Parameters
ID of the stream
Response
Timestamp (in milliseconds) at which the stream object was created
Name of the token used to create this object
Rate at which sourceBytes increases (bytes/second)
If currently active
Indicates whether the stream is healthy or not.
A string array of human-readable errors describing issues affecting the stream, if any.
Rate at which transcodedBytes increases (bytes/second)
Points to the parent stream object
Used to form playback URL
Whether the playback policy for a asset or stream is public or signed
Should this stream be recorded? Uses default settings. For more customization, create and configure an object store.
Duration of all the source segments, sec
Used to form the RTMP ingest URL
If currently suspended
Duration of all the transcoded segments, sec
Was this page helpful?
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
}