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/recordings/{recordingId} Authentication: Requires API Key in the request header. Path Parameters:
ParameterTypeDescription
recordingIdstringThe unique identifier of the recording
Response: Single recording object with full track and file details. Rate limit: Once every 1 second. Status Codes:
  • 200 OK Recording retrieval successful.
  • 401 Unauthorized Authentication failed.
  • 404 Not Found Recording not found or not accessible.
  • 429 Too Many Requests Rate limit exceeded.

​
Sample Request

GET /api/v3/recordings/rec123 HTTP/1.1
Host: platform.riverside.com
Authorization: Bearer YOUR_API_KEY

​
Sample Response

{
  "recording_id": "rec123",
  "name": "Episode 12 - Interview with Jane",
  "project_id": "proj789",
  "project_name": "Season 1",
  "studio_id": "studio456",
  "studio_name": "Main Studio",
  "status": "ready",
  "created_date": "2025-01-15T14:30:00Z",
  "tracks": [
    {
      "id": "track001",
      "type": "participant",
      "status": "done",
      "files": [
        {
          "name": "jane_audio.wav",
          "size": 52428800,
          "type": "raw_audio",
          "download_url": "https://platform.riverside.fm/api/v3/download/file/file001"
        },
        {
          "name": "jane_video.mp4",
          "size": 157286400,
          "type": "raw_video",
          "download_url": "https://platform.riverside.fm/api/v3/download/file/file002"
        }
      ]
    },
    {
      "id": "track002",
      "type": "screenshare",
      "status": "done",
      "files": [
        {
          "name": "screenshare.mp4",
          "size": 83886080,
          "type": "raw_video",
          "download_url": "https://platform.riverside.fm/api/v3/download/file/file003"
        }
      ]
    }
  ],
  "transcription": {
    "status": "done",
    "files": [
      {
        "type": "srt",
        "download_url": "https://platform.riverside.fm/api/v3/download/transcription/rec123?type=srt"
      },
      {
        "type": "txt",
        "download_url": "https://platform.riverside.fm/api/v3/download/transcription/rec123?type=txt"
      }
    ]
  }
}