GET Video Assets by Video Id
Overview
The following table contains information about the GET method for managing process of retrieving assets of a specific video.
| GET Video Assets | |
|---|---|
| Method | GET |
| URL or Endpoint | /api/projects/projectId/videos/assets/videoId |
| Headers | Authorization |
| Parameters | videoId, projectId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
projectId | Yes | string | Unique Id of the project |
videoId | Yes | string | Unique id of the video |
Request Body
The GET method doesn't contain a request body.
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"filmStrip": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/thumbnails/filmstrip0.jpg",
"filmStripVtt": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/thumbnails/filmstrip.vtt",
"thumbnail": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/thumbnails/retina.jpg",
"customThumbnail": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/thumbnails/retina.jpg",
//If video contains chapters, the URL of the VTT file will apear like this:
"chaptersVtt": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/chapter.vtt",
"thumbnailSecond": null,
"originalFile": "{originalFile}",
"playBackUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/master_file.m3u8",
"streamResponse": {
"keyId": "",
"contentId": "",
"progress": 100,
"progressTillReadiness": 100,
"status": "Complete",
"encodingProcessRemainingTime": 0,
"insertDate": "2024-12-25T13:05:34.9467128",
"encodingProcessFinishTime": "2024-06-25T12:30:31.298662Z",
"streams": [
{
"assetType": "Video",
"streamType": "hls",
"root": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/master_file.m3u8",
"qualityTypes": [
{
"id": "{videoId}",
"mediaType": "Video",
"qualityType": "1440p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/1440p/index.m3u8",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 25760572,
"width": 1440,
"height": 2560,
"bitrate": 6852288,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Video",
"qualityType": "1080p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/1080p/index.m3u8",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 16206631,
"width": 1080,
"height": 1920,
"bitrate": 4307398,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Video",
"qualityType": "720p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/720p/index.m3u8",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 6285510,
"width": 720,
"height": 1280,
"bitrate": 1664702,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Video",
"qualityType": "480p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/480p/index.m3u8",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 3146829,
"width": 480,
"height": 854,
"bitrate": 828649,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Video",
"qualityType": "360p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/360p/index.m3u8",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 1583953,
"width": 360,
"height": 640,
"bitrate": 412345,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Video",
"qualityType": "240p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/240p/index.m3u8",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 721676,
"width": 240,
"height": 428,
"bitrate": 182660,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
}
]
},
{
"assetType": "Video",
"streamType": "mp4",
"root": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/mp4/master_file.gjp4",
"qualityTypes": [
{
"id": "{videoId}",
"mediaType": "Video",
"qualityType": "1440p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/mp4/1440p.mp4",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 25554052,
"width": 1440,
"height": 2560,
"bitrate": 6797277,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Video",
"qualityType": "240p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/mp4/240p.mp4",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 721534,
"width": 240,
"height": 428,
"bitrate": 182622,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Video",
"qualityType": "480p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/mp4/480p.mp4",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 3166938,
"width": 480,
"height": 854,
"bitrate": 834006,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Video",
"qualityType": "360p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/mp4/360p.mp4",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 1590328,
"width": 360,
"height": 640,
"bitrate": 414043,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Video",
"qualityType": "720p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/mp4/720p.mp4",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 6310660,
"width": 720,
"height": 1280,
"bitrate": 1671401,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Video",
"qualityType": "1080p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/mp4/1080p.mp4",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 17154184,
"width": 1080,
"height": 1920,
"bitrate": 4559798,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
}
]
},
{
"assetType": "Video",
"streamType": "transcription",
"root": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/transcription/master_file.gjp4",
"qualityTypes": [
{
"id": "{videoId}",
"mediaType": "Video",
"qualityType": "320kbps_audio",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/transcription/320kbps_audio.mp3",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 481681,
"width": 0,
"height": 0,
"bitrate": 0,
"audioCodec": "mp3",
"audioBitrate": 128000,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
}
]
},
{
"assetType": "Audio",
"streamType": "hls",
"root": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/720p/audio/index.m3u8",
"qualityTypes": [
{
"id": "{videoId}",
"mediaType": "Audio",
"qualityType": "1440p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/1440p/audio/index.m3u8",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 25760572,
"width": 0,
"height": 0,
"bitrate": 0,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Audio",
"qualityType": "1080p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/1080p/audio/index.m3u8",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 16206631,
"width": 0,
"height": 0,
"bitrate": 0,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Audio",
"qualityType": "720p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/720p/audio/index.m3u8",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 6285510,
"width": 0,
"height": 0,
"bitrate": 0,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Audio",
"qualityType": "480p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/480p/audio/index.m3u8",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 3146829,
"width": 0,
"height": 0,
"bitrate": 0,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Audio",
"qualityType": "360p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/360p/audio/index.m3u8",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 1583953,
"width": 0,
"height": 0,
"bitrate": 0,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
},
{
"id": "{videoId}",
"mediaType": "Audio",
"qualityType": "240p",
"streamUrl": "https://cdn.vpplayer.tech/{projectId}/encode/{videoId}/hls/240p/audio/index.m3u8",
"statusDescription": "Complete",
"status": "Complete",
"duration": 30.036667,
"size": 721676,
"width": 0,
"height": 0,
"bitrate": 0,
"audioCodec": "aac",
"audioBitrate": 2273,
"audioSampleRate": 48000,
"progress": 100,
"startDateTime": "2025-02-14T13:02:12.523Z",
"endDateTime": "2025-02-14T13:02:12.523Z"
}
]
}
]
}
},
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful it will return true. Otherwise will return false |
| errors | array[string] | Indicates if there was an error |
| messages | array[string] | Returns the response message from back-end |
| result | array[Object] | Returns the response object |
| filmstrip | string | URL of the filmstrip image. |
| filmstripVtt | string | URL of the VTT file for the filmstrip |
| thumbnail | string | URL of the default thumbnail image of the video |
| customThumbnail | string | URL of a custom thumbnail image |
| chaptersVtt | string | URL of the VTT file for chapters |
| thumbnailSecond | string | Another thumbnail image URL |
| originalFile | string | A unique identifier for the original video file |
| playbackUrl | string | URL for video playback. |
| streamResponse | array[Object] | Returns the stream response as an array of objects. |
| keyId | string | Id of the key |
| contentId | string | Id of the content |
| progress | integer($int32) | Overall progress of the encoding process |
| progressTillReadiness | integer($int32) | Progress until the video is ready |
| status | string | Current status of the encoding process |
| encodingProcessRemainingTime | integer($int32) | Time remaining for encoding to complete |
| insertDate | Date | Date and time when the video was inserted |
| EncodingProcessFinishTime | Date | Timestamp of when the encoding finished |
| streams | array[Object] | Returns the streams as an array of objects. |
| assetType | string | Type of media |
| streamType | string | Format of the stream |
| root | string | The URL of the root. |
| qualityTypes | array[Object] | Returns the quality types as an array of quality types. |
| id | string | Unique identifier for this particular quality |
| mediaType | string | Type of the media |
| qualityType | string | Describes the quality of the stream |
| streamUrl | string | URL to access specific quality stream |
| statusDescription | string | Description of the current status |
| status | string | Status of the quality stream |
| duration | double | Duration of the stream in seconds |
| size | integer($int32) | Size of the stream file in bytes |
| width | integer($int32) | Width of the video in pixels |
| height | integer($int32) | Height of the video in pixels |
| bitrate | integer($int32) | Bitrate of the stream in bits per seconds |
| audioCodec | string | Codec used for the audio stream |
| audioBitrate | integer($int32) | Bitrate of the audio stream in Hz. |
| audioSampleRate | integer($int32) | Sample rate of the audio stream in Hz |
| progress | integer($int32) | Progress of encoding for quality type |
| startDateTime | Date-Time | The UTC timestamp when the process begins. |
| endDateTime | Date-Time | The UTC timestamp when the process ends. |
| resultInfo | string | Returns extra information about the result |
| statusCode | integer($int32) | Returns the HTTP Status Code |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed