Skip to main content

GET streams

GET /stream to retrieve all stream objects with the same userId. The response will include both parent stream objects and the historic stream objects with a parentId (stream objects representing a single live stream session). This historic type of "child-session" stream object will be deprecated in an upcoming version of the API in favor of the session object.

GET /stream?streamsonly=1 to retrieve all stream objects with the same userId and exclude the historic stream objects with a parentId (stream objects representing a single live stream session).

curl -H 'authorization: Bearer {api-key}' \
"https://livepeer.studio/api/stream?streamsonly=1"

Quick filters

FilterExampleDescription
All stream objects with the same userId/api/stream?streamsonly=1excludes the historic stream objects with a parentId (stream objects representing a single live stream session)
All active stream objects/api/stream?streamsonly=1&filters=[{"id": "isActive", "value": true}]true returns active stream objects. false returns idle stream objects. The default value for new stream objects is false. This example shows a decoded JSON object. But, remember that anything passed as a parameter in a GET request URL must be URL encoded.
All stream objects with recording on/api/stream?streamsonly=1&filters=[{"id": "record", "value": true}]true returns stream objects with record turned on. The default value for new stream objects is false. This example shows a decoded JSON object. But, remember that anything passed as a parameter in a GET request URL must be URL encoded.