Skip to main content
POST
Preview frames of a video project as a contact sheet, with the problems found on them.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

canvasId
string
required

Body

application/json

What to preview

Request body for a project preview

companyId
string
required

Company ID

sceneId
string

One scene across its length; omit for one frame per scene

times
number[]

Exact seconds to show instead (up to 12)

Response

Contact sheet and the problems found on it

Contact sheet of preview frames

imageUrl
string

Public JPEG contact sheet of the frames

times
number[]

Seconds shown, in order

problems
string[]

Problems found on the frames, with their time