Video Details
This API fetches the video details.
Endpoint
Headers
The JWT Access token should be passed in the authorization header for all APIs.
Header | Value |
---|---|
Authorization | JWT token. |
Response Body
{
"status_code": "A3102",
"status_message": "Video validation and harmonization in progress",
"key": "vid-01hpr7958wq1v97r58n8m0jrfd",
"name": "Video-1",
"ext_video_id": "596afghhhxx",
"project_key": "prj-01hpr6t70xedtepht8b196krsy",
"subtitles": [
{
"key": "sub-01xcv6t70xedtepht8b196krfg",
"kind": "captions",
"default": false,
"language": "English",
"url": "https://media-20220224063945059100000003.s3.amazonaws.com/2582/video/2582_60384_cdfeffc3-f174-47e7-8010-996747ebca6d_Aany1LnGDXgP9Pr.vtt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAVH3HWP7HZ6SO6UHS%2F20240220%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20240220T054503Z&X-Amz-Expires=36000&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjED0aCXVzLWVhc3QtMSJIMEYCIQCNsuml%2BdSiyDQhoa8GYbJ2LDXWE%2FpNHeldMGnx8MZKsQIhAPC3P2lbGG5jI3%2BMMGkDyHWjrQ4F38U%2FcXwX7Et5a8NXKu0DCCUQAhoMMzYwNDU3ODYzMTE5IgzN5S03kiTboN1z3JQqygMzpjwmC1x5M4ns3ivFTCDoTQjFYxOxCakaaFULJISD0CKR49S%2BhTv0lGOXE%2FWuLHMrIRA17yRWOaEVHeXmo%2FEuFXW7%2Feg%2Foaf5kdTFCAwIzbOZcyI%2FDzyWkrYd1Dm9YQda79YG3iCDPq9UT87o7W2nw8s99aFEjBmCY8FgVQs3GsR0q71An7dGZCmF5nU3CVH06Xk%4a0fd3736a4bca6222252727c51a65c56859469fd44b4f369b16e07a9c9b928b"
}
]
"cast": [
{
"name": "Mark",
"role": "Actor"
},
{
"name": "Susan",
"role": "Actress"
}
],
"poster": {
"url": "https://media.devtest.indee.tv/2582/2582_poster_1908335069.jpg?Expires=1708433103&Signature=SLya1ftOiEMsr1-3Ud5t3ufOcTORgU0aLMZoRxUb1TpjMKcPYQJXlrXSt8DgpLo87HjKtvkOY6kw5sylAjUY5P~hMbvr7S5Ow9Wog3Il2fzOZVVbYv8kKrkD8RUjKmPYL1k0e8D0M~npByY~hQq0RxmSyfEi~bNuOSn~jjr7BbU4pvp58Kp4EOv4iJxjYseSF~Ft8bpbNONpSeehRNRLTfL19YYOp5xwXkqcp2~LnfoKyQ9nyWktsDqXF29rnQUgV0D83VucpvE-fp-CAsPZzxuy0qskaq-o2qdB1ikJ3ruWf8vmAvXi8BDM8iSRmxTh3nwkVIlC3e3L15fDeoK4pw__&Key-Pair-Id=K2NTQVU4FZL5P0",
"status_code": "A3133",
"status_message": "Video poster added successfully"
},
"audio_tracks": [
{
"key": "aud-01fwzm9p60wsf5t4s3tye8r42a",
"track_name": "ISO Media file produced by Googl",
"file_name": "audio-source-0.aac",
"url": "https://media.indee.tv/2582/video/60384_audio-source-0.aac?Expires=1708433103&Signature=SLya1ftOiEMsr1-3Ud5t3ufOcTORgU0aLMZoRxUb1TpjMKcPYQJXlrXSt8DgpLo87HjKtvkOY6kw5sylAjUY5P~hMbvr7S5Ow9Wog3Il2fzOZVVbYv8kKrkD8RUjKmPYL1k0e8D0M~npByY&Key-Pair-Id=K2NTQVU4FZL5P0",
"default": true,
"status_code": "A3122",
"status_message": "Audio file uploaded successfully"
}
],
"description": "Video for Season 2 Episode 5",
"season": 1,
"episode": 1,
"rough_cut": false,
"notes": "something",
"original_air_date": 1692835200,
"video": ""
}
The API response will contain the "status_code" which will describe the state of the video, the significance of each status code is described in this section of the API status codes document.
Name | Type | Description |
---|---|---|
ext_video_id |
String | A customer provided unique ID for the video |
name |
String | A video name |
description |
String | A video description |
project_key |
String | The project key to which the video will be added |
season |
int | Season number to which the video belongs to |
episode |
int | Episode number to which the video belongs to |
poster |
dict | A URL and other parameters to add customer’s asset for the video poster |
cast |
Array | A collection of asset pair of role and name |
original_air_date |
int | The first time the episode was aired in epoch format. |
rough_cut |
Boolean | True / False if the video is a rough cut video |
notes |
String | Notes on video |
subtitles |
Array | Depending on the upload type it will have params |
language |
String | Language of the subtitle. |
default (subtitles) |
Boolean | Specifies if the subtitle should be set as the default subtitle during playback. If more than one subtitle is set as default, an error code of A4114 will be reported. |
audio_tracks |
Array | Depending on the upload type it will have params |
track_name |
String | Name of the audio track. |
default (audio tracks) |
Boolean | Specifies if the particular track is set as the default track during playback. If more than one track is set as default, an error code of A4124 will be reported. |
video |
dict | Depending on the upload type it will have params |
Error Codes
Indee provides a comprehensive list of Error Codes. To know more, see Common Error and Success Codes.