Skip to main content
POST
Create a scene

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

X-Workspace-Id
string

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

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

Body

application/json
name
string
required
Required string length: 1 - 120
draft
object

Import: the draft to start from, refused (422) unless show is an object. A studio's saved project has this shape.

Response

The scene

id
string
name
string
version
integer

The published version; 0: never published

publishedAt
string<date-time> | null
createdAt
string<date-time>
updatedAt
string<date-time>
workspaceId
string
draftRevision
string

GET: the draft's revision now, what publish and discard take

streams
object[]

The streams that play it