POST Create Video (Upload)

Syntax

The following method is used to create a new video object in the system using POST.

Note: This method creates a video object by passing a valid video JSON object in the POST body raw data.

Note: Currently the only mandatory parameter and value that are required for creating a Video object in the system is a 'name'.

URL
Note: The parameter highlighted in red is a placeholder for the mandatory value described bellow..

http://api.vidible.tv/COMPANY_KEY/video
  • COMPANY_KEY - Replace this placeholder with your Company Key.
    Note: If you do not have a Company Key, please contact our support team and provide your company's name and details.

JSON Payload

  • JSON Video Object - Pass a valid JSON Video Object via the method's 'Body' 'Raw' data. For further details on how to structure the Video JSON Object, please see Video JSON object specification.

    Important! 'Content-type' parameter header must be set with a value of 'application/json'.

    Note: The minimal video object depends on the selected create video method, either: Encoded or External.
    Encoded allows you to pass an original video file URL that will be ingested into our system and encoded by a selected Encoding profile. External allows you to pass an encoded video URL form your own CDN that will display the video in our platform.

 

 

Try it out by clicking here.

 

Examples

 

Basic Create Encoded Request

DescriptionThis method is for creating a new video using an original video file URL that will be encoded by our system using a specified encoding profile.

Method: POST

URL:

http://api.vidible.tv/5d3f3b3ac9374m3463be2557e04697ad/video

 

JSON Object

Note: The following JSON Object is sent via the 'Body' 'Raw' data with a Header 'Content-type' parameter set to 'application/json'.

{
"name" : "Create Video & Encode Rendition",
"encodingProfileId" : "59b7c68f92fdde7548969982",
"storageType" : "ENCODED",
"originalVideoUrl" : "http://cdn.vidible.tv/stage/2016-04/06/5705274ee4b0e57305dd5599_v1.orig.mp4"
}

 

Response

{
"id": "56d3002ee4b0286b7d0d3959",
"companyId": "56caee32e4b013d45a4273eb",
"creationDate": 1456668718982,
"name": "Create Video & Encode Rendition",
"metadata": {

},
"encodedVariants": [],
"thumbnailsNew": [],
"commonRating": {
"value": "G",
"descriptors": [],
"minAge": 0
},
"audienceGender": "All",
"countries": [],
"media": {

},
"contentLifecycle": "Evergreen",
"associatedCompanies": [],
"logo": {
"region": {
"x": 0,
"y": 0,
"w": 0,
"h": 0
}
},
"sellerRuleId": "56caee32e4b099244a14355a",
"deleted": false,
"supportedPlayerTypes": ["O2"],
"playbackAvailable": false,
"ageRatings": ["NONE_SPECIFIED"],
"external": true,
"version": 1
}

 

 

Basic Create External Request

DescriptionThis method is for creating a new video by specifying an external CDN video rendition file URL. The video will be represented in the Portal, but not ingested using our encoding.

Method: POST

URL:

http://api.vidible.tv/5d3f3b3ac9374m3463be2557e04697ad/video

 

JSON Object

Note: The following JSON Object is sent via the 'Body' 'Raw' data with a Header 'Content-type' parameter set to 'application/json'.

{
"name" : "Create External Hosted Video Rendition",
"storageType" : "EXTERNAL",
"encodedVariants": [
{
"advancedQuality": false,
"aspectRatio": 0,
"audioBitRate": 96,
"audioQuality": 5,
"crop": false,
"fileSizeBytes": 7305771,
"frameStep": true,
"height": 250,
"mono": true,
"provider": "ENCODING_COM",
"videoBitRate": 1500,
"videoQuality": 3,
"videoUrl": "http://cdn.vidible.tv/stage/2016-04/06/57052913e4b0e57305dd779e_300x250_v1.mp4",
"width": 300
}
]
}

 

Response

{
"id": "57459eb6e4b0ec4b37fc9808",
"companyId": "56d5921ce4b0f5991ad44713",
"creationDate": 1464180406001,
"name": "Create External Hosted Video Rendition",
"originalVideoUrl": "http://cdn.vidible.tv/stage/2016-04/06/5705274ee4b0e57305dd5599_v1.orig.mp4",
"metadata": {},
"encodedVariants": [],
"thumbnailsNew": [],
"commonRating": {
"value": "G",
"descriptors": [],
"minAge": 0
},
"audienceGender": "All",
"countries": [],
"media": {},
"contentLifecycle": "Evergreen",
"associatedCompanies": [],
"logo": {
"region": {
"x": 0,
"y": 0,
"w": 0,
"h": 0
}
},
"sellerRuleId": "56d5921ee4b0edf4cd64842e",
"deleted": false,
"supportedPlayerTypes": [
"O2"
],
"playbackAvailable": true,
"ageRatings": [
"NONE_SPECIFIED"
],
"storageType": "ENCODED",
"version": 1,
"classificationResult": {
"concepts": [],
"entities": [],
"taxonomyCategories": []
},
"hidden": false,
"subtitles": [],
"encodingProfileId": "59b7c68f92fdde7548969982",
"tags": []
}

 

 

 

Advanced Create Request

DescriptionThis is an example of a video that already has a rendition available on our CDN. The video object includes several optional attributes.

Method: POST

URL:

http://api.vidible.tv/5d3f3b3ac9374m3463be2557e04697ad/video

 

JSON Object

Note: The following JSON Object is sent via the 'Body' 'Raw' data with a Header 'Content-type' parameter set to 'application/json'.

{
"name": "Hillary Clinton Easily Wins South Carolina Primary",
"description": "Correspondent Craig Boswell reports.",
"category": ["US News"],
"keywords": ["cbs 2 philly", "philadelphia news", "eyewitness news weekends"],
"encodedVariants": [
{
"audioBitRate": 96,
"width": 640,
"height": 360,
"advancedQuality": false,
"audioQuality": 5,
"videoQuality": 3,
"videoBitRate": 600,
"crop": false,
"frameStep": false,
"mono": false,
"provider": "ENCODING_COM",
"aspectRatio": 1.7777777777777777,
"renditionType": "LD",
"videoUrl": "http://cdn.vidible.tv/prod/2016-02/28/56d302cae4b080b62b8e8760_640x360_v1.mp4",
"fileSizeBytes": 9797115,
"modificationDate": 1456673784382,
"file": ""
}
],
"commonRating": {
"value": "G",
"descriptors": [],
"minAge": 0
},
"credit": "CBS News 3",
"audienceGender": "All",
"author": ["Daily News"],
"clickUrl": "http://www.cbsnews.com/",
"ageRatings": ["SENIORS", "TEENS", "ADULTS"]
}

 

Response

{
"id": "56d30ea3e4b0286b7d0d3fd9",
"companyId": "56caee32e4b013d45a4273eb",
"creationDate": 1456672419315,
"name": "Hillary Clinton Easily Wins South Carolina Primary",
"description": "Correspondent Craig Boswell reports.",
"metadata": {

},
"category": ["US News"],
"keywords": ["cbs 2 philly",
"philadelphia news",
"eyewitness news weekends"],
"encodedVariants": [{
"audioBitRate": 96,
"width": 640,
"height": 360,
"advancedQuality": false,
"audioQuality": 5,
"videoQuality": 3,
"videoBitRate": 600,
"crop": false,
"frameStep": false,
"mono": false,
"provider": "ENCODING_COM",
"aspectRatio": 1.7777777777777777,
"renditionType": "LD",
"videoUrl": "http://cdn.vidible.tv/prod/2016-02/28/56d302cae4b080b62b8e8760_640x360_v1.mp4",
"fileSizeBytes": 9797115,
"modificationDate": 1456673784382,
"file": ""
}],
"thumbnailsNew": [],
"commonRating": {
"value": "G",
"descriptors": [],
"minAge": 0
},
"credit": "CBS News 3",
"audienceGender": "All",
"countries": [],
"media": {

},
"contentLifecycle": "Evergreen",
"associatedCompanies": [],
"author": ["Daily News"],
"clickUrl": "http://www.cbsnews.com/",
"logo": {
"region": {
"x": 0,
"y": 0,
"w": 0,
"h": 0
}
},
"sellerRuleId": "56caee32e4b099244a14355a",
"deleted": false,
"supportedPlayerTypes": ["O2"],
"playbackAvailable": false,
"ageRatings": ["TEENS",
"SENIORS",
"ADULTS"],
"external": true,
"version": 1
}

 

 

Have more questions? Submit a request