Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.overlap.ai/llms.txt

Use this file to discover all available pages before exploring further.

Clip objects are returned in the clips array when GET /workflow-results/{triggerId} finishes with status: "Completed". Use id when calling the render endpoint, renderedUrl as the editable preview video, and thumbnailURL when displaying clip previews. 
{
  "id": "0e3b1690-3bad-42cc-810d-87fd433054b8",
  "title": "Startup Founder: You're Your Startup's Biggest Threat",
  "bio": "An experienced startup founder and investor reveals how a founder's own psychology can make or break a company.",
  "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 renders.
titlestringTitle of the clip.
biostringShort contextual description or bio for the clip.
keywordsstring[]Relevant 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.
aspectRatiostringAspect ratio of the clip, such as "16:9" or "9:16".
renderedUrlstringFinal rendered URL, if render=true was passed when triggered.
thumbnailURLstringURL to the thumbnail image for the clip.
viralityScorenumberNumerical score indicating the clip’s predicted virality.

Get Results

Poll until clips are ready and retrieve the Clip array

Render Clip

Re-render a clip by sending its id as clipId