Rendering

Preview a project

Metadata and layout lint (default), approximate composition HTML, or an exact rendered frame. For live playback with the app compositor, use the embedded player described in the video-preview guide.

format=json without at is cheap and starts no browser. A frame (format=image, or any request with at) launches Chromium and carries its own limit of 10 a minute per key, on top of your plan rate.

get/projects/{id}/preview

Request

Base URL: https://api.vidmoat.com/v1
URL: https://api.vidmoat.com/v1/projects/{id}/preview
Auth: HTTP bearer

Path parameters

idstring required

The project id.

Query parameters

format'json' | 'image' | 'html'

json for metadata and lint (plus a frame as a data URI when at is set), image for JPEG bytes, html for the composition.

atnumber

Timeline time in seconds. Past the end is clamped. Defaults to 0 for image.

resolution'full' | 'half'

For html only.

Response

Preview a project

projectIdstring

The project.

durationSecnumber

Timeline length.

canvasobject

{ width, height, fps }.

compositionobject

{ url, contentType, timelineHandle, seekExample }: the HTML composition and how to seek it.

frameobject

Without at: { url, imageUrl, note }. With at: { at, url, dataUri, width, height }.

suggestedPreviewTimesnumber[]

Timestamps worth looking at with the preview endpoint before you render.

Changes

No recorded changes to this operation across all 1 revision of this API.