POST
/
stream
Authorization
Body
curl --request POST \
  --url https://livepeer.studio/api/stream \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "test_stream",
  "creatorId": {
    "type": "unverified",
    "value": "<string>"
  },
  "playbackPolicy": {
    "type": "public",
    "webhookId": "<string>",
    "webhookContext": {}
  },
  "profiles": [
    {
      "width": 129,
      "name": "720p",
      "height": 129,
      "bitrate": 401,
      "fps": 1,
      "fpsDen": 2,
      "gop": "<string>",
      "profile": "H264Baseline",
      "encoder": "h264"
    }
  ],
  "record": true,
  "multistream": {
    "targets": [
      {
        "id": "PUSH123",
        "profile": "720p"
      }
    ]
  }
}'
[
  {
    "id": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
    "name": "test_stream",
    "creatorId": {
      "type": "unverified",
      "value": "<string>"
    },
    "lastSeen": 1587667174725,
    "sourceSegments": 1,
    "transcodedSegments": 2,
    "sourceSegmentsDuration": 1,
    "transcodedSegmentsDuration": 2,
    "sourceBytes": 1,
    "transcodedBytes": 2,
    "ingestRate": 1,
    "outgoingRate": 2,
    "isActive": true,
    "isHealthy": true,
    "issues": [
      "<string>"
    ],
    "createdByTokenName": "<string>",
    "createdAt": 1587667174725,
    "parentId": "de7818e7-610a-4057-8f6f-b785dc1e6f88",
    "streamKey": "hgebdhhigq",
    "playbackId": "eaw4nk06ts2d0mzb",
    "playbackPolicy": {
      "type": "public",
      "webhookId": "<string>",
      "webhookContext": {}
    },
    "profiles": [
      {
        "width": 129,
        "name": "720p",
        "height": 129,
        "bitrate": 401,
        "fps": 1,
        "fpsDen": 2,
        "gop": "<string>",
        "profile": "H264Baseline",
        "encoder": "h264"
      }
    ],
    "record": true,
    "multistream": {
      "targets": [
        {
          "id": "PUSH123",
          "profile": "720p"
        }
      ]
    },
    "suspended": true
  }
]

Authorizations

Authorization
string
headerrequired

Bearer api-key

Body

application/json
name
string
required
creatorId
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.

multistream
object

Response

200 - application/json
id
string
name
string
required
creatorId
object
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

Indicates whether the stream is healthy or not.

issues
string[]

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

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.

multistream
object
suspended
boolean

If currently suspended

Was this page helpful?

OverviewRetrieve a stream