Streamloop is an MCP server published by io.github.streamloop, hosted at mcp.streamloop.app. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 42 tools, including stream_list, stream_get, stream_create, stream_create_copy, stream_update.
Manage cloud-hosted 24/7 video streams, playlists, destinations, schedules, media and workspaces.
Nothing else in the archive shares these values.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
List streams filtered by status, id, name and return their quick overview.
| Parameter | Type | Description |
|---|---|---|
| id | string | |
| name | string | Part of the name, case-insensitive. |
| sort | string | By creation time. |
| after | string | nextCursor of the previous page. |
| first | integer | |
| status | string | active: live or starting. scheduled: waiting for its start time. inactive: neither. |
None yet. Changes appear after a server's second daily check.
{
"name": "stream_list",
"title": "List streams",
"description": "List streams filtered by status, id, name and return their quick overview.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"id": {
"type": "string",
"pattern": "^stream_"
},
"name": {
"type": "string",
"description": "Part of the name, case-insensitive."
},
"sort": {
"enum": [
"newest",
"oldest"
],
"type": "string",
"default": "newest",
"description": "By creation time."
},
"after": {
"type": "string",
"description": "nextCursor of the previous page."
},
"first": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
},
"status": {
"enum": [
"active",
"scheduled",
"inactive"
],
"type": "string",
"description": "active: live or starting. scheduled: waiting for its start time. inactive: neither."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"items",
"nextCursor",
"hasMore",
"total"
],
"properties": {
"items": {},
"total": {},
"hasMore": {},
"nextCursor": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "List streams",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Get stream (loop) information, use it to get its current state, enabled destinations and configuration.
| Parameter | Type | Description |
|---|---|---|
| id * | string |
{
"name": "stream_get",
"title": "Get stream",
"description": "Get stream (loop) information, use it to get its current state, enabled destinations and configuration.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^stream_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"name",
"state",
"kind",
"schedule",
"outputs",
"videoPlaylistId",
"audioPlaylistId",
"sceneId",
"youtubeLiveStats",
"problem"
],
"properties": {
"id": {},
"kind": {},
"name": {},
"state": {},
"issues": {},
"outputs": {},
"problem": {},
"sceneId": {},
"schedule": {},
"audioPlaylistId": {},
"videoPlaylistId": {},
"youtubeLiveStats": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Get stream",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Create a new stream. You can create stream for pre-recorded videos or live scene stream (supports pre-recorded videos too). Live scene is used for more complex setups to include features like overlays, layouts, multiple inputs, and so on. Afterwards, use stream_update to set its quality and framerate (a new stream has none, and cannot start without them), stream_add_output to link destination, scene_* to manage linked scene and playlist_* to manage playlists linked to the stream.
| Parameter | Type | Description |
|---|---|---|
| kind * | string | one of ["pre_recorded","scene"] |
| name * | string |
{
"name": "stream_create",
"title": "Create stream",
"description": "Create a new stream. You can create stream for pre-recorded videos or live scene stream (supports pre-recorded videos too). Live scene is used for more complex setups to include features like overlays, layouts, multiple inputs, and so on. Afterwards, use stream_update to set its quality and framerate (a new stream has none, and cannot start without them), stream_add_output to link destination, scene_* to manage linked scene and playlist_* to manage playlists linked to the stream.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"kind"
],
"properties": {
"kind": {
"enum": [
"pre_recorded",
"scene"
],
"type": "string"
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"kind",
"sceneId"
],
"properties": {
"id": {},
"kind": {},
"sceneId": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Create stream",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Copies a stream into a new draft: its settings, playlists (items and playing order), linked destinations and YouTube settings; never its schedule. A scene stream's copy plays the same scene as the original, not a copy of it: editing the scene changes both. `copied` lists what was carried over.
| Parameter | Type | Description |
|---|---|---|
| id * | string | The stream to copy. |
| name | string | Name of the copy. Omitted: the original's name with "(copy)". |
{
"name": "stream_create_copy",
"title": "Copy stream",
"description": "Copies a stream into a new draft: its settings, playlists (items and playing order), linked destinations and YouTube settings; never its schedule. A scene stream's copy plays the same scene as the original, not a copy of it: editing the scene changes both. `copied` lists what was carried over.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^stream_",
"description": "The stream to copy."
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Name of the copy. Omitted: the original's name with \"(copy)\"."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"copied"
],
"properties": {
"id": {},
"copied": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Copy stream",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Updates stream configuration. Quality and framerate: not while live.
| Parameter | Type | Description |
|---|---|---|
| id * | string | |
| name | string | |
| quality | string | Output resolution. Higher costs more credits per minute. |
| framerate | string | one of ["f_24","f_25","f_30","f_60"] |
| storageBackend | string | standard: up to 50 GiB of media, included. large: grows with the playlist, billed per GiB-month. |
| streamDuration | integer | Seconds a session runs before it stops by itself, for manual starts and schedules alike: stream_schedule durationSeconds writes this same value. 0: until stopped. |
| runBackupStream | boolean | Dual stream: also publish to YouTube's backup ingest in parallel. Adds 40% of the stream's price while live. |
{
"name": "stream_update",
"title": "Update stream",
"description": "Updates stream configuration. Quality and framerate: not while live.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^stream_"
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"quality": {
"enum": [
"q_720p",
"q_1080p",
"q_1440p",
"q_2160p"
],
"type": "string",
"description": "Output resolution. Higher costs more credits per minute."
},
"framerate": {
"enum": [
"f_24",
"f_25",
"f_30",
"f_60"
],
"type": "string"
},
"storageBackend": {
"enum": [
"standard",
"large"
],
"type": "string",
"description": "standard: up to 50 GiB of media, included. large: grows with the playlist, billed per GiB-month."
},
"streamDuration": {
"type": "integer",
"maximum": 31536000,
"minimum": 0,
"description": "Seconds a session runs before it stops by itself, for manual starts and schedules alike: stream_schedule durationSeconds writes this same value. 0: until stopped."
},
"runBackupStream": {
"type": "boolean",
"description": "Dual stream: also publish to YouTube's backup ingest in parallel. Adds 40% of the stream's price while live."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Update stream",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Updates YouTube broadcast settings (only when has linked YouTube channel using Oauth).
| Parameter | Type | Description |
|---|---|---|
| id * | string | |
| tags | array | Replaces the current tags. |
| title | string | |
| privacy | string | one of ["public","unlisted","private"] |
| category | string | one of ["Film & Animation","Autos & Vehicles","Music","Pets & Animals","Sports","Travel & Events","Gaming","People & Blogs","Comedy","Entertainment","News & Politics","Howto & Style","Education","Science & T… |
| enableDvr | boolean | Viewers can pause and rewind. |
| embeddable | boolean | |
| adFrequency | string | Mid-roll ad breaks. Partner Program channels only. |
| description | string | |
| madeForKids | string | Required by YouTube before a stream can start. Ask the user, never assume. |
| retryMirror | boolean | Copy the stream's schedule onto YouTube again, e.g. after reconnecting the channel. |
| ageRestricted | string | one of ["unspecified","yes","no"] |
| defaultLanguage | string | Language of the title, e.g. en, es-MX. |
| recordFromStart | boolean | Keep the broadcast as a video after it ends. |
| thumbnailSource | string | auto: a frame of the first video. custom: thumbnailObjectID. none: YouTube's own. |
| latencyPreference | string | one of ["normal","low","ultra_low"] |
| thumbnailObjectID | string | An uploaded image, for thumbnailSource custom. |
| defaultAudioLanguage | string | Spoken language, e.g. en, es-MX. |
| scheduleOnYoutubeWhenScheduled | boolean | Show the broadcast as upcoming on the channel as soon as the stream is scheduled. |
{
"name": "stream_update_youtube_broadcast_settings",
"title": "Update YouTube broadcast settings",
"description": "Updates YouTube broadcast settings (only when has linked YouTube channel using Oauth).",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^stream_"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Replaces the current tags."
},
"title": {
"type": "string",
"maxLength": 100
},
"privacy": {
"enum": [
"public",
"unlisted",
"private"
],
"type": "string"
},
"category": {
"enum": [
"Film & Animation",
"Autos & Vehicles",
"Music",
"Pets & Animals",
"Sports",
"Travel & Events",
"Gaming",
"People & Blogs",
"Comedy",
"Entertainment",
"News & Politics",
"Howto & Style",
"Education",
"Science & Technology",
"Nonprofits & Activism"
],
"type": "string"
},
"enableDvr": {
"type": "boolean",
"description": "Viewers can pause and rewind."
},
"embeddable": {
"type": "boolean"
},
"adFrequency": {
"enum": [
"off",
"conservative",
"balanced",
"aggressive"
],
"type": "string",
"description": "Mid-roll ad breaks. Partner Program channels only."
},
"description": {
"type": "string",
"maxLength": 5000
},
"madeForKids": {
"enum": [
"unspecified",
"yes",
"no"
],
"type": "string",
"description": "Required by YouTube before a stream can start. Ask the user, never assume."
},
"retryMirror": {
"type": "boolean",
"description": "Copy the stream's schedule onto YouTube again, e.g. after reconnecting the channel."
},
"ageRestricted": {
"enum": [
"unspecified",
"yes",
"no"
],
"type": "string"
},
"defaultLanguage": {
"type": "string",
"description": "Language of the title, e.g. en, es-MX."
},
"recordFromStart": {
"type": "boolean",
"description": "Keep the broadcast as a video after it ends."
},
"thumbnailSource": {
"enum": [
"auto",
"custom",
"none"
],
"type": "string",
"description": "auto: a frame of the first video. custom: thumbnailObjectID. none: YouTube's own."
},
"latencyPreference": {
"enum": [
"normal",
"low",
"ultra_low"
],
"type": "string"
},
"thumbnailObjectID": {
"type": "string",
"pattern": "^obj_",
"description": "An uploaded image, for thumbnailSource custom."
},
"defaultAudioLanguage": {
"type": "string",
"description": "Spoken language, e.g. en, es-MX."
},
"scheduleOnYoutubeWhenScheduled": {
"type": "boolean",
"description": "Show the broadcast as upcoming on the channel as soon as the stream is scheduled."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"properties": {
"mirrorRetried": {},
"youtubeSettings": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Update YouTube broadcast settings",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Deletes a stream with its playlists and schedule. Uploaded media and destinations are kept. A scene stream's scene is deleted with it unless another stream plays that scene. Refused with STREAM_LIVE while it is on air: stop it first. A stream already deleted is NOT_FOUND.
| Parameter | Type | Description |
|---|---|---|
| id * | string |
{
"name": "stream_remove",
"title": "Remove stream",
"description": "Deletes a stream with its playlists and schedule. Uploaded media and destinations are kept. A scene stream's scene is deleted with it unless another stream plays that scene. Refused with STREAM_LIVE while it is on air: stop it first. A stream already deleted is NOT_FOUND.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^stream_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"deleted",
"id"
],
"properties": {
"id": {},
"deleted": {},
"sceneDeleted": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Remove stream",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Links a destination to the stream. Up to 5 per stream, disabled ones included, and one YouTube channel connected through OAuth at most (RTMP destinations to YouTube are not counted). Not while live.
| Parameter | Type | Description |
|---|---|---|
| streamId * | string | |
| destinationId * | string |
{
"name": "stream_add_output",
"title": "Link a destination to a stream",
"description": "Links a destination to the stream. Up to 5 per stream, disabled ones included, and one YouTube channel connected through OAuth at most (RTMP destinations to YouTube are not counted). Not while live.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"streamId",
"destinationId"
],
"properties": {
"streamId": {
"type": "string",
"pattern": "^stream_"
},
"destinationId": {
"type": "string",
"pattern": "^dest_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"outputs"
],
"properties": {
"id": {},
"outputs": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Link a destination to a stream",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Unlinks a destination from the stream; one that is not linked is left as it is. Not while live; use stream_toggle_output.
| Parameter | Type | Description |
|---|---|---|
| streamId * | string | |
| destinationId * | string |
{
"name": "stream_remove_output",
"title": "Unlink a destination from a stream",
"description": "Unlinks a destination from the stream; one that is not linked is left as it is. Not while live; use stream_toggle_output.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"streamId",
"destinationId"
],
"properties": {
"streamId": {
"type": "string",
"pattern": "^stream_"
},
"destinationId": {
"type": "string",
"pattern": "^dest_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"outputs"
],
"properties": {
"id": {},
"outputs": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Unlink a destination from a stream",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Enables or disables a linked destination without unlinking it. Disabling works while live and takes that destination off air; enabling does not work while live.
| Parameter | Type | Description |
|---|---|---|
| enabled * | boolean | |
| streamId * | string | |
| destinationId * | string |
{
"name": "stream_toggle_output",
"title": "Enable or disable a stream's destination",
"description": "Enables or disables a linked destination without unlinking it. Disabling works while live and takes that destination off air; enabling does not work while live.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"streamId",
"destinationId",
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
},
"streamId": {
"type": "string",
"pattern": "^stream_"
},
"destinationId": {
"type": "string",
"pattern": "^dest_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"outputs"
],
"properties": {
"id": {},
"outputs": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Enable or disable a stream's destination",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}Schedules the stream to start at a set time, optionally with an end and a repeat. Replaces any existing schedule.
| Parameter | Type | Description |
|---|---|---|
| days | array | weekly: weekdays to start on, in UTC. Omitted: every 7 days. |
| endAt | string | When a session ends. Needed for daily and weekly. Omitted: runs until stopped. |
| repeat | string | What happens after a session ends. none: nothing. daily / weekly: the same session again at the same time. restart: run for durationSeconds, stop, wait restartGapSeconds, start a new session, and so on until stopped; e.g. restart every 12 hours with a 30 s break is durationSeconds 43200, restartGapS… |
| startAt * | string | Start time with the user's UTC offset, e.g. 2026-09-22T06:00:00-04:00. No offset: refused. |
| streamId * | string | |
| durationSeconds | integer | Instead of endAt: a session ends this long after going live. Required for restart, where it is at least 600. Stored as the stream's streamDuration, so it also ends manual starts and stays after stream_cancel_schedule; stream_update streamDuration 0 removes it. |
| restartGapSeconds | integer | restart: seconds between one session ending and the next starting. 0: right away. |
{
"name": "stream_schedule",
"title": "Schedule stream",
"description": "Schedules the stream to start at a set time, optionally with an end and a repeat. Replaces any existing schedule.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"streamId",
"startAt"
],
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"SUNDAY",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY"
],
"type": "string"
},
"description": "weekly: weekdays to start on, in UTC. Omitted: every 7 days."
},
"endAt": {
"type": "string",
"format": "date-time",
"description": "When a session ends. Needed for daily and weekly. Omitted: runs until stopped."
},
"repeat": {
"enum": [
"none",
"daily",
"weekly",
"restart"
],
"type": "string",
"description": "What happens after a session ends. none: nothing. daily / weekly: the same session again at the same time. restart: run for durationSeconds, stop, wait restartGapSeconds, start a new session, and so on until stopped; e.g. restart every 12 hours with a 30 s break is durationSeconds 43200, restartGapSeconds 30."
},
"startAt": {
"type": "string",
"format": "date-time",
"description": "Start time with the user's UTC offset, e.g. 2026-09-22T06:00:00-04:00. No offset: refused."
},
"streamId": {
"type": "string",
"pattern": "^stream_"
},
"durationSeconds": {
"type": "integer",
"minimum": 60,
"description": "Instead of endAt: a session ends this long after going live. Required for restart, where it is at least 600. Stored as the stream's streamDuration, so it also ends manual starts and stays after stream_cancel_schedule; stream_update streamDuration 0 removes it."
},
"restartGapSeconds": {
"type": "integer",
"minimum": 0,
"description": "restart: seconds between one session ending and the next starting. 0: right away."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"stream",
"scheduledUTC"
],
"properties": {
"stream": {},
"scheduledUTC": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Schedule stream",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Removes the stream's schedule and repeat. A live session keeps running. The stream's streamDuration stays (stream_update streamDuration 0 removes it).
| Parameter | Type | Description |
|---|---|---|
| streamId * | string |
{
"name": "stream_cancel_schedule",
"title": "Cancel stream schedule",
"description": "Removes the stream's schedule and repeat. A live session keeps running. The stream's streamDuration stays (stream_update streamDuration 0 removes it).",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"streamId"
],
"properties": {
"streamId": {
"type": "string",
"pattern": "^stream_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Cancel stream schedule",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Starts the stream now. It answers at once with state preparing; the stream goes preparing, activating, then active (on air) within about a minute: read it with stream_get, which also says why when it fails. Refused with STREAM_NOT_READY and the issues to fix when it is not ready, and while it is already starting or running.
| Parameter | Type | Description |
|---|---|---|
| streamId * | string |
{
"name": "stream_start",
"title": "Start stream",
"description": "Starts the stream now. It answers at once with state preparing; the stream goes preparing, activating, then active (on air) within about a minute: read it with stream_get, which also says why when it fails. Refused with STREAM_NOT_READY and the issues to fix when it is not ready, and while it is already starting or running.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"streamId"
],
"properties": {
"streamId": {
"type": "string",
"pattern": "^stream_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"state"
],
"properties": {
"id": {},
"state": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Start stream",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": false
}
}Stops the stream: it goes off air on every destination and stops spending credits. Media, playlists and settings are kept. A schedule starts it again unless `cancelSchedule` is set. A scheduled stream that is not running yet is left as it is, unless `cancelSchedule` is set.
| Parameter | Type | Description |
|---|---|---|
| streamId * | string | |
| cancelSchedule | boolean | Also remove its schedule, so a repeat does not start it again. |
{
"name": "stream_stop",
"title": "Stop stream",
"description": "Stops the stream: it goes off air on every destination and stops spending credits. Media, playlists and settings are kept. A schedule starts it again unless `cancelSchedule` is set. A scheduled stream that is not running yet is left as it is, unless `cancelSchedule` is set.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"streamId"
],
"properties": {
"streamId": {
"type": "string",
"pattern": "^stream_"
},
"cancelSchedule": {
"type": "boolean",
"description": "Also remove its schedule, so a repeat does not start it again."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Stop stream",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}Checks whether the stream can start, including whether the workspace has the credits for it, and returns the blocking issues with how to fix each. A few show only once an earlier one is fixed (sound is checked once there is video), so check again after fixing. It does not contact the destination: a wrong stream key shows only when the stream starts.
| Parameter | Type | Description |
|---|---|---|
| streamId * | string |
{
"name": "stream_preflight_check",
"title": "Check a stream can start",
"description": "Checks whether the stream can start, including whether the workspace has the credits for it, and returns the blocking issues with how to fix each. A few show only once an earlier one is fixed (sound is checked once there is video), so check again after fixing. It does not contact the destination: a wrong stream key shows only when the stream starts.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"streamId"
],
"properties": {
"streamId": {
"type": "string",
"pattern": "^stream_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"ready",
"issues"
],
"properties": {
"ready": {},
"issues": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Check a stream can start",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Lists destinations (YouTube channels and custom RTMP endpoints) with their status. Stream keys are never returned.
| Parameter | Type | Description |
|---|---|---|
| id | string | |
| kind | string | Filter destinations by either youtube_oauth (direct YouTube connection) or rtmp (includes YouTube as well, but by RTMP keys). |
| name | string | Part of the name, case-insensitive. |
| sort | string | By creation time. |
{
"name": "destination_list",
"title": "List destinations",
"description": "Lists destinations (YouTube channels and custom RTMP endpoints) with their status. Stream keys are never returned.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"id": {
"type": "string",
"pattern": "^dest_"
},
"kind": {
"enum": [
"youtube_oauth",
"rtmp"
],
"type": "string",
"description": "Filter destinations by either youtube_oauth (direct YouTube connection) or rtmp (includes YouTube as well, but by RTMP keys)."
},
"name": {
"type": "string",
"description": "Part of the name, case-insensitive."
},
"sort": {
"enum": [
"newest",
"oldest"
],
"type": "string",
"default": "newest",
"description": "By creation time."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"items",
"total"
],
"properties": {
"items": {},
"total": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "List destinations",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Returns how to connect a platform: its RTMP ingest URL, where the user finds the stream key, and platform limits. Use it before destination_create_rtmp; never guess an ingest URL.
| Parameter | Type | Description |
|---|---|---|
| platform * | string | one of ["youtube","twitch","facebook","x","kick","tiktok","linkedin","telegram","other"] |
{
"name": "destination_connection_hints",
"title": "How to connect a platform",
"description": "Returns how to connect a platform: its RTMP ingest URL, where the user finds the stream key, and platform limits. Use it before destination_create_rtmp; never guess an ingest URL.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"platform"
],
"properties": {
"platform": {
"enum": [
"youtube",
"twitch",
"facebook",
"x",
"kick",
"tiktok",
"linkedin",
"telegram",
"other"
],
"type": "string"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"platform",
"displayName",
"methods",
"whereToFindTheKey",
"gotchas"
],
"properties": {
"gotchas": {},
"methods": {},
"platform": {},
"displayName": {},
"whereToFindTheKey": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "How to connect a platform",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Creates a destination from an RTMP URL and stream key (Twitch, Kick, Facebook, any RTMP server). A stream key backs one destination: the same key again is refused with the existing destination's id. The URL cannot be changed later (remove the destination and create it again); the key can, with destination_update. `rtmpUrl` is shown by destination_list, so the key goes in `rtmpKey`, never in the URL.
| Parameter | Type | Description |
|---|---|---|
| name * | string | |
| rtmpKey * | string | |
| rtmpUrl * | string |
{
"name": "destination_create_rtmp",
"title": "Create RTMP destination",
"description": "Creates a destination from an RTMP URL and stream key (Twitch, Kick, Facebook, any RTMP server). A stream key backs one destination: the same key again is refused with the existing destination's id. The URL cannot be changed later (remove the destination and create it again); the key can, with destination_update. `rtmpUrl` is shown by destination_list, so the key goes in `rtmpKey`, never in the URL.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"rtmpUrl",
"rtmpKey"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"rtmpKey": {
"type": "string",
"minLength": 1
},
"rtmpUrl": {
"type": "string",
"pattern": "^rtmps?://"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"name",
"kind",
"status"
],
"properties": {
"id": {},
"kind": {},
"name": {},
"status": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Create RTMP destination",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Connects a YouTube channel through Google OAuth. Without `channelId` returns the consent URL for the user to open (valid for about 10 minutes), `channels` (authorized, with no destination yet: pass one's `channelId` to create it) and `connected` (channels that already are destinations); with `channelId` creates the destination.
| Parameter | Type | Description |
|---|---|---|
| name | string | With channelId only. Omitted: the channel title. |
| channelId | string | From this tool's previous answer. |
{
"name": "destination_create_youtube_oauth",
"title": "Connect a YouTube channel",
"description": "Connects a YouTube channel through Google OAuth. Without `channelId` returns the consent URL for the user to open (valid for about 10 minutes), `channels` (authorized, with no destination yet: pass one's `channelId` to create it) and `connected` (channels that already are destinations); with `channelId` creates the destination.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "With channelId only. Omitted: the channel title."
},
"channelId": {
"type": "string",
"minLength": 1,
"description": "From this tool's previous answer."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"properties": {
"id": {},
"channels": {},
"connected": {},
"authorizationUrl": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Connect a YouTube channel",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Renames a destination or replaces its RTMP stream key. A live stream uses the new key after a restart.
| Parameter | Type | Description |
|---|---|---|
| id * | string | |
| name | string | |
| rtmpKey | string |
{
"name": "destination_update",
"title": "Update destination",
"description": "Renames a destination or replaces its RTMP stream key. A live stream uses the new key after a restart.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^dest_"
},
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"rtmpKey": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"name",
"kind",
"status"
],
"properties": {
"id": {},
"kind": {},
"name": {},
"status": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Update destination",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Removes a destination from the workspace; it no longer appears in destination_list, and every stream it was linked to loses that output (stream_get lists a stream's outputs). Refused while a live stream uses it. The channel or RTMP server itself is not touched.
| Parameter | Type | Description |
|---|---|---|
| id * | string |
{
"name": "destination_remove",
"title": "Remove destination",
"description": "Removes a destination from the workspace; it no longer appears in destination_list, and every stream it was linked to loses that output (stream_get lists a stream's outputs). Refused while a live stream uses it. The channel or RTMP server itself is not touched.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^dest_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"removed",
"id"
],
"properties": {
"id": {},
"removed": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Remove destination",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Returns a playlist: its version, playing order (`mode`) and items (item id, media id, name, duration). Items come in their stored order: shuffle and custom play them in another order without reordering them here. Playlist ids come from stream_get.
| Parameter | Type | Description |
|---|---|---|
| id * | string | |
| after | string | nextCursor of the previous page. |
| first | integer |
{
"name": "playlist_get",
"title": "Get playlist",
"description": "Returns a playlist: its version, playing order (`mode`) and items (item id, media id, name, duration). Items come in their stored order: shuffle and custom play them in another order without reordering them here. Playlist ids come from stream_get.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^pl_"
},
"after": {
"type": "string",
"description": "nextCursor of the previous page."
},
"first": {
"type": "integer",
"default": 100,
"maximum": 200,
"minimum": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"kind",
"version",
"mode",
"customOrderId",
"items",
"nextCursor",
"hasMore",
"total"
],
"properties": {
"id": {},
"kind": {},
"mode": {},
"items": {},
"total": {},
"hasMore": {},
"version": {},
"nextCursor": {},
"customOrderId": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Get playlist",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Adds, removes and reorders playlist items with a JSON Patch (RFC 6902) over the document playlist_get returns. All operations apply or none. Media must be ready (upload_get_import_job_state) and of the playlist's kind: video in a video playlist, audio in an audio one. `test` checks /version only, and refuses the patch with CONFLICT when the playlist changed since it was read.
| Parameter | Type | Description |
|---|---|---|
| live | boolean | Apply to the running stream now. Omitted: a live stream keeps its current playlist until restarted. |
| patch * | array | |
| playlistId * | string |
{
"name": "playlist_patch",
"title": "Edit playlist",
"description": "Adds, removes and reorders playlist items with a JSON Patch (RFC 6902) over the document playlist_get returns. All operations apply or none. Media must be ready (upload_get_import_job_state) and of the playlist's kind: video in a video playlist, audio in an audio one. `test` checks /version only, and refuses the patch with CONFLICT when the playlist changed since it was read.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"playlistId",
"patch"
],
"properties": {
"live": {
"type": "boolean",
"description": "Apply to the running stream now. Omitted: a live stream keeps its current playlist until restarted."
},
"patch": {
"type": "array",
"items": {
"type": "object",
"required": [
"op",
"path"
],
"properties": {
"op": {
"enum": [
"add",
"remove",
"move",
"replace",
"test"
],
"type": "string"
},
"from": {
"type": "string",
"pattern": "^/items/\\d+$",
"description": "move only."
},
"path": {
"type": "string",
"pattern": "^/(items/(\\d+|-)|version)$",
"description": "/items/<index>, /items/- (end), or /version (test only)."
},
"value": {
"description": "add, replace: {\"objectId\":\"obj_…\"}. test: the version from playlist_get."
}
},
"additionalProperties": false
},
"examples": [
[
{
"op": "add",
"path": "/items/-",
"value": {
"objectId": "obj_123"
}
},
{
"op": "move",
"from": "/items/4",
"path": "/items/0"
}
]
],
"minItems": 1
},
"playlistId": {
"type": "string",
"pattern": "^pl_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"kind",
"version",
"mode",
"customOrderId",
"items",
"nextCursor",
"hasMore",
"total"
],
"properties": {
"id": {},
"kind": {},
"live": {},
"mode": {},
"items": {},
"total": {},
"hasMore": {},
"version": {},
"nextCursor": {},
"customOrderId": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Edit playlist",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Copies all items of one playlist into another, empty one of the same kind. The target also takes the source's sequential or shuffle setting; a custom order is never copied.
| Parameter | Type | Description |
|---|---|---|
| sourcePlaylistId * | string | |
| targetPlaylistId * | string | Must be empty. |
{
"name": "playlist_copy",
"title": "Copy playlist",
"description": "Copies all items of one playlist into another, empty one of the same kind. The target also takes the source's sequential or shuffle setting; a custom order is never copied.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sourcePlaylistId",
"targetPlaylistId"
],
"properties": {
"sourcePlaylistId": {
"type": "string",
"pattern": "^pl_"
},
"targetPlaylistId": {
"type": "string",
"pattern": "^pl_",
"description": "Must be empty."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"kind",
"version",
"mode",
"customOrderId",
"items",
"nextCursor",
"hasMore",
"total"
],
"properties": {
"id": {},
"kind": {},
"mode": {},
"items": {},
"total": {},
"hasMore": {},
"version": {},
"nextCursor": {},
"customOrderId": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Copy playlist",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Sets how a playlist plays: in order, shuffled, or by a custom order. See custom_order_* to create an arbitrary order defined by a script: it can pick the next item based on the time, the previously played item, and so on. For custom, `picks` are the first items it plays over the playlist as it is now (`id` is the media id) and `warnings` what the order could not do with this playlist.
| Parameter | Type | Description |
|---|---|---|
| mode * | string | one of ["sequential","shuffle","custom"] |
| playlistId * | string | |
| customOrderId | string | Required for custom. |
{
"name": "playlist_set_playing_order",
"title": "Set playing order",
"description": "Sets how a playlist plays: in order, shuffled, or by a custom order. See custom_order_* to create an arbitrary order defined by a script: it can pick the next item based on the time, the previously played item, and so on. For custom, `picks` are the first items it plays over the playlist as it is now (`id` is the media id) and `warnings` what the order could not do with this playlist.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"playlistId",
"mode"
],
"properties": {
"mode": {
"enum": [
"sequential",
"shuffle",
"custom"
],
"type": "string"
},
"playlistId": {
"type": "string",
"pattern": "^pl_"
},
"customOrderId": {
"type": "string",
"pattern": "^oseq_",
"description": "Required for custom."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"playlistId",
"version",
"mode",
"customOrderId"
],
"properties": {
"mode": {},
"picks": {},
"version": {},
"warnings": {},
"playlistId": {},
"customOrderId": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Set playing order",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Lists custom orders (playing-order rules written from a text description), or returns one with its rules when `id` is given.
| Parameter | Type | Description |
|---|---|---|
| id | string | |
| name | string | Part of the name, case-insensitive. |
| sort | string | By creation time. |
{
"name": "custom_order_list",
"title": "List custom orders",
"description": "Lists custom orders (playing-order rules written from a text description), or returns one with its rules when `id` is given.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"id": {
"type": "string",
"pattern": "^oseq_"
},
"name": {
"type": "string",
"description": "Part of the name, case-insensitive."
},
"sort": {
"enum": [
"newest",
"oldest"
],
"type": "string",
"default": "newest",
"description": "By creation time."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"properties": {
"id": {},
"name": {},
"next": {},
"error": {},
"items": {},
"ready": {},
"reply": {},
"rules": {},
"total": {},
"status": {},
"hasMore": {},
"versions": {},
"createdAt": {},
"playlists": {},
"description": {},
"diagnostics": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "List custom orders",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Creates a custom order from a description of how the playlist should play, e.g. "start with the intro, never two songs in a row". Apply it with playlist_set_playing_order.
| Parameter | Type | Description |
|---|---|---|
| name * | string | |
| intent * | string | How it should play, in the user's words. |
| playlistId | string | The playlist it is for, so rules can name its items. |
{
"name": "custom_order_create",
"title": "Create custom order",
"description": "Creates a custom order from a description of how the playlist should play, e.g. \"start with the intro, never two songs in a row\". Apply it with playlist_set_playing_order.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"intent"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"intent": {
"type": "string",
"maxLength": 8192,
"minLength": 1,
"description": "How it should play, in the user's words."
},
"playlistId": {
"type": "string",
"pattern": "^pl_",
"description": "The playlist it is for, so rules can name its items."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"name",
"status",
"ready",
"reply",
"diagnostics",
"version"
],
"properties": {
"id": {},
"name": {},
"next": {},
"ready": {},
"reply": {},
"status": {},
"version": {},
"warnings": {},
"diagnostics": {},
"playlistsUpdated": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Create custom order",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Changes a custom order with an instruction in words. Playlists using it pick up the change.
| Parameter | Type | Description |
|---|---|---|
| id * | string | |
| message * | string | The change, in the user's words. |
{
"name": "custom_order_refine",
"title": "Refine custom order",
"description": "Changes a custom order with an instruction in words. Playlists using it pick up the change.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id",
"message"
],
"properties": {
"id": {
"type": "string",
"pattern": "^oseq_"
},
"message": {
"type": "string",
"maxLength": 8192,
"minLength": 1,
"description": "The change, in the user's words."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"name",
"status",
"ready",
"reply",
"diagnostics",
"version"
],
"properties": {
"id": {},
"name": {},
"next": {},
"ready": {},
"reply": {},
"status": {},
"version": {},
"warnings": {},
"diagnostics": {},
"playlistsUpdated": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Refine custom order",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Lists uploaded media (video, audio, images) with size, duration (milliseconds) and whether it is ready to play.
| Parameter | Type | Description |
|---|---|---|
| name | string | Part of the name, case-insensitive. |
| sort | string | By creation time. |
| type | string | one of ["video","audio","image"] |
| after | string | nextCursor of the previous page. |
| first | integer |
{
"name": "upload_list",
"title": "List uploads",
"description": "Lists uploaded media (video, audio, images) with size, duration (milliseconds) and whether it is ready to play.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "Part of the name, case-insensitive."
},
"sort": {
"enum": [
"newest",
"oldest"
],
"type": "string",
"default": "newest",
"description": "By creation time."
},
"type": {
"enum": [
"video",
"audio",
"image"
],
"type": "string"
},
"after": {
"type": "string",
"description": "nextCursor of the previous page."
},
"first": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"items",
"nextCursor",
"hasMore",
"total"
],
"properties": {
"items": {},
"total": {},
"hasMore": {},
"nextCursor": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "List uploads",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Creates a media record and returns the URL(s) to PUT the file to; the URLs stop working after 11 hours. After the PUT (after the last part, for multipart) call upload_get_import_job_state until it reports ready: that also assembles a multipart upload. For a file that is already online, use upload_import_from_url.
| Parameter | Type | Description |
|---|---|---|
| name * | string | File name with its extension, e.g. intro.mp4; at most 255 characters. |
| type * | string | one of ["video","audio","image"] |
| fileSize * | integer | Bytes. A file that lands larger than this is refused and deleted. At most 15 GB (16,106,127,360); a file larger than declared is refused when the upload completes. |
| mimeType * | string | e.g. video/mp4. The PUT must send it as Content-Type. |
| multipart | boolean | true: one URL per part, at most 100; PUT partSize bytes to each in order (the last part takes the rest). Files over 5 GB always get parts. Default false: one PUT. |
{
"name": "upload_get_upload_url",
"title": "Get an upload URL",
"description": "Creates a media record and returns the URL(s) to PUT the file to; the URLs stop working after 11 hours. After the PUT (after the last part, for multipart) call upload_get_import_job_state until it reports ready: that also assembles a multipart upload. For a file that is already online, use upload_import_from_url.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"type",
"mimeType",
"fileSize"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "File name with its extension, e.g. intro.mp4; at most 255 characters."
},
"type": {
"enum": [
"video",
"audio",
"image"
],
"type": "string"
},
"fileSize": {
"type": "integer",
"minimum": 1,
"description": "Bytes. A file that lands larger than this is refused and deleted. At most 15 GB (16,106,127,360); a file larger than declared is refused when the upload completes."
},
"mimeType": {
"type": "string",
"description": "e.g. video/mp4. The PUT must send it as Content-Type."
},
"multipart": {
"type": "boolean",
"description": "true: one URL per part, at most 100; PUT partSize bytes to each in order (the last part takes the rest). Files over 5 GB always get parts. Default false: one PUT."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {},
"parts": {},
"partSize": {},
"uploadId": {},
"uploadUrl": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Get an upload URL",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Imports media from a URL: a video page (YouTube, Vimeo, Twitch, …) or a direct file link. Runs in the background; follow it with upload_get_import_job_state.
| Parameter | Type | Description |
|---|---|---|
| url * | string | |
| maxHeight | integer | Omitted: best quality. |
| endSeconds | number | Import up to this point. |
| startSeconds | number | Import from this point. |
{
"name": "upload_import_from_url",
"title": "Import media from a URL",
"description": "Imports media from a URL: a video page (YouTube, Vimeo, Twitch, …) or a direct file link. Runs in the background; follow it with upload_get_import_job_state.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"maxHeight": {
"enum": [
360,
480,
720,
1080,
1440,
2160
],
"type": "integer",
"description": "Omitted: best quality."
},
"endSeconds": {
"type": "number",
"description": "Import up to this point.",
"exclusiveMinimum": 0
},
"startSeconds": {
"type": "number",
"minimum": 0,
"description": "Import from this point."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"name",
"type",
"ready"
],
"properties": {
"id": {},
"name": {},
"type": {},
"ready": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Import media from a URL",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Returns whether media is ready to play, for an import and for a direct upload alike: progress and error, then its duration (milliseconds) and resolution (null when not measured). `ready` is true only once the file has been analysed; call again while it is false and `error` is null. status `failed` with an `error` is final: the file is not usable; remove it with upload_remove.
| Parameter | Type | Description |
|---|---|---|
| id * | string |
{
"name": "upload_get_import_job_state",
"title": "Get media state",
"description": "Returns whether media is ready to play, for an import and for a direct upload alike: progress and error, then its duration (milliseconds) and resolution (null when not measured). `ready` is true only once the file has been analysed; call again while it is false and `error` is null. status `failed` with an `error` is final: the file is not usable; remove it with upload_remove.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^obj_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"id",
"name",
"type",
"ready",
"status",
"progress",
"error",
"duration",
"width",
"height",
"fps",
"hasVideo",
"hasAudio"
],
"properties": {
"id": {},
"fps": {},
"name": {},
"type": {},
"error": {},
"ready": {},
"width": {},
"height": {},
"status": {},
"duration": {},
"hasAudio": {},
"hasVideo": {},
"progress": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Get media state",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Deletes media: video, audio or an image. Refused with IN_USE, naming what uses it when known, while a playlist uses it; an image also while it is a stream's YouTube thumbnail or while the workspace has scenes. Media already removed answers removed:true again.
| Parameter | Type | Description |
|---|---|---|
| id * | string |
{
"name": "upload_remove",
"title": "Delete media",
"description": "Deletes media: video, audio or an image. Refused with IN_USE, naming what uses it when known, while a playlist uses it; an image also while it is a stream's YouTube thumbnail or while the workspace has scenes. Media already removed answers removed:true again.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"pattern": "^obj_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"removed",
"id"
],
"properties": {
"id": {},
"removed": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Delete media",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Returns the account, its workspace and its money. `billing.balance` is US dollars and `creditsLeft` the same amount in credits (1,000,000 credits = $1); `goodStanding` false means streams cannot start until credits are added. `spend` is the burn rate now and `running` each stream that is on air now, with its cost so far. `rates` is the price per quality and frame rate, in credits per minute.
No parameters.
{
"name": "account_get",
"title": "Get account",
"description": "Returns the account, its workspace and its money. `billing.balance` is US dollars and `creditsLeft` the same amount in credits (1,000,000 credits = $1); `goodStanding` false means streams cannot start until credits are added. `spend` is the burn rate now and `running` each stream that is on air now, with its cost so far. `rates` is the price per quality and frame rate, in credits per minute.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"account",
"workspace",
"billing",
"spend",
"running",
"rates"
],
"properties": {
"rates": {},
"spend": {},
"account": {},
"billing": {},
"running": {},
"workspace": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Get account",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Reads a live scene by path. Start with `*`: it returns the resource types (frame, source, component, element, …) and their definitions, which describe everything else. Reads the draft unless `state` or `revision` is given.
| Parameter | Type | Description |
|---|---|---|
| as | string | For a frame or one of its layers. image: a picture of it as it goes on air, to check the result. json: the frame as a tree of layers instead of code. |
| at | number | With as image: milliseconds since the frame went on air (to see an animation's later moment). |
| data | string | With as image: live reads the sources now, sample uses their sample rows. |
| path | string | *, a type (element/Text), a resource (frame/intro), or a mask (frame/*). |
| paths | array | Instead of path: several paths read in one call, e.g. every element type a task needs. Each is answered as path would be, or with its error. Draft only, no pictures. |
| state | string | one of ["draft","published"] |
| overlay | string | With as image: a guide drawn over the picture. grid: lines every 10 %; ids: each layer's outline and id. |
| sceneId * | string | From stream_get. |
| revision | integer | A published revision from scene_list_revisions. |
{
"name": "scene_get",
"title": "Read a scene",
"description": "Reads a live scene by path. Start with `*`: it returns the resource types (frame, source, component, element, …) and their definitions, which describe everything else. Reads the draft unless `state` or `revision` is given.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sceneId"
],
"properties": {
"as": {
"enum": [
"image",
"json"
],
"type": "string",
"description": "For a frame or one of its layers. image: a picture of it as it goes on air, to check the result. json: the frame as a tree of layers instead of code."
},
"at": {
"type": "number",
"minimum": 0,
"description": "With as image: milliseconds since the frame went on air (to see an animation's later moment)."
},
"data": {
"enum": [
"live",
"sample"
],
"type": "string",
"description": "With as image: live reads the sources now, sample uses their sample rows."
},
"path": {
"type": "string",
"description": "*, a type (element/Text), a resource (frame/intro), or a mask (frame/*)."
},
"paths": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"description": "Instead of path: several paths read in one call, e.g. every element type a task needs. Each is answered as path would be, or with its error. Draft only, no pictures."
},
"state": {
"enum": [
"draft",
"published"
],
"type": "string",
"default": "draft"
},
"overlay": {
"enum": [
"grid",
"ids"
],
"type": "string",
"description": "With as image: a guide drawn over the picture. grid: lines every 10 %; ids: each layer's outline and id."
},
"sceneId": {
"type": "string",
"pattern": "^scn_",
"description": "From stream_get."
},
"revision": {
"type": "integer",
"minimum": 1,
"description": "A published revision from scene_list_revisions."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"summary"
],
"properties": {
"image": {},
"value": {},
"summary": {},
"revision": {},
"draftRevision": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Read a scene",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Creates or changes one resource in the scene draft. `replace` writes the whole resource (read its type with scene_get first for the shape); `merge` changes only the fields given and keeps the rest. Send one of them. Where a scene_get answer says `value` or `edits`, that is `replace` and `merge` here. Viewers see changes after scene_publish.
| Parameter | Type | Description |
|---|---|---|
| path * | string | e.g. frame/intro, source/data/headlines. |
| merge | object | Only the fields to change, merged into the existing resource; null removes a field. E.g. {"props":{"value":"New headline"}} on frame/intro/headline keeps its position and style. |
| replace | object | The whole resource, shaped as scene_get returns it; a field left out is cleared. Creates the path when it does not exist. |
| sceneId * | string | |
| basedOnVersionId | string | Optional safety check: the `revision` from scene_get or from the last scene_set answer for this path. With it the change is refused (CONFLICT) if the resource changed since. Omitted: writes over whatever is there. |
{
"name": "scene_set",
"title": "Change a scene's draft",
"description": "Creates or changes one resource in the scene draft. `replace` writes the whole resource (read its type with scene_get first for the shape); `merge` changes only the fields given and keeps the rest. Send one of them. Where a scene_get answer says `value` or `edits`, that is `replace` and `merge` here. Viewers see changes after scene_publish.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sceneId",
"path"
],
"properties": {
"path": {
"type": "string",
"description": "e.g. frame/intro, source/data/headlines."
},
"merge": {
"type": "object",
"description": "Only the fields to change, merged into the existing resource; null removes a field. E.g. {\"props\":{\"value\":\"New headline\"}} on frame/intro/headline keeps its position and style."
},
"replace": {
"type": "object",
"description": "The whole resource, shaped as scene_get returns it; a field left out is cleared. Creates the path when it does not exist."
},
"sceneId": {
"type": "string",
"pattern": "^scn_"
},
"basedOnVersionId": {
"type": "string",
"description": "Optional safety check: the `revision` from scene_get or from the last scene_set answer for this path. With it the change is refused (CONFLICT) if the resource changed since. Omitted: writes over whatever is there."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"summary",
"path",
"revision",
"created",
"diff",
"draftRevision"
],
"properties": {
"diff": {},
"path": {},
"created": {},
"summary": {},
"revision": {},
"draftRevision": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Change a scene's draft",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": false
}
}Removes a resource from the scene draft. Refused when something else uses it.
| Parameter | Type | Description |
|---|---|---|
| path * | string | |
| sceneId * | string |
{
"name": "scene_remove",
"title": "Remove from a scene's draft",
"description": "Removes a resource from the scene draft. Refused when something else uses it.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sceneId",
"path"
],
"properties": {
"path": {
"type": "string"
},
"sceneId": {
"type": "string",
"pattern": "^scn_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"summary",
"removed",
"draftRevision"
],
"properties": {
"removed": {},
"summary": {},
"draftRevision": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Remove from a scene's draft",
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": true
}
}Lists the scene's published revisions, newest first.
| Parameter | Type | Description |
|---|---|---|
| sceneId * | string |
{
"name": "scene_list_revisions",
"title": "List a scene's published revisions",
"description": "Lists the scene's published revisions, newest first.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sceneId"
],
"properties": {
"sceneId": {
"type": "string",
"pattern": "^scn_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"revisions"
],
"properties": {
"revisions": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "List a scene's published revisions",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Publishes the scene draft; streams playing the scene show it at once. Refused with SCENE_INVALID and the problems to fix.
| Parameter | Type | Description |
|---|---|---|
| sceneId * | string |
{
"name": "scene_publish",
"title": "Publish a scene",
"description": "Publishes the scene draft; streams playing the scene show it at once. Refused with SCENE_INVALID and the problems to fix.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sceneId"
],
"properties": {
"sceneId": {
"type": "string",
"pattern": "^scn_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"summary",
"revision",
"publishedAt"
],
"properties": {
"summary": {},
"revision": {},
"publishedAt": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Publish a scene",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}Publishes an earlier revision again as a new revision; streams playing the scene show it at once. The draft is not changed: it still holds the latest edits.
| Parameter | Type | Description |
|---|---|---|
| sceneId * | string | |
| revision * | integer | From scene_list_revisions. |
{
"name": "scene_rollback_to_revision",
"title": "Publish an earlier revision again",
"description": "Publishes an earlier revision again as a new revision; streams playing the scene show it at once. The draft is not changed: it still holds the latest edits.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sceneId",
"revision"
],
"properties": {
"sceneId": {
"type": "string",
"pattern": "^scn_"
},
"revision": {
"type": "integer",
"minimum": 1,
"description": "From scene_list_revisions."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"summary",
"revision",
"publishedAt"
],
"properties": {
"summary": {},
"revision": {},
"publishedAt": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Publish an earlier revision again",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}Reads what the scene has on air: each stream the scene is set on, with online (whether that stream is on air now) and, while it is, the frame on air, the frame cued next, the controls' values, each source's status and what its playlists play. Empty when no stream has the scene.
| Parameter | Type | Description |
|---|---|---|
| sceneId * | string |
{
"name": "scene_get_live_state",
"title": "Get what a scene has on air",
"description": "Reads what the scene has on air: each stream the scene is set on, with online (whether that stream is on air now) and, while it is, the frame on air, the frame cued next, the controls' values, each source's status and what its playlists play. Empty when no stream has the scene.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sceneId"
],
"properties": {
"sceneId": {
"type": "string",
"pattern": "^scn_"
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"playing"
],
"properties": {
"playing": {},
"summary": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Get what a scene has on air",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Acts on the scene on air, as its operator would; viewers see it at once. goFrame takes a frame to air, next cues one, setControl sets a control, setData replaces a table's rows, skip moves a playlist source to its next item. Changes what is on air, never the draft. The answer is the state after the action, with `applied` false when it did not show within a few seconds (scene_get_live_state reads it again). Refused with SCENE_OFFLINE while no stream plays the scene (stream_start starts one), and with SCENE_RELOADING for a few seconds after scene_publish when the action names something only the new revision has: retry then.
| Parameter | Type | Description |
|---|---|---|
| op * | string | one of ["goFrame","next","setControl","setData","skip"] |
| rows | array | setData: the new rows, each an object of column to value. They replace every row. |
| value | any | setControl: a toggle true or false, a text a string, a number a number, a select one of its options; none for a button. |
| target | string | goFrame, next: the frame, by the id in its path frame/<id>. next with no target clears the cue. |
| sceneId * | string | |
| actionId | string | A new uuid per action. After SCENE_TIMEOUT retry with the same actionId and arguments: it is applied at most once. |
| sourceId | string | setData: the table's id, as in source/data/<id>. skip: the playlist source's id; omitted: the scene's first. |
| streamId | string | Only when more than one stream plays the scene; from scene_get_live_state. |
| controlId | string | setControl: the id in its path control/<id>. |
| transition | object | goFrame: how it cuts. Omitted: the frame's own. |
{
"name": "scene_control_live",
"title": "Act on a scene on air",
"description": "Acts on the scene on air, as its operator would; viewers see it at once. goFrame takes a frame to air, next cues one, setControl sets a control, setData replaces a table's rows, skip moves a playlist source to its next item. Changes what is on air, never the draft. The answer is the state after the action, with `applied` false when it did not show within a few seconds (scene_get_live_state reads it again). Refused with SCENE_OFFLINE while no stream plays the scene (stream_start starts one), and with SCENE_RELOADING for a few seconds after scene_publish when the action names something only the new revision has: retry then.",
"inputSchema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sceneId",
"op"
],
"properties": {
"op": {
"enum": [
"goFrame",
"next",
"setControl",
"setData",
"skip"
],
"type": "string"
},
"rows": {
"type": "array",
"items": {
"type": "object"
},
"description": "setData: the new rows, each an object of column to value. They replace every row."
},
"value": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"description": "setControl: a toggle true or false, a text a string, a number a number, a select one of its options; none for a button."
},
"target": {
"type": "string",
"description": "goFrame, next: the frame, by the id in its path frame/<id>. next with no target clears the cue."
},
"sceneId": {
"type": "string",
"pattern": "^scn_"
},
"actionId": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "A new uuid per action. After SCENE_TIMEOUT retry with the same actionId and arguments: it is applied at most once."
},
"sourceId": {
"type": "string",
"description": "setData: the table's id, as in source/data/<id>. skip: the playlist source's id; omitted: the scene's first."
},
"streamId": {
"type": "string",
"pattern": "^stream_",
"description": "Only when more than one stream plays the scene; from scene_get_live_state."
},
"controlId": {
"type": "string",
"description": "setControl: the id in its path control/<id>."
},
"transition": {
"type": "object",
"required": [
"kind"
],
"properties": {
"ms": {
"type": "integer",
"minimum": 0
},
"kind": {
"enum": [
"cut",
"fade",
"slide",
"wipe",
"dip"
],
"type": "string"
}
},
"description": "goFrame: how it cuts. Omitted: the frame's own.",
"additionalProperties": false
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"anyOf": [
{
"type": "object",
"required": [
"streamId",
"online",
"frame",
"next"
],
"properties": {
"next": {},
"frame": {},
"online": {},
"streamId": {}
}
},
{
"type": "object",
"required": [
"code",
"detail"
],
"properties": {
"code": {},
"detail": {},
"errors": {},
"failed": {},
"issues": {},
"applied": {},
"currentVersion": {},
"currentRevision": {}
}
}
],
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"additionalProperties": {}
},
"annotations": {
"title": "Act on a scene on air",
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}Streamloop runs a video stream 24/7 to YouTube or any RTMP destination. A stream plays a playlist of pre-recorded media on a loop, or a live scene. Setup: stream_create → upload_import_from_url (or upload_get_upload_url + PUT) → playlist_patch → destination_list / destination_create_* → stream_add_output → stream_preflight_check → stream_start or stream_schedule. Ids are prefixed (stream_, pl_, obj_, dest_, oseq_, scn_): read them from a tool, never invent one. Errors carry a code and what to do next.
Names, descriptions and schemas were written by the server and are shown as data.