Operations

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

Search Videos

Search videos and projects in the specified account

Request

Request URL

https://api.videoindexer.ai/{location}/Accounts/{accountId}/Videos/Search[?sourceLanguage][&isBase][&hasSourceVideoFile][&sourceVideoId][&state][&privacy][&id][&partition][&externalId][&owner][&face][&query][&textScope][&language][&pageSize][&skip][&accessToken]

Request parameters

location

string

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

string

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

string

Include only videos/projects with that source language. 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.
isBase (optional)

boolean

true will include only videos; false will include only projects
hasSourceVideoFile (optional)

boolean

true will include videos that have a source file; false will include projects as well as videos without a source file
sourceVideoId (optional)

string

Include only the video with the given id as well as projects that have a source video with the given id
state (optional)

array

A processing state of videos. Projects are always in 'Processed' state. Allowed values: Uploaded/Processing/Processed/Failed/Quarantined
privacy (optional)

array

A privacy level. Allowed values: Private/Public
id (optional)

array

A video id to search for.
partition (optional)

array

A partition to search for.
externalId (optional)

array

An external id to search for (which was associated with the video at upload).
owner (optional)

array

An owner to search for.
face (optional)

array

A face to search for.
query (optional)

array

Free text to search for.
textScope (optional)

array

The text scope to search in.. Allowed values: Transcript/Ocr/Annotations/Brands/NamedLocations/NamedPeople
language (optional)

array

The language to search in. You can specify multiple language parameters (e.g. $language=English&language=French) to search multiple languages. Having no language parameter will search all languages. Videos/projects are searchable in their source language as well as any language they were translated to by another operation. Supported languages: Serbian (Cyrillic): sr-Cyrl-RS, Serbian (Latin): sr-Latn-RS, Bosnian: bs-Latn, Chinese (Simplified): zh-Hans, Chinese (Traditional): zh-Hant, Filipino: fil-PH, Fijian: en-FJ, Samoan: en-WS, English: en-US, Greek: el-GR, Spanish: es-ES, Estonian: et-EE, Persian: fa-IR, Finnish: fi-FI, French: fr-FR, Haitian: fr-HT, Afrikaans: af-ZA, Arabic: ar-EG, Danish: da-DK, German: de-DE, Bulgarian: bg-BG, Bangla: bn-BD, Malagasy: mg-MG, Malay: ms-MY, Maltese: mt-MT, Catalan: ca-ES, Czech: cs-CZ, Dutch: nl-NL, Norwegian: nb-NO, Indonesian: id-ID, Italian: it-IT, Lithuanian: lt-LT, Latvian: lv-LV, Japanese: ja-JP, Urdu: ur-PK, Ukrainian: uk-UA, Hindi: hi-IN, Hebrew: he-IL, Hungarian: hu-HU, Croatian: hr-HR, Korean: ko-KR, Vietnamese: vi-VN, Turkish: tr-TR, Tamil: ta-IN, Thai: th-TH, Tongan: to-TO, Russian: ru-RU, Romanian: ro-RO, Portuguese: pt-BR, Polish: pl-PL, Swedish: sv-SE, Kiswahili: sw-KE, Slovenian: sl-SI, Slovak: sk-SK.
pageSize (optional)

integer

Format - int32. The number of results to return.
skip (optional)

integer

Format - int32. The number of results to skip (used for paging).
accessToken (optional)

string

Required for private videos/projects or account scope search
Should be given as parameter in URL query string or in Authorization header as Bearer token, and match the authorization scope of the call (A video token for a single video/project search, or account token with read permissions)
Note that Access tokens expire within 1 hour
See more details here

Request headers

x-ms-client-request-id (optional)

string

Format - uuid. A globally unique identifier (GUID) for the request which can be sent by client for instrumentation purposes. The server makes sure all logs associated with handling the request can be linked to the client request id so a client can provide this request id in support tickets so support engineers could find the logs linked to this particular request, so avoid using the same request id for different requests, including in retry scenarios.

Request body

Responses

200 OK

Search results

Response headers

x-ms-request-id (optional)

string

A globally unique identifier (GUID) for the request which is assigned by the server for instrumentation purposes. The server makes sure all logs associated with handling the request can be linked to the server request id so a client can provide this request id in support tickets so support engineers could find the logs linked to this particular request. The server makes sure this request id will never repeat itself.

Representations

application/json

{
  "results": [
    {
      "accountId": "SampleAccountId",
      "id": "476892a745",
      "partition": null,
      "externalId": null,
      "metadata": null,
      "name": "test2",
      "description": null,
      "created": "2018-04-25T17=40=28.273+00=00",
      "lastModified": "2018-04-25T17=43=11.548+00=00",
      "lastIndexed": "2018-04-25T17=40=38.561+00=00",
      "privacyMode": "Private",
      "userName": "SampleUserName",
      "isOwned": true,
      "isBase": true,
      "state": "Processed",
      "processingProgress": "",
      "durationInSeconds": 13,
      "thumbnailVideoId": "476892a745",
      "thumbnailId": "d869021e-2a0b-4355-9c80-144e51aa8f6d",
      "social": {
        "likedByUser": false,
        "likes": 0,
        "views": 0
      },
      "searchMatches": [],
      "indexingPreset": "Default",
      "streamingPreset": "Default",
      "sourceLanguage": "en-US"
    },
    {
      "accountId": "SampleAccountId",
      "id": "30e66ec1b1",
      "partition": null,
      "externalId": null,
      "metadata": null,
      "name": "test3",
      "description": null,
      "created": "2018-04-25T16=50=00.967+00=00",
      "lastModified": "2018-04-25T16=58=13.409+00=00",
      "lastIndexed": "2018-04-25T16=50=12.991+00=00",
      "privacyMode": "Private",
      "userName": "SampleUserName",
      "isOwned": true,
      "isBase": true,
      "state": "Processing",
      "processingProgress": "",
      "durationInSeconds": 13,
      "thumbnailVideoId": "30e66ec1b1",
      "thumbnailId": "55848b7b-8be7-4285-893e-cdc366e09133",
      "social": {
        "likedByUser": false,
        "likes": 0,
        "views": 0
      },
      "searchMatches": [],
      "indexingPreset": "Default",
      "streamingPreset": "Default",
      "sourceLanguage": "en-US"
    },
    {
      "accountId": "SampleAccountId",
      "id": "3a9220459b",
      "partition": null,
      "externalId": null,
      "metadata": null,
      "name": "SampleVideo_1280x720_2mb222",
      "description": null,
      "created": "2018-04-25T16=29=43.099+00=00",
      "lastModified": "2018-04-25T16=57=07.7+00=00",
      "lastIndexed": "2018-04-25T16=29=54.767+00=00",
      "privacyMode": "Private",
      "userName": "ExampleUser",
      "isOwned": true,
      "isBase": true,
      "state": "Processing",
      "processingProgress": "",
      "durationInSeconds": 13,
      "thumbnailVideoId": "3a9220459b",
      "thumbnailId": "21700e5e-9736-42b9-9bbb-124df35295eb",
      "social": {
        "likedByUser": false,
        "likes": 0,
        "views": 0
      },
      "searchMatches": [],
      "indexingPreset": "Default",
      "streamingPreset": "Default",
      "sourceLanguage": "en-US"
    }
  ],
  "nextPage": {
    "pageSize": 25,
    "skip": 0,
    "done": true
  }
}

400 Bad Request

Response headers

x-ms-request-id (optional)

string

A globally unique identifier (GUID) for the request which is assigned by the server for instrumentation purposes. The server makes sure all logs associated with handling the request can be linked to the server request id so a client can provide this request id in support tickets so support engineers could find the logs linked to this particular request. The server makes sure this request id will never repeat itself.

Representations

application/json

{
  "errorType": "INVALID_INPUT",
  "message": "Language 'BadLanguage' is not supported"
}

401 Unauthorized

Response headers

x-ms-request-id (optional)

string

A globally unique identifier (GUID) for the request which is assigned by the server for instrumentation purposes. The server makes sure all logs associated with handling the request can be linked to the server request id so a client can provide this request id in support tickets so support engineers could find the logs linked to this particular request. The server makes sure this request id will never repeat itself.

Representations

application/json

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

500 Internal Server Error

Response headers

x-ms-request-id (optional)

string

A globally unique identifier (GUID) for the request which is assigned by the server for instrumentation purposes. The server makes sure all logs associated with handling the request can be linked to the server request id so a client can provide this request id in support tickets so support engineers could find the logs linked to this particular request. The server makes sure this request id will never repeat itself.

Representations

application/json

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

429 Too many requests

Too many requests were sent, use Retry-After response header to decide when to send the next request

Response headers

Retry-After (optional)

integer

A non-negative decimal integer indicating the seconds to delay after the response is received
x-ms-request-id (optional)

string

A globally unique identifier (GUID) for the request which is assigned by the server for instrumentation purposes. The server makes sure all logs associated with handling the request can be linked to the server request id so a client can provide this request id in support tickets so support engineers could find the logs linked to this particular request. The server makes sure this request id will never repeat itself.

Representations

application/json

504 Gateway Timeout

Server did not respond to gateway within expected time

Response headers

x-ms-request-id (optional)

string

A globally unique identifier (GUID) for the request which is assigned by the server for instrumentation purposes. The server makes sure all logs associated with handling the request can be linked to the server request id so a client can provide this request id in support tickets so support engineers could find the logs linked to this particular request. The server makes sure this request id will never repeat itself.

Representations

application/json

{
  "errorType": "SERVER_TIMEOUT",
  "message": "Server did not respond to gateway within expected time"
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Videos/Search?sourceLanguage={string}&isBase={boolean}&hasSourceVideoFile={boolean}&sourceVideoId={string}&state={array}&privacy={array}&id={array}&partition={array}&externalId={array}&owner={array}&face={array}&query={array}&textScope={array}&language={array}&pageSize=25&skip=0&accessToken={string}"
-H "x-ms-client-request-id: "

--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("x-ms-client-request-id", "");

            // Request parameters
            queryString["sourceLanguage"] = "{string}";
            queryString["isBase"] = "{boolean}";
            queryString["hasSourceVideoFile"] = "{boolean}";
            queryString["sourceVideoId"] = "{string}";
            queryString["state"] = "{array}";
            queryString["privacy"] = "{array}";
            queryString["id"] = "{array}";
            queryString["partition"] = "{array}";
            queryString["externalId"] = "{array}";
            queryString["owner"] = "{array}";
            queryString["face"] = "{array}";
            queryString["query"] = "{array}";
            queryString["textScope"] = "{array}";
            queryString["language"] = "{array}";
            queryString["pageSize"] = "25";
            queryString["skip"] = "0";
            queryString["accessToken"] = "{string}";
            var uri = "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Videos/Search?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}

// // 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/Search");

            builder.setParameter("sourceLanguage", "{string}");
            builder.setParameter("isBase", "{boolean}");
            builder.setParameter("hasSourceVideoFile", "{boolean}");
            builder.setParameter("sourceVideoId", "{string}");
            builder.setParameter("state", "{array}");
            builder.setParameter("privacy", "{array}");
            builder.setParameter("id", "{array}");
            builder.setParameter("partition", "{array}");
            builder.setParameter("externalId", "{array}");
            builder.setParameter("owner", "{array}");
            builder.setParameter("face", "{array}");
            builder.setParameter("query", "{array}");
            builder.setParameter("textScope", "{array}");
            builder.setParameter("language", "{array}");
            builder.setParameter("pageSize", "25");
            builder.setParameter("skip", "0");
            builder.setParameter("accessToken", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("x-ms-client-request-id", "");


            // 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
            "sourceLanguage": "{string}",
            "isBase": "{boolean}",
            "hasSourceVideoFile": "{boolean}",
            "sourceVideoId": "{string}",
            "state": "{array}",
            "privacy": "{array}",
            "id": "{array}",
            "partition": "{array}",
            "externalId": "{array}",
            "owner": "{array}",
            "face": "{array}",
            "query": "{array}",
            "textScope": "{array}",
            "language": "{array}",
            "pageSize": "25",
            "skip": "0",
            "accessToken": "{string}",
        };
      
        $.ajax({
            url: "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Videos/Search?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("x-ms-client-request-id","");
            },
            type: "GET",
            // 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/Search";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"sourceLanguage={string}",
                         @"isBase={boolean}",
                         @"hasSourceVideoFile={boolean}",
                         @"sourceVideoId={string}",
                         @"state={array}",
                         @"privacy={array}",
                         @"id={array}",
                         @"partition={array}",
                         @"externalId={array}",
                         @"owner={array}",
                         @"face={array}",
                         @"query={array}",
                         @"textScope={array}",
                         @"language={array}",
                         @"pageSize=25",
                         @"skip=0",
                         @"accessToken={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"x-ms-client-request-id"];
    // 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/Search');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'x-ms-client-request-id' => '',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'sourceLanguage' => '{string}',
    'isBase' => '{boolean}',
    'hasSourceVideoFile' => '{boolean}',
    'sourceVideoId' => '{string}',
    'state' => '{array}',
    'privacy' => '{array}',
    'id' => '{array}',
    'partition' => '{array}',
    'externalId' => '{array}',
    'owner' => '{array}',
    'face' => '{array}',
    'query' => '{array}',
    'textScope' => '{array}',
    'language' => '{array}',
    'pageSize' => '25',
    'skip' => '0',
    'accessToken' => '{string}',
);

$url->setQueryVariables($parameters);

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

// 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
    'x-ms-client-request-id': '',
}

params = urllib.urlencode({
    # Request parameters
    'sourceLanguage': '{string}',
    'isBase': '{boolean}',
    'hasSourceVideoFile': '{boolean}',
    'sourceVideoId': '{string}',
    'state': '{array}',
    'privacy': '{array}',
    'id': '{array}',
    'partition': '{array}',
    'externalId': '{array}',
    'owner': '{array}',
    'face': '{array}',
    'query': '{array}',
    'textScope': '{array}',
    'language': '{array}',
    'pageSize': '25',
    'skip': '0',
    'accessToken': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.videoindexer.ai')
    conn.request("GET", "/{location}/Accounts/{accountId}/Videos/Search?%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
    'x-ms-client-request-id': '',
}

params = urllib.parse.urlencode({
    # Request parameters
    'sourceLanguage': '{string}',
    'isBase': '{boolean}',
    'hasSourceVideoFile': '{boolean}',
    'sourceVideoId': '{string}',
    'state': '{array}',
    'privacy': '{array}',
    'id': '{array}',
    'partition': '{array}',
    'externalId': '{array}',
    'owner': '{array}',
    'face': '{array}',
    'query': '{array}',
    'textScope': '{array}',
    'language': '{array}',
    'pageSize': '25',
    'skip': '0',
    'accessToken': '{string}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'sourceLanguage' => '{string}',
    'isBase' => '{boolean}',
    'hasSourceVideoFile' => '{boolean}',
    'sourceVideoId' => '{string}',
    'state' => '{array}',
    'privacy' => '{array}',
    'id' => '{array}',
    'partition' => '{array}',
    'externalId' => '{array}',
    'owner' => '{array}',
    'face' => '{array}',
    'query' => '{array}',
    'textScope' => '{array}',
    'language' => '{array}',
    'pageSize' => '25',
    'skip' => '0',
    'accessToken' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['x-ms-client-request-id'] = ''
# 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