What’s it for
The Riverside Business API helps save manual effort by programmatically allowing your team to get recording media and exported edits out of your Riverside account, and delete what’s no longer needed. It also lists the events scheduled in your account — studio sessions and live webinars — and registers audience members to Riverside Webinars.Authentication
Currently the Business API is for select Business accounts only. Speak to your customer success manager for more information on how to generate your API key. All API requests require authentication via a Bearer token in the Authorization header:Versioning
The current version of the API is v3. We recommend using v3 for all new integrations.Hierarchy
Riverside’s user dashboard is organized into a hierarchy that helps keep media resources organized for traversal:
While the Riverside user dashboard also contains Edits, these are currently not supported in the Riverside API (are available only after exporting).
Scheduled events — studio sessions and live webinars — sit alongside this hierarchy rather than inside it. An event belongs to aStudio, and once it has been recorded its media appears in aProjectunder that studio. See the Event object and Get Events.
Documentation
Our API documentation is organized by endpoints and objects.Endpoints Reference
How to call our endpoints, and what responses to expect.
Objects Reference
Access the assets of your Riverside account.
Webhooks
Receive real-time, signed HTTP callbacks when events happen in your account.