Skip to main content
PUT
Set a video's thumbnail

Authorizations

Authorization
string
header
required

API key obtained from your Tella account settings

Path Parameters

id
string
required

Unique video identifier

Example:

"vid_abc123def456"

Body

application/json

Request body for setting a video's thumbnail. Provide exactly one of sourceId (uploaded image) or inpointMs (frame from the video).

inpointMs
integer

Pick a video frame as the thumbnail: time in ms on the video's playback timeline (cuts applied, cumulative across clips). Clears any previously uploaded thumbnail image. Mutually exclusive with sourceId.

Required range: 0 <= x <= 9007199254740991
Example:

4500

sourceId
string

Use an uploaded image as the thumbnail. Source ID from POST /v1/sources (kind: 'image'); upload the image bytes to the source's uploadUrl first. Mutually exclusive with inpointMs.

Minimum string length: 1
Example:

"su_abc123def456"

Response

Thumbnail set successfully

The thumbnail that was set

customThumbnailURL
string

CDN URL of the uploaded thumbnail image. Only present when the thumbnail was set from a sourceId.

Example:

"https://ucarecdn.com/12345678-abcd-4ef0-9012-3456789abcde/"

inpointMs
integer

The thumbnail frame time in ms. Only present when the thumbnail was set from an inpointMs.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

4500