Sign in
Videos

Set a video's thumbnail

Sets the video's thumbnail from either an uploaded image or a frame of the video itself. Provide exactly one of sourceId (an image source from POST /v1/sources with kind: "image" — upload the image bytes to its uploadUrl first) or inpointMs (a time on the video's playback timeline). Setting one mode clears the other.

put/v1/videos/{id}/thumbnail

Path parameters

idstring required

Unique video identifier

Example:vid_abc123def456

Unique video identifier

Request body

inpointMsinteger

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.

sourceIdstring

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.

Example request

{
  "inpointMs": 4500,
  "sourceId": "su_abc123def456"
}

Response

Thumbnail set successfully

customThumbnailURLstring

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

inpointMsinteger

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

Example response

{
  "customThumbnailURL": "https://ucarecdn.com/12345678-abcd-4ef0-9012-3456789abcde/",
  "inpointMs": 4500
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.