Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.riverside.fm/llms.txt

Use this file to discover all available pages before exploring further.

HTTP Method: GET URL: /api/v3/exports Authentication: Requires API Key in the request header. Query Parameters:
ParameterTypeDescription
studioIdstringFilter exports by studio ID
projectIdstringFilter exports by project ID
start_datestringReturn exports created on or after this date (ISO 8601 format)
end_datestringReturn exports created on or before this date (ISO 8601 format)
pagenumberPage number for pagination (starts at 1, defaults to 1)
  • Providing only start_date returns all recordings from that date forward
  • Providing only end_date returns all recordings up to that date
  • Use both to filter by a specific date range
  • Date filtering can be combined with studioId or projectId
  • If no filter is provided, returns exports from all studios in the account
Response: Paginated list of export objects Rate limit: Once every 1 second. Sorting: Lists objects in order of “newest created first” Pagination: Default page size is 20 exports Status Codes:
  • 200 OK Exports retrieval successful.
  • 401 Unauthorized Authentication failed.
  • 429 Too Many Requests Rate limit exceeded.

​
Sample Request

GET /api/v3/exports?projectId=proj789 HTTP/1.1
Host: platform.riverside.com
Authorization: Bearer YOUR_API_KEY

​
Sample Request with date range

GET /api/v3/exports?start_date=2025-01-01&end_date=2025-01-31 HTTP/1.1
Host: platform.riverside.fm
Authorization: Bearer YOUR_API_KEY

​
Sample Response

{
  "page": 1,
  "next_page_url": "https://platform.riverside.fm/api/v3/exports?projectId=proj789&page=2",
  "total_items": 28,
  "total_pages": 2,
  "data": [
    {
      "export_id": "exp_123",
      "name": "Episode 12 – Final",
      "project_id": "proj789",
      "project_name": "Podcast – 2025",
      "studio_id": "studio456",
      "studio_name": "Main Studio",
      "status": "ready",
      "created_date": "2025-01-20T15:30:00Z",
      "type": "video",
      "quality": "1080p HD",
      "download_url": "https://platform.riverside.fm/api/v3/download/export/exp_123",
      "error": null
    },
    {
      "export_id": "exp_124",
      "name": "Episode 12 – Audio Only",
      "project_id": "proj789",
      "project_name": "Podcast – 2025",
      "studio_id": "studio456",
      "studio_name": "Main Studio",
      "status": "ready",
      "created_date": "2025-01-20T15:35:00Z",
      "type": "audio",
      "quality": "WAV HD",
      "download_url": "https://platform.riverside.fm/api/v3/download/export/exp_124",
      "error": null
    }
  ]
}