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. Also, the API can be used to register 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:
Authorization: Bearer YOUR_API_KEY
Versioning
The current version of the API is v3. We recommend using v3 for all new integrations.
API v1 and v2 will be deprecated on February 24, 2026. Please migrate to v3 before this date.
| Version | Status | Sunset Date | Base URL |
|---|
| v3 | Current | - | /api/v3/ |
| v2 | Sunset Feb 24, 2026 | Feb 24, 2026 | /api/v2/ |
| v1 | Sunset Feb 24, 2026 | Feb 24, 2026 | /api/v1/ |
Hierarchy
Riverside’s user dashboard is organized into a hierarchy that helps keep media resources organized for traversal:
Production
├─ Studio
│ ├─ Project
│ │ ├─ Recording
│ │ │ ├─ Track
│ │ │ │ ├─ File
│ │ ├─ Export
While the Riverside user dashboard also contains Edits, these are currently not supported in the Riverside API (are available only after exporting).
Documentation
Our API documentation is organized by endpoints and objects.
