Quickstart

This walkthrough takes you from nothing to a running stream with curl and an API key. The flow is: create the stream, upload a video, add it to the stream’s playlist, add a destination, and start. Set your key and workspace once, so the snippets stay short. An API key carries no workspace, so every request names one in X-Workspace-Id (see Conventions):

export SL_KEY="sl_your_key_here"

Find your workspace

curl https://api.streamloop.app/v1/workspaces \
  -H "X-API-Key: $SL_KEY"

Pick a workspace from the list and keep its id:

export SL_WS="wksp_…"

A 401 means the key is missing, wrong or revoked.

Create the stream

quality is one of q_720p, q_1080p, q_1440p, q_2160p. framerate is f_24, f_25, f_30 or f_60:

curl -X POST https://api.streamloop.app/v1/streams \
  -H "X-API-Key: $SL_KEY" -H "X-Workspace-Id: $SL_WS" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Lofi radio", "quality": "q_1080p", "framerate": "f_30" }'

Note the stream id (stream_…). The stream comes with two empty playlists, one for video and one for audio.

Upload a video

Uploading a local file takes three calls: create the upload, PUT the bytes to a presigned URL, and mark it complete.

# 1. Create the upload record. Note its id (obj_…).
curl -X POST https://api.streamloop.app/v1/uploads \
  -H "X-API-Key: $SL_KEY" -H "X-Workspace-Id: $SL_WS" \
  -H "Content-Type: application/json" \
  -d '{ "name": "my-video.mp4", "type": "video", "mimeType": "video/mp4" }'

# 2. Get a presigned URL and upload the file to it.
curl -X POST https://api.streamloop.app/v1/uploads/obj_…/upload-url \
  -H "X-API-Key: $SL_KEY" -H "X-Workspace-Id: $SL_WS"
curl -X PUT -H "Content-Type: video/mp4" --upload-file my-video.mp4 "<presigned URL>"

# 3. Mark it complete, which starts processing.
curl -X POST https://api.streamloop.app/v1/uploads/obj_…/complete \
  -H "X-API-Key: $SL_KEY" -H "X-Workspace-Id: $SL_WS"

GET /uploads/{id} shows when the file is ready.

Add it to the playlist

Find the stream’s video playlist, then add the upload to it:

curl "https://api.streamloop.app/v1/playlists?streamId=stream_…" \
  -H "X-API-Key: $SL_KEY" -H "X-Workspace-Id: $SL_WS"

curl -X POST https://api.streamloop.app/v1/playlists/pl_…/operations \
  -H "X-API-Key: $SL_KEY" -H "X-Workspace-Id: $SL_WS" \
  -H "Content-Type: application/json" \
  -d '{ "operations": [ { "addObjects": { "objectIds": ["obj_…"], "position": "END" } } ] }'

Use the playlist whose kind is video. All operations in one call succeed or fail together.

Add a destination

Create an RTMP destination from your platform’s ingest URL and stream key (RTMP is the protocol live platforms use to receive video), then add it to the stream:

curl -X POST https://api.streamloop.app/v1/destinations \
  -H "X-API-Key: $SL_KEY" -H "X-Workspace-Id: $SL_WS" \
  -H "Content-Type: application/json" \
  -d '{ "name": "My channel", "rtmpUrl": "rtmp://a.rtmp.youtube.com/live2", "rtmpKey": "xxxx-xxxx-xxxx-xxxx" }'

curl -X POST https://api.streamloop.app/v1/streams/stream_…/destinations \
  -H "X-API-Key: $SL_KEY" -H "X-Workspace-Id: $SL_WS" \
  -H "Content-Type: application/json" \
  -d '{ "destinationId": "dest_…" }'

A stream can send to up to 5 destinations (multistream), at most one of them YouTube.

Check it's ready to go live

curl https://api.streamloop.app/v1/streams/stream_…/readiness \
  -H "X-API-Key: $SL_KEY" -H "X-Workspace-Id: $SL_WS"

{ "ready": true, "issues": [] }

If ready is false, fix the listed issues (for example, the video is still processing) and check again.

Start streaming

curl -X POST https://api.streamloop.app/v1/streams/stream_…/start \
  -H "X-API-Key: $SL_KEY" -H "X-Workspace-Id: $SL_WS"

The stream is live within about a minute and loops your video 24/7. Stop it any time with POST /streams/{id}/stop.

Monitor it

On a connected YouTube channel, poll live stats while it runs:

curl https://api.streamloop.app/v1/streams/stream_…/live-stats \
  -H "X-API-Key: $SL_KEY" -H "X-Workspace-Id: $SL_WS"

GET /streams/{id}/destinations shows each destination’s delivery state.

Prefer not to call endpoints in order? Connect an AI agent to the MCP server and describe what you want. It runs the same operations as tools. See Use Streamloop with AI.

What’s next

Schedule instead of start

Call POST /streams/{id}/schedule to go live automatically, once, daily or weekly.

Play a scene

Build a live, designed scene with the Scenes API and put it on the stream with PUT /streams/{id}/scene.

Get started

REST API

Scenes API

MCP server

GraphQL API

What’s next

Schedule instead of start

Play a scene

​What’s next

Schedule instead of start

Play a scene

What’s next