Create or replace a resource

curl --request PUT \
  --url https://api.streamloop.app/v1/scenes/{id}/resources/{path} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Weather",
  "description": "London weather over a dark gradient",
  "code": "<Frame background={{ type: \"gradient\", from: \"#05070F\", to: \"#1B2A4A\", angle: 160 }}>\n  <Text id=\"temp\" value={data.weather.rows[0].temperature_2m} x={96} y={54} style={{ fontSize: 72, color: \"#FFFFFF\" }} />\n</Frame>"
}
'

import requests

url = "https://api.streamloop.app/v1/scenes/{id}/resources/{path}"

payload = {
    "name": "Weather",
    "description": "London weather over a dark gradient",
    "code": "<Frame background={{ type: \"gradient\", from: \"#05070F\", to: \"#1B2A4A\", angle: 160 }}>
  <Text id=\"temp\" value={data.weather.rows[0].temperature_2m} x={96} y={54} style={{ fontSize: 72, color: \"#FFFFFF\" }} />
</Frame>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Weather',
    description: 'London weather over a dark gradient',
    code: '<Frame background={{ type: "gradient", from: "#05070F", to: "#1B2A4A", angle: 160 }}>\n  <Text id="temp" value={data.weather.rows[0].temperature_2m} x={96} y={54} style={{ fontSize: 72, color: "#FFFFFF" }} />\n</Frame>'
  })
};

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>"
}

{
  "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>"
}

{
  "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>"
}

Create or replace a resource

The whole resource, as GET answers it: a frame/<id> { name, description?, transition?, code } (code: its <Frame>…</Frame> element in JSX) or { name, root } (JSON); a component { description, props, tsx }; a source its fields. Or the code alone, with Content-Type: text/jsx (a frame/<id>), text/tsx (a component) or text/typescript (the script). Built and checked as the studio checks it: a refused change changes nothing and answers every problem (422 CHECK_FAILED, errors). If-Match: the revision you read; 412 PRECONDITION_FAILED (with currentRevision) if it changed since (*: it must exist); If-None-Match: * creates only. A new resource answers 201 with its Location. Code sent as the wrong kind for its path, or a body that is neither JSON nor code (application/xml), is 415.

PUT

scenes

{id}

resources

{path}

Create or replace a resource

curl --request PUT \
  --url https://api.streamloop.app/v1/scenes/{id}/resources/{path} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Weather",
  "description": "London weather over a dark gradient",
  "code": "<Frame background={{ type: \"gradient\", from: \"#05070F\", to: \"#1B2A4A\", angle: 160 }}>\n  <Text id=\"temp\" value={data.weather.rows[0].temperature_2m} x={96} y={54} style={{ fontSize: 72, color: \"#FFFFFF\" }} />\n</Frame>"
}
'

import requests

url = "https://api.streamloop.app/v1/scenes/{id}/resources/{path}"

payload = {
    "name": "Weather",
    "description": "London weather over a dark gradient",
    "code": "<Frame background={{ type: \"gradient\", from: \"#05070F\", to: \"#1B2A4A\", angle: 160 }}>
  <Text id=\"temp\" value={data.weather.rows[0].temperature_2m} x={96} y={54} style={{ fontSize: 72, color: \"#FFFFFF\" }} />
</Frame>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Weather',
    description: 'London weather over a dark gradient',
    code: '<Frame background={{ type: "gradient", from: "#05070F", to: "#1B2A4A", angle: 160 }}>\n  <Text id="temp" value={data.weather.rows[0].temperature_2m} x={96} y={54} style={{ fontSize: 72, color: "#FFFFFF" }} />\n</Frame>'
  })
};

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>"
}

{
  "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>"
}

{
  "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

If-Match

string

The revision (ETag) you read — one, or a comma-separated list of which any current one matches — compared strongly (a weak W/"…" tag never matches): refused with 412 PRECONDITION_FAILED if the resource changed since or no longer exists (the problem carries currentRevision, null when it is gone, and for a layer frameRevision: either is taken). A layer takes its own revision or that of the frame/<id> it is in. *: it must exist. Checked atomically with the write: of two writes sent at once with the same revision, one lands and the other is 412.

If-None-Match

string

*: create only — 412 if the resource exists already. On a GET, the ETag you hold (a weak W/"…" one too): 304 when nothing changed.

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/*)

Body

The body is of type object.

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

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

Create or replace a resource

Authorizations

Headers

Path Parameters

Body

Response