Operations

API change history

The Operations API contains all the Video Indexer APIs, such as Upload video, Get insights, and other operations

Upload Video

Uploads the given video, starts indexing it and returns a new Video id.
The supported formats are listed here

Try it

Request

Request URL

Request parameters

  • string

    Location indicates the Azure region to which the call should be routed
    See more details here

  • string

    Format - guid. Account ID is a globally unique identifier (GUID) for the account.
    See more details here

  • string

    The video name

  • string

    Access token should match the authorization scope of the call (Account, with Write)
    Note that Access tokens expire within 1 hour
    See more details here

  • (optional)
    string

    The video privacy mode. Allowed values: Private/Public

  • (optional)
    string

    Index priority, can be used in paid regions only. Allowed values: Low/Normal/High

  • (optional)
    string

    The video description.

  • (optional)
    string

    A partition to partition videos by (used for searching a specific partition)

  • (optional)
    string

    An external id to associate with the video (can be searched for later).

  • (optional)
    string

    An external URL to associate with the video (can be retrieved later)

  • (optional)
    string

    A url to notify when indexing is completed. It should be a POST url and VideoIndexer will add 2 additional query string parameters to it: id and state.

    For example, if the callback url is 'https://test.com/notifyme?projectName=MyProject', the notification will be sent with additional parameters to 'https://test.com/notifyme?projectName=MyProject&id=1234abcd&state=Processed'.

  • (optional)
    string

    Metadata to associate with the video (will be returned in queries).

  • (optional)
    string

    The language of the video, to be used when generating the transcript. Supported languages: Chinese (Simplified): zh-Hans, English: en-US, Spanish: es-ES, French: fr-FR, Arabic: ar-EG, German: de-DE, Italian: it-IT, Japanese: ja-JP, Hindi: hi-IN, Korean: ko-KR, Russian: ru-RU, Portuguese: pt-BR.

  • (optional)
    string

    A public url of the video/audio file (url encoded). If not specified, the file should be passed as a multipart/form body content.

  • (optional)
    string

    The uploaded file name.

  • (optional)
    string

    The indexing preset to use. Allowed values: Default/AudioOnly/VideoOnly/DefaultWithNoiseReduction

  • (optional)
    string

    The streaming preset to use. Allowed values: NoStreaming/Default/SingleBitrate/AdaptiveBitrate

  • (optional)
    string

    Linguistic model id as received by 'create linguistic model' call

  • (optional)
    string

    Faces will be identified against the provided person model.

  • (optional)
    boolean

    Indicates whether to send a success mail once video was succesfully indexed

  • (optional)
    string

    Azure media services asset id. Used to index from existing assets in your connected Azure media services account. (Paid only)

  • (optional)
    string

    List of brands categories delimited by comma. Video indexer will only take these categories in to account when indexing. If not specified all brands will be used.

Request headers

  • (optional)
    string
    Media type of the body sent to the API.

Responses

200 OK

Video uploaded successfully

Representations

404 Not Found

Account not found

Representations

400 Bad Request

Invalid input

Representations

401 Unauthorized

Representations

{
  "errorType": "USER_NOT_ALLOWED",
  "message": "Access token is not authorized to access account 'SampleAccountId'."
}

500 Internal Server Error

Representations

{
  "errorType": "GENERAL",
  "message": "There was an error."
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Videos?name={name}&accessToken={accessToken}?privacy=Private&priority={string}&description={string}&partition={string}&externalId={string}&externalUrl={string}&callbackUrl={string}&metadata={string}&language={string}&videoUrl={string}&fileName={string}&indexingPreset=Default&streamingPreset=Default&linguisticModelId={string}&personModelId={string}&sendSuccessEmail=False&assetId={string}&brandsCategories={string}"
-H "Content-Type: multipart/form-data"

--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

            // Request parameters
            queryString["privacy"] = "Private";
            queryString["priority"] = "{string}";
            queryString["description"] = "{string}";
            queryString["partition"] = "{string}";
            queryString["externalId"] = "{string}";
            queryString["externalUrl"] = "{string}";
            queryString["callbackUrl"] = "{string}";
            queryString["metadata"] = "{string}";
            queryString["language"] = "{string}";
            queryString["videoUrl"] = "{string}";
            queryString["fileName"] = "{string}";
            queryString["indexingPreset"] = "Default";
            queryString["streamingPreset"] = "Default";
            queryString["linguisticModelId"] = "{string}";
            queryString["personModelId"] = "{string}";
            queryString["sendSuccessEmail"] = "False";
            queryString["assetId"] = "{string}";
            queryString["brandsCategories"] = "{string}";
            var uri = "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Videos?name={name}&accessToken={accessToken}&" + 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://api.videoindexer.ai/{location}/Accounts/{accountId}/Videos?name={name}&accessToken={accessToken}");

            builder.setParameter("privacy", "Private");
            builder.setParameter("priority", "{string}");
            builder.setParameter("description", "{string}");
            builder.setParameter("partition", "{string}");
            builder.setParameter("externalId", "{string}");
            builder.setParameter("externalUrl", "{string}");
            builder.setParameter("callbackUrl", "{string}");
            builder.setParameter("metadata", "{string}");
            builder.setParameter("language", "{string}");
            builder.setParameter("videoUrl", "{string}");
            builder.setParameter("fileName", "{string}");
            builder.setParameter("indexingPreset", "Default");
            builder.setParameter("streamingPreset", "Default");
            builder.setParameter("linguisticModelId", "{string}");
            builder.setParameter("personModelId", "{string}");
            builder.setParameter("sendSuccessEmail", "False");
            builder.setParameter("assetId", "{string}");
            builder.setParameter("brandsCategories", "{string}");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "multipart/form-data");


            // 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
            "privacy": "Private",
            "priority": "{string}",
            "description": "{string}",
            "partition": "{string}",
            "externalId": "{string}",
            "externalUrl": "{string}",
            "callbackUrl": "{string}",
            "metadata": "{string}",
            "language": "{string}",
            "videoUrl": "{string}",
            "fileName": "{string}",
            "indexingPreset": "Default",
            "streamingPreset": "Default",
            "linguisticModelId": "{string}",
            "personModelId": "{string}",
            "sendSuccessEmail": "False",
            "assetId": "{string}",
            "brandsCategories": "{string}",
        };
      
        $.ajax({
            url: "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Videos?name={name}&accessToken={accessToken}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","multipart/form-data");
            },
            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://api.videoindexer.ai/{location}/Accounts/{accountId}/Videos?name={name}&accessToken={accessToken}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"privacy=Private",
                         @"priority={string}",
                         @"description={string}",
                         @"partition={string}",
                         @"externalId={string}",
                         @"externalUrl={string}",
                         @"callbackUrl={string}",
                         @"metadata={string}",
                         @"language={string}",
                         @"videoUrl={string}",
                         @"fileName={string}",
                         @"indexingPreset=Default",
                         @"streamingPreset=Default",
                         @"linguisticModelId={string}",
                         @"personModelId={string}",
                         @"sendSuccessEmail=False",
                         @"assetId={string}",
                         @"brandsCategories={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"multipart/form-data" forHTTPHeaderField:@"Content-Type"];
    // 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://api.videoindexer.ai/{location}/Accounts/{accountId}/Videos?name={name}&accessToken={accessToken}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'multipart/form-data',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'privacy' => 'Private',
    'priority' => '{string}',
    'description' => '{string}',
    'partition' => '{string}',
    'externalId' => '{string}',
    'externalUrl' => '{string}',
    'callbackUrl' => '{string}',
    'metadata' => '{string}',
    'language' => '{string}',
    'videoUrl' => '{string}',
    'fileName' => '{string}',
    'indexingPreset' => 'Default',
    'streamingPreset' => 'Default',
    'linguisticModelId' => '{string}',
    'personModelId' => '{string}',
    'sendSuccessEmail' => 'False',
    'assetId' => '{string}',
    'brandsCategories' => '{string}',
);

$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': 'multipart/form-data',
}

params = urllib.urlencode({
    # Request parameters
    'privacy': 'Private',
    'priority': '{string}',
    'description': '{string}',
    'partition': '{string}',
    'externalId': '{string}',
    'externalUrl': '{string}',
    'callbackUrl': '{string}',
    'metadata': '{string}',
    'language': '{string}',
    'videoUrl': '{string}',
    'fileName': '{string}',
    'indexingPreset': 'Default',
    'streamingPreset': 'Default',
    'linguisticModelId': '{string}',
    'personModelId': '{string}',
    'sendSuccessEmail': 'False',
    'assetId': '{string}',
    'brandsCategories': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.videoindexer.ai')
    conn.request("POST", "/{location}/Accounts/{accountId}/Videos?name={name}&accessToken={accessToken}&%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': 'multipart/form-data',
}

params = urllib.parse.urlencode({
    # Request parameters
    'privacy': 'Private',
    'priority': '{string}',
    'description': '{string}',
    'partition': '{string}',
    'externalId': '{string}',
    'externalUrl': '{string}',
    'callbackUrl': '{string}',
    'metadata': '{string}',
    'language': '{string}',
    'videoUrl': '{string}',
    'fileName': '{string}',
    'indexingPreset': 'Default',
    'streamingPreset': 'Default',
    'linguisticModelId': '{string}',
    'personModelId': '{string}',
    'sendSuccessEmail': 'False',
    'assetId': '{string}',
    'brandsCategories': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.videoindexer.ai')
    conn.request("POST", "/{location}/Accounts/{accountId}/Videos?name={name}&accessToken={accessToken}&%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://api.videoindexer.ai/{location}/Accounts/{accountId}/Videos?name={name}&accessToken={accessToken}')

query = URI.encode_www_form({
    # Request parameters
    'privacy' => 'Private',
    'priority' => '{string}',
    'description' => '{string}',
    'partition' => '{string}',
    'externalId' => '{string}',
    'externalUrl' => '{string}',
    'callbackUrl' => '{string}',
    'metadata' => '{string}',
    'language' => '{string}',
    'videoUrl' => '{string}',
    'fileName' => '{string}',
    'indexingPreset' => 'Default',
    'streamingPreset' => 'Default',
    'linguisticModelId' => '{string}',
    'personModelId' => '{string}',
    'sendSuccessEmail' => 'False',
    'assetId' => '{string}',
    'brandsCategories' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'multipart/form-data'
# 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