Streamloop

Make a stream also publish to one of the workspace's destinations (list_destinations), enabled. Up to 5 per stream and one YouTube channel at most (DESTINATION_LIMIT, YOUTUBE_DESTINATION_LIMIT, DESTINATION_DUPLICATE). A second destination needs multistream on the workspace (MULTISTREAM_NOT_ENABLED). Refused while the stream is live (STREAM_LIVE), and for a destination the stream's quality or codec cannot reach (DESTINATION_INCOMPATIBLE). Returns the stream's whole destination list after the change, as list_stream_destinations does.

Use this for every playlist change: add media, remove items, reorder, or switch between sequential and shuffle, as one ordered batch. All-or-nothing — if any operation is invalid, nothing is written. A stream that is NOT currently live picks the change up on its next start, with nothing else to call. A stream that IS live keeps playing the arrangement it started with until swap_live_playlist replaces it. Media ids (obj_...) come from list_uploads; item ids (plitm_...) come from get_playlist. Operations apply in sequence, each seeing the result of the previous, so an index in a later operation must account for the earlier ones. Pass basedOnVersion (the `version` from get_playlist) to be told about a concurrent edit instead of overwriting it.

Make a playlist play in a saved order. This is the step that changes playback, and unlike a playlist edit it needs no swap_live_playlist — a running stream picks the new order up for its next items. The version in use is pinned at assign time and never advances on its own, so call this again after refine_playlist_order to adopt an improvement. Check get_playlist_order(id, playlistId) first: assignment succeeds even when items the order names are missing, returning dependencyWarnings, and those items simply never get picked. Only a rule that cannot run over the playlist at all is refused. Returns dependencyWarnings, the playlist (id, version, compatibility status), the order and the version now pinned.

Disarm a scheduled stream and return it to an unscheduled, inactive state, clearing any daily or weekly repeat. Use this to stop a recurring stream coming back; it has no effect on a stream that is currently live (stop_stream does that).

Answer 'would start_stream work right now?' without changing anything. Runs the same pre-flight configuration checks a start does and returns ready plus every blocking issue — typically a missing or archived destination, an empty video playlist, media too big for the stream's storage, or, for a stream playing a scene, a scene that is missing, not published or invalid. It does NOT check whether uploads have finished processing: a playlist takes only completed uploads, but their media facts (duration, sound) arrive about 15-25 s after an upload completes, so wait that long after uploading before starting. Credits and YouTube live eligibility are deliberately NOT part of it (both are re-checked at the moment the stream activates), so ready=true means correctly configured, not guaranteed to go live — pair it with get_billing_overview when a ready stream still will not start. Call it before start_stream and before relying on a schedule_stream window. Returns streamReadiness: ready, and issues[] each with code, error, suggestion, path and stage.

Step 2 of uploading a local file: call it once the bytes have been PUT to the url create_upload returned — by you, or by the user — which starts processing. Until this is called the media is unusable, and calling it before the PUT finishes leaves a broken record. Nothing to call for a url import: import_upload_from_url completes on its own.

Acts on the scene on air, as its operator would: goFrame (take frame/<target> to air, with a transition), next (cue frame/<target> so the take is instant; no target clears the cue), setControl (set one of its controls; scene_get control/* lists them), setData (replace a table's rows), skip (a playlist source to its next item). Viewers see it at once. The arguments are checked first, then against what is published (a frame, control, table or playlist source it doesn't have, a toggle given "yes": INVALID_INPUT); only then is it refused while nothing plays it (SCENE_OFFLINE). A SCENE_TIMEOUT may or may not have applied: send an actionId (a new uuid per action, kept by you) and retry with the SAME actionId and arguments — it is applied at most once. Without an actionId, never retry an action that isn't idempotent (skip, a button) blind: read get_scene_state first. Needs a stream playing the published scene (set_stream_scene, start_stream); it changes what is on air, never the draft. Answers streamId, online, frame (on air after the action) and next.

Use this to reuse an arrangement on a second stream instead of rebuilding it: copies one playlist's contents into another playlist of the same kind. The target must be EMPTY — this never merges or overwrites. The target stream picks the contents up on its next start; if it is already live, swap_live_playlist puts them on the air.

An empty playlist owned by a scene, for one of its playlist sources to play (a stream's own two playlists come with the stream). Fill it with apply_playlist_operations. Each call creates another. Returns the new playlist: id (pl_...), name, sceneId, kind, mode, version, createdAt.

Describe a playback order in plain language and have one written and validated. Pass the playlist it is for as playlistId: the order is written against that playlist's REAL items, so leaving it out produces a rule aimed at nothing. Creating does NOT apply it — assign_playlist_order does. Read `status` on the result: READY = usable; INVALID = written but it failed validation, and `diagnostics` say why (refine it, this is not a transport error); MESSAGE = a clarifying question or refusal, nothing was produced; PENDING = still running, poll get_playlist_order. The answer, under createOrderSequencer, also has sequencer (the order: id oseq_..., name, latestReadyVersionID) and version (the version written, or null).

Create a destination for any platform that gives out an RTMP ingest URL and stream key (Twitch, Facebook, Kick, X, TikTok, Telegram, a self-hosted server, or YouTube when its channel is not connected here). Take rtmpUrl from get_connection_hints(platform).ingestUrl rather than guessing it — a wrong host is a stream that silently never connects. The key is stored encrypted and never read back. Use create_youtube_destination instead when the channel is connected through Streamloop: only then can titles, privacy and thumbnails be managed from here. Attach the new destination to a stream with add_stream_destination.

Creates a scene with an empty draft, nothing published. Build it with scene_set (frame/<id> for each frame, source/… for what it reads), then publish_scene. Each call creates another scene. Answers the scene: id (scn_…), name, version 0, and its timestamps.

Makes the key an encoder (OBS, vMix, a phone app) sends a live feed with, for one of the scene's rtmp or srt sources: RTMP, RTMPS and SRT URLs with the key, shown in this answer only — give them to the user. Make the source first (scene_set source/rtmp/<id>). The source's status is waiting until an encoder connects with this key, and live while it publishes. The key's own id (ingkey_…) is what revoke_scene_ingest_key takes. Answers id, sourceId, key, keyPrefix, status, live, rtmpUrl and rtmpsUrl.

Use this to set up a new loop or a stream for a scene. The stream is created empty and CANNOT start until it has (1) a destination — add_stream_destination with one from list_destinations, or get_connection_hints for how to make one — plus (2) either a playable video playlist (at least one item) or an attached published scene (set_stream_scene). Creating a stream also creates its two empty playlists (one video, one audio): for a loop, find them with list_playlists(streamId) and fill them with apply_playlist_operations — a playlist loop needs nothing published before the first start. Media facts (duration, sound) of an upload arrive about 15-25 s after it completes: a start right after uploading can be refused (state invalid) until then. When it runs is schedule_stream's job. Returns the new stream under createStream: id (stream_...), name, state, quality, framerate, createdAt.

Step 1 of uploading a LOCAL file: reserves the media record and returns `uploadUrl`, a presigned PUT you can use immediately. This server does not relay bytes, but YOU probably can — if the client can run a command or make an HTTP request, do the PUT itself: curl -X PUT -H 'Content-Type: <the mimeType you passed>' --data-binary @<file> '<uploadUrl>' The Content-Type header MUST equal the mimeType given here, or the signature is rejected. The url is valid for about 11 hours and takes the whole file in one request (up to 5 GB; a bigger file, up to 15 GB, must come in through import_upload_from_url). If the client cannot make requests, hand `uploadUrl` to the user. Then call complete_upload — media that is never PUT and completed stays unusable. If the file is already reachable over https (including a file the user attached in this conversation), skip all of this and use discover_external_media + import_upload_from_url instead. Returns object (the media record: id obj_..., name, type, mimeType, fileSize, uploaded false, createdAt), uploadUrl and next (the next step).

Turn an already-consented YouTube channel into a destination a stream can publish to, with managed broadcasts (update_stream's `youtube` settings, get_stream_live_stats). Takes the channel `id` from list_youtube_channels — NOT the YouTube channel URL or handle. If that list is empty, the account has not consented yet: start_youtube_connection first.

Deletes the scene, its draft and every published version, for good. Refused (SCENE_IN_USE) while a stream plays it. Its ingest keys are revoked and its cameras removed.

Deletes a saved secret for good: its value cannot be read back, and a table that names it ("$secret:<name>") stops getting it. Only set_scene_secret with the key again restores it. Answers deleted (the name).

Permanently delete a stream, its playlists and its schedule. Irreversible, and it cannot be undone by re-creating the stream: uploads survive but the arrangement does not. Stop the stream first if it is live. To keep a stream but take it off the air, use stop_stream (plus cancel_stream_schedule). Requires confirm=true and the streamloop:destructive scope.

Permanently remove a media file from the library: its stored bytes and every file derived from it are deleted. Irreversible. An upload that never finished (no complete_upload after the PUT, an import that failed) is dropped too: nothing was stored. Refused, with nothing changed, while a playlist or a recent stream still uses it (IN_USE) — remove it from those playlists first with apply_playlist_operations — and for an image (UNSUPPORTED_TYPE). Requires confirm=true and the streamloop:destructive scope.

Puts the draft back to the published version: every change made since it was published is lost (nothing on air changes). draftRevision (required) is the draft you reviewed: if it changed after that, nothing is discarded (CONFLICT). dryRun: true lists what would be lost and discards nothing — show the user that first. Refused (NOT_PUBLISHED) when nothing is published.

Look at any media url and report what could be imported from it: each asset with its quality options, sizes and duration. REQUIRED BEFORE import_upload_from_url, which takes the opaque asset and quality ids only this tool hands out — they cannot be constructed. Works for a media page AND for a direct file link, which is what makes it the right tool for a FILE THE USER ATTACHED in this conversation: pass the attachment's https url and import from it, with no local file and no PUT. Reads the url only; nothing is imported and no credits are spent. Import only the user's own or otherwise licensed content. Returns externalLinkContents: provider, and items[] each with id (assetId), name, mime, size, durationSeconds and qualities[] (id = qualityId, label, width, height, fps, estimatedSize).

Who this token belongs to: the signed-in account's id, email, name, language and the default run-length new streams inherit. Use it to confirm which account an agent is acting for. It says nothing about which workspace is in use (get_selected_workspace) or about credits (get_billing_overview). Returns me: id, email, firstName, lastName, avatarURL, role, locale, defaultStreamDuration, createdAt.

Use this to answer 'can this keep streaming, and for how long' — and whenever a stream fails to start or stops with no configuration problem, since check_stream_readiness deliberately does not look at credits. One call returns the credit balance, credits left, whether the account is in good standing, how fast credits are being spent right now, which streams are live and what they are costing, and the per-minute rate of each output quality (so a remaining-time estimate needs no second call). Read-only: buying credits is not possible from here, so if the balance is short, point the user at the Streamloop dashboard. Returns me.billing (balance, creditsLeft, goodStanding, eligibleForFreeCredits), spendSummary, activeUsage and pricingTiers.

Use this FIRST when the user names a platform they want to stream to ("put this on YouTube", "also send it to Twitch") and there is no destination for it yet. Returns, for that platform: the connection methods, the exact `ingestUrl` to pass to create_rtmp_destination (or null when the platform issues one per session), what each method can and cannot do afterwards, the Streamloop tools to call in order, where in the platform's own UI the user finds the stream key, and the behaviour that otherwise ends a 24/7 loop early. NEVER guess an ingest url — a wrong host is a stream that silently never connects. Static guidance: it reads nothing, changes nothing and costs nothing. YouTube in particular has TWO answers and they are not equivalent: a managed connection (Google consent, and only then can titles, privacy, thumbnails and viewer counts be managed from here) or a plain stream key (video only).

Use this before editing a playlist (item ids for remove and reorder come from here, and so does the `version` the edit tools take) and after swapping one onto a live stream (to see the swap finished). Returns the draft items in play order, what a running stream is playing right now, whether the draft differs from that, how it differs, and any custom playback order attached: id, name, kind, mode, version, liveVersion, hasUnpublishedChanges, publishStatus, items, liveItems, diff, orderSequencer and its version and status.

One saved order: its description, how many playlists use it, and its newest usable version with any validation problems. Pass playlistId as well to get the answer that actually matters before assigning — whether this order can run over THAT playlist (`assignable`), which items it expects but cannot find, and a dry-run of the first items it would pick, in order. Do that instead of assigning to find out. Returns orderSequencer (id, name, description, assignedPlaylistsCount, latestReadyVersion with validationStatus and diagnostics) and, with playlistId, againstPlaylist (assignable, missingRefs, dependencyWarnings, blockingDiagnostics, version.dryRun.picks).

What a scene has on air. Answers streams: each stream that plays it, with its id (stream), name and state and, under onAir while it runs, the frame/<id> on air (frame) and the one cued next, the controls' values, each source's status and what its playlists play. With no stream playing it, streams is empty and summary says how to put it on air.

Which workspace this connection is working in right now, and where that came from: `explicit` (a select_workspace call), `header` or `env` (the client pinned it in its own configuration), or `token-hint` (the default the login carries). Call it when a result is unexpectedly empty, to confirm you are looking in the right workspace before telling the user something does not exist.

One stream's full configuration: current state, output quality and framerate, the destinations it publishes to (each enabled or not, with its delivery state), and its scheduled window including recurrence and repeat weekdays. Use it before changing a stream. For whether it could start right now, call check_stream_readiness instead (this tool reports what is configured, not what is missing); for live viewer numbers, get_stream_live_stats.

How a live stream is doing ON YOUTUBE: watch URL, broadcast status, concurrent viewers, views and likes. Only meaningful while the stream is live to a YouTube channel connected through Streamloop — a custom RTMP destination reports nothing here, since those numbers live with that platform. Returns the stream as node: id, name and youtubeLiveStats (watchUrl, lifecycle, concurrentViewers, totalViews, likeCount, fetchedAt, and mirrorStatus / mirrorLastError for the YouTube broadcast sync); youtubeLiveStats is null when there is no connected YouTube broadcast. For whether Streamloop itself considers the stream healthy, read state from get_stream.

Use this for questions about the past — 'how many hours did I stream last month', 'is my spend going up' — not about the present. Returns minutes streamed, credits spent and session counts bucketed over a period and split by output quality. get_billing_overview has the current balance and burn rate instead. Returns usageAnalytics: totalMinutes, totalCredits, sessionCount, byQuality[] (quality, minutes, credits) and buckets[] (date, minutes, credits, sessions).

One media file in detail: duration, resolution, framerate, whether it has video and audio (probed from the file itself, not from its name), a temporary download URL, a thumbnail, and — for a URL import — how far the download has got and why it failed. Use it to confirm media is ready to stream, and to read the duration a schedule window has to fit. Returns id, name, type, mimeType, fileSize, uploaded, duration, width, height, fps, hasVideo, hasAudio, downloadUrl, thumbnailUrl, meta and externalSource.

Import chosen assets from a media url — a page, a direct file link, or a file the user attached in this conversation — straight into the workspace, with no local file and no PUT. Each selection must echo an assetId and qualityId from discover_external_media for the SAME url; invented ids are rejected. One selection produces one media item, so the same asset can be imported twice with different ranges to get two clips. Downloading is asynchronous: poll get_upload until it reports the import finished. Attachment urls usually expire, so import promptly rather than storing the link for later. Returns one media record per selection (id obj_..., name, type, uploaded, externalSource with its download state).

Find the places this workspace can publish to — connected YouTube channels and custom RTMP endpoints — and their ids, which is what add_stream_destination needs. Check `status`: only an `active` destination can carry a stream; `needs_reauth` and `revoked` mean the YouTube connection must be re-consented (start_youtube_connection) before a stream using it will start. Returns a page of rows (id, name, kind, status, rtmpURL, ytChannelTitleCached, archivedAt, lastUsedAt, createdAt) plus nextCursor and total.

Find saved custom playback orders (order sequencers) and their ids. Use it before creating one — an order the user already has can be assigned to another playlist instead of rewritten. Pass streamId to see only orders that can run over that stream's playlist. `latestReadyVersionID` null means nothing usable has been produced yet. Which order a given playlist is using is on get_playlist, not here. Returns a page of rows (id, name, description, latestReadyVersionID, retiredAt, createdAt, assignedPlaylistsCount) plus nextCursor and total.

Use this to get from a stream to something you can edit: pass streamId and you get the two playlists that stream owns — one video, one audio, created empty with it. Pass sceneId for the playlists a scene's sources play. Also the way to find a playlist id before any other playlist tool. Returns a page of rows (id, name, streamID, sceneId, kind, mode, version, createdAt) plus nextCursor and total; get_playlist has the items.

Lists a scene's ingest keys (id ingkey_…, which source, live or not, never the key itself), its secrets (names only) and its IP cameras: what create_scene_ingest_key and set_scene_secret made. Answers ingestKeys (id, sourceId, keyPrefix, status, live, rtmpUrl, rtmpsUrl), secrets (name, updatedAt) and cameras (id, sourceId, url without credentials, transport, the last connection test).

Lists a scene's published versions, newest first. Answers items (version, publishedAt, publishedBy), nextCursor and hasMore. Read one with scene_get and version.

Lists the workspace's scenes, newest first: id, name, the version last published (0: never) and when. Read one's draft with scene_get (path "" lists what it holds). Answers items (id, name, version, publishedAt, createdAt, updatedAt), nextCursor and hasMore.

Where a stream publishes, in the order they were added: each destination, whether it is enabled, and while the stream runs its delivery state (connecting, live, reconnecting, failed with a reason). Returns the stream id and destinations[]: destinationID, enabled, disabledReason, state, stateReason, stateSince, and the destination's id, name, kind and status.

Find streams and their ids — the starting point for every other stream tool. Each row carries the name, current state, scheduled start and whether that schedule repeats, which is enough to tell a one-off from a daily loop without a second call. Filter by name, run state and creation window. Returns a page of rows plus nextCursor and total. Use get_stream for one stream's full configuration.

Find media and their ids (obj_...) — what apply_playlist_operations adds to a playlist. Removed media is not listed. `uploaded` false means the media is still arriving or processing and cannot be streamed yet. Returns a page of rows (id, name, type, mimeType, fileSize, uploaded, createdAt) plus nextCursor and total; get_upload has one item's duration, resolution and import progress.

Every workspace this account belongs to, with the account's role in each and which one is currently in use. Streams, media, playlists, destinations and credits all belong to ONE workspace and are never shared between them, so when a user says something exists and it is not in a list, check here before concluding it is missing — the answer is usually that another workspace is selected. Pass an `id` from here to select_workspace, or give the user the id to pin in their client configuration. `role` matters for workspace administration, which happens in the dashboard. Returns workspaces[] (id, identityId, name, slug, personal, role, active), selectedWorkspaceId and selectionSource (explicit, header, env or token-hint).

The YouTube channels this workspace has Google consent for, with live channel data (title, handle, country, subscriber count, connection status). These are NOT destinations yet: pass a channel's `id` to create_youtube_destination to get something a stream can publish to. Use list_destinations to see which channels already have one. An empty result means no Google account is connected — start_youtube_connection.

Publishes the draft exactly as it was at draftRevision (required) as the scene's next version: what streams playing it play from then on. All of it is checked first; a refusal (SCENE_INVALID) lists each problem — fix them with scene_set and publish again. Edits made after draftRevision are not published (the answer says so, stale: true). If someone published after the version your draft is based on, it is refused (STALE_PUBLISH: publishedVersion and what would be reverted) — read the draft again; only with the user's say-so send overwritePublished: <that version>. When that version is a revert (publishedVersionIsRevert), reading again changes nothing: overwritePublished, or discard_scene_draft to keep it.A scene on air is refused with CONFIRM_REQUIRED naming the streams — tell the user, then send confirm: true. An unchanged draft publishes nothing; dryRun checks it and lists what would change. Answers summary (what happened and what to do next), version, publishedAt, changes (what changed, as resource paths), notes, and the streams playing it.

Continue the conversation about an existing order — 'never end on an instrumental', 'put the announcement second instead' — producing a new version. Use this rather than creating a second order for the same purpose. Pass the playlist currently being composed against so the rewrite sees its real items. Interpret `status` exactly as for create_playlist_order. A new version does NOT reach playlists already using this order: they stay on the version they were assigned, until assign_playlist_order is called again. Returns, under refineOrderSequencer, the same status, diagnostics, sequencer and version as create_playlist_order.

Take a destination off a stream (the destination itself stays in the workspace). Refused while the stream is live (STREAM_LIVE): disable it with set_stream_destination_enabled instead. Returns the stream's whole destination list after the change, as list_stream_destinations does.

Changes the scene's display name, the one list_scenes and the dashboard show. Its draft, published versions and the streams playing it are untouched. Answers the scene: id, name, version.

Publishes an earlier version's document as the next version (the versions in between stay; the draft is untouched — publishing the draft later is refused with STALE_PUBLISH until you send overwritePublished, and discard_scene_draft makes the draft this version too). expectedVersion (required) is the latest published version you saw (list_scene_versions, list_scenes): if someone published since, nothing changes (STALE_PUBLISH: publishedVersion and what the revert would also take off air). On air it is refused with CONFIRM_REQUIRED like a publish: tell the user, then send confirm: true.