Get Results
curl --request GET \
--url https://api.joinoverlap.com/workflow-results/{triggerId}import requests
url = "https://api.joinoverlap.com/workflow-results/{triggerId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.joinoverlap.com/workflow-results/{triggerId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.joinoverlap.com/workflow-results/{triggerId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.joinoverlap.com/workflow-results/{triggerId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.joinoverlap.com/workflow-results/{triggerId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.joinoverlap.com/workflow-results/{triggerId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyGet Results
Poll the status of a triggered workflow and retrieve generated clips
GET
/
workflow-results
/
{triggerId}
Get Results
curl --request GET \
--url https://api.joinoverlap.com/workflow-results/{triggerId}import requests
url = "https://api.joinoverlap.com/workflow-results/{triggerId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.joinoverlap.com/workflow-results/{triggerId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.joinoverlap.com/workflow-results/{triggerId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.joinoverlap.com/workflow-results/{triggerId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.joinoverlap.com/workflow-results/{triggerId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.joinoverlap.com/workflow-results/{triggerId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyEndpoint
GET https://api.joinoverlap.com/workflow-results/{triggerId}
POST /trigger-template returns a triggerId. We recommend polling every 5-10 seconds until the workflow reaches Completed or Error.
Use
renderedUrl as the editable preview video. Call POST /render when you need a finalized export after clip edits.Authentication
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Path Parameters
| Parameter | Description |
|---|---|
triggerId | Unique workflow run identifier returned by POST /trigger-template. |
Response Format
{
"status": "Pending | Processing | Learning | Completed | Error",
"clips": [],
"error": "Error message when status is Error"
}
Completed and failed runs finish with Error.
Completed Response
{
"clips": [
{
"aspectRatio": "16:9",
"bio": "An experienced startup founder and investor explains how founder psychology can make or break a company.",
"duration": 51.724999,
"endTimestamp": 51.724999,
"id": "0e3b1690-3bad-42cc-810d-87fd433054b8",
"keywords": ["startup", "founder psychology", "self-awareness"],
"people": ["Startup Founder"],
"renderedUrl": "https://cdn.overlap.ai/fe249157-6be2-4fce-9aec-961f800604f1.mp4",
"startTimestamp": 0.0,
"thumbnailURL": "https://cdn.overlap.ai/thumbnails/ce99b3c5-4d5d-4cc4-ae69-b835d23fe77a_thumb.jpg",
"timestampBoundary": {
"start": 0.0,
"end": 30.0
},
"title": "Startup Founder: You're Your Startup's Biggest Threat",
"viralityScore": 89.5
}
],
"status": "Completed"
}
Processing Response
{
"clips": [],
"status": "Processing"
}
Error Response
{
"clips": [],
"status": "Error",
"error": "Workflow failed while processing the source video."
}
Recommended Polling Pattern
javascript
async function getWorkflowResults(triggerId) {
const response = await fetch(
`https://api.joinoverlap.com/workflow-results/${triggerId}`,
{
headers: {
"Authorization": `Bearer ${process.env.OVERLAP_API_KEY}`,
"Content-Type": "application/json"
}
}
);
return response.json();
}
- Continue polling while
statusisPending,Processing,Learning, or another in-progress workflow step. - Stop polling when
statusisCompletedand use the returnedclips. - Stop polling when
statusisErrorand show or log the returnederror.
Clip Object
| Property | Type | Description |
|---|---|---|
id | string | Unique identifier for the clip. Use this as clipId for update and render calls. |
title | string | Title of the clip. |
bio | string | Short contextual description or bio for the clip. |
keywords | string[] | Array of relevant keywords or tags associated with the clip. |
people | string[] | Array of people (e.g., speakers) featured in the clip. |
duration | number | Total duration of the clip in seconds. |
startTimestamp | number | Timestamp (in seconds) where the clip starts in the source video. |
endTimestamp | number | Timestamp (in seconds) where the clip ends in the source video. |
timestampBoundary | object | Object defining the clipping boundary (see below). |
timestampBoundary.start | number | Start boundary (in seconds) for clip extraction. |
timestampBoundary.end | number | End boundary (in seconds) for clip extraction. |
aspectRatio | string | Aspect ratio of the clip, e.g., "16:9" or "9:16". |
renderedUrl | string | Public preview video URL. Use /render for a finalized export after changes. |
rawUrl | string | Raw clip URL when available. |
thumbnailURL | string | URL to the thumbnail image for the clip. |
viralityScore | number | Numerical score indicating the clip’s predicted virality potential. |
Update Clip
Save edited clip fields before rendering
Render Clip
Create a finalized clip export
Was this page helpful?