Video API

Welcome to the Microsoft Project Oxford Video API. Video API is a cloud-based API that provides advanced algorithms for tracking faces, detecting motion, and stabilizing video. These APIs allow you to build more personalized and intelligent apps by understanding and automatically transforming your video content.

Thumbnail

Generates a motion thumbnail from a video. The Video Thumbnail API provides an automatic summary for videos to let people see a preview or snapshot quickly. Selection of scenes from a video create a preview in form of a short video.
• The supported input video formats include MP4, MOV, and WMV. Video file size should be no larger than 100MB.
• The number of scenes displayed in the thumbnail is either chosen by the user or defaults to the optimal duration supported by the Video API’s algorithm.
• A scene is a collection of indexed frames. Scenes are mapped according to sequence in video.
• Fade in/fade out effects are included in the thumbnail by default, but can be turned off by the user.
• Audio is included by default, but can be turned off by the user. Pauses in audio are detected to divide video into coherent scenes and avoid breaking sentences of speech.
• Output files are deleted after 24 hours.

  • Optimal Duration of Video Thumbnail Supported by Video API shown in table below.
Motion Thumbnail
Video duration (d) d < 3min 3min < d < 15min 15min < d < 30min 30min < d
Thumbnail duration 15sec (2-3 scenes) 30sec (3-5 scenes) 60sec (5-10 scenes) 90sec (10-15 scenes)

Open API testing console

Request URL

Request parameters

(optional)
number

Specifies maximum duration of output video (in seconds). The default value is 0, which indicates the duration will be automatically decided by the algorithm.

(optional)
boolean

Indicates whether output video should include audio track. The default value is true.

(optional)
boolean

Indicates whether output video should have fade in/out effect during scene changes. The default value is true.

Request headers

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

{
	"url":"http://www.example.com/sample.mp4"
}
[binary video data]

Response 202

The service has accepted the request and will start the process later.
In the response, there is a "Operation-Location" header. Client side should further query the operation status from the URL specified in this header.

Operation-LocationClient side should use this URL to query video operation status/result.
Example: https://api.projectoxford.ai/video/v1.0/operations/EF217D0C-9085-45D7-AAE0-2B36471B89B5 .

Response 400

Error code and message returned in JSON:

Error CodeDescription
InvalidVideoSizeVideo size is too small or too big.
BadArgumentFailed to deserialize JSON request.

{
   "error":
             {
                 "code":"InvalidVideoSize",
                 "message":"Video size is too small or too big."
             }
}

Response 415

When Content-Type is not application/json or application/octet-stream.

Response 401

Access denied due to invalid subscription key.

{
    "error":{
        "code": "Unauthorized",
        "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." 
    }
}

Response 403

Quota limit exceeded.

{
    "error":{
        "code": "QuotaLimitExceeded",
        "message": "Out of call volume quota. Quota will be replenished later." 
    }
}

Response 429

Rate limit exceeded.

{
    "error":{
        "code": "RateLimitExceeded",
        "message": "Rate limit is exceeded. Try again later." 
    }
}

Code samples

@ECHO OFF

curl -v -X POST "https://westus.api.cognitive.microsoft.com/video/v1.0/generatethumbnail?maxMotionThumbnailDurationInSecs={number}&outputAudio={boolean}&fadeInFadeOut={boolean}"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["maxMotionThumbnailDurationInSecs"] = "{number}";
            queryString["outputAudio"] = "{boolean}";
            queryString["fadeInFadeOut"] = "{boolean}";
            var uri = "https://westus.api.cognitive.microsoft.com/video/v1.0/generatethumbnail?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://westus.api.cognitive.microsoft.com/video/v1.0/generatethumbnail");

            builder.setParameter("maxMotionThumbnailDurationInSecs", "{number}");
            builder.setParameter("outputAudio", "{boolean}");
            builder.setParameter("fadeInFadeOut", "{boolean}");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "maxMotionThumbnailDurationInSecs": "{number}",
            "outputAudio": "{boolean}",
            "fadeInFadeOut": "{boolean}",
        };
      
        $.ajax({
            url: "https://westus.api.cognitive.microsoft.com/video/v1.0/generatethumbnail?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://westus.api.cognitive.microsoft.com/video/v1.0/generatethumbnail";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"maxMotionThumbnailDurationInSecs={number}",
                         @"outputAudio={boolean}",
                         @"fadeInFadeOut={boolean}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://westus.api.cognitive.microsoft.com/video/v1.0/generatethumbnail');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'maxMotionThumbnailDurationInSecs' => '{number}',
    'outputAudio' => '{boolean}',
    'fadeInFadeOut' => '{boolean}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'maxMotionThumbnailDurationInSecs': '{number}',
    'outputAudio': '{boolean}',
    'fadeInFadeOut': '{boolean}',
})

try:
    conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("POST", "/video/v1.0/generatethumbnail?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'maxMotionThumbnailDurationInSecs': '{number}',
    'outputAudio': '{boolean}',
    'fadeInFadeOut': '{boolean}',
})

try:
    conn = http.client.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("POST", "/video/v1.0/generatethumbnail?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://westus.api.cognitive.microsoft.com/video/v1.0/generatethumbnail')
uri.query = URI.encode_www_form({
    # Request parameters
    'maxMotionThumbnailDurationInSecs' => '{number}',
    'outputAudio' => '{boolean}',
    'fadeInFadeOut' => '{boolean}'
})

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body