Update a stream

curl --request PATCH \
  --url https://api.streamloop.app/v1/streams/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "addPlaylistIDs": [
    "<string>"
  ],
  "addPreparedPlaylistIDs": [
    "<string>"
  ],
  "agentModeEnabled": true,
  "audioUploadObjectID": "<string>",
  "clearAudioUploadObject": true,
  "clearDestination": true,
  "clearFramerate": true,
  "clearName": true,
  "clearPlaylists": true,
  "clearPreparedPlaylists": true,
  "clearQuality": true,
  "clearScheduleEndAt": true,
  "clearScheduleStartAt": true,
  "clearStorageBackend": true,
  "clearStreamBackend": true,
  "clearStreamDuration": true,
  "clearStreamKey": true,
  "clearStreamState": true,
  "clearVideoUploadObject": true,
  "clearYoutubeSettings": true,
  "destinationID": "<string>",
  "name": "<string>",
  "removePlaylistIDs": [
    "<string>"
  ],
  "removePreparedPlaylistIDs": [
    "<string>"
  ],
  "runBackupStream": true,
  "scheduleEndAt": "2023-11-07T05:31:56Z",
  "scheduleStartAt": "2023-11-07T05:31:56Z",
  "streamDestination": "youtube",
  "streamDuration": 123,
  "streamKey": "<string>",
  "streamStateID": "<string>",
  "videoUploadObjectID": "<string>",
  "youtubeSettingsID": "<string>"
}
'

import requests

url = "https://api.streamloop.app/v1/streams/{id}"

payload = {
    "addPlaylistIDs": ["<string>"],
    "addPreparedPlaylistIDs": ["<string>"],
    "agentModeEnabled": True,
    "audioUploadObjectID": "<string>",
    "clearAudioUploadObject": True,
    "clearDestination": True,
    "clearFramerate": True,
    "clearName": True,
    "clearPlaylists": True,
    "clearPreparedPlaylists": True,
    "clearQuality": True,
    "clearScheduleEndAt": True,
    "clearScheduleStartAt": True,
    "clearStorageBackend": True,
    "clearStreamBackend": True,
    "clearStreamDuration": True,
    "clearStreamKey": True,
    "clearStreamState": True,
    "clearVideoUploadObject": True,
    "clearYoutubeSettings": True,
    "destinationID": "<string>",
    "name": "<string>",
    "removePlaylistIDs": ["<string>"],
    "removePreparedPlaylistIDs": ["<string>"],
    "runBackupStream": True,
    "scheduleEndAt": "2023-11-07T05:31:56Z",
    "scheduleStartAt": "2023-11-07T05:31:56Z",
    "streamDestination": "youtube",
    "streamDuration": 123,
    "streamKey": "<string>",
    "streamStateID": "<string>",
    "videoUploadObjectID": "<string>",
    "youtubeSettingsID": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    addPlaylistIDs: ['<string>'],
    addPreparedPlaylistIDs: ['<string>'],
    agentModeEnabled: true,
    audioUploadObjectID: '<string>',
    clearAudioUploadObject: true,
    clearDestination: true,
    clearFramerate: true,
    clearName: true,
    clearPlaylists: true,
    clearPreparedPlaylists: true,
    clearQuality: true,
    clearScheduleEndAt: true,
    clearScheduleStartAt: true,
    clearStorageBackend: true,
    clearStreamBackend: true,
    clearStreamDuration: true,
    clearStreamKey: true,
    clearStreamState: true,
    clearVideoUploadObject: true,
    clearYoutubeSettings: true,
    destinationID: '<string>',
    name: '<string>',
    removePlaylistIDs: ['<string>'],
    removePreparedPlaylistIDs: ['<string>'],
    runBackupStream: true,
    scheduleEndAt: '2023-11-07T05:31:56Z',
    scheduleStartAt: '2023-11-07T05:31:56Z',
    streamDestination: 'youtube',
    streamDuration: 123,
    streamKey: '<string>',
    streamStateID: '<string>',
    videoUploadObjectID: '<string>',
    youtubeSettingsID: '<string>'
  })
};

fetch('https://api.streamloop.app/v1/streams/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "framerate": "f_24",
  "name": "<string>",
  "quality": "q_720p",
  "state": "draft"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

Update a stream

Update a stream. When retryMirror: true, the resolver also writes a fresh MirrorIntent for the latest desired state of this stream’s YouTube schedule mirror — used to recover after reauth / quota reset / channel freeing. retryMirror is a sibling argument rather than a field on UpdateStreamInput because that input type is generated by ent and cannot carry non-column fields. Has no effect when the stream has no existing MirrorIntent (INVALID_ARG is returned in that case).

When input.status is set, the resolver translates the legacy enum value to the equivalent lifecycle command and routes it through streamlifecycle.Transition() instead of writing the column directly. input.status is deprecated; frontends should call the command mutations directly.

Resources are permanently bound to the workspace that created them and cannot be moved between workspaces.

PATCH

streams

{id}

Update a stream

curl --request PATCH \
  --url https://api.streamloop.app/v1/streams/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "addPlaylistIDs": [
    "<string>"
  ],
  "addPreparedPlaylistIDs": [
    "<string>"
  ],
  "agentModeEnabled": true,
  "audioUploadObjectID": "<string>",
  "clearAudioUploadObject": true,
  "clearDestination": true,
  "clearFramerate": true,
  "clearName": true,
  "clearPlaylists": true,
  "clearPreparedPlaylists": true,
  "clearQuality": true,
  "clearScheduleEndAt": true,
  "clearScheduleStartAt": true,
  "clearStorageBackend": true,
  "clearStreamBackend": true,
  "clearStreamDuration": true,
  "clearStreamKey": true,
  "clearStreamState": true,
  "clearVideoUploadObject": true,
  "clearYoutubeSettings": true,
  "destinationID": "<string>",
  "name": "<string>",
  "removePlaylistIDs": [
    "<string>"
  ],
  "removePreparedPlaylistIDs": [
    "<string>"
  ],
  "runBackupStream": true,
  "scheduleEndAt": "2023-11-07T05:31:56Z",
  "scheduleStartAt": "2023-11-07T05:31:56Z",
  "streamDestination": "youtube",
  "streamDuration": 123,
  "streamKey": "<string>",
  "streamStateID": "<string>",
  "videoUploadObjectID": "<string>",
  "youtubeSettingsID": "<string>"
}
'

import requests

url = "https://api.streamloop.app/v1/streams/{id}"

payload = {
    "addPlaylistIDs": ["<string>"],
    "addPreparedPlaylistIDs": ["<string>"],
    "agentModeEnabled": True,
    "audioUploadObjectID": "<string>",
    "clearAudioUploadObject": True,
    "clearDestination": True,
    "clearFramerate": True,
    "clearName": True,
    "clearPlaylists": True,
    "clearPreparedPlaylists": True,
    "clearQuality": True,
    "clearScheduleEndAt": True,
    "clearScheduleStartAt": True,
    "clearStorageBackend": True,
    "clearStreamBackend": True,
    "clearStreamDuration": True,
    "clearStreamKey": True,
    "clearStreamState": True,
    "clearVideoUploadObject": True,
    "clearYoutubeSettings": True,
    "destinationID": "<string>",
    "name": "<string>",
    "removePlaylistIDs": ["<string>"],
    "removePreparedPlaylistIDs": ["<string>"],
    "runBackupStream": True,
    "scheduleEndAt": "2023-11-07T05:31:56Z",
    "scheduleStartAt": "2023-11-07T05:31:56Z",
    "streamDestination": "youtube",
    "streamDuration": 123,
    "streamKey": "<string>",
    "streamStateID": "<string>",
    "videoUploadObjectID": "<string>",
    "youtubeSettingsID": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    addPlaylistIDs: ['<string>'],
    addPreparedPlaylistIDs: ['<string>'],
    agentModeEnabled: true,
    audioUploadObjectID: '<string>',
    clearAudioUploadObject: true,
    clearDestination: true,
    clearFramerate: true,
    clearName: true,
    clearPlaylists: true,
    clearPreparedPlaylists: true,
    clearQuality: true,
    clearScheduleEndAt: true,
    clearScheduleStartAt: true,
    clearStorageBackend: true,
    clearStreamBackend: true,
    clearStreamDuration: true,
    clearStreamKey: true,
    clearStreamState: true,
    clearVideoUploadObject: true,
    clearYoutubeSettings: true,
    destinationID: '<string>',
    name: '<string>',
    removePlaylistIDs: ['<string>'],
    removePreparedPlaylistIDs: ['<string>'],
    runBackupStream: true,
    scheduleEndAt: '2023-11-07T05:31:56Z',
    scheduleStartAt: '2023-11-07T05:31:56Z',
    streamDestination: 'youtube',
    streamDuration: 123,
    streamKey: '<string>',
    streamStateID: '<string>',
    videoUploadObjectID: '<string>',
    youtubeSettingsID: '<string>'
  })
};

fetch('https://api.streamloop.app/v1/streams/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "framerate": "f_24",
  "name": "<string>",
  "quality": "q_720p",
  "state": "draft"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

Authorizations

Authorization

string

header

required

OAuth 2.1 authorization-code flow with PKCE.

FlowAuthorization Code

Authorization URL: https://auth.streamloop.app/api/auth/oauth2/authorize
Token URL: https://auth.streamloop.app/api/auth/oauth2/token

Scopes1

streamloop:write

Create and control streams, destinations, and playlists

Headers

Idempotency-Key

string

Optional client-generated key. A repeated request with the same key replays the original response (within 24h) instead of re-executing — safe retries.

Path Parameters

string

required

Resource identifier.

Body

application/json

UpdateStreamInput is used for update Stream object. Input was generated by ent.

addPlaylistIDs

string[]

addPreparedPlaylistIDs

string[]

agentModeEnabled

boolean | null

Feature flag: run stream in agent mode (/agent) with replica-based orchestration.

audioUploadObjectID

string | null

clearAudioUploadObject

boolean | null

clearDestination

boolean | null

clearFramerate

boolean | null

clearName

boolean | null

clearPlaylists

boolean | null

clearPreparedPlaylists

boolean | null

clearQuality

boolean | null

clearScheduleEndAt

boolean | null

clearScheduleStartAt

boolean | null

clearStorageBackend

boolean | null

clearStreamBackend

boolean | null

clearStreamDuration

boolean | null

clearStreamKey

boolean | null

clearStreamState

boolean | null

clearVideoUploadObject

boolean | null

clearYoutubeSettings

boolean | null

destinationID

string | null

framerate

enum<string> | null

Available options:

f_24,

f_25,

f_30,

f_60

name

string | null

quality

enum<string> | null

Available options:

q_720p,

q_1080p,

q_1440p,

q_2160p

removePlaylistIDs

string[]

removePreparedPlaylistIDs

string[]

runBackupStream

boolean | null

Stream preference: enable backup destination streaming in agent mode.

scheduleEndAt

string<date-time> | null

scheduleStartAt

string<date-time> | null

storageBackend

enum<string> | null

Storage tier for this stream's media. 'standard' suits typical playlists and is included. 'large' is for big playlists: storage is provisioned to fit your content and grows as you add to it, billed per GiB-month. Takes effect at the next stream start.

Available options:

standard,

large

streamBackend

enum<string> | null

RTMP publisher backend. Editing is restricted.

Available options:

ffmpeg,

manifest

streamDestination

enum<string> | null

Available options:

youtube

streamDuration

integer | null

Stream duration in seconds. 0 = never expires. Copied from user default on creation.

streamKey

string | null

DEPRECATED: use destination_id. Kept for backward-compat during destination migration.

streamStateID

string | null

videoUploadObjectID

string | null

youtubeSettingsID

string | null

Response

Successful response.

createdAt

string<date-time>

required

string

required

framerate

enum<string> | null

Available options:

f_24,

f_25,

f_30,

f_60

name

string | null

quality

enum<string> | null

Available options:

q_720p,

q_1080p,

q_1440p,

q_2160p

state

enum<string> | null

Available options:

draft,

invalid,

scheduled,

preparing,

activating,

active,

failing,

failed,

stopping,

stopped

Get started

REST API

MCP server

GraphQL API

Update a stream

Authorizations

Headers

Path Parameters

Body

Response