Managed Streams API · Dashboard
Playlists & schedules
Loop Hubfly space Storage videos into channels and run timed control actions, once or on a repeating rule.
Base URL: https://api.hubfly.space. Use a Dashboard bearer token authorized for the project. Replace :projectId in each path with the Dashboard project ID. JSON routes use Content-Type: application/json.
Stream servers live in a project of type managed; other projects return 409 MANAGED_PROJECT_REQUIRED. Replace :instanceId with the stream server ID from the instance list. Each endpoint lists the permission it needs; a token scoped to the stream permissions must hold that exact permission.
How to use these endpoints
- Link a Storage bucket with
readaccess first (Recordings & storage), then build a playlist from its assets, object keys or publichttpsURLs. - Preview a schedule's next start times before you save it.
startis a local time in the schedule'stimezone;rruleis an RFC 5545 subset (DAILY, WEEKLY, MONTHLY). - Each schedule runs up to 20 control ops at its start and its end. The stream server runs them itself, so shows start on time even if Hubfly space's Dashboard is unreachable.
- List runs to see what fired, was missed or failed.
Preview a weekly show
curl -X POST "https://api.hubfly.space/api/v1/projects/$PROJECT_ID/managed/instances/$INSTANCE_ID/stream/schedules/preview" \
-H "Authorization: Bearer $HUBFLY_TOKEN" \
-H "Content-Type: application/json" \
-d '{"timezone":"Africa/Kigali","start":"2026-11-02T18:00:00","rrule":"FREQ=WEEKLY;BYDAY=MO","durationMinutes":90}'The response uses the standard Dashboard envelope: ok, data, and meta on success. On failure, use the returned error code and message to decide whether to correct the request or retry. The exact schema and response codes for each operation are below.
Endpoint reference
Dashboard endpoints (12)
These JSON routes are served by the Hubfly space Dashboard API and use Dashboard project authorization.
POSTCreate a playlistDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/playlists/create
Create an ordered list of media a channel or mixer can play. Each item is a Storage object (storageLinkId and objectKey), a Storage asset (assetId, resolved to the object key of its ready HLS rendition) or a public https url; inMs and outMs trim it.
- Requires
stream:admin. - Every Storage item is checked before saving: its link must have
readorread_writeaccess and the object or asset must be in the link's bucket, and an asset needs a ready HLS rendition. Problems return422 STREAM_INVALIDwith adetailsentry per item. encodingisauto(default) orreencode. Credentials inside an item URL are stored encrypted, not returned.- A server holds up to 50 playlists of up to 500 items each; a duplicate name returns
409 STREAM_NAME_TAKEN.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
name | string | Yes |
loop | boolean | No |
shuffle | boolean | No |
encoding | auto | reencode | No |
items | object[] | No |
Complete request schema
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"loop": {
"type": "boolean"
},
"shuffle": {
"type": "boolean"
},
"encoding": {
"type": "string",
"enum": [
"auto",
"reencode"
]
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"storageLinkId": {
"type": "string"
},
"objectKey": {
"type": "string"
},
"assetId": {
"type": "string"
},
"url": {
"type": "string"
},
"media": {
"type": "string",
"enum": [
"file",
"hls"
]
},
"inMs": {
"type": "number"
},
"outMs": {
"type": "number",
"nullable": true
},
"title": {
"type": "string"
}
},
"required": [],
"additionalProperties": false
}
}
},
"required": [
"name"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "playlist": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "loop": { "type": "boolean" }, "shuffle": { "type": "boolean" }, "encoding": { "type": "string", "enum": [ "auto", "reencode" ] }, "items": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "storage", "type": "string" }, "storageLink": { "type": "string" }, "objectKey": { "type": "string" }, "media": { "type": "string", "enum": [ "file", "hls" ] }, "inMs": { "type": "number" }, "outMs": { "type": "number", "nullable": true }, "title": { "type": "string" } }, "required": [ "type", "storageLink", "objectKey", "media", "inMs", "outMs", "title" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "const": "url", "type": "string" }, "url": { "type": "string" }, "media": { "type": "string", "enum": [ "file", "hls" ] }, "inMs": { "type": "number" }, "outMs": { "type": "number", "nullable": true }, "title": { "type": "string" } }, "required": [ "type", "url", "media", "inMs", "outMs", "title" ], "additionalProperties": false } ] } }, "revision": { "type": "number" }, "createdByUserId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "name", "loop", "shuffle", "encoding", "items", "revision", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false }, "sync": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "applied" ] }, "generation": { "type": "number" }, "error": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "code", "message" ], "additionalProperties": false } } }, "required": [ "status", "generation", "error", "warnings" ], "additionalProperties": false } }, "required": [ "playlist", "sync" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "playlist": { "id": "string", "name": "string", "loop": true, "shuffle": true, "encoding": "auto", "items": [ null ], "revision": 0, "createdByUserId": "string", "createdAt": "string", "updatedAt": "string" }, "sync": { "status": "pending", "generation": 0, "error": "string", "warnings": [ { "path": "string", "code": "string", "message": "string" } ] } }, "meta": { "requestId": "string", "timestamp": "string" } }
GETList playlistsDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/playlists
List the server's playlists with loop, shuffle, encoding and their items: Storage objects (storageLink and objectKey) or public https URLs, each with media (hls or file), in and out points and a title.
- Requires
stream:read.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "loop": { "type": "boolean" }, "shuffle": { "type": "boolean" }, "encoding": { "type": "string", "enum": [ "auto", "reencode" ] }, "items": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "storage", "type": "string" }, "storageLink": { "type": "string" }, "objectKey": { "type": "string" }, "media": { "type": "string", "enum": [ "file", "hls" ] }, "inMs": { "type": "number" }, "outMs": { "type": "number", "nullable": true }, "title": { "type": "string" } }, "required": [ "type", "storageLink", "objectKey", "media", "inMs", "outMs", "title" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "const": "url", "type": "string" }, "url": { "type": "string" }, "media": { "type": "string", "enum": [ "file", "hls" ] }, "inMs": { "type": "number" }, "outMs": { "type": "number", "nullable": true }, "title": { "type": "string" } }, "required": [ "type", "url", "media", "inMs", "outMs", "title" ], "additionalProperties": false } ] } }, "revision": { "type": "number" }, "createdByUserId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "name", "loop", "shuffle", "encoding", "items", "revision", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": [ { "id": "string", "name": "string", "loop": true, "shuffle": true, "encoding": "auto", "items": [ null ], "revision": 0, "createdByUserId": "string", "createdAt": "string", "updatedAt": "string" } ], "meta": { "requestId": "string", "timestamp": "string" } }
DELETEDelete a playlistDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/playlists/:playlistId/delete
Delete a playlist. The Storage objects it plays are not touched.
- Requires
stream:admin. - Refused with
409 STREAM_IN_USEwhile a channel, mixer or schedule still uses the playlist; the error lists thereferrers.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
playlistId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "deleted": { "const": true, "type": "boolean" }, "sync": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "applied" ] }, "generation": { "type": "number" }, "error": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "code", "message" ], "additionalProperties": false } } }, "required": [ "status", "generation", "error", "warnings" ], "additionalProperties": false } }, "required": [ "deleted", "sync" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "deleted": true, "sync": { "status": "pending", "generation": 0, "error": "string", "warnings": [ { "path": "string", "code": "string", "message": "string" } ] } }, "meta": { "requestId": "string", "timestamp": "string" } }
GETRead a playlistDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/playlists/:playlistId
Return one playlist with its resolved items and revision. Asset items appear as the Storage object of their HLS rendition.
- Requires
stream:read.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
playlistId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "loop": { "type": "boolean" }, "shuffle": { "type": "boolean" }, "encoding": { "type": "string", "enum": [ "auto", "reencode" ] }, "items": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "storage", "type": "string" }, "storageLink": { "type": "string" }, "objectKey": { "type": "string" }, "media": { "type": "string", "enum": [ "file", "hls" ] }, "inMs": { "type": "number" }, "outMs": { "type": "number", "nullable": true }, "title": { "type": "string" } }, "required": [ "type", "storageLink", "objectKey", "media", "inMs", "outMs", "title" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "const": "url", "type": "string" }, "url": { "type": "string" }, "media": { "type": "string", "enum": [ "file", "hls" ] }, "inMs": { "type": "number" }, "outMs": { "type": "number", "nullable": true }, "title": { "type": "string" } }, "required": [ "type", "url", "media", "inMs", "outMs", "title" ], "additionalProperties": false } ] } }, "revision": { "type": "number" }, "createdByUserId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "name", "loop", "shuffle", "encoding", "items", "revision", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "id": "string", "name": "string", "loop": true, "shuffle": true, "encoding": "auto", "items": [ null ], "revision": 0, "createdByUserId": "string", "createdAt": "string", "updatedAt": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
PUTUpdate a playlistDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/playlists/:playlistId/update
Change a playlist's name, loop, shuffle, encoding or items. Omitted fields keep their value; items, when sent, replaces the whole list and is checked as on create.
- Requires
stream:admin. - Send
revisionequal to the playlist's currentrevision; if it changed meanwhile you get409 STREAM_REVISION_CONFLICT. - Invalid items return
422 STREAM_INVALIDwithdetails.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
playlistId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
revision | number | Yes |
name | string | No |
loop | boolean | No |
shuffle | boolean | No |
encoding | auto | reencode | No |
items | object[] | No |
Complete request schema
{
"type": "object",
"properties": {
"revision": {
"type": "number"
},
"name": {
"type": "string"
},
"loop": {
"type": "boolean"
},
"shuffle": {
"type": "boolean"
},
"encoding": {
"type": "string",
"enum": [
"auto",
"reencode"
]
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"storageLinkId": {
"type": "string"
},
"objectKey": {
"type": "string"
},
"assetId": {
"type": "string"
},
"url": {
"type": "string"
},
"media": {
"type": "string",
"enum": [
"file",
"hls"
]
},
"inMs": {
"type": "number"
},
"outMs": {
"type": "number",
"nullable": true
},
"title": {
"type": "string"
}
},
"required": [],
"additionalProperties": false
}
}
},
"required": [
"revision"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "playlist": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "loop": { "type": "boolean" }, "shuffle": { "type": "boolean" }, "encoding": { "type": "string", "enum": [ "auto", "reencode" ] }, "items": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "const": "storage", "type": "string" }, "storageLink": { "type": "string" }, "objectKey": { "type": "string" }, "media": { "type": "string", "enum": [ "file", "hls" ] }, "inMs": { "type": "number" }, "outMs": { "type": "number", "nullable": true }, "title": { "type": "string" } }, "required": [ "type", "storageLink", "objectKey", "media", "inMs", "outMs", "title" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "const": "url", "type": "string" }, "url": { "type": "string" }, "media": { "type": "string", "enum": [ "file", "hls" ] }, "inMs": { "type": "number" }, "outMs": { "type": "number", "nullable": true }, "title": { "type": "string" } }, "required": [ "type", "url", "media", "inMs", "outMs", "title" ], "additionalProperties": false } ] } }, "revision": { "type": "number" }, "createdByUserId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "name", "loop", "shuffle", "encoding", "items", "revision", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false }, "sync": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "applied" ] }, "generation": { "type": "number" }, "error": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "code", "message" ], "additionalProperties": false } } }, "required": [ "status", "generation", "error", "warnings" ], "additionalProperties": false } }, "required": [ "playlist", "sync" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "playlist": { "id": "string", "name": "string", "loop": true, "shuffle": true, "encoding": "auto", "items": [ null ], "revision": 0, "createdByUserId": "string", "createdAt": "string", "updatedAt": "string" }, "sync": { "status": "pending", "generation": 0, "error": "string", "warnings": [ { "path": "string", "code": "string", "message": "string" } ] } }, "meta": { "requestId": "string", "timestamp": "string" } }
POSTCreate a scheduleDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/schedules/create
Schedule control ops at a local time, once or repeating: onStart runs at start in timezone and onEnd after durationMinutes. The node fires schedules itself, so a show starts on time even when the Dashboard is unreachable.
- Requires
stream:admin. startis a local date-time without offset (YYYY-MM-DDTHH:MM:SS).rruleis optional (none means once) and supportsFREQDAILY,WEEKLYorMONTHLYwithINTERVAL,BYDAY,BYMONTHDAY,BYHOUR,BYMINUTEand at most one ofCOUNTorUNTIL.durationMinutesis 1–10,080.onStartandonEndhold up to 20 ops each and may not useclip.createorinput.disconnect.- A server holds up to 100 schedules. Invalid timing or ops return
422 STREAM_INVALID(codes such asinvalid_rruleandinvalid_op); a duplicate name returns409 STREAM_NAME_TAKEN.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
name | string | Yes |
enabled | boolean | No |
timezone | string | Yes |
start | string | Yes |
rrule | string | No |
durationMinutes | number | Yes |
onStart | object | object | object | object | object | object | object | object | object | object | object | object[] | No |
onEnd | object | object | object | object | object | object | object | object | object | object | object | object[] | No |
Complete request schema
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"timezone": {
"type": "string"
},
"start": {
"type": "string"
},
"rrule": {
"type": "string",
"nullable": true
},
"durationMinutes": {
"type": "number"
},
"onStart": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"op": {
"const": "mixer.scene",
"type": "string"
},
"mixer": {
"type": "string"
},
"scene": {
"type": "string"
},
"transition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"cut",
"fade"
]
},
"durationMs": {
"type": "number"
}
},
"required": [
"type",
"durationMs"
],
"additionalProperties": false
}
},
"required": [
"op",
"mixer",
"scene"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "mixer.layer",
"type": "string"
},
"mixer": {
"type": "string"
},
"source": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
},
"crop": {
"type": "object",
"properties": {
"l": {
"type": "number"
},
"t": {
"type": "number"
},
"r": {
"type": "number"
},
"b": {
"type": "number"
}
},
"required": [
"l",
"t",
"r",
"b"
],
"additionalProperties": false
},
"z": {
"type": "number"
},
"opacity": {
"type": "number"
},
"visible": {
"type": "boolean"
}
},
"required": [
"op",
"mixer",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "mixer.audio",
"type": "string"
},
"mixer": {
"type": "string"
},
"source": {
"type": "string"
},
"gainDb": {
"type": "number"
},
"muted": {
"type": "boolean"
}
},
"required": [
"op",
"mixer",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "mixer.text",
"type": "string"
},
"mixer": {
"type": "string"
},
"source": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"op",
"mixer",
"source",
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "graphics.set",
"type": "string"
},
"graphic": {
"type": "string"
},
"variables": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"op",
"graphic",
"variables"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"channel.start",
"channel.stop"
]
},
"channel": {
"type": "string"
}
},
"required": [
"op",
"channel"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "channel.source",
"type": "string"
},
"channel": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"input",
"mixer",
"playlist"
]
},
"ref": {
"type": "string"
}
},
"required": [
"type",
"ref"
],
"additionalProperties": false
}
},
"required": [
"op",
"channel",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "channel.slate",
"type": "string"
},
"channel": {
"type": "string"
},
"on": {
"type": "boolean"
},
"slate": {
"type": "string"
}
},
"required": [
"op",
"channel",
"on"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"destination.start",
"destination.stop"
]
},
"destination": {
"type": "string"
}
},
"required": [
"op",
"destination"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"recording.start",
"recording.stop"
]
},
"channel": {
"type": "string"
}
},
"required": [
"op",
"channel"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "playlist.play",
"type": "string"
},
"channel": {
"type": "string"
},
"playlist": {
"type": "string"
},
"item": {
"type": "number"
}
},
"required": [
"op",
"channel",
"playlist"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "playlist.next",
"type": "string"
},
"channel": {
"type": "string"
}
},
"required": [
"op",
"channel"
],
"additionalProperties": false
}
]
}
},
"onEnd": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"op": {
"const": "mixer.scene",
"type": "string"
},
"mixer": {
"type": "string"
},
"scene": {
"type": "string"
},
"transition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"cut",
"fade"
]
},
"durationMs": {
"type": "number"
}
},
"required": [
"type",
"durationMs"
],
"additionalProperties": false
}
},
"required": [
"op",
"mixer",
"scene"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "mixer.layer",
"type": "string"
},
"mixer": {
"type": "string"
},
"source": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
},
"crop": {
"type": "object",
"properties": {
"l": {
"type": "number"
},
"t": {
"type": "number"
},
"r": {
"type": "number"
},
"b": {
"type": "number"
}
},
"required": [
"l",
"t",
"r",
"b"
],
"additionalProperties": false
},
"z": {
"type": "number"
},
"opacity": {
"type": "number"
},
"visible": {
"type": "boolean"
}
},
"required": [
"op",
"mixer",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "mixer.audio",
"type": "string"
},
"mixer": {
"type": "string"
},
"source": {
"type": "string"
},
"gainDb": {
"type": "number"
},
"muted": {
"type": "boolean"
}
},
"required": [
"op",
"mixer",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "mixer.text",
"type": "string"
},
"mixer": {
"type": "string"
},
"source": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"op",
"mixer",
"source",
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "graphics.set",
"type": "string"
},
"graphic": {
"type": "string"
},
"variables": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"op",
"graphic",
"variables"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"channel.start",
"channel.stop"
]
},
"channel": {
"type": "string"
}
},
"required": [
"op",
"channel"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "channel.source",
"type": "string"
},
"channel": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"input",
"mixer",
"playlist"
]
},
"ref": {
"type": "string"
}
},
"required": [
"type",
"ref"
],
"additionalProperties": false
}
},
"required": [
"op",
"channel",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "channel.slate",
"type": "string"
},
"channel": {
"type": "string"
},
"on": {
"type": "boolean"
},
"slate": {
"type": "string"
}
},
"required": [
"op",
"channel",
"on"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"destination.start",
"destination.stop"
]
},
"destination": {
"type": "string"
}
},
"required": [
"op",
"destination"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"recording.start",
"recording.stop"
]
},
"channel": {
"type": "string"
}
},
"required": [
"op",
"channel"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "playlist.play",
"type": "string"
},
"channel": {
"type": "string"
},
"playlist": {
"type": "string"
},
"item": {
"type": "number"
}
},
"required": [
"op",
"channel",
"playlist"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "playlist.next",
"type": "string"
},
"channel": {
"type": "string"
}
},
"required": [
"op",
"channel"
],
"additionalProperties": false
}
]
}
}
},
"required": [
"name",
"timezone",
"start",
"durationMinutes"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "schedule": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "timezone": { "type": "string" }, "start": { "type": "string" }, "rrule": { "type": "string" }, "durationMinutes": { "type": "number" }, "onStart": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "const": "mixer.scene", "type": "string" }, "mixer": { "type": "string" }, "scene": { "type": "string" }, "transition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cut", "fade" ] }, "durationMs": { "type": "number" } }, "required": [ "type", "durationMs" ], "additionalProperties": false } }, "required": [ "op", "mixer", "scene" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.layer", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" }, "crop": { "type": "object", "properties": { "l": { "type": "number" }, "t": { "type": "number" }, "r": { "type": "number" }, "b": { "type": "number" } }, "required": [ "l", "t", "r", "b" ], "additionalProperties": false }, "z": { "type": "number" }, "opacity": { "type": "number" }, "visible": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.audio", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "gainDb": { "type": "number" }, "muted": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.text", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "text": { "type": "string" } }, "required": [ "op", "mixer", "source", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "graphics.set", "type": "string" }, "graphic": { "type": "string" }, "variables": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "op", "graphic", "variables" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "channel.start", "channel.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.source", "type": "string" }, "channel": { "type": "string" }, "source": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "input", "mixer", "playlist" ] }, "ref": { "type": "string" } }, "required": [ "type", "ref" ], "additionalProperties": false } }, "required": [ "op", "channel", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.slate", "type": "string" }, "channel": { "type": "string" }, "on": { "type": "boolean" }, "slate": { "type": "string" } }, "required": [ "op", "channel", "on" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "destination.start", "destination.stop" ] }, "destination": { "type": "string" } }, "required": [ "op", "destination" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "recording.start", "recording.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.play", "type": "string" }, "channel": { "type": "string" }, "playlist": { "type": "string" }, "item": { "type": "number" } }, "required": [ "op", "channel", "playlist" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.next", "type": "string" }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false } ] } }, "onEnd": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "const": "mixer.scene", "type": "string" }, "mixer": { "type": "string" }, "scene": { "type": "string" }, "transition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cut", "fade" ] }, "durationMs": { "type": "number" } }, "required": [ "type", "durationMs" ], "additionalProperties": false } }, "required": [ "op", "mixer", "scene" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.layer", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" }, "crop": { "type": "object", "properties": { "l": { "type": "number" }, "t": { "type": "number" }, "r": { "type": "number" }, "b": { "type": "number" } }, "required": [ "l", "t", "r", "b" ], "additionalProperties": false }, "z": { "type": "number" }, "opacity": { "type": "number" }, "visible": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.audio", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "gainDb": { "type": "number" }, "muted": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.text", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "text": { "type": "string" } }, "required": [ "op", "mixer", "source", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "graphics.set", "type": "string" }, "graphic": { "type": "string" }, "variables": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "op", "graphic", "variables" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "channel.start", "channel.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.source", "type": "string" }, "channel": { "type": "string" }, "source": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "input", "mixer", "playlist" ] }, "ref": { "type": "string" } }, "required": [ "type", "ref" ], "additionalProperties": false } }, "required": [ "op", "channel", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.slate", "type": "string" }, "channel": { "type": "string" }, "on": { "type": "boolean" }, "slate": { "type": "string" } }, "required": [ "op", "channel", "on" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "destination.start", "destination.stop" ] }, "destination": { "type": "string" } }, "required": [ "op", "destination" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "recording.start", "recording.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.play", "type": "string" }, "channel": { "type": "string" }, "playlist": { "type": "string" }, "item": { "type": "number" } }, "required": [ "op", "channel", "playlist" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.next", "type": "string" }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false } ] } }, "nextStartAt": { "type": "string", "description": "Date string", "nullable": true }, "upcoming": { "type": "array", "items": { "type": "string" } }, "revision": { "type": "number" }, "createdByUserId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "name", "enabled", "timezone", "start", "rrule", "durationMinutes", "onStart", "onEnd", "nextStartAt", "upcoming", "revision", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false }, "sync": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "applied" ] }, "generation": { "type": "number" }, "error": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "code", "message" ], "additionalProperties": false } } }, "required": [ "status", "generation", "error", "warnings" ], "additionalProperties": false } }, "required": [ "schedule", "sync" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "schedule": { "id": "string", "name": "string", "enabled": true, "timezone": "string", "start": "string", "rrule": "string", "durationMinutes": 0, "onStart": [ null ], "onEnd": [ null ], "nextStartAt": "string", "upcoming": [ "string" ], "revision": 0, "createdByUserId": "string", "createdAt": "string", "updatedAt": "string" }, "sync": { "status": "pending", "generation": 0, "error": "string", "warnings": [ { "path": "string", "code": "string", "message": "string" } ] } }, "meta": { "requestId": "string", "timestamp": "string" } }
GETList schedulesDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/schedules
List the server's schedules with their timing (timezone, local start, rrule, durationMinutes), onStart and onEnd control ops, nextStartAt and upcoming, the next 10 starts in UTC.
- Requires
stream:read.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "timezone": { "type": "string" }, "start": { "type": "string" }, "rrule": { "type": "string" }, "durationMinutes": { "type": "number" }, "onStart": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "const": "mixer.scene", "type": "string" }, "mixer": { "type": "string" }, "scene": { "type": "string" }, "transition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cut", "fade" ] }, "durationMs": { "type": "number" } }, "required": [ "type", "durationMs" ], "additionalProperties": false } }, "required": [ "op", "mixer", "scene" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.layer", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" }, "crop": { "type": "object", "properties": { "l": { "type": "number" }, "t": { "type": "number" }, "r": { "type": "number" }, "b": { "type": "number" } }, "required": [ "l", "t", "r", "b" ], "additionalProperties": false }, "z": { "type": "number" }, "opacity": { "type": "number" }, "visible": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.audio", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "gainDb": { "type": "number" }, "muted": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.text", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "text": { "type": "string" } }, "required": [ "op", "mixer", "source", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "graphics.set", "type": "string" }, "graphic": { "type": "string" }, "variables": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "op", "graphic", "variables" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "channel.start", "channel.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.source", "type": "string" }, "channel": { "type": "string" }, "source": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "input", "mixer", "playlist" ] }, "ref": { "type": "string" } }, "required": [ "type", "ref" ], "additionalProperties": false } }, "required": [ "op", "channel", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.slate", "type": "string" }, "channel": { "type": "string" }, "on": { "type": "boolean" }, "slate": { "type": "string" } }, "required": [ "op", "channel", "on" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "destination.start", "destination.stop" ] }, "destination": { "type": "string" } }, "required": [ "op", "destination" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "recording.start", "recording.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.play", "type": "string" }, "channel": { "type": "string" }, "playlist": { "type": "string" }, "item": { "type": "number" } }, "required": [ "op", "channel", "playlist" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.next", "type": "string" }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false } ] } }, "onEnd": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "const": "mixer.scene", "type": "string" }, "mixer": { "type": "string" }, "scene": { "type": "string" }, "transition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cut", "fade" ] }, "durationMs": { "type": "number" } }, "required": [ "type", "durationMs" ], "additionalProperties": false } }, "required": [ "op", "mixer", "scene" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.layer", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" }, "crop": { "type": "object", "properties": { "l": { "type": "number" }, "t": { "type": "number" }, "r": { "type": "number" }, "b": { "type": "number" } }, "required": [ "l", "t", "r", "b" ], "additionalProperties": false }, "z": { "type": "number" }, "opacity": { "type": "number" }, "visible": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.audio", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "gainDb": { "type": "number" }, "muted": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.text", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "text": { "type": "string" } }, "required": [ "op", "mixer", "source", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "graphics.set", "type": "string" }, "graphic": { "type": "string" }, "variables": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "op", "graphic", "variables" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "channel.start", "channel.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.source", "type": "string" }, "channel": { "type": "string" }, "source": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "input", "mixer", "playlist" ] }, "ref": { "type": "string" } }, "required": [ "type", "ref" ], "additionalProperties": false } }, "required": [ "op", "channel", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.slate", "type": "string" }, "channel": { "type": "string" }, "on": { "type": "boolean" }, "slate": { "type": "string" } }, "required": [ "op", "channel", "on" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "destination.start", "destination.stop" ] }, "destination": { "type": "string" } }, "required": [ "op", "destination" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "recording.start", "recording.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.play", "type": "string" }, "channel": { "type": "string" }, "playlist": { "type": "string" }, "item": { "type": "number" } }, "required": [ "op", "channel", "playlist" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.next", "type": "string" }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false } ] } }, "nextStartAt": { "type": "string", "description": "Date string", "nullable": true }, "upcoming": { "type": "array", "items": { "type": "string" } }, "revision": { "type": "number" }, "createdByUserId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "name", "enabled", "timezone", "start", "rrule", "durationMinutes", "onStart", "onEnd", "nextStartAt", "upcoming", "revision", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": [ { "id": "string", "name": "string", "enabled": true, "timezone": "string", "start": "string", "rrule": "string", "durationMinutes": 0, "onStart": [ null ], "onEnd": [ null ], "nextStartAt": "string", "upcoming": [ "string" ], "revision": 0, "createdByUserId": "string", "createdAt": "string", "updatedAt": "string" } ], "meta": { "requestId": "string", "timestamp": "string" } }
POSTPreview schedule timesDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/schedules/preview
Expand a schedule timing before saving it: returns up to 20 next starts in UTC, or errors (path, code, message) explaining why the timing does not expand. Nothing is saved.
- Requires
stream:read. - Invalid timing comes back in
errorswith an emptystarts, not as an error response. - Uses the node's RRULE rules: a local time skipped by a daylight-saving change moves forward by the gap, and an ambiguous one uses its first occurrence.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
timezone | string | Yes |
start | string | Yes |
rrule | string | No |
durationMinutes | number | Yes |
Complete request schema
{
"type": "object",
"properties": {
"timezone": {
"type": "string"
},
"start": {
"type": "string"
},
"rrule": {
"type": "string",
"nullable": true
},
"durationMinutes": {
"type": "number"
}
},
"required": [
"timezone",
"start",
"durationMinutes"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "starts": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "code", "message" ], "additionalProperties": false } } }, "required": [ "starts" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "starts": [ "string" ], "errors": [ { "path": "string", "code": "string", "message": "string" } ] }, "meta": { "requestId": "string", "timestamp": "string" } }
DELETEDelete a scheduleDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/schedules/:scheduleId/delete
Delete a schedule. If one of its occurrences is running, its onEnd ops run immediately once the node applies the change.
- Requires
stream:admin.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
scheduleId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "deleted": { "const": true, "type": "boolean" }, "sync": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "applied" ] }, "generation": { "type": "number" }, "error": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "code", "message" ], "additionalProperties": false } } }, "required": [ "status", "generation", "error", "warnings" ], "additionalProperties": false } }, "required": [ "deleted", "sync" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "deleted": true, "sync": { "status": "pending", "generation": 0, "error": "string", "warnings": [ { "path": "string", "code": "string", "message": "string" } ] } }, "meta": { "requestId": "string", "timestamp": "string" } }
GETRead a scheduleDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/schedules/:scheduleId
Return one schedule with its timing, ops, revision, nextStartAt and upcoming, the next 10 starts in UTC.
- Requires
stream:read.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
scheduleId | path | Yes | string | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "timezone": { "type": "string" }, "start": { "type": "string" }, "rrule": { "type": "string" }, "durationMinutes": { "type": "number" }, "onStart": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "const": "mixer.scene", "type": "string" }, "mixer": { "type": "string" }, "scene": { "type": "string" }, "transition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cut", "fade" ] }, "durationMs": { "type": "number" } }, "required": [ "type", "durationMs" ], "additionalProperties": false } }, "required": [ "op", "mixer", "scene" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.layer", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" }, "crop": { "type": "object", "properties": { "l": { "type": "number" }, "t": { "type": "number" }, "r": { "type": "number" }, "b": { "type": "number" } }, "required": [ "l", "t", "r", "b" ], "additionalProperties": false }, "z": { "type": "number" }, "opacity": { "type": "number" }, "visible": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.audio", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "gainDb": { "type": "number" }, "muted": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.text", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "text": { "type": "string" } }, "required": [ "op", "mixer", "source", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "graphics.set", "type": "string" }, "graphic": { "type": "string" }, "variables": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "op", "graphic", "variables" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "channel.start", "channel.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.source", "type": "string" }, "channel": { "type": "string" }, "source": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "input", "mixer", "playlist" ] }, "ref": { "type": "string" } }, "required": [ "type", "ref" ], "additionalProperties": false } }, "required": [ "op", "channel", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.slate", "type": "string" }, "channel": { "type": "string" }, "on": { "type": "boolean" }, "slate": { "type": "string" } }, "required": [ "op", "channel", "on" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "destination.start", "destination.stop" ] }, "destination": { "type": "string" } }, "required": [ "op", "destination" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "recording.start", "recording.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.play", "type": "string" }, "channel": { "type": "string" }, "playlist": { "type": "string" }, "item": { "type": "number" } }, "required": [ "op", "channel", "playlist" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.next", "type": "string" }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false } ] } }, "onEnd": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "const": "mixer.scene", "type": "string" }, "mixer": { "type": "string" }, "scene": { "type": "string" }, "transition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cut", "fade" ] }, "durationMs": { "type": "number" } }, "required": [ "type", "durationMs" ], "additionalProperties": false } }, "required": [ "op", "mixer", "scene" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.layer", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" }, "crop": { "type": "object", "properties": { "l": { "type": "number" }, "t": { "type": "number" }, "r": { "type": "number" }, "b": { "type": "number" } }, "required": [ "l", "t", "r", "b" ], "additionalProperties": false }, "z": { "type": "number" }, "opacity": { "type": "number" }, "visible": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.audio", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "gainDb": { "type": "number" }, "muted": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.text", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "text": { "type": "string" } }, "required": [ "op", "mixer", "source", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "graphics.set", "type": "string" }, "graphic": { "type": "string" }, "variables": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "op", "graphic", "variables" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "channel.start", "channel.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.source", "type": "string" }, "channel": { "type": "string" }, "source": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "input", "mixer", "playlist" ] }, "ref": { "type": "string" } }, "required": [ "type", "ref" ], "additionalProperties": false } }, "required": [ "op", "channel", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.slate", "type": "string" }, "channel": { "type": "string" }, "on": { "type": "boolean" }, "slate": { "type": "string" } }, "required": [ "op", "channel", "on" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "destination.start", "destination.stop" ] }, "destination": { "type": "string" } }, "required": [ "op", "destination" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "recording.start", "recording.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.play", "type": "string" }, "channel": { "type": "string" }, "playlist": { "type": "string" }, "item": { "type": "number" } }, "required": [ "op", "channel", "playlist" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.next", "type": "string" }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false } ] } }, "nextStartAt": { "type": "string", "description": "Date string", "nullable": true }, "upcoming": { "type": "array", "items": { "type": "string" } }, "revision": { "type": "number" }, "createdByUserId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "name", "enabled", "timezone", "start", "rrule", "durationMinutes", "onStart", "onEnd", "nextStartAt", "upcoming", "revision", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "id": "string", "name": "string", "enabled": true, "timezone": "string", "start": "string", "rrule": "string", "durationMinutes": 0, "onStart": [ null ], "onEnd": [ null ], "nextStartAt": "string", "upcoming": [ "string" ], "revision": 0, "createdByUserId": "string", "createdAt": "string", "updatedAt": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
GETList schedule runsDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/schedules/:scheduleId/runs
List the fires the node reported for one schedule, newest first: each run's phase (start or end), status (ok, missed or failed), time and error. Pass nextCursor back as before for older runs.
- Requires
stream:read. limitis 1–200 (default 50).- After a node restart, a phase due less than 5 minutes earlier runs late; older ones are recorded as
missed.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
scheduleId | path | Yes | string | — |
before | query | No | string | — |
limit | query | No | number | — |
Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "runs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "scheduleId": { "type": "string" }, "phase": { "type": "string", "enum": [ "start", "end" ] }, "status": { "type": "string", "enum": [ "failed", "ok", "missed" ] }, "firedAt": { "type": "string", "description": "Date string" }, "error": { "type": "string", "nullable": true } }, "required": [ "id", "scheduleId", "phase", "status", "firedAt", "error" ], "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "runs", "nextCursor" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "runs": [ { "id": "string", "scheduleId": "string", "phase": "start", "status": "failed", "firedAt": "string", "error": "string" } ], "nextCursor": "string" }, "meta": { "requestId": "string", "timestamp": "string" } }
PUTUpdate a scheduleDetails +/api/v1/projects/:projectId/managed/instances/:instanceId/stream/schedules/:scheduleId/update
Change a schedule's name, enabled state, timing or ops. Future occurrences are recomputed; an occurrence already running keeps its end time, unless the schedule is disabled, in which case its onEnd ops run immediately.
- Requires
stream:admin. - Send
revisionequal to the schedule's currentrevision; if it changed meanwhile you get409 STREAM_REVISION_CONFLICT. - Invalid timing or ops return
422 STREAM_INVALIDwithdetails.
Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
projectId | path | Yes | string | — |
instanceId | path | Yes | string | — |
scheduleId | path | Yes | string | — |
JSON request body
| Field | Type / allowed values | Required |
|---|---|---|
revision | number | Yes |
name | string | No |
enabled | boolean | No |
timezone | string | No |
start | string | No |
rrule | string | No |
durationMinutes | number | No |
onStart | object | object | object | object | object | object | object | object | object | object | object | object[] | No |
onEnd | object | object | object | object | object | object | object | object | object | object | object | object[] | No |
Complete request schema
{
"type": "object",
"properties": {
"revision": {
"type": "number"
},
"name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"timezone": {
"type": "string"
},
"start": {
"type": "string"
},
"rrule": {
"type": "string",
"nullable": true
},
"durationMinutes": {
"type": "number"
},
"onStart": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"op": {
"const": "mixer.scene",
"type": "string"
},
"mixer": {
"type": "string"
},
"scene": {
"type": "string"
},
"transition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"cut",
"fade"
]
},
"durationMs": {
"type": "number"
}
},
"required": [
"type",
"durationMs"
],
"additionalProperties": false
}
},
"required": [
"op",
"mixer",
"scene"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "mixer.layer",
"type": "string"
},
"mixer": {
"type": "string"
},
"source": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
},
"crop": {
"type": "object",
"properties": {
"l": {
"type": "number"
},
"t": {
"type": "number"
},
"r": {
"type": "number"
},
"b": {
"type": "number"
}
},
"required": [
"l",
"t",
"r",
"b"
],
"additionalProperties": false
},
"z": {
"type": "number"
},
"opacity": {
"type": "number"
},
"visible": {
"type": "boolean"
}
},
"required": [
"op",
"mixer",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "mixer.audio",
"type": "string"
},
"mixer": {
"type": "string"
},
"source": {
"type": "string"
},
"gainDb": {
"type": "number"
},
"muted": {
"type": "boolean"
}
},
"required": [
"op",
"mixer",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "mixer.text",
"type": "string"
},
"mixer": {
"type": "string"
},
"source": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"op",
"mixer",
"source",
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "graphics.set",
"type": "string"
},
"graphic": {
"type": "string"
},
"variables": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"op",
"graphic",
"variables"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"channel.start",
"channel.stop"
]
},
"channel": {
"type": "string"
}
},
"required": [
"op",
"channel"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "channel.source",
"type": "string"
},
"channel": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"input",
"mixer",
"playlist"
]
},
"ref": {
"type": "string"
}
},
"required": [
"type",
"ref"
],
"additionalProperties": false
}
},
"required": [
"op",
"channel",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "channel.slate",
"type": "string"
},
"channel": {
"type": "string"
},
"on": {
"type": "boolean"
},
"slate": {
"type": "string"
}
},
"required": [
"op",
"channel",
"on"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"destination.start",
"destination.stop"
]
},
"destination": {
"type": "string"
}
},
"required": [
"op",
"destination"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"recording.start",
"recording.stop"
]
},
"channel": {
"type": "string"
}
},
"required": [
"op",
"channel"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "playlist.play",
"type": "string"
},
"channel": {
"type": "string"
},
"playlist": {
"type": "string"
},
"item": {
"type": "number"
}
},
"required": [
"op",
"channel",
"playlist"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "playlist.next",
"type": "string"
},
"channel": {
"type": "string"
}
},
"required": [
"op",
"channel"
],
"additionalProperties": false
}
]
}
},
"onEnd": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"op": {
"const": "mixer.scene",
"type": "string"
},
"mixer": {
"type": "string"
},
"scene": {
"type": "string"
},
"transition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"cut",
"fade"
]
},
"durationMs": {
"type": "number"
}
},
"required": [
"type",
"durationMs"
],
"additionalProperties": false
}
},
"required": [
"op",
"mixer",
"scene"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "mixer.layer",
"type": "string"
},
"mixer": {
"type": "string"
},
"source": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
},
"crop": {
"type": "object",
"properties": {
"l": {
"type": "number"
},
"t": {
"type": "number"
},
"r": {
"type": "number"
},
"b": {
"type": "number"
}
},
"required": [
"l",
"t",
"r",
"b"
],
"additionalProperties": false
},
"z": {
"type": "number"
},
"opacity": {
"type": "number"
},
"visible": {
"type": "boolean"
}
},
"required": [
"op",
"mixer",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "mixer.audio",
"type": "string"
},
"mixer": {
"type": "string"
},
"source": {
"type": "string"
},
"gainDb": {
"type": "number"
},
"muted": {
"type": "boolean"
}
},
"required": [
"op",
"mixer",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "mixer.text",
"type": "string"
},
"mixer": {
"type": "string"
},
"source": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"op",
"mixer",
"source",
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "graphics.set",
"type": "string"
},
"graphic": {
"type": "string"
},
"variables": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"op",
"graphic",
"variables"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"channel.start",
"channel.stop"
]
},
"channel": {
"type": "string"
}
},
"required": [
"op",
"channel"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "channel.source",
"type": "string"
},
"channel": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"input",
"mixer",
"playlist"
]
},
"ref": {
"type": "string"
}
},
"required": [
"type",
"ref"
],
"additionalProperties": false
}
},
"required": [
"op",
"channel",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "channel.slate",
"type": "string"
},
"channel": {
"type": "string"
},
"on": {
"type": "boolean"
},
"slate": {
"type": "string"
}
},
"required": [
"op",
"channel",
"on"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"destination.start",
"destination.stop"
]
},
"destination": {
"type": "string"
}
},
"required": [
"op",
"destination"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"recording.start",
"recording.stop"
]
},
"channel": {
"type": "string"
}
},
"required": [
"op",
"channel"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "playlist.play",
"type": "string"
},
"channel": {
"type": "string"
},
"playlist": {
"type": "string"
},
"item": {
"type": "number"
}
},
"required": [
"op",
"channel",
"playlist"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"op": {
"const": "playlist.next",
"type": "string"
},
"channel": {
"type": "string"
}
},
"required": [
"op",
"channel"
],
"additionalProperties": false
}
]
}
}
},
"required": [
"revision"
],
"additionalProperties": false
}Responses
200— Successful responseResponse schema
{ "type": "object", "properties": { "ok": { "const": true, "type": "boolean" }, "data": { "type": "object", "properties": { "schedule": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "timezone": { "type": "string" }, "start": { "type": "string" }, "rrule": { "type": "string" }, "durationMinutes": { "type": "number" }, "onStart": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "const": "mixer.scene", "type": "string" }, "mixer": { "type": "string" }, "scene": { "type": "string" }, "transition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cut", "fade" ] }, "durationMs": { "type": "number" } }, "required": [ "type", "durationMs" ], "additionalProperties": false } }, "required": [ "op", "mixer", "scene" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.layer", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" }, "crop": { "type": "object", "properties": { "l": { "type": "number" }, "t": { "type": "number" }, "r": { "type": "number" }, "b": { "type": "number" } }, "required": [ "l", "t", "r", "b" ], "additionalProperties": false }, "z": { "type": "number" }, "opacity": { "type": "number" }, "visible": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.audio", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "gainDb": { "type": "number" }, "muted": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.text", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "text": { "type": "string" } }, "required": [ "op", "mixer", "source", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "graphics.set", "type": "string" }, "graphic": { "type": "string" }, "variables": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "op", "graphic", "variables" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "channel.start", "channel.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.source", "type": "string" }, "channel": { "type": "string" }, "source": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "input", "mixer", "playlist" ] }, "ref": { "type": "string" } }, "required": [ "type", "ref" ], "additionalProperties": false } }, "required": [ "op", "channel", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.slate", "type": "string" }, "channel": { "type": "string" }, "on": { "type": "boolean" }, "slate": { "type": "string" } }, "required": [ "op", "channel", "on" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "destination.start", "destination.stop" ] }, "destination": { "type": "string" } }, "required": [ "op", "destination" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "recording.start", "recording.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.play", "type": "string" }, "channel": { "type": "string" }, "playlist": { "type": "string" }, "item": { "type": "number" } }, "required": [ "op", "channel", "playlist" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.next", "type": "string" }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false } ] } }, "onEnd": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "op": { "const": "mixer.scene", "type": "string" }, "mixer": { "type": "string" }, "scene": { "type": "string" }, "transition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cut", "fade" ] }, "durationMs": { "type": "number" } }, "required": [ "type", "durationMs" ], "additionalProperties": false } }, "required": [ "op", "mixer", "scene" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.layer", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" }, "crop": { "type": "object", "properties": { "l": { "type": "number" }, "t": { "type": "number" }, "r": { "type": "number" }, "b": { "type": "number" } }, "required": [ "l", "t", "r", "b" ], "additionalProperties": false }, "z": { "type": "number" }, "opacity": { "type": "number" }, "visible": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.audio", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "gainDb": { "type": "number" }, "muted": { "type": "boolean" } }, "required": [ "op", "mixer", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "mixer.text", "type": "string" }, "mixer": { "type": "string" }, "source": { "type": "string" }, "text": { "type": "string" } }, "required": [ "op", "mixer", "source", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "graphics.set", "type": "string" }, "graphic": { "type": "string" }, "variables": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "op", "graphic", "variables" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "channel.start", "channel.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.source", "type": "string" }, "channel": { "type": "string" }, "source": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "input", "mixer", "playlist" ] }, "ref": { "type": "string" } }, "required": [ "type", "ref" ], "additionalProperties": false } }, "required": [ "op", "channel", "source" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "channel.slate", "type": "string" }, "channel": { "type": "string" }, "on": { "type": "boolean" }, "slate": { "type": "string" } }, "required": [ "op", "channel", "on" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "destination.start", "destination.stop" ] }, "destination": { "type": "string" } }, "required": [ "op", "destination" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "type": "string", "enum": [ "recording.start", "recording.stop" ] }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.play", "type": "string" }, "channel": { "type": "string" }, "playlist": { "type": "string" }, "item": { "type": "number" } }, "required": [ "op", "channel", "playlist" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "const": "playlist.next", "type": "string" }, "channel": { "type": "string" } }, "required": [ "op", "channel" ], "additionalProperties": false } ] } }, "nextStartAt": { "type": "string", "description": "Date string", "nullable": true }, "upcoming": { "type": "array", "items": { "type": "string" } }, "revision": { "type": "number" }, "createdByUserId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "description": "Date string" }, "updatedAt": { "type": "string", "description": "Date string" } }, "required": [ "id", "name", "enabled", "timezone", "start", "rrule", "durationMinutes", "onStart", "onEnd", "nextStartAt", "upcoming", "revision", "createdByUserId", "createdAt", "updatedAt" ], "additionalProperties": false }, "sync": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "applied" ] }, "generation": { "type": "number" }, "error": { "type": "string", "nullable": true }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "code", "message" ], "additionalProperties": false } } }, "required": [ "status", "generation", "error", "warnings" ], "additionalProperties": false } }, "required": [ "schedule", "sync" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "requestId", "timestamp" ], "additionalProperties": false } }, "required": [ "ok", "data", "meta" ], "additionalProperties": false }Example response
{ "ok": true, "data": { "schedule": { "id": "string", "name": "string", "enabled": true, "timezone": "string", "start": "string", "rrule": "string", "durationMinutes": 0, "onStart": [ null ], "onEnd": [ null ], "nextStartAt": "string", "upcoming": [ "string" ], "revision": 0, "createdByUserId": "string", "createdAt": "string", "updatedAt": "string" }, "sync": { "status": "pending", "generation": 0, "error": "string", "warnings": [ { "path": "string", "code": "string", "message": "string" } ] } }, "meta": { "requestId": "string", "timestamp": "string" } }