Skip to main content
HTTP Method: GET URL: /api/v3/timelines/{timelineId} Authentication: Requires API Key in the request header. Authorization: The edit (clip) referenced by the timeline export must belong to the account associated with the API token. Path Parameters:
ParameterTypeDescription
timelineIdstringThe timeline export job identifier returned by Create Timeline Export.
Response: The current status of the timeline export. Poll this endpoint until status is done (the download_url becomes available) or failed. Rate limit: Once every 1 second for unique requests. Polling: After creating a timeline export, poll this endpoint until the job reaches a terminal state:
  1. queued — the export has been accepted and is waiting to be processed.
  2. processing — the timeline file is being generated.
  3. done — generation finished; download_url is populated.
  4. failed — generation failed; see error for the reason.
When status is done, download_url is a stable Riverside route — Download Timeline File — that 301-redirects to a short-lived signed ZIP URL. Persist the download_url route, not the URL it redirects to (the latter expires). Status Codes:
  • 200 OK Timeline export status retrieved successfully.
  • 401 Unauthorized Authentication failed (missing or invalid API token).
  • 404 Not Found Timeline export not found.
  • 410 Gone Timeline export no longer exists; the export was re-triggered and the prior timeline_id is stale. Create a new export and poll the new timeline_id.
  • 429 Too Many Requests This endpoint is rate limited.
  • 500 Internal Server Error Unexpected server error.

​
Sample Request

GET /api/v3/timelines/NjYxOGMyZTRmMmE5YjgwMDEyMzRhYmNkOnByZW1pZXJlOmV4cF8xMjM6MQ HTTP/1.1
Host: platform.riverside.fm
Authorization: Bearer YOUR_API_KEY

​
Sample Response — In Progress

{
  "timeline_id": "NjYxOGMyZTRmMmE5YjgwMDEyMzRhYmNkOnByZW1pZXJlOmV4cF8xMjM6MQ",
  "clip_id": "6618c2e4f2a9b8001234abcd",
  "target": "premiere_pro",
  "format": "xml",
  "include_comments_markers_chapters": true,
  "status": "processing",
  "download_url": null,
  "error": null
}

​
Sample Response — Done

{
  "timeline_id": "NjYxOGMyZTRmMmE5YjgwMDEyMzRhYmNkOnByZW1pZXJlOmV4cF8xMjM6MQ",
  "clip_id": "6618c2e4f2a9b8001234abcd",
  "target": "premiere_pro",
  "format": "xml",
  "include_comments_markers_chapters": true,
  "status": "done",
  "download_url": "https://platform.riverside.fm/api/v3/download/timeline/NjYxOGMyZTRmMmE5YjgwMDEyMzRhYmNkOnByZW1pZXJlOmV4cF8xMjM6MQ",
  "error": null
}