Skip to main content
POST
Act on air

Authorizations

X-API-Key
string
header
required

A Streamloop API key (sl_…). It carries no workspace: send X-Workspace-Id too (400 WORKSPACE_REQUIRED otherwise).

Headers

Idempotency-Key
string

Retry safely: the key (per caller, workspace, method and path) is taken before the request runs, and its first answer is replayed for 24 hours, with Idempotency-Replayed: true — a repeat sent while the first still runs waits for it. The same key with a different body is 422 IDEMPOTENCY_KEY_REUSED. A 5xx is not kept: the retry runs.

Maximum string length: 200
X-Workspace-Id
string

The workspace to act in. Required with an API key; otherwise the session's own.

Path Parameters

id
string
required

The scene's id (scn_…)

Pattern: ^scn_

Body

application/json

The same names as the MCP's control_scene. Checked before anything else (422 INVALID_INPUT for an unknown op, a field the op doesn't take, a missing target, controlId or sourceId, a value of the wrong type): goFrame { target, transition? }, next { target? }, setControl { controlId, value? }, setData { sourceId, rows }, skip { sourceId? }; any of them with streamId.

op
enum<string>
required
Available options:
goFrame,
setControl,
setData,
next,
skip
streamId
string

Which stream (stream_…), when more than one plays the scene

target
string

goFrame (required), next: which one to take or cue, by the id in its path frame/<id>; next without it clears the cue

transition

goFrame: a kind, or { kind, ms } (default: the frame's own)

Available options:
cut,
fade,
slide,
wipe,
dip
controlId
string

setControl: the control's id (as in control/<id>)

value

setControl: its new value (a toggle true or false, a select one of its options; none for a button)

sourceId
string

setData: the table's id (as in source/data/<id>); skip: the playlist source's id (default: the first)

rows
object[]

setData: the table's rows

Response

Applied

The response is of type object.