LiveReacting

Read one project in full: its name, video format, audio quality, planned duration, connected destinations, current stream status and how many schedules are pending. Use this to check a project is set up the way the customer expects before starting a stream. Scenes are left out by default because they can be long; pass includeScenes only when you actually need them, or use livereacting_get_scenes, which pages properly.

livereacting_get_project

Bring a file into the media library from a Google Drive, Dropbox or YouTube URL. For a direct link to a media file on any other host, use livereacting_import_from_url; for a file on the customer's own computer, use livereacting_upload_file. The import runs in the background. This returns a fileId straight away; poll livereacting_get_import_status with it to find out when the file is ready. Only one import can run at a time per account. Only a single YouTube video imports here: a YouTube playlist page or channel URL is refused with VALIDATION_ERROR, so do not promise a customer that a playlist can be imported through this tool. Pass one video URL at a time.

livereacting_import_media

Bring a file into the media library from a direct http or https link to a video, audio or image file on any public host, for example a CDN or storage bucket URL. The link must return the file itself, not a web page: the content type decides the media type, and it must match `type`. Links that point to a private or internal address are refused with URL_NOT_ALLOWED. The file must fit the plan's max file size; a video counts against the storage quota. Google Drive, Dropbox and YouTube links go to livereacting_import_media instead. The import runs in the background. This returns a fileId straight away; poll livereacting_get_import_status with it to find out when the file is ready. Only one import can run at a time per account.

livereacting_import_from_url

List the video, audio and image files in this LiveReacting account's media library, and optionally the folders they are organised into. Use the returned file ids when building a playlist. A file whose issues.errors is not empty cannot go in a playlist until the problem is fixed, which usually means encoding it with livereacting_encode_media first. Files and folders are paginated separately: `offset` pages the files, `folderOffset` pages the folders. Set `includeFolders: true` to get folders as well, which also requires `type`. To add a file, use livereacting_upload_file for a file on the customer's machine, livereacting_import_from_url for a direct link to a media file, or livereacting_import_media for a Google Drive, Dropbox or YouTube link.

livereacting_list_media

Read the scenes of a project, with a summary of the layers in each one. A scene is one arrangement of content; exactly one scene is active at a time and the active scene is what goes out on air. Give a sceneId to read a single scene, or leave it out to list them all. Use this to find the layer id of a playlist before calling livereacting_get_layer or livereacting_set_playlist, and to find the scene id before livereacting_activate_scene. Returns 20 scenes at a time and at most 50 layer summaries per scene.

livereacting_get_scenes

List a project's finished broadcasts, newest first: the live id, when each started and ended, how long it ran, peak viewers and any error, per destination. Use a live id from here with livereacting_get_stream_analytics. Only finished broadcasts appear; read a running one with livereacting_get_stream_status.

livereacting_list_broadcasts

List the LiveReacting projects on this account, newest first. A project is the reusable template for a stream: its video format, its destinations, and the scenes that hold the content. Start here when the customer names a stream but you do not have its id. Each entry carries the project id, its name, whether it is live right now, and how many future schedules it has. Use livereacting_get_project for the detail of one of them. Returns 20 projects at a time.

livereacting_list_projects

List the YouTube, Facebook, Twitch, LinkedIn, X and custom RTMP destinations connected to this LiveReacting account. Use the returned ids when creating a project. A destination has to be connected in the LiveReacting Studio first; you cannot add one from here.

livereacting_list_destinations

Make one scene the active scene, so its content is what goes out on air. Exactly one scene is active at a time, and activating a scene deactivates the previous one. Calling it again for the same scene changes nothing, so it is safe to repeat. If the project is streaming and autoSynch is on, the switch reaches the live stream immediately; the response says whether it did with the synced field. Scene ids come from livereacting_get_scenes.

livereacting_activate_scene

Push the project's current setup to the stream that is running now. A running stream uses the copy of the project it was started with, so edits made while it runs are invisible to viewers until they are synced. Only needed when the project has autoSynch off; with autoSynch on, edits reach the stream by themselves. Safe to call more than once -- syncing twice has the same effect as once. Fails with NO_ACTIVE_LIVE when nothing is running.

livereacting_sync_stream

Queue video files for encoding so they can be streamed. A file whose resolution or frame rate is above the account limit has to be encoded before it will play in a stream; livereacting_get_media_file with includeMetadata tells you which ones. Encoding runs in the background: this returns immediately with the files it queued and the ones it skipped (not found, not a video, or already queued or encoding). Poll livereacting_get_encode_status to find out when they are ready. A file that has already finished encoding is encoded again if you send it, so send only files that still need it, and after a timeout check livereacting_get_encode_status before you call this again.

livereacting_encode_media

Read one layer in full: its type, name, position, settings, and — for a playlist layer — its items and which one is playing. Layer ids come from livereacting_get_scenes. A playlist can hold up to 600 videos, so the items are returned 50 at a time: itemTotal is the real length and nextOffset pages through the rest. Read every page before you decide what a full playlist contains. Every layer type is readable here, including the text, image and interactive layers that can only be edited in the LiveReacting Studio.

livereacting_get_layer

Read the analytics of one broadcast. Get the broadcast id from livereacting_list_broadcasts. type: "youtube" is included with every paid plan. type: "playlists" is available on request rather than on every plan, so it can return FEATURE_NOT_AVAILABLE for an account that is otherwise working normally. Tell the customer to email [email protected] to ask for access to it. type: "youtube" returns what YouTube reports for the broadcast -- views, watch time, likes, peak and average concurrent viewers, revenue where it is available, plus traffic sources, daily trend, age and gender split, devices and geography. The channel must also have granted analytics access. type: "playlists" returns what LiveReacting itself recorded: one row per recorded playback action, naming the file, the action, its timestamp and how many people were watching at that moment. The row-shaped YouTube sections are only returned when you name them in `sections`, 50 rows at a time. There is no CSV export here; use the REST API for that.

livereacting_get_stream_analytics

Read what a project's stream is doing right now: the overall status (LIVE, PREPARING, SCHEDULED or OFFLINE), the active live id, how long it has been running, and per destination the status, viewer count, peak viewers, start and stop times, duration and any error. When a destination is failing, read its error field first. error: "AUTH_ERROR" means the customer's connection to that platform is expired or invalid, and nobody can fix it through this API: tell them to reconnect that destination in the LiveReacting Studio. The response also sets destinationsNeedingReconnect and a notice when this happens. tokenExpired appears only when a platform positively reports an expired session, which in practice only Instagram does. Its absence means we have no signal, NOT that the connection is healthy. Custom RTMP, HLS and SRT destinations have no login at all, so they never report it; when one of those fails the cause is usually a wrong server URL or stream key, or the receiving end rejecting the connection. Poll no more often than every 5 seconds. A stream needs tens of seconds to reach LIVE, and the account is limited to 150 requests per minute across all tools, so tight polling rate-limits the customer's other work. This reports only what the platform has recorded. It is not an encoder health check, and a status of LIVE is not by itself proof that video is reaching viewers.

livereacting_get_stream_status

Replace the entire contents of a video or audio playlist layer. The files you send become the whole playlist: anything already in it that you do not send again is removed, and playback restarts from the first item. There is no way to append with this tool. So to add, remove or reorder a video, first call livereacting_get_layer and page through every item until nextOffset is null, apply your change to that complete list, and send the complete list back. Sending only the new video deletes everything else. The response reports removedItemCount and warns whenever the playlist got shorter — check it before telling the customer the change worked. Writes are not merged. If two callers write the same playlist at once, the later write replaces the earlier one and both report success, so do not run parallel edits against one playlist. If the customer may be editing it in the LiveReacting Studio at the same moment, read the list again immediately before writing, and tell them not to edit while you work. Files must have finished importing and encoding. A playlist holds at most 600 items. This tool works on videoPlaylist and audioPlaylist layers only. This is NOT idempotent: sending the same list twice produces the same contents, but each call regenerates every playlistItemId and restarts playback. After a timeout, read the layer with livereacting_get_layer rather than calling again.

livereacting_set_playlist

Schedule a project to go live at one or more future times. Nothing starts now. Four rules the API will otherwise only teach you by refusing the call: 1. A project can hold one set of schedules. If it already has any, this fails with ACTIVE_SCHEDULES_EXIST. Call livereacting_cancel_schedules first, then schedule again. Scheduling does not replace existing schedules. 2. Every date must be at least 3 minutes and at most 28 days in the future. 3. More than one date requires a fixed duration on the project. A manual duration accepts a single date only, because the platform cannot tell when the runs would overlap. Set a duration with livereacting_update_project, or schedule one date at a time. 4. With a fixed duration, one run must end at least 3 minutes before the next one starts. A shorter gap is refused, and the message names the earliest time the later run can take. Every run stops at the plan's maximum stream length, and a Facebook-only stream stops after 8 hours, whatever you schedule.

livereacting_schedule_stream

Start uploading a file from the machine you run on (or the customer's) into the media library. This server cannot read local files, so the upload has three steps: (1) call this tool with the file name, type and exact size in bytes; (2) send each part with an HTTP PUT to its URL, for example by running each returned command with FILE set to the local path (each prints the part's HTTP status) -- a part must be exactly its `size` in bytes, or storage refuses it with 403; (3) call livereacting_complete_upload with the uploadToken. A file up to 256 MiB is one part. If you cannot run commands or make HTTP PUT requests, you cannot upload; ask for a public link and use livereacting_import_from_url instead. The extension must match the type (video: .mp4 .m4v .mov .flv .webm .ogv .3gp .wmv .avi .mkv; audio: .mp3 .m4a .wav; image: .jpg .jpeg .png .gif .bmp .svg .heic .webp). The size must fit the plan's max file size, and a video is refused once storage is full. The part URLs and the token expire after 3 days.

livereacting_upload_file

Start streaming a project to its destinations immediately. Works on any project: a 24/7 looping playlist, a one-off pre-recorded broadcast, a simulcast to several destinations, or a stream whose overlays were built in the LiveReacting Studio. This call is NOT idempotent. If it times out, call livereacting_get_stream_status and read the status. PREPARING or LIVE means the start succeeded. OFFLINE means it did not, and only then may you call this tool again. Do not retry on a timeout: a second start can create a duplicate broadcast attempt. If the project is already running or already scheduled, this returns the existing live id instead of starting anything. Honest limits, so you do not promise the customer something the platform will not do: - Every plan has a maximum stream length, and the stream stops when it is reached, even with a manual duration. A 24/7 channel needs a plan without a length limit, such as the 24/7 plan. - A Facebook-only stream stops after a maximum of 8 hours. A 24/7 Facebook-only channel is not possible. Add another destination for longer runs. - Thumbnails and live announcements are not supported through the API.

livereacting_start_stream

End the stream that is currently running for a project. Every viewer stops watching immediately and the broadcast cannot be resumed; a later start creates a new broadcast. Confirm with the customer before calling this on a stream you did not start. This does not cancel scheduled streams. Use livereacting_cancel_schedules for those. Like starting, stopping is not idempotent: on a timeout call livereacting_get_stream_status rather than calling this again.

livereacting_stop_stream

Change the settings of an existing project. Only the fields you send are changed. Five fields are refused while the project is LIVE, PREPARING or SCHEDULED — not only while it is on air: format, duration, audioQuality, destinationIds and youtubeAdvancedSettings. To change any of those, stop the stream with livereacting_stop_stream or cancel the schedule with livereacting_cancel_schedules first. name, title, description and autoSynch can be changed at any time. Changes to title or description can also update the broadcast on its destination platforms, including a scheduled broadcast. To change the playlist use livereacting_set_playlist instead.

livereacting_update_project