API reference

A JSON API to manage streams and destinations, retrieve recordings, clips, analytics and highlights, and control unified cross-platform chat programmatically.

Base URL

https://streamrepeater.com/api

curl https://streamrepeater.com/api/openapi.json -o streamrepeater-openapi.json

Authentication

All endpoints use a Sanctum Personal Access Token. Generate or revoke tokens in Settings → API tokens. Requests are limited to 60 per minute per IP, and errors are returned as JSON.

Send the token in the Authorization header as a Bearer token:

curl -H "Authorization: Bearer YOUR_TOKEN_HERE" https://streamrepeater.com/api/channels

Your account is limited to the workspaces you belong to. Tokens can be read-only or read/write. Changing streams and destinations requires a write token and the Manage streams role in that workspace. Workspace and stream provisioning endpoints are admin-only and are documented in the admin console.

Errors & conventions

Errors return a JSON body containing message; validation failures (422) also include an errors map keyed by field. Other common statuses are 401 for a missing or invalid token, 403 when the token lacks an ability, role or workspace access, and 404 when a resource is missing or not visible. Growing chat and event feeds accept ?after=<id> to retrieve only newer rows.

Endpoints

AI Streams

Create and run always-on channels from AI-generated video, steer them on air and inspect why they are or are not generating. The workspace plan must include AI Streams; writes require a write token and the Manage streams role. Creation and editing use the dashboard checks, and a new stream stays off until start is called. Provider keys are managed only in the dashboard; the API reports connection and key health but never returns a key. See AI Streams help articles for product behaviour.

Push a topic into a live stream. Use this when an event such as a goal, sale or breaking story should take over the channel. The topic runs for minutes (30 by default), then the running order resumes where it stopped. Existing clips play first and clips_ahead reports how many. A topic never starts a stopped stream or raises its generation rate, and it passes the same content and spending checks.

curl -X POST -H "Authorization: Bearer YOUR_TOKEN_HERE" -H "Content-Type: application/json" \
  -d '{"instruction":"Fans erupt as the home side scores","minutes":10,"label":"Goal! 1-0"}' \
  https://streamrepeater.com/api/v1/tenants/1/ai-streams/5/topic

{
  "ok": true,
  "entry": { "id": 21, "kind": "date", "start_time": "19:42", "timezone": "UTC", "duration_minutes": 10 },
  "on_air_now": true,
  "clips_ahead": 2,
  "stream_active": true,
  "message": "The next clip this stream commissions will be about this topic. 2 clips already queued or being made will play first."
}

Play a particular beat next with POST …/beats/{beat}/cue, or create and cue one with {"instruction": "…", "cue": true}. Why is it quiet? GET …/status returns the same stable reason as the stream page: stopped, not-entitled, no-provider, no-prompt, no-key, spend-limit or null, together with guidance.

# Create a stream (never starts it), then start it
curl -X POST -H "Authorization: Bearer YOUR_TOKEN_HERE" -H "Content-Type: application/json" \
  -d '{"name":"Harbour cam","channel_ids":[3],"provider":"luma","prompt":"A calm harbour at dawn","clip_seconds":8,"aspect":"16:9","buffer_target":3,"budget_limit":50,"clip_cost_estimate":0.4}' \
  https://streamrepeater.com/api/v1/tenants/1/ai-streams
curl -X POST -H "Authorization: Bearer YOUR_TOKEN_HERE" https://streamrepeater.com/api/v1/tenants/1/ai-streams/5/start

Destination parameters

POST and PUT accept a custom destination or saved preset. A custom destination uses name, protocol (rtmp, rtsp or srt) and url. Optional video_settings may contain resolution (source, 1080p, 720p, 480p) and bitrate in Kbps. Toggle accepts {"enabled": true} or {"enabled": false}.

Example: list streams

curl -H "Authorization: Bearer YOUR_TOKEN_HERE" https://streamrepeater.com/api/channels

[
  {
    "id": 1,
    "path_name": "acme--main",
    "status": "live",
    "tenant": { "id": 1, "name": "Acme" },
    "destinations": [
      { "id": 7, "name": "YouTube", "protocol": "rtmp",
        "relay_process": { "status": "running" } }
    ]
  }
]

Example: add a destination

curl -H "Authorization: Bearer YOUR_TOKEN_HERE" \
                  -H "Content-Type: application/json" \
                  -d '{"name":"Twitch","protocol":"rtmp","url":"rtmp://live.twitch.tv/app/KEY"}' \
                  https://streamrepeater.com/api/channels/1/destinations

Example: update a destination

curl -X PUT -H "Authorization: Bearer YOUR_TOKEN_HERE" \
                  -H "Content-Type: application/json" \
                  -d '{"name":"YouTube backup","protocol":"rtmp","url":"rtmps://a.rtmps.youtube.com:443/live2/KEY","video_settings":{"resolution":"720p","bitrate":3500}}' \
                  https://streamrepeater.com/api/channels/1/destinations/7

Example: pause a destination

curl -X PATCH -H "Authorization: Bearer YOUR_TOKEN_HERE" \
                  -H "Content-Type: application/json" \
                  -d '{"enabled":false}' \
                  https://streamrepeater.com/api/channels/1/destinations/7/toggle

Example: delete a destination

curl -X DELETE -H "Authorization: Bearer YOUR_TOKEN_HERE" \
                  https://streamrepeater.com/api/channels/1/destinations/7

{
  "message": "Destination pending deletion.",
  "destination": { "id": 7, "enabled": false, "pending_deletion": true }
}

Example: stream status

curl -H "Authorization: Bearer YOUR_TOKEN_HERE" https://streamrepeater.com/api/channels/1/status

{
  "channel_id": 1,
  "path_name": "acme--main",
  "status": "live",
  "viewers": 7,
  "destinations": [
    { "id": 7, "name": "YouTube", "enabled": true, "relay_status": "running" }
  ]
}

Example: delete a stream

curl -X DELETE -H "Authorization: Bearer YOUR_TOKEN_HERE" \
                  https://streamrepeater.com/api/channels/1

{
  "message": "Channel pending deletion.",
  "channel_id": 1,
  "pending_deletion": true
}

Example: stream analytics

curl -H "Authorization: Bearer YOUR_TOKEN_HERE" https://streamrepeater.com/api/channels/1/analytics

{
  "channel_id": 1,
  "window": "24h",
  "samples": [
    { "sampled_at": "2026-06-26T12:00:00Z", "inbound_bps": 5200000, "outbound_bps": 10400000, "viewers": 12 }
  ]
}

Example: list highlights

curl -H "Authorization: Bearer YOUR_TOKEN_HERE" https://streamrepeater.com/api/channels/1/highlights

[
  { "id": 4, "occurred_at": "2026-06-26T14:32:00Z", "messages": 47, "intensity": 60,
    "sample": [ { "author": "fan123", "message": "LETS GOOO" } ] }
]

Unified chat

Read live cross-platform chat, reply as the broadcaster and moderate through the same engine as the dashboard. Replies support twitch, kick and youtube when connected with the required scope. Actions are delete, timeout (10 minutes) and ban. Integrations must be enabled; writes require the Manage streams role.

# Poll new messages since the last id you saw
curl -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  "https://streamrepeater.com/api/tenants/1/chat?after=1024"

# Reply as your channel
curl -H "Authorization: Bearer YOUR_TOKEN_HERE" -H "Content-Type: application/json" \
  -d '{"platform":"twitch","message":"thanks for the raid!"}' \
  https://streamrepeater.com/api/tenants/1/chat/reply

# Time out a message’s author for 10 minutes
curl -H "Authorization: Bearer YOUR_TOKEN_HERE" -H "Content-Type: application/json" \
  -d '{"action":"timeout"}' \
  https://streamrepeater.com/api/tenants/1/chat/messages/2048/moderate

Integrations & automations

Read connected platforms, automation rules and event history, and send your own events into the rules engine. A custom event runs every matching action, so an external service can drive lights, Discord, webhooks, OBS and other on-stream automation. Responses omit connection tokens and action secrets.

# Fire a custom event — runs every rule listening for "custom.donation"
curl -H "Authorization: Bearer YOUR_TOKEN_HERE" -H "Content-Type: application/json" \
  -d '{"type":"custom.donation","context":{"name":"Ada","amount":"5.00"}}' \
  https://streamrepeater.com/api/tenants/1/events

{ "ok": true, "matched_rules": 2 }

# Read the recent event feed
curl -H "Authorization: Bearer YOUR_TOKEN_HERE" "https://streamrepeater.com/api/tenants/1/events?after=900"

Create rules for custom.* events in Integrations → Automations, then reference context fields such as @{{ amount }} in action templates.

Event webhooks

Create developer webhooks under Settings → Developer webhooks. Each delivery is a JSON POST signed in X-Streamrepeater-Signature with sha256= followed by the HMAC-SHA256 of the raw body using the endpoint signing secret.

{
  "id": "9b6f6b4d-2d13-4d4b-b3b8-54ff5d29c9ef",
  "event": "stream.live",
  "created_at": "2026-06-16T12:00:00+00:00",
  "data": {
    "channel": { "id": 1, "title": "Main Feed" },
    "destination_count": 2
  }
}

Available events include the canonical stream, destination, recording, bandwidth, AI-stream and AI-provider event identifiers shown above. Each carries message, details and its stream or provider; repeated events are collapsed like notification-bell items. AI events can trigger automation rules. Settings can send a ping test. Webhook endpoints can also be managed at /tenants/{tenant}/webhooks; the signing secret is returned once when created.

Need help integrating? Get in touch.