PATCH
/
stream
/
{id}
curl --request PATCH \
  --url https://livepeer.studio/api/stream/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "creatorId": {
    "type": "unverified",
    "value": "<string>"
  },
  "multistream": {
    "targets": [
      {
        "id": "PUSH123",
        "profile": "720p"
      }
    ]
  },
  "playbackPolicy": {
    "refreshInterval": 123,
    "type": "public",
    "webhookContext": {},
    "webhookId": "<string>"
  },
  "profiles": [
    {
      "bitrate": 401,
      "encoder": "H.264",
      "fps": 123,
      "fpsDen": 2,
      "gop": "<string>",
      "height": 129,
      "name": "720p",
      "profile": "H264Baseline",
      "quality": 43,
      "width": 129
    }
  ],
  "record": true,
  "suspended": true,
  "userTags": {}
}'
This response has no body data.

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

Body

application/json
creatorId
multistream
object
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.

suspended
boolean

If currently suspended

userTags
object

User input tags associated with the stream