Endpoints
Get Workflow Status
GET endpoint to retrieve the status and results of a workflow run
GET
Endpoint
- 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:
Response Format
See the structure of Clip at the bottom of the page
Sample Response (Completed)
Sample Response (Not Completed)
clips
(array) — List of result clips whenstatus
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
Property | Type | Description |
---|---|---|
id | string | Unique identifier for the clip. |
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" . |
url | string | Public URL to the delivered clip file. |
publicURL | string | Alias for url ; public-facing clip URL. |
extendedClipURL | string | URL to the full-resolution or extended version of the clip. |
thumbnailURL | string | URL to the thumbnail image for the clip. |
viralityScore | number | Numerical score indicating the clip’s predicted virality potential. |