Skip to main content
Clip objects are returned in the clips array when GET /workflow-results/{triggerId} finishes with status: "Completed" and in the clip field from GET /clip. Use id as clipId for update and render calls. Workflow result responses return the basic clip fields listed below. GET /clip returns the latest saved clip document and can include additional metadata, source URLs, subtitle configuration, and legacy aliases. Fields are included when available, so some values may be omitted on a given clip. Use renderedUrl as the preview video when present, then call POST /render when you need a finalized export.

Preserved transcript fields

New clips from organizations with transcript reuse enabled can include: Preserved words include stable source word/sentence IDs and sentence-edge markers. Repeated montage ranges have separate occurrence IDs. Text corrections and punctuation changes preserve speech timing and the original catalog.

Basic Example

Basic Properties

These fields may appear in clips returned from workflow result endpoints and GET /clip.

Additional GET /clip Properties

These fields are returned only by GET /clip when they exist on the saved clip document. They are not part of the basic clip object returned by workflow result endpoints.
Some clip responses include legacy aliases, such as taskID with taskId or sourceID with sourceId. Prefer the camelCase fields in new integrations.

Downloading media URLs

Supported public media fields can use cdn.overlap.ai instead of a direct storage address as the public CDN rollout is enabled. Treat returned URLs as opaque: do not replace hostnames, remove path prefixes, or strip query parameters. Use the clip ID, rather than a storage URL, as the clip’s identity. Fetch a returned public media URL with a normal GET request. The media GET does not need your Overlap API key; keep that key on requests to the Overlap API only. Public CDN v1 URLs are unsigned and non-expiring, and anyone with a URL can download or forward it. Private or signed URLs from other providers retain their own access requirements. Browser JavaScript additionally depends on the media host’s CORS policy. The public CDN v1 rollout targets GET/HEAD from any website, with no credentials; do not assume that older or alternate storage hosts already allow arbitrary browser origins. Server-side GET downloads are not subject to browser CORS. Use a finalized renderUrl returned by POST /render to download the edited composition. Downloading a source URL retrieves the source object, not the cuts, captions, crop instructions, or overlays described by editing JSON.

Get Results

Retrieve clips after a workflow completes

Update Clip

Save editable fields before rendering

Render Clip

Render a finalized export