Auf dieser Seite
Authentifizierung
Erstelle im Dashboard unter Konto → API-Keys einen API-Key. Geschützte Endpunkte akzeptieren einen dieser Header:
X-API-Key: YOUR-API-KEYAuthorization: Bearer YOUR-API-KEYDer Key wird beim Erstellen einmal angezeigt. Bewahre ihn sicher auf. Sende Anfragen über HTTPS.
Anfragelimits
Die Limits gelten pro API-Key. Überschreitungen liefern HTTP 429.
| Tarif | Anfragen / Minute |
|---|---|
| Starter / Creator | 60 |
| IRL Pro / IRL Pro+ | 600 |
Antworten & Fehler
| HTTP | Bedeutung |
|---|---|
200 / 201 | Anfrage erfolgreich |
202 | Auftrag zur Verarbeitung angenommen |
400 | Ungültige Eingabe; Details stehen in der Antwort |
401 | API-Key fehlt oder ist ungültig |
404 | Ressource nicht gefunden |
409 | Aktion passt nicht zum aktuellen Zustand |
429 | Zu viele Anfragen |
500 | Serverfehler; später erneut versuchen |
Endpunkte
POST /v1/scenes/switch
Wechsle die aktive Szene einer laufenden Cloud-OBS-Sitzung.
Beispiel für den Request-Body
{ "scene": "BRB" }GET /v1/destinations
Lies deine gespeicherten Streaming-Ziele aus. Stream-Keys sind nicht in der Antwort enthalten.
POST /v1/destinations
Speichere ein Streaming-Ziel (bis zu 10 gespeicherte Einträge). Gleichzeitige Ausgaben hängen von Tarif und Streaming-Setup ab. Verwende die tatsächliche RTMP-URL und den Stream-Key deines Ziels.
Beispiel für den 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
Lies eine Momentaufnahme deines Streams: Bitrate, Status und Cloud-OBS-Aktivität.
POST /v1/clips
Fordere einen Clip aus dem laufenden Stream an. duration_s: 5–300 Sekunden, Standard 30. Eine erfolgreiche Antwort kann einen eingereihten Auftrag melden; der Clip ist dann noch nicht zwingend verfügbar.
Beispiel für den Request-Body
{ "duration_s": 30, "title": "Stream highlight" }GET /v1/overlays
Lies deine Overlays, ihre Konfiguration und zugeordneten Szenen aus.
PATCH /v1/overlays/:id
Aktualisiere dein Overlay. Alle Felder sind optional. Config wird auf oberster Ebene zusammengeführt: Ein mitgegebenes verschachteltes Objekt ersetzt das bisherige Objekt unter diesem Schlüssel.
Beispiel für den Request-Body
{
"config": { "fontSize": 22, "showAvatars": true },
"is_active": true,
"scene_names": ["Live", "BRB"]
}Fragen zu einer Integration?
Beschreibe Endpunkt, HTTP-Status und erwartetes Ergebnis im Discord. Entferne API-Keys und Stream-Keys, bevor du Beispiele teilst.
Discord Support