Riverside Business API

« To Riverside for Business studio features: Overview

The Riverside Business API helps save manual effort by programmatically allowing your team to get recording media out of your Riverside account and delete what’s no longer needed.

This can optimize your post-production workflows, enable you to manage content at scale, and improve the security of storing your data long term. 

Who: Account owners
Plan: Some Business plans, contact your CSM
Device: Computer browser

About the API

The Riverside Business API supports:

Recordings

  • Retrieving a list of productions with associated studios, projects, and recordings.
  • Retrieving a list of recordings with optional filtering by either studio ID or project ID. Each recording includes information about tracks.
  • Retrieving a single recording by its ID. Each recording includes information about tracks.
  • Downloading the media file of a track.
  • Downloading the transcription file of a track.
  • Deleting a recording by its ID.

Edits

  • Retrieving a list of exported edits with optional filtering by studio ID, project ID, or recording ID.

  • Retrieving a single exported edit by its ID.

  • Downloading the media file of an exported edit.

  • Deleting an exported edit by its ID.

  • Retrieving a list of edits in your workspace with optional filtering by studio, project, or date range using the List Edits endpoint.

Timeline exports

  • Triggering a timeline export for a specific edit using the Create Timeline Export endpoint. 

  • Checking the status of a timeline export job and retrieving the download URL using the Get Timeline endpoint. 

  • Downloading a ZIP file containing the timeline file (XML or AAF) and all aligned media using the Download Timeline File endpoint.

Webinars

At this time, the Riverside Business API does not support:

  • Developing new functionalities or apps built on top of the Riverside platform (i.e. integrations and apps).

Setting up the API 

Once your CSM enables the feature, follow the steps below to set it up.

Step by step

  1. Log in to your Riverside account.

  2. In the bottom left corner, click the account menu button.
  3. Click Settings.
  4. Under Team, click API.
  5. Under Generate API key, click Generate.
  6. In the pop-up, under Your API Key, click Copy.
    Your API key is copied to your clipboard. 
    Once the pop-up closes, the key expires. Generate a new key at any time.

Icon.svg Good to know

  • You can only generate 1 API key and only 1 API key can be active at once.
  • The Business API retrieves data when you request it. To have Riverside send webinar events to your tools automatically as they happen, use webhooks.
  • To save your files to Google Drive, use the download file endpoint of the API, then set up Google's API to upload the files.