HTTP API reference › Gala Launchpad › recording-assets
Gala Launchpad — recording-assets
7 operations in this group.
- GET /v1/tokens/{tokenName}/recordings/{assetId}/assets/animated.{ext} — Get recording animated preview
- GET /v1/tokens/{tokenName}/recordings/{assetId}/assets/poster.jpg — Get recording poster image
- GET /v1/tokens/{tokenName}/recordings/{assetId}/assets/storyboard.{ext} — Get recording storyboard sprite
- GET /v1/tokens/{tokenName}/recordings/{assetId}/assets/storyboard.json — Get recording storyboard JSON
- GET /v1/tokens/{tokenName}/recordings/{assetId}/assets/storyboard.vtt — Get recording storyboard VTT
- GET /v1/tokens/{tokenName}/recordings/{assetId}/assets/stream.m3u8 — Get recording stream
- GET /v1/tokens/{tokenName}/recordings/{assetId}/assets/thumbnail.{ext} — Get recording thumbnail
GET /v1/tokens/{tokenName}/recordings/{assetId}/assets/animated.{ext}
RecordingAssetsController_getRecordingAnimated
Get recording animated preview
Redirects to Mux animated preview. Supports start, end, width, fps params.
token name asset id
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tokenName | path | required | Token name identifier | |
| assetId | path | required | Mux asset ID of the recording | |
| ext | path | required | string enum: gif, webp | Format: gif or webp |
Responses
301 — Redirect to Mux animated preview
No body.
404 — Recording not found
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}/recordings/{assetId}/assets/poster.jpg
RecordingAssetsController_getRecordingPoster
Get recording poster image
Redirects to high-res (1920x1080) recording thumbnail for video player posters.
token name asset id
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tokenName | path | required | Token name identifier | |
| assetId | path | required | Mux asset ID of the recording |
Responses
301 — Redirect to Mux poster thumbnail
No body.
404 — Recording not found
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}/recordings/{assetId}/assets/storyboard.{ext}
RecordingAssetsController_getRecordingStoryboardImage
Get recording storyboard sprite
Redirects to Mux storyboard sprite image.
token name asset id
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tokenName | path | required | Token name identifier | |
| assetId | path | required | Mux asset ID of the recording | |
| ext | path | required | string enum: png, jpg, webp | Format: png, jpg, or webp |
Responses
301 — Redirect to Mux storyboard sprite
No body.
404 — Recording not found
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}/recordings/{assetId}/assets/storyboard.json
RecordingAssetsController_getRecordingStoryboardJson
Get recording storyboard JSON
Redirects to Mux storyboard metadata JSON.
token name asset id
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tokenName | path | required | Token name identifier | |
| assetId | path | required | Mux asset ID of the recording |
Responses
301 — Redirect to Mux storyboard JSON
No body.
404 — Recording not found
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}/recordings/{assetId}/assets/storyboard.vtt
RecordingAssetsController_getRecordingStoryboardVtt
Get recording storyboard VTT
Redirects to Mux storyboard VTT for timeline hover previews.
token name asset id
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tokenName | path | required | Token name identifier | |
| assetId | path | required | Mux asset ID of the recording |
Responses
301 — Redirect to Mux storyboard VTT
No body.
404 — Recording not found
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}/recordings/{assetId}/assets/stream.m3u8
RecordingAssetsController_getRecordingStream
Get recording stream
Redirects to Mux HLS recording playback
token name asset id
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tokenName | path | required | Token name identifier | |
| assetId | path | required | Mux asset ID of the recording |
Responses
301 — Redirect to Mux HLS recording
No body.
404 — Recording not found or does not belong to this token
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}/recordings/{assetId}/assets/thumbnail.{ext}
RecordingAssetsController_getRecordingThumbnail
Get recording thumbnail
Redirects to Mux recording thumbnail. Supports time, width, height params.
token name asset id
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tokenName | path | required | Token name identifier | |
| assetId | path | required | Mux asset ID of the recording | |
| ext | path | required | string enum: jpg, png, webp | Image format: jpg, png, or webp |
Responses
301 — Redirect to Mux recording thumbnail
No body.
404 — Recording not found
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: recordings · Next group: simulcasts