obs-relay
Broadcast control has escaped the interface

OBS-RELAY

Programmatic control for OBS.

REST, WebSocket, and OSC control for scenes, presets, playlists, audio, streaming, overlays, recording, and automation. Build your own control surface and drive OBS like software, not a menu.

Read Docs ↗ Get Started ↗
⌘REST ⚡WebSocket ∿OSC ◉OBS Studio

Powerful. Programmable. OBS.

Capabilities

Scene Control

Create, switch, and manage scenes with precision across your live workflow.

Presets & Automation

Apply and automate scene collections, side effects, and broadcast states.

Playlist Scheduling

Queue and schedule media playlists, hot-swap channels, and auto-advance items.

WebSocket Events

Receive real-time events for state changes, scene switches, and playback updates.

OSC / TouchOSC

Control OBS over OSC for phones, tablets, and custom hardware interfaces.

Recording & Streaming

Start, stop, pause, resume, and monitor recording and streaming from code.

Browser Prototyper

Build and preview browser sources and control surfaces directly in the stack.

Overlay Control

Update text, images, and browser overlays on the fly from your tools or UI.

Simple. Powerful. Open.

Protocol example

Request
$ curl -X POST http://localhost:8080/presets/intermission/activate \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "preset": "intermission",
  "actions": [
    { "action": "switch_scene", "scene": "Intermission" },
    { "action": "playlist_activate", "playlist": "intermission" }
  ]
}

Control. Orchestrate. Automate.

System concept

obs-relay is the control layer between your software and OBS Studio. Your app talks to obs-relay over REST, WebSocket, or OSC, and obs-relay handles scenes, playlists, overlays, audio, recording, and streaming behavior inside OBS.

Swipe to explore diagram
System concept diagram showing Your App or Tool connecting to obs-relay API, which then connects to OBS Studio, then Record and Stream, then Audience. Around the obs-relay API are feature modules for Scene Control, Presets, Playlist Scheduler, Overlay Control, Audio Control, and TouchOSC.

This graphic captures the project at a glance: your software in, broadcast orchestration out. It communicates that obs-relay is not just a utility endpoint, but the programmable hub that coordinates the whole OBS workflow.

Build beyond the interface

Everything OBS can do — now in your code. Start with the docs, use the setup guide, or jump into the browser GUI prototyper.

Open Docs ↗ View GUI ↗ Start Building ↗