Skip to main content
GET
Get a video thumbnail or animated preview

Authorizations

Authorization
string
header
required

API key obtained from your Tella account settings

Path Parameters

id
string
required

Unique video identifier

Example:

"vid_abc123def456"

Query Parameters

format
enum<string>

Output format. Defaults to jpg.

Available options:
jpg,
png,
webp,
gif,
mp4
Example:

"jpg"

inpointMs
integer

Frame offset in ms on the playback timeline (cuts applied) — clip-relative for the clip thumbnail, video-relative (cumulative across clips) for the video thumbnail. Defaults to 0.

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

1000

durationMs
integer

Duration of the animated preview in ms. Only valid when format is gif or mp4.

Required range: x <= 9007199254740991
Example:

3000

width
integer

Output width in pixels. The thumbnail keeps the video's aspect ratio; a missing side is derived from it.

Required range: x <= 9007199254740991
Example:

1280

height
integer

Output height in pixels. Derived from the video's aspect ratio when omitted.

Required range: x <= 9007199254740991
Example:

720

download

Suggest a download disposition on the signed URL.

Available options:
true
Example:

"false"

response
enum<string>

Set to 'json' to receive {url} instead of the default 302 redirect.

Available options:
json
Example:

"json"

Response

Returned when ?response=json is set

Signed CDN URL for the requested thumbnail. Returned only when ?response=json is set; otherwise the endpoint redirects to the URL with a 302.

url
string<uri>
required