HTTP API reference › Gala Launchpad › assets

Gala Launchpad — assets

8 operations in this group.

• GET /v1/tokens/{tokenName}/assets/animated.{ext} — Get animated preview
• GET /v1/tokens/{tokenName}/assets/image — Get token image
• GET /v1/tokens/{tokenName}/assets/live.m3u8 — Get live stream
• GET /v1/tokens/{tokenName}/assets/poster.jpg — Get poster image
• GET /v1/tokens/{tokenName}/assets/storyboard.{ext} — Get storyboard sprite sheet
• GET /v1/tokens/{tokenName}/assets/storyboard.json — Get storyboard JSON
• GET /v1/tokens/{tokenName}/assets/storyboard.vtt — Get storyboard VTT
• GET /v1/tokens/{tokenName}/assets/thumbnail.{ext} — Get stream thumbnail

GET /v1/tokens/{tokenName}/assets/animated.{ext}

AssetsController_getAnimated

Get animated preview

Redirects to Mux animated GIF/WebP. Supports start, end, width, height, fps params.

Parameters

Name	In	Required	Type	Description
tokenName	path	required		Token name identifier
ext	path	required	string enum: gif, webp	Format: gif or webp
fps	query	optional		Frames per second (default 15, max 30)
width	query	optional		Width in pixels (max 640)
end	query	optional		End time in seconds
start	query	optional		Start time in seconds

Responses

301 — Redirect to Mux animated preview

No body.

404 — Token not found or no stream configured

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

default — Shared error envelope returned by the application exception filter.

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

Example response

[]

GET /v1/tokens/{tokenName}/assets/image

AssetsController_getImage

Get token image

Redirects to the token pool image

Parameters

Name	In	Required	Type	Description
tokenName	path	required		Token name identifier

Responses

302 — Redirect to pool image

No body.

404 — Token not found or no image available

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

default — Shared error envelope returned by the application exception filter.

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

Example response

[]

GET /v1/tokens/{tokenName}/assets/live.m3u8

AssetsController_getLiveStream

Get live stream

Redirects to Mux HLS live stream URL

Parameters

Name	In	Required	Type	Description
tokenName	path	required		Token name identifier

Responses

301 — Redirect to Mux HLS stream

No body.

404 — Token not found or no stream configured

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

default — Shared error envelope returned by the application exception filter.

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

Example response

[]

GET /v1/tokens/{tokenName}/assets/poster.jpg

AssetsController_getPoster

Get poster image

Redirects to high-res (1920x1080) thumbnail optimized for video player posters.

Parameters

Name	In	Required	Type	Description
tokenName	path	required		Token name identifier
fit_mode	query	optional		Override fit mode (default smartcrop)
height	query	optional		Override height (default 1080)
width	query	optional		Override width (default 1920)

Responses

301 — Redirect to Mux poster thumbnail

No body.

404 — Token not found or no stream configured

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

default — Shared error envelope returned by the application exception filter.

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

Example response

[]

GET /v1/tokens/{tokenName}/assets/storyboard.{ext}

AssetsController_getStoryboardImage

Get storyboard sprite sheet

Redirects to Mux storyboard sprite image. VOD only.

Parameters

Name	In	Required	Type	Description
tokenName	path	required		Token name identifier
ext	path	required	string enum: png, jpg, webp	Format: png, jpg, or webp

Responses

301 — Redirect to Mux storyboard sprite

No body.

404 — Token not found or no stream configured

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

default — Shared error envelope returned by the application exception filter.

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

Example response

[]

GET /v1/tokens/{tokenName}/assets/storyboard.json

AssetsController_getStoryboardJson

Get storyboard JSON

Redirects to Mux storyboard metadata JSON. VOD only.

Parameters

Name	In	Required	Type	Description
tokenName	path	required		Token name identifier

Responses

301 — Redirect to Mux storyboard JSON

No body.

404 — Token not found or no stream configured

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

default — Shared error envelope returned by the application exception filter.

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

Example response

[]

GET /v1/tokens/{tokenName}/assets/storyboard.vtt

AssetsController_getStoryboardVtt

Get storyboard VTT

Redirects to Mux storyboard VTT for timeline hover previews. VOD only.

Parameters

Name	In	Required	Type	Description
tokenName	path	required		Token name identifier
format	query	optional		Image format in VTT: webp (default jpg)

Responses

301 — Redirect to Mux storyboard VTT

No body.

404 — Token not found or no stream configured

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

default — Shared error envelope returned by the application exception filter.

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

Example response

[]

GET /v1/tokens/{tokenName}/assets/thumbnail.{ext}

AssetsController_getThumbnail

Get stream thumbnail

Redirects to Mux thumbnail. Supports time, width, height, rotate, fit_mode params.

Parameters

Name	In	Required	Type	Description
tokenName	path	required		Token name identifier
ext	path	required	string enum: jpg, png, webp	Image format: jpg, png, or webp
fit_mode	query	optional		preserve, stretch, crop, smartcrop, or pad
height	query	optional		Height in pixels
width	query	optional		Width in pixels
time	query	optional		Thumbnail time in seconds

Responses

301 — Redirect to Mux thumbnail

No body.

404 — Token not found or no stream configured

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

default — Shared error envelope returned by the application exception filter.

Content type: application/json

Schema: ApiErrorEnvelope

Field	Type	Required	Description
error	boolean enum: true	yes
message	oneOf: string | array<string>	yes
status	integer	yes	HTTP status code.
message	string	yes
statusCode	integer	yes	HTTP status code.

Example response

[]

---

Previous group: Token Active Users · Next group: stream-actions