Operations
API change historyThe Operations API contains all the Video Indexer APIs, such as Upload video, Get insights, and other operations, as well authorization operations to obtain access tokens for calling the the other operations
Request
Request URL
Request parameters
-
string
Format - guid. Account ID is a globally unique identifier (GUID) for the account.
See more details here -
(optional)string
Include only videos/projects with that source language. Supported languages: Chinese (Simplified): zh-Hans, English United Kingdom: en-GB, English Australia: en-AU, English United States: en-US, Spanish: es-ES, Spanish (Mexico): es-MX, French: fr-FR, Arabic Syrian Arab Republic: ar-SY, Arabic Egypt: ar-EG, German: de-DE, Italian: it-IT, Japanese: ja-JP, Hindi: hi-IN, Korean: ko-KR, Russian: ru-RU, Portuguese: pt-BR.
-
(optional)boolean
true will include only videos; false will include only projects
-
(optional)boolean
true will include videos that have a source file; false will include projects as well as videos without a source file
-
(optional)string
Include only the video with the given id as well as projects that have a source video with the given id
-
(optional)array
A processing state of videos. Projects are always in 'Processed' state. Allowed values: Uploaded/Processing/Processed/Failed/Quarantined
-
(optional)array
A privacy level. Allowed values: Private/Public
-
(optional)array
A video id to search for.
-
(optional)array
A partition to search for.
-
(optional)array
An external id to search for (which was associated with the video at upload).
-
(optional)array
An owner to search for.
-
(optional)array
A face to search for.
-
(optional)array
An animated character to search for.
-
(optional)array
Free text to search for. Example 1: '&query=north america' -> searches for videos with 'north' and / or 'america' and ranks videos with more hits higher. Example 2: '&query=north+america' -> search for videos with all of the words (AND operator). Example 3: '&query=north|america' -> searches for videos with any of the words (OR operator). Example 4: '&query=north&query=america' -> searches for videos with any of the words (OR operator). Example 5: '&query=-north' -> searches for videos without the word 'north' (NOT operator). Example 6: '&query="north america"' -> searches for videos with the phrase 'north america' (exact match). Example 7: '&query="north america"'&query=-east -> searches for videos with the phrase 'north america' (exact match) OR videos without the word 'east'. NOTICE: These parameters should be sent url-encoded. This is confusing because a space ' ' is encoded as '+' and '+' is encoded as '%2B'. Open text query like '&query=north america' is sent as '&query=north+america' and an AND query like '&query=north+america' is sent as '&query=north%2Bamerica'.
-
(optional)array
The text scope to search in. Allowed values: Transcript/Topics/Ocr/Annotations/Brands/NamedLocations/NamedPeople
-
(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, English United Kingdom: en-GB, Fijian: en-FJ, English Australia: en-AU, Samoan: en-WS, English United States: en-US, Greek: el-GR, Spanish: es-ES, Spanish (Mexico): es-MX, Estonian: et-EE, Persian: fa-IR, Finnish: fi-FI, French (Canada): fr-CA, French: fr-FR, Haitian: fr-HT, Afrikaans: af-ZA, Arabic (Saudi Arabia): ar-SA, Arabic Syrian Arab Republic: ar-SY, Arabic (Qatar): ar-QA, Arabic Egypt: ar-EG, Arabic Modern Standard (Bahrain): ar-BH, Arabic (Oman): ar-OM, Arabic (Lebanon): ar-LB, Arabic (Kuwait): ar-KW, Arabic (Jordan): ar-JO, Arabic (Iraq): ar-IQ, 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.
-
(optional)string
Format - date-time (as date-time in RFC3339). Filter items created before the specified date Accepted format: RFC 3339, section 5.6. Example: '2017-07-21T17:32:28Z'
-
(optional)string
Format - date-time (as date-time in RFC3339). Filter items created after the specified date Accepted format: RFC 3339, section 5.6. Example: '2017-07-21T17:32:28Z'
-
(optional)integer
Format - int32. The number of results to return.
-
(optional)integer
Format - int32. The number of results to skip (used for paging).
-
(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
-
(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
-
(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
{
"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
-
(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
{
"ErrorType": "INVALID_INPUT",
"Message": "Language 'BadLanguage' is not supported"
}
401 Unauthorized
Response headers
-
(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
{
"ErrorType": "USER_NOT_ALLOWED",
"Message": "Access token is not authorized to access account 'SampleAccountId'."
}
500 Internal Server Error
Response headers
-
(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
{
"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
-
(optional)integer
A non-negative decimal integer indicating the seconds to delay after the response is received
-
(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
504 Gateway Timeout
Server did not respond to gateway within expected time
Response headers
-
(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
{
"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}&animatedcharacter={array}&query={array}&textScope={array}&language={array}&createdAfter={string}&createdBefore={string}&pageSize=25&skip=0&accessToken={string}"
-H "x-ms-client-request-id: "
-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("x-ms-client-request-id", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// 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["animatedcharacter"] = "{array}";
queryString["query"] = "{array}";
queryString["textScope"] = "{array}";
queryString["language"] = "{array}";
queryString["createdAfter"] = "{string}";
queryString["createdBefore"] = "{string}";
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("animatedcharacter", "{array}");
builder.setParameter("query", "{array}");
builder.setParameter("textScope", "{array}");
builder.setParameter("language", "{array}");
builder.setParameter("createdAfter", "{string}");
builder.setParameter("createdBefore", "{string}");
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.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
"sourceLanguage": "{string}",
"isBase": "{boolean}",
"hasSourceVideoFile": "{boolean}",
"sourceVideoId": "{string}",
"state": "{array}",
"privacy": "{array}",
"id": "{array}",
"partition": "{array}",
"externalId": "{array}",
"owner": "{array}",
"face": "{array}",
"animatedcharacter": "{array}",
"query": "{array}",
"textScope": "{array}",
"language": "{array}",
"createdAfter": "{string}",
"createdBefore": "{string}",
"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","");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
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}",
@"animatedcharacter={array}",
@"query={array}",
@"textScope={array}",
@"language={array}",
@"createdAfter={string}",
@"createdBefore={string}",
@"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 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://api.videoindexer.ai/{location}/Accounts/{accountId}/Videos/Search');
$url = $request->getUrl();
$headers = array(
// Request headers
'x-ms-client-request-id' => '',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$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}',
'animatedcharacter' => '{array}',
'query' => '{array}',
'textScope' => '{array}',
'language' => '{array}',
'createdAfter' => '{string}',
'createdBefore' => '{string}',
'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': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
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}',
'animatedcharacter': '{array}',
'query': '{array}',
'textScope': '{array}',
'language': '{array}',
'createdAfter': '{string}',
'createdBefore': '{string}',
'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': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
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}',
'animatedcharacter': '{array}',
'query': '{array}',
'textScope': '{array}',
'language': '{array}',
'createdAfter': '{string}',
'createdBefore': '{string}',
'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}',
'animatedcharacter' => '{array}',
'query' => '{array}',
'textScope' => '{array}',
'language' => '{array}',
'createdAfter' => '{string}',
'createdBefore' => '{string}',
'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 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