OCT-103 Gumlet outreach
POST/video/assets/{asset_id}/thumbnail-select

Select a video frame for the asset thumbnail

Updates a video asset's thumbnail by selecting a frame from the video. Supply frame_at_second to specify the timestamp for thumbnail extraction; fractional seconds are supported. The response includes the asset identifier and the thumbnail update timestamp.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
asset_idstringrequired

The identifier of the video asset whose thumbnail to update.

The video timestamp from which to extract the thumbnail.

frame_at_secondnumberrequired

Actual time in second at which thumbnail extraction needs to be done. It can be a fraction of a second as well

5 status codes
200Returns the asset ID, a success flag, and the thumbnail update timestamp in milliseconds since the epoch.
asset_idstringoptional

Asset ID

successbooleanoptional
thumbnail_updated_atintegeroptional

Milliseconds since epoch for the updated time.

400Returned when the request is invalid.

One documented failure

  • video_asset_not_in_ready_state

    Uploading a custom thumbnail is only allowed when the video asset is in the ready state.

errorobjectrequired
401Returned when the API key or bearer token is missing or invalid.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account is unpaid or the authenticated user lacks the required role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired
500Returned when an internal server error occurs.

One documented failure

  • internal_server_error

    We have encountered some server error. We have been notified and will fix it soon.

errorobjectrequired

Error handling

A 400 is returned for a bad request, a 401 when the API key or bearer token is missing or invalid, a 403 for an unpaid account or insufficient role permissions, and a 500 for an internal server error. frame_at_second is required and specifies the video time from which to extract the thumbnail; asset_id must identify the asset.