v31

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

Storyboards

Retrieve storyboard metadata in JSON format

Fetch metadata for the storyboard image in JSON format, detailing the coordinates and time ranges of each thumbnail.

get/{PLAYBACK_ID}/storyboard.json

Path parameters

PLAYBACK_IDstring required

The asset or live stream's playback ID.

Query parameters

TOKENstring

Signed token (JWT) for secure video playback.

program_start_timeinteger

Set the start time of the asset created from a live stream when using the instant clipping feature. The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.

program_end_timeinteger

Set the end time of the asset created from a live stream when using the instant clipping feature. The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.

asset_start_timenumber float

Set the relative start time of the asset (in seconds) when using the instant clipping feature.

asset_end_timenumber float

Set the relative end time of the asset (in seconds) when using the instant clipping feature.

format'jpg' | 'png' | 'webp'

The format of the storyboard image URL in the response. Can be either 'jpg', 'png', or 'webp'. Defaults to 'jpg'.

Response

JSON storyboard retrieved successfully.

string required