Pick a thumbnail - api.video

Pick a thumbnail from the given time code. If you'd like to upload an image for your thumbnail, use the Upload a Thumbnail endpoint. There may be a short delay for the thumbnail to update.
Tutorials using Thumbnail picking.

{ "assets": { "hls": "https://cdn.api.video/stream/831a9bd9-9f50-464c-a369-8e9d914371ae/hls/manifest.m3u8", "iframe": "<iframe src=\"//embed.api.video/vi4k0jvEUuaTdRAEjQ4Jfrgz?token=831a9bd9-9f50-464c-a369-8e9d914371ae\" width=\"100%\" height=\"100%\" frameborder=\"0\" scrolling=\"no\" allowfullscreen=\"\"></iframe>", "mp4": "https://cdn.api.video/vod/vi4k0jvEUuaTdRAEjQ4Jfrgz/token/8fd70443-d9f0-45d2-b01c-12c8cfc707c9/mp4/720/source.mp4", "player": "https://embed.api.video/vi4k0jvEUuaTdRAEjQ4Jfrgz?token=831a9bd9-9f50-464c-a369-8e9d914371ae", "thumbnail": "https://cdn.api.video/stream/831a9bd9-9f50-464c-a369-8e9d914371ae/thumbnail.jpg" }, "description": "An amazing video explaining string theory", "metadata": [ { "key": "Author", "value": "John Doe" }, { "key": "Format", "value": "Tutorial" } ], "mp4Support": true, "panoramic": false, "playerId": "pl45KFKdlddgk654dspkze", "public": false, "publishedAt": "4665-07-14T23:36:18.598Z", "source": { "uri": "/videos/vi4k0jvEUuaTdRAEjQ4Jfrgz/source" }, "tags": [ "maths", "string theory", "video" ], "title": "Maths video", "videoId": "vi4k0jvEUuaTdRAEjQ4Jfrgz" }

Request

Path Params

videoId

string

required

Unique identifier of the video you want to add a thumbnail to, where you use a section of your video as the thumbnail.

Example:

vi4k0jvEUuaTdRAEjQ4Jfrgz

Body Params application/json

timecode

string

required

Frame in video to be used as a placeholder before the video plays.
Example: '"00:01:00.000" for 1 minute into the video.'
Valid Patterns:
"hh:mm:ss.ms"
"hh:mm:ss:frameNumber"
"124" (integer value is reported as seconds)
If selection is out of range, "00:00:00.00" will be chosen.

Match pattern:

Examples

Responses

🟢200Success

application/json

Body

assets

object (videoAssets)

optional

Collection of details about the video object that you can use to work with the video object.

hls

string <uri>

optional

This is the manifest URL. For HTTP Live Streaming (HLS), when a HLS video stream is initiated, the first file to download is the manifest. This file has the extension M3U8, and provides the video player with information about the various bitrates available for streaming.

iframe

string

optional

Code to use video from a third party website

Example:

mp4

string <uri>

optional

Available only if mp4Support is enabled. Raw mp4 url.

Example:

https://cdn.api.video/vod/vi4k0jvEUuaTdRAEjQ4Jfrgz/token/8fd70443-d9f0-45d2-b01c-12c8cfc707c9/mp4/720/source.mp4

player

string <uri>

optional

Raw url of the player.

Example:

https://embed.api.video/1b9d6ae8-8f57-4b6d-8552-d636926b4f5f?token=831a9bd9-9f50-464c-a369-8e9d914371ae

thumbnail

string <uri>

optional

Poster of the video.

Example:

https://cdn.api.video/stream/831a9bd9-9f50-464c-a369-8e9d914371ae/thumbnail.jpg

description

string

optional

A description for the video content.

Example:

An amazing video explaining string theory.

metadata

array[object (metadata) {2}]

optional

Metadata you can use to categorise and filter videos. Metadata is a list of dictionaries, where each dictionary represents a key value pair for categorising a video. Dynamic Metadata allows you to define a key that allows any value pair.

Example:

[{"key":"Author", "value":"John Doe"}, {"key":"Format", "value":"Tutorial"}]

key

string

optional

The constant that defines the data set.

Example:

Color

value

string

optional

A variable which belongs to the data set.

Example:

Green

mp4Support

boolean

optional

This lets you know whether mp4 is supported. If enabled, an mp4 URL will be provided in the response for the video.

Example:

true

panoramic

boolean

optional

Defines if video is panoramic.

Example:

false

playerId

string

optional

The id of the player that will be applied on the video.

Example:

pl45KFKdlddgk654dspkze

public

boolean

optional

Defines if the content is publicly reachable or if a unique token is needed for each play session. Default is true. Tutorials on private videos.

Example:

false

publishedAt

string

optional

The date and time the API created the video. Date and time are provided using ISO-8601 UTC format.

Example:

2019-12-16T08:25:51.000Z

source

object (videoSource)

optional

Source information about the video.

liveStream

object (video_source_live_stream)

optional

This appears if the video is from a Live Record.

type

string

optional

uri

string

optional

The URL where the video is stored.

Example:

/videos/vi4k0jvEUuaTdRAEjQ4Prklg/source