REST API ReferenceEndpointsProjects

Create a timeline interchange

Starts a timeline interchange job that converts a project into an editor interchange document (Final Cut Pro FCPXML, Adobe Premiere Pro XML, OpenTimelineIO, or an SRT caption sidecar). Returns immediately with an interchange job id; the file becomes available when the job completes. Unlike `POST /v1/projects/{projectId}/export` (which renders a flattened MP4), this preserves the project as an editable timeline of separate clips, tracks, and captions so you can keep editing it in a desktop video editor. Choose `mediaDelivery` to control how the document references media: `REMOTE_URLS` produces a single document that links to signed media URLs, while `BUNDLE` produces a zip containing the document plus every referenced media file for durable offline relinking.

Authentication

AuthorizationBearer
API key from [app.videogen.io/developers](https://app.videogen.io/developers). The full key is only shown once when you create it.

Path parameters

projectIdstringRequired

The project id (e.g. vg_proj_...).

Request

This endpoint expects an object.
formatenumOptional

Editor interchange document format. FCPXML is Final Cut Pro (also imported by DaVinci Resolve and others). PREMIERE_XML is the Final Cut 7 xmeml XML that Adobe Premiere Pro imports natively. OTIO is OpenTimelineIO, the vendor-neutral format. SRT is a SubRip caption sidecar.

mediaDeliveryenumOptional

How the interchange document references media. REMOTE_URLS produces a single document that links to signed media URLs. BUNDLE produces a zip containing the document plus every referenced media file, referenced by relative path, for durable offline relinking.

Response

Timeline interchange accepted.
interchangeJobIdstring

Opaque timeline interchange job id (e.g. vg_inte_...). Poll GET /v1/timeline-interchange/{interchangeJobId} for completion.