Start a stream

curl --request POST \
  --url https://api.streamloop.app/v1/streams/{id}/start \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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

{
  "id": "<string>",
  "state": "draft",
  "createdAt": "2023-11-07T05:31:56Z",
  "destinations": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "destination": {
        "id": "<string>",
        "kind": "custom_rtmp",
        "name": "<string>"
      },
      "destinationID": "<string>",
      "enabled": true,
      "state": "idle",
      "disabledReason": "<string>",
      "stateReason": "<string>",
      "stateSince": "2023-11-07T05:31:56Z"
    }
  ],
  "framerate": "f_24",
  "name": "<string>",
  "quality": "q_720p",
  "runBackupStream": true,
  "scene": {
    "id": "<string>"
  },
  "scheduleEndAt": "2023-11-07T05:31:56Z",
  "scheduleRepeat": "none",
  "scheduleRepeatDays": [
    "SUNDAY"
  ],
  "scheduleStartAt": "2023-11-07T05:31:56Z",
  "storageBackend": "standard",
  "streamDuration": 123
}

{
  "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>"
}

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

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

Start a stream

Starts the stream now. Allowed from draft, scheduled (it starts now instead of at its window), stopped, failed and invalid; any other state is 409 STREAM_ILLEGAL_TRANSITION. It first runs the checks GET /streams//readiness runs, plus a YouTube live-eligibility check; when one fails the answer is still 200, with the stream in state invalid (GET /streams//readiness says why; fix it and start again). 422 STREAM_GUARD_FAILED (the problem also carries reason and cause) is a refusal at the moment of starting. The stream plays its playlists as they are when it starts, so edits made while it is not live need no publish. Answers once the start is accepted (state preparing): it is live within about a minute, longer while media is prepared.

POST

streams

{id}

start

Start a stream

curl --request POST \
  --url https://api.streamloop.app/v1/streams/{id}/start \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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

{
  "id": "<string>",
  "state": "draft",
  "createdAt": "2023-11-07T05:31:56Z",
  "destinations": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "destination": {
        "id": "<string>",
        "kind": "custom_rtmp",
        "name": "<string>"
      },
      "destinationID": "<string>",
      "enabled": true,
      "state": "idle",
      "disabledReason": "<string>",
      "stateReason": "<string>",
      "stateSince": "2023-11-07T05:31:56Z"
    }
  ],
  "framerate": "f_24",
  "name": "<string>",
  "quality": "q_720p",
  "runBackupStream": true,
  "scene": {
    "id": "<string>"
  },
  "scheduleEndAt": "2023-11-07T05:31:56Z",
  "scheduleRepeat": "none",
  "scheduleRepeatDays": [
    "SUNDAY"
  ],
  "scheduleStartAt": "2023-11-07T05:31:56Z",
  "storageBackend": "standard",
  "streamDuration": 123
}

{
  "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>"
}

{
  "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.

Headers

X-Workspace-Id

string

Workspace this request operates in — the workspace id (wksp_…) or the organization id, from GET /workspaces. Required with an API key, which carries no workspace (400 WORKSPACE_REQUIRED without it). With an OAuth token it defaults to the workspace the token was issued for. Responds 403 WORKSPACE_FORBIDDEN when the caller is not a current member, rather than falling back to another workspace.

Idempotency-Key

string

Optional client-generated key. A repeated request with the same key, method and path (by the same caller in the same workspace) replays the original response, with Idempotency-Replayed: true, for 24 hours instead of running again — safe retries. The same key with a different body is refused with 422 IDEMPOTENCY_KEY_REUSED (nothing runs): use a new key for each new request. A 5xx answer is not remembered (a retry runs).

Path Parameters

string

required

Resource identifier.

Response

Successful response.

string

required

state

enum<string>

required

Available options:

draft,

invalid,

scheduled,

preparing,

activating,

active,

failing,

failed,

stopping,

stopped

createdAt

string<date-time>

destinations

object[]

Outputs in creation order.

Show child attributes

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

runBackupStream

boolean

Also publish to YouTube's backup ingest, for redundancy. Doubles the streaming cost while live.

scene

object | null

The scene a stream plays (a live, designed stream) instead of its video playlist. Scenes are made and published with the Scenes API — its OpenAPI document is GET /v1/scenes/openapi.json. Publish the scene before attaching it with PUT /v1/streams/{id}/scene.

Show child attributes

scheduleEndAt

string<date-time> | null

scheduleRepeat

enum<string>

Available options:

none,

daily,

weekly

scheduleRepeatDays

enum<string>[]

Weekdays a weekly window starts on, as the UTC weekday of scheduleStartAt. Empty = every 7 days from the anchor. Always empty unless scheduleRepeat is weekly.

Available options:

SUNDAY,

MONDAY,

TUESDAY,

WEDNESDAY,

THURSDAY,

FRIDAY,

SATURDAY

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

streamDuration

integer | null

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

Get started

REST API

Scenes API

MCP server

GraphQL API

Start a stream

Authorizations

Headers

Path Parameters

Response