Skip to main content

Set Thumbnail from Storyboard

POST 
/api/v1/assets/:asset_id/thumbnail/from_storyboard

Use one of a video's storyboard frames as the asset's thumbnail, instead of uploading an image.

Storyboard frames are the stills FileSpin extracts from a video (see Get Storyboard). They are numbered from 1, matching their file names: frame 42 is storyboard_000042.jpg. The asset's storyboard conversion in Get Data reports how many there are as file_count.

The result is the same as Upload Custom Thumbnail: the frame becomes the asset's user-provided thumbnail, survives an original replace and any reprocessing, and Revert Custom Thumbnail goes back to the automatic one.

HTTP REQUEST​

KeyValueDescription
ASSET_IDstringAsset ID, 32 character alphanumeric UUID
frameintegerStoryboard frame number, from 1 to the storyboard's file_count

HTTP RESPONSE​

Returns 202 — the frame is processed asynchronously. Note addons_info.ON_DEMAND_IMAGE.version from Get Data before the call, then poll until user_provided is true and version is higher.

Existing ODI URLs can keep showing the previous thumbnail for a while because of CDN and browser caching. Add the new version to the URL as v to show it straight away: see Showing an updated thumbnail.

Request​

Responses​

Frame accepted and queued. Poll /data until addons_info.ON_DEMAND_IMAGE.user_provided is true and its version is higher than before the call.