Connect your own tools.

POST /v1/scenes/switch

Switch the active scene in a running Cloud OBS session.

Example request body

{ "scene": "BRB" }

GET /v1/destinations

Read your saved streaming destinations. Stream keys are not included in the response.

POST /v1/destinations

Save a streaming destination (up to 10 saved entries). The number of simultaneous outputs depends on your plan and streaming setup. Use the actual RTMP URL and stream key provided by your destination.

Example request body

{
  "name": "My destination",
  "platform": "custom",
  "rtmp_url": "rtmp://YOUR-INGEST-HOST/live",
  "stream_key": "YOUR-STREAM-KEY",
  "enabled": true
}

platform: twitch, youtube, kick, facebook, tiktok, instagram, custom

GET /v1/stats/live

Read a snapshot of your stream: bitrate, state and Cloud OBS activity.

POST /v1/clips

Request a clip from the running stream. duration_s: 5–300 seconds, default 30. A successful response may report a queued request; it does not always mean the clip is already available.

Example request body

{ "duration_s": 30, "title": "Stream highlight" }

GET /v1/overlays

Read your overlays, configuration and assigned scenes.

PATCH /v1/overlays/:id

Update your overlay. All fields are optional. Config is merged at the top level: a supplied nested object replaces the previous object at that key.

Example request body

{
  "config": { "fontSize": 22, "showAvatars": true },
  "is_active": true,
  "scene_names": ["Live", "BRB"]
}