Read a resource

curl --request GET \
  --url https://api.streamloop.app/v1/scenes/{id}/resources/{path} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.streamloop.app/v1/scenes/{id}/resources/{path}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "summary": "<string>",
  "value": {
    "path": "<string>",
    "revision": "<string>",
    "code": "<string>",
    "name": "<string>",
    "description": "<string>",
    "transition": {
      "kind": "cut",
      "ms": 123
    },
    "sound": "<string>",
    "children": [
      {
        "path": "<string>",
        "description": "<string>",
        "as": "image",
        "args": {}
      }
    ]
  },
  "path": "<string>",
  "revision": "<string>",
  "frameRevision": "<string>",
  "created": true,
  "diff": "<string>",
  "removed": [
    "<string>"
  ],
  "draftRevision": "<string>"
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "line": 123,
      "path": "<string>",
      "node": "<string>",
      "message": "<string>"
    }
  ],
  "currentRevision": "<string>"
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "line": 123,
      "path": "<string>",
      "node": "<string>",
      "message": "<string>"
    }
  ],
  "currentRevision": "<string>"
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "line": 123,
      "path": "<string>",
      "node": "<string>",
      "message": "<string>"
    }
  ],
  "currentRevision": "<string>"
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "line": 123,
      "path": "<string>",
      "node": "<string>",
      "message": "<string>"
    }
  ],
  "currentRevision": "<string>"
}

Read a resource

A resource with its revision (also the ETag) and children (the paths to read next); a type (frame, source/data, element/Text: what it takes, with an example); or a list (a path ending in /*). as=image on a frame/<id> or a layer answers a PNG of it as it goes on air, drawn by the channel’s renderer — or, with Accept: application/json, the picture as a data URL with what drew (drawn) and what is wrong (issues: outside title-safe, overlapping, too small, a bound table with no rows). version reads a published version instead of the draft. If-None-Match with the ETag you hold answers 304 when nothing changed.

GET

scenes

{id}

resources

{path}

Read a resource

curl --request GET \
  --url https://api.streamloop.app/v1/scenes/{id}/resources/{path} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.streamloop.app/v1/scenes/{id}/resources/{path}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "summary": "<string>",
  "value": {
    "path": "<string>",
    "revision": "<string>",
    "code": "<string>",
    "name": "<string>",
    "description": "<string>",
    "transition": {
      "kind": "cut",
      "ms": 123
    },
    "sound": "<string>",
    "children": [
      {
        "path": "<string>",
        "description": "<string>",
        "as": "image",
        "args": {}
      }
    ]
  },
  "path": "<string>",
  "revision": "<string>",
  "frameRevision": "<string>",
  "created": true,
  "diff": "<string>",
  "removed": [
    "<string>"
  ],
  "draftRevision": "<string>"
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "line": 123,
      "path": "<string>",
      "node": "<string>",
      "message": "<string>"
    }
  ],
  "currentRevision": "<string>"
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "line": 123,
      "path": "<string>",
      "node": "<string>",
      "message": "<string>"
    }
  ],
  "currentRevision": "<string>"
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "line": 123,
      "path": "<string>",
      "node": "<string>",
      "message": "<string>"
    }
  ],
  "currentRevision": "<string>"
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "line": 123,
      "path": "<string>",
      "node": "<string>",
      "message": "<string>"
    }
  ],
  "currentRevision": "<string>"
}

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

string

required

The scene's id (scn_…)

Pattern: ^scn_

path

string

required

A resource path, slashes and all: frame/intro, frame/intro/title, source/data/headlines/rows, component/LowerThird, script/show.ts, a type (element/Text) or a list (frame/*)

Query Parameters

enum<string>

image: a PNG of a frame/<id> (at most 1280 px wide) or a layer (full size); json: a frame/<id> as a node tree instead of JSX

Available options:

image,

json

version

string

A published version's number (a positive integer), or published; anything else is 422 INVALID_INPUT

limit

integer

Rows per page (…/rows)

Required range: 1 <= x <= 200

offset

integer

First row (…/rows)

Required range: x >= 0

number

Picture: ms since that frame/<id> went on air

overlay

enum<string>

Picture: a 10 % grid, or each layer's outline and id

Available options:

grid,

ids

data

enum<string>

Picture: bindings read live values (the default: tables as last read) or each table's sample rows. A picture draws the frame as it would go on air — it is not a capture of a running stream: controls and state are at their starting values

Available options:

live,

sample

Response

The answer, or a PNG for as=image (a picture lists, with Accept: application/json, what didn't draw in notDrawn and why in issues — an Image whose file the channel can't load among them)

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

Show child attributes

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

Get started

REST API

Scenes API

MCP server

GraphQL API

Read a resource

Authorizations

Headers

Path Parameters

Query Parameters

Response