Skip to main content
GET
List what a scene holds

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.

Path Parameters

id
string
required

The scene's id (scn_…)

Pattern: ^scn_

Response

The answer

What a draft operation answers. summary says what happened in a sentence; value is what a read found.

summary
string
value
object

What was read: a resource (with revision and children), a type (what it takes), or a list

path
string

A write: where it is stored (a new id is made unique)

revision
string

A write: the resource's new revision

frameRevision
string

A layer's write: the revision of the frame/<id> it is in (If-Match takes either)

created
boolean
diff
string

A write: a unified diff of what changed

removed
string[]
draftRevision
string

The whole draft as this answer saw it: publish takes it