Videos

Get a video thumbnail or animated preview

Returns a signed CDN URL for a still image (jpg/png/webp) or animated preview (gif/mp4) of a video at a time on the video's playback timeline (cuts applied, cumulative across clips). By default returns a 302 redirect — set ?response=json to get {url} JSON instead.

get/v1/videos/{id}/thumbnail

Path parameters

idstring required

Unique video identifier

Example:vid_abc123def456

Unique video identifier

Query parameters

format'jpg' | 'png' | 'webp' | 'gif' | 'mp4'

Output format. Defaults to jpg.

Example:jpg

Output format. Defaults to jpg.

startTimeMsinteger

Frame offset in ms on the playback timeline (cuts applied) — clip-relative for the clip thumbnail, video-relative (cumulative across clips) for the video thumbnail. Defaults to 0.

Example:1000

Frame offset in ms on the playback timeline (cuts applied) — clip-relative for the clip thumbnail, video-relative (cumulative across clips) for the video thumbnail. Defaults to 0.

durationMsinteger

Duration of the animated preview in ms. Only valid when format is gif or mp4.

Example:3000

Duration of the animated preview in ms. Only valid when format is gif or mp4.

fpsnumber

Frame rate for MP4 previews. Must be 1, 2, 5, 10, or 30. Defaults to 30.

Example:10

Frame rate for MP4 previews. Must be 1, 2, 5, 10, or 30. Defaults to 30.

widthinteger

Output width in pixels. The thumbnail keeps the video's aspect ratio; a missing side is derived from it.

Example:1280

Output width in pixels. The thumbnail keeps the video's aspect ratio; a missing side is derived from it.

heightinteger

Output height in pixels. Derived from the video's aspect ratio when omitted.

Example:720

Output height in pixels. Derived from the video's aspect ratio when omitted.

'true'
OR
'false'

Suggest a download disposition on the signed URL.

response'json'

Set to 'json' to receive {url} instead of the default 302 redirect.

Example:json

Set to 'json' to receive {url} instead of the default 302 redirect.

Response

Returned when ?response=json is set

urlstring uri required

Changes

Changed in 1 of the 2 revisions of this API.11

    • deleted the query request parameter inpointMs

      request-parameter-removed

    • added the new optional query request parameter startTimeMs

      new-optional-request-parameter