Skip to main content
Clip objects are returned in the clips array when GET /workflow-results/{triggerId} finishes with status: "Completed". Use id as clipId for update and render calls. Use renderedUrl as the preview video while a user reviews edits, then call POST /render when you need a finalized export.

Example

{
  "id": "0e3b1690-3bad-42cc-810d-87fd433054b8",
  "title": "Startup Founder: You're Your Startup's Biggest Threat",
  "bio": "An experienced startup founder and investor explains a key startup risk.",
  "keywords": ["startup", "founder psychology", "self-awareness"],
  "people": ["Startup Founder"],
  "duration": 51.724999,
  "startTimestamp": 0.0,
  "endTimestamp": 51.724999,
  "timestampBoundary": {
    "start": 0.0,
    "end": 30.0
  },
  "aspectRatio": "16:9",
  "renderedUrl": "https://cdn.overlap.ai/fe249157-6be2-4fce-9aec-961f800604f1.mp4",
  "thumbnailURL": "https://cdn.overlap.ai/thumbnails/ce99b3c5-4d5d-4cc4-ae69-b835d23fe77a_thumb.jpg",
  "viralityScore": 89.5
}

Properties

PropertyTypeDescription
idstringUnique identifier for the clip. Use this as clipId for /update-clip and /render.
titlestringClip title.
biostringShort contextual description for the clip.
keywordsstring[]Keywords or tags associated with the clip.
peoplestring[]People or speakers featured in the clip.
durationnumberTotal duration of the clip in seconds.
startTimestampnumberTimestamp, in seconds, where the clip starts in the source video.
endTimestampnumberTimestamp, in seconds, where the clip ends in the source video.
timestampBoundaryobjectObject defining the clipping boundary.
timestampBoundary.startnumberStart boundary, in seconds, for clip extraction.
timestampBoundary.endnumberEnd boundary, in seconds, for clip extraction.
aspectRatiostringClip aspect ratio, such as "16:9" or "9:16".
renderedUrlstringPublic preview video URL.
rawUrlstringRaw clip URL when available.
thumbnailURLstringThumbnail image URL.
transcriptUrlstringJSON transcript URL when available.
fpsnumberFrames per second when available.
videoHeightnumberVideo height in pixels when available.
videoResolutionstringVideo resolution when available, such as "1920x1080".
viralityScorenumberScore estimating predicted clip performance.

Get Results

Retrieve clips after a workflow completes

Update Clip

Save editable fields before rendering

Render Clip

Render a finalized export