GET
/
stream
/
{id}
curl --request GET \
  --url https://livepeer.studio/api/stream/{id} \
  --header 'Authorization: Bearer <token>'

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

ID of the stream

Response

200 - application/json
id
string
name
string
required
kind
string
deprecated
creatorId
object
userTags
object

User input tags associated with the stream

lastSeen
number
sourceSegments
number
transcodedSegments
number
sourceSegmentsDuration
number

Duration of all the source segments, sec

transcodedSegmentsDuration
number

Duration of all the transcoded segments, sec

sourceBytes
number
transcodedBytes
number
ingestRate
number

Rate at which sourceBytes increases (bytes/second)

outgoingRate
number

Rate at which transcodedBytes increases (bytes/second)

isActive
boolean

If currently active

isHealthy
boolean | null

Indicates whether the stream is healthy or not.

issues
string[] | null

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

createdByTokenName
string

Name of the token used to create this object

createdAt
number

Timestamp (in milliseconds) at which stream object was created

parentId
string

Points to parent stream object

streamKey
string

Used to form RTMP ingest URL

pull
object

Configuration for a stream that should be actively pulled from an external source, rather than pushed to Livepeer. If specified, the stream will not have a streamKey.

playbackId
string

The playback ID to use with the Playback Info endpoint to retrieve playback URLs.

playbackPolicy
object | null

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

profiles
object[]

Profiles to transcode the stream into. If not specified, a default set of profiles will be used with 240p, 360p, 480p and 720p resolutions. Keep in mind that the source rendition is always kept.

projectId
string

The ID of the project

record
boolean

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

recordingSpec
object

Configuration for recording the stream. This can only be set if record is true.

multistream
object
suspended
boolean

If currently suspended

lastTerminatedAt
number | null

Timestamp (in milliseconds) when the stream was last terminated

userId
string
deprecated
renditions
object