Sign in
Thumbnails

Retrieve a video thumbnail

Fetch a thumbnail image from a video at a specified time with optional transformations.

get/{PLAYBACK_ID}/thumbnail.{EXTENSION}

Path parameters

PLAYBACK_IDstring required

The asset or live stream's playback ID.

EXTENSION'jpg' | 'png' | 'webp' required

The image file extension, either 'jpg', 'png', or 'webp'.

Query parameters

TOKENstring

Signed token (JWT) for secure video playback.

timenumber float

The time (in seconds) of the video timeline where the image should be pulled. Defaults to the middle of the original video.

widthinteger

The width of the thumbnail (in pixels). Defaults to the width of the original video.

heightinteger

The height of the thumbnail (in pixels). Defaults to the height of the original video.

rotate90 | 180 | 270

Rotate the image clockwise by the given number of degrees.

fit_mode'preserve' | 'stretch' | 'crop' | 'smartcrop' | 'pad'

How to fit a thumbnail within the specified width + height.

flip_vboolean

Flip the image top-bottom after performing all other transformations.

flip_hboolean

Flip the image left-right after performing all other transformations.

program_timeinteger

Set the time of the thumbnail for an asset created from a live stream when using the instant clipping feature. The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.

latestboolean

When set to true, pulls the latest thumbnail from the playback ID of an ongoing live stream. Can only be used with live streams. Can be used to build moderation and classification workflows, see documentation for more details.

Response

Thumbnail image retrieved successfully.

Changes

Changed in 2 of the 28 revisions of this API.5

  • 323c1dc63b7a4See the full diff
    • ○

      api tag Thumbnails added

      api-tag-added

    • ○

      api tag Image removed

      api-tag-removed

    • ○

      added the new optional query request parameter latest

      new-optional-request-parameter

    • ○

      added the new optional query request parameter program_time

      new-optional-request-parameter

  • d4d7fca3b7381See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog