Skip to main content
Clip objects are returned in the clips array when GET /workflow-results/{triggerId} finishes with status: "Completed" and in the clip field from GET /clip. Use id as clipId for update and render calls. Workflow result responses return the basic clip fields listed below. GET /clip returns the latest saved clip document and can include additional metadata, source URLs, subtitle configuration, and legacy aliases. Fields are included when available, so some values may be omitted on a given clip. Use renderedUrl as the preview video when present, then call POST /render when you need a finalized export.

Basic Example

Basic Properties

These fields may appear in clips returned from workflow result endpoints and GET /clip.

Additional GET /clip Properties

These fields are returned only by GET /clip when they exist on the saved clip document. They are not part of the basic clip object returned by workflow result endpoints.
Some clip responses include legacy aliases, such as taskID with taskId or sourceID with sourceId. Prefer the camelCase fields in new integrations.

Get Results

Retrieve clips after a workflow completes

Update Clip

Save editable fields before rendering

Render Clip

Render a finalized export