Skip to main content
HTTP Method: POST URL: /api/v3/edits/{clipId}/timeline Authentication: Requires API Key in the request header. Authorization: The edit (clip) must belong to the account associated with the API token. Path Parameters:
ParameterTypeDescription
clipIdstringID of the edit (clip) to export a timeline for. Obtain it from the List Edits endpoint (clip_id).
Request Body Parameters:
ParameterTypeDescription
targetstringTarget editing application. One of premiere_pro, final_cut_pro, pro_tools. Determines the generated file format (see below).
include_comments_markers_chaptersbooleanEmbed the edit’s comments, markers, and chapters into the generated timeline file.
Target → format mapping:
targetformat
premiere_proxml
final_cut_proxml
pro_toolsaaf
The download is always a ZIP archive, not a bare .xml / .aaf file. The format value describes the timeline file inside the ZIP; the archive also bundles the referenced media (video/audio) and image assets the timeline points to. See Download Timeline File.
Response: A timeline export job is queued. The response includes a timeline_id used to poll for completion via the Get Timeline Export endpoint. The job is asynchronous — status is queued on creation and the download_url is null until processing is done. Rate limit: Once every 1 second for unique requests. Status Codes:
  • 202 Accepted Timeline export queued.
  • 401 Unauthorized Authentication failed (missing or invalid API token).
  • 404 Not Found Edit not found.
  • 429 Too Many Requests This endpoint is rate limited.
  • 500 Internal Server Error Unexpected server error.

​
Sample Request

POST /api/v3/edits/6618c2e4f2a9b8001234abcd/timeline HTTP/1.1
Host: platform.riverside.fm
Authorization: Bearer YOUR_API_KEY

{
  "target": "premiere_pro",
  "include_comments_markers_chapters": true
}

​
Sample Response (202 Accepted)

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