index/functions/getTokenStoryboardUrl.md

getTokenStoryboardUrl(tokenName, baseUrl, extension?): string

Get redirect URL for a token storyboard

Contact sheet of thumbnails extracted from a stream, used for scrubbing/seeking through video timelines. Can be in VTT, JSON, or image format.

Backend: Redirects to Mux storyboard if available, otherwise placeholder.

Parameters

Parameter	Type	Description
tokenName	string	Token name (lowercase)
baseUrl	string	API base URL
extension?	string	File extension (optional, default: 'vtt')

Returns

string

Full redirect URL to storyboard

Throws

Error if token name is invalid or extension format is incorrect

Example

// VTT format (for video.js/HLS.js integration)
const storyboardVtt = getTokenStoryboardUrl('anime', 'https://api.example.com', 'vtt');
// → "https://api.example.com/v1/tokens/anime/assets/storyboard.vtt"

// JSON format (for custom scrapers)
const storyboardJson = getTokenStoryboardUrl('anime', 'https://api.example.com', 'json');
// → "https://api.example.com/v1/tokens/anime/assets/storyboard.json"

Since

7.3.0