Publish an older version again

curl --request POST \
  --url https://api.streamloop.app/v1/scenes/{id}/revert \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "version": 2,
  "expectedVersion": 1,
  "confirm": true
}
'

import requests

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

payload = {
    "version": 2,
    "expectedVersion": 1,
    "confirm": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({version: 2, expectedVersion: 1, confirm: true})
};

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

{
  "version": 123,
  "summary": "<string>",
  "publishedAt": "2023-11-07T05:31:56Z",
  "unchanged": true,
  "changes": [
    "<string>"
  ],
  "dryRun": true,
  "notes": [
    "<string>"
  ],
  "stale": true
}

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

Publish an older version again

Its document becomes the next version (the draft is untouched: publishing the draft later is refused with STALE_PUBLISH until you send overwritePublished, and discard makes the draft this version too). expectedVersion is required — the latest published version you saw (version in GET /scenes/), or send it as If-Match: "<n>" (sent both ways, they must be the same number, else 422 INVALID_INPUT); if someone published since — found up front or by a revert that lands first — nothing changes: STALE_PUBLISH (status 409 for expectedVersion, 412 for If-Match) with publishedVersion and what the revert would also take off air (reverted). On air, it is refused with CONFIRM_REQUIRED like a publish: send confirm: true to accept that.

POST

scenes

{id}

revert

Publish an older version again

curl --request POST \
  --url https://api.streamloop.app/v1/scenes/{id}/revert \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "version": 2,
  "expectedVersion": 1,
  "confirm": true
}
'

import requests

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

payload = {
    "version": 2,
    "expectedVersion": 1,
    "confirm": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({version: 2, expectedVersion: 1, confirm: true})
};

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

{
  "version": 123,
  "summary": "<string>",
  "publishedAt": "2023-11-07T05:31:56Z",
  "unchanged": true,
  "changes": [
    "<string>"
  ],
  "dryRun": true,
  "notes": [
    "<string>"
  ],
  "stale": true
}

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

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

If-Match

string

The published version you saw, instead of expectedVersion

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_

Body

application/json

version

integer

required

A published version's number (0 or less: 422 INVALID_INPUT; one that doesn't exist: 404)

Required range: x >= 1

expectedVersion

integer

The latest published version you saw (required, or If-Match)

Required range: x >= 0

confirm

boolean

I accept what CONFIRM_REQUIRED named: viewers see this at once

Response

Published

version

integer

The published version after this call. On a dry run it is unchanged (0: never published) and the draft would become the next one

summary

string

What happened and what comes next, in a sentence

publishedAt

string<date-time> | null

null on a dry run of a scene never published

unchanged

boolean

The draft was what is published already: no new version

changes

string[]

What changed since the previous version, as resource paths (change frame/main/title props.value, add source/data/hn)

dryRun

boolean

Only checked: nothing was published

notes

string[]

What to know about this publish: edits a pinned draftRevision left in the draft, a revert's draft

stale

boolean

The draftRevision was an older one: the draft has changed since, and those changes are not published

Get started

REST API

Scenes API

MCP server

GraphQL API

Publish an older version again

Authorizations

Headers

Path Parameters

Body

Response