v31

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-28124212862.9 KB
Animated Images

Retrieve an animated image from a video

Fetch an animated GIF or WebP image from a video segment with optional transformations.

get/{PLAYBACK_ID}/animated.{EXTENSION}

Path parameters

PLAYBACK_IDstring required

The asset or live stream's playback ID.

EXTENSION'gif' | 'webp' required

The image file extension, either 'gif' or 'webp'.

Query parameters

TOKENstring

Signed token (JWT) for secure video playback.

startnumber float

The time (in seconds) of the video timeline where the animated GIF should begin. Defaults to 0.

endnumber float

The time (in seconds) of the video timeline where the GIF ends. Defaults to 5 seconds after the start. Maximum total duration of GIF is limited to 10 seconds; minimum total duration of GIF is 250ms.

widthinteger

The width in pixels of the animated GIF. Default is 320px, or if height is provided, the width is determined by preserving aspect ratio with the height. Max width is 640px.

heightinteger

The height in pixels of the animated GIF. The default height is determined by preserving aspect ratio with the width provided. Maximum height is 640px.

fpsinteger

The frame rate of the generated GIF. Defaults to 15 fps. Max 30 fps.

Response

Animated image retrieved successfully.