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

Create a thumbnail upload URL

Creates an upload URL for replacing a video asset's thumbnail with an image file. Use the asset_ID to request the URL, then upload the image to the returned upload_url with a PUT request. The response also includes the thumbnail update timestamp.

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

1 parameter
asset_IDstringrequired

The identifier of the previously created video asset whose thumbnail to update.

5 status codes
200Returns the asset ID, thumbnail update timestamp, and upload_url for uploading the new thumbnail with a PUT request.
asset_idstringoptional

Asset ID

thumbnail_updated_atintegeroptional

Thumbnail updated at timestamp in milliseconds since epoch

upload_urlstringoptional

Upload URL on which new thumbnail must be uploaded using a PUT request

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. The asset_ID path parameter must identify the asset whose thumbnail you want to update.