Skip to main content
GET
https://api.joinoverlap.com
/
workflow-results
/
{triggerId}
Get Workflow Status
curl --request GET \
  --url https://api.joinoverlap.com/workflow-results/{triggerId}

​
Endpoint

GET https://api.joinoverlap.com/workflow-results/{triggerId}
  • Path Parameters
    • triggerId — The unique identifier for this workflow run (returned by the trigger endpoint).
You can find triggerId in the response when you trigger a workflow via the POST /trigger endpoint.

​
Authentication

All requests must include a valid Bearer token: 
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

​
Response Format

{
	"status" : "Processing" | "Learning" | "Completed | "Error",
	"clips" : Clip[] # if status=Completed,
	"error" : string # if status=Error
}
See the structure of Clip at the bottom of the page

​
Sample Response (Completed)

{
  "clips": [
    {
      "aspectRatio": "16:9",
      "bio": "An experienced startup founder and investor reveals how a founder’s own psychology—what Carl Jung called the shadow—can make or break a company.",
      "duration": 51.724999,
      "endTimestamp": 51.724999,
      "extendedClipURL": "https://cdn.overlap.ai/fe249157-6be2-4fce-9aec-961f800604f1.mp4",
      "id": "0e3b1690-3bad-42cc-810d-87fd433054b8",
      "keywords": [
        "startup",
        "founder psychology",
        "Jung’s shadow",
        "entrepreneurship",
        "self-awareness",
        "growth"
      ],
      "people": [
        "Startup Founder"
      ],
      "publicURL": "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",
      "url": "https://cdn.overlap.ai/fe249157-6be2-4fce-9aec-961f800604f1.mp4",
      "viralityScore": 89.5
    }
  ],
  "status": "Completed"
}

​
Sample Response (Not Completed)

{
  "clips": [],
  "status": "Processing"
}
  • clips (array) — List of result clips when status is "Completed". Empty array otherwise.
  • status (string) — Current state of the workflow run. One of:
    • `“pending”
    • "Processing"
    • "Learning"
    • "Completed"
    • "Error"
We recommended polling this endpoint in a backoff loop.

​
Clip Object

PropertyTypeDescription
idstringUnique identifier for the clip.
titlestringTitle of the clip.
biostringShort contextual description or bio for the clip.
keywordsstring[]Array of relevant keywords or tags associated with the clip.
peoplestring[]Array of people (e.g., 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 (see below).
timestampBoundary.startnumberStart boundary (in seconds) for clip extraction.
timestampBoundary.endnumberEnd boundary (in seconds) for clip extraction.
aspectRatiostringAspect ratio of the clip, e.g., "16:9" or "9:16".
urlstringPublic URL to the delivered clip file.
publicURLstringAlias for url; public-facing clip URL.
extendedClipURLstringURL to the full-resolution or extended version of the clip.
thumbnailURLstringURL to the thumbnail image for the clip.
viralityScorenumberNumerical score indicating the clip’s predicted virality potential.