WIwithchima
Clips

Get a clip thumbnail or animated preview

Changed on

Returns a signed CDN URL for a still image (jpg/png/webp) or animated preview (gif/mp4) of a clip — the rendered composite with the clip's layouts, zooms, and masks. By default returns a 302 redirect to the URL — set ?response=json to get {url} JSON instead. startTimeMs is on the clip's playback timeline (cuts applied). durationMs only applies to gif/mp4.

get/v1/videos/{id}/clips/{clipId}/thumbnail

Request

Path parameters

idstring required

Video identifier

Example:vid_abc123def456
clipIdstring required

Clip identifier

Example:cl_xyz789ghi012

Query parameters

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

Output format. Defaults to jpg.

Example: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
durationMsinteger

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

Example:3000
fpsnumber

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

Example:10
widthinteger

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

Example:1280
heightinteger

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

Example:720
'true'
OR
'false'
'true'
OR
'false'
response'json'

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

Example:json

Response

Returned when ?response=json is set

urlstring uri required

Changes

  • 6ae7d793a0a7Revision changes
    • info

      added the new optional query request parameter subtitles

  • ac47c99c144fRevision changes
    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status