Operations
API change historyThe Operations API contains all the Video Indexer APIs, such as Upload video, Get insights, and other operations
Request
Request URL
Request parameters
-
(optional)string
Free text to search for.
-
(optional)string
The text scope to search in.
-
(optional)string
A privacy level (Private, Organization, Public).
-
(optional)string
A breakdown id to search for.
-
(optional)string
A partition to search for.
-
(optional)string
An owner to search for.
-
(optional)string
A face to search for.
-
(optional)string
An external id to search for (which was associated with the video at upload).
-
(optional)integer
The number of results to return.
-
(optional)integer
The number of results to skip (used for paging).
-
(optional)string
Include only videos with that source language. You can specify multiple language parameters (e.g. $language=English&language=French) to search multiple languages. Having no language parameter will search all languages. Supported languages: Afrikaans: Af-ZA, Arabic: ar-EG, Bangla: Bn-BD, Bosnian: Bs-Latn, Bulgarian: Bg-BG, Catalan: Ca-ES, Chinese (Simplified): zh-Hans, Chinese (Traditional): Zh-Hant, Croatian: Hr-HR, Czech: Cs-CZ, Danish: Da-DK, Dutch: Nl-NL, English: en-US, Estonian: Et-EE, Fijian: En-FJ, Filipino: fil-PH, Finnish: Fi-FI, French: fr-FR, German: de-DE, Greek: El-GR, Haitian: Fr-HT, Hebrew: He-IL, Hindi: Hi-IN, Hungarian: Hu-HU, Indonesian: Id-ID, Italian: it-IT, Japanese: ja-JP, Kiswahili: Sw-KE, Korean: Ko-KR, Latvian: Lv-LV, Lithuanian: Lt-LT, Malagasy: Mg-MG, Malay: Ms-MY, Maltese: Mt-MT, Norwegian: Nb-NO, Persian: Fa-IR, Polish: Pl-PL, Portuguese: pt-BR, Romanian: Ro-RO, Russian: ru-RU, Samoan: En-WS, Serbian (Cyrillic): Sr-Cyrl-RS, Serbian (Latin): Sr-Latn-RS, Slovak: Sk-SK, Slovenian: Sl-SI, Spanish: es-ES, Swedish: Sv-SE, Tamil: Ta-IN, Thai: Th-TH, Tongan: To-TO, Turkish: Tr-TR, Ukrainian: Uk-UA, Urdu: Ur-PK, Vietnamese: Vi-VN.
-
(optional)string
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. Supported languages: Afrikaans: Af-ZA, Arabic: ar-EG, Bangla: Bn-BD, Bosnian: Bs-Latn, Bulgarian: Bg-BG, Catalan: Ca-ES, Chinese (Simplified): zh-Hans, Chinese (Traditional): Zh-Hant, Croatian: Hr-HR, Czech: Cs-CZ, Danish: Da-DK, Dutch: Nl-NL, English: en-US, Estonian: Et-EE, Fijian: En-FJ, Filipino: fil-PH, Finnish: Fi-FI, French: fr-FR, German: de-DE, Greek: El-GR, Haitian: Fr-HT, Hebrew: He-IL, Hindi: Hi-IN, Hungarian: Hu-HU, Indonesian: Id-ID, Italian: it-IT, Japanese: ja-JP, Kiswahili: Sw-KE, Korean: Ko-KR, Latvian: Lv-LV, Lithuanian: Lt-LT, Malagasy: Mg-MG, Malay: Ms-MY, Maltese: Mt-MT, Norwegian: Nb-NO, Persian: Fa-IR, Polish: Pl-PL, Portuguese: pt-BR, Romanian: Ro-RO, Russian: ru-RU, Samoan: En-WS, Serbian (Cyrillic): Sr-Cyrl-RS, Serbian (Latin): Sr-Latn-RS, Slovak: Sk-SK, Slovenian: Sl-SI, Spanish: es-ES, Swedish: Sv-SE, Tamil: Ta-IN, Thai: Th-TH, Tongan: To-TO, Turkish: Tr-TR, Ukrainian: Uk-UA, Urdu: Ur-PK, Vietnamese: Vi-VN.
-
(optional)string
Required for private videos or account scope search
Access token should match the authorization scope of the call - A video token (for a single video search) or account token with read permissions
Note that Access tokens expire within 1 hour
See more details here
Request body
Responses
200 OK
Search results
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": "SampleUserName",
"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
Representations
401 Unauthorized
Representations
500 Internal Server Error
Server error
Representations
Code samples
@ECHO OFF
curl -v -X GET "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Videos/Search?query={string}&textScope={string}&privacy={string}&id={string}&partition={string}&owner={string}&face={string}&externalId={string}&pageSize={integer}&skip={integer}&sourceLanguage=English&language=English&accessToken={string}"
--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 parameters
queryString["query"] = "{string}";
queryString["textScope"] = "{string}";
queryString["privacy"] = "{string}";
queryString["id"] = "{string}";
queryString["partition"] = "{string}";
queryString["owner"] = "{string}";
queryString["face"] = "{string}";
queryString["externalId"] = "{string}";
queryString["pageSize"] = "{integer}";
queryString["skip"] = "{integer}";
queryString["sourceLanguage"] = "English";
queryString["language"] = "English";
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("query", "{string}");
builder.setParameter("textScope", "{string}");
builder.setParameter("privacy", "{string}");
builder.setParameter("id", "{string}");
builder.setParameter("partition", "{string}");
builder.setParameter("owner", "{string}");
builder.setParameter("face", "{string}");
builder.setParameter("externalId", "{string}");
builder.setParameter("pageSize", "{integer}");
builder.setParameter("skip", "{integer}");
builder.setParameter("sourceLanguage", "English");
builder.setParameter("language", "English");
builder.setParameter("accessToken", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
// 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
"query": "{string}",
"textScope": "{string}",
"privacy": "{string}",
"id": "{string}",
"partition": "{string}",
"owner": "{string}",
"face": "{string}",
"externalId": "{string}",
"pageSize": "{integer}",
"skip": "{integer}",
"sourceLanguage": "English",
"language": "English",
"accessToken": "{string}",
};
$.ajax({
url: "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Videos/Search?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
},
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",
@"query={string}",
@"textScope={string}",
@"privacy={string}",
@"id={string}",
@"partition={string}",
@"owner={string}",
@"face={string}",
@"externalId={string}",
@"pageSize={integer}",
@"skip={integer}",
@"sourceLanguage=English",
@"language=English",
@"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 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
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'query' => '{string}',
'textScope' => '{string}',
'privacy' => '{string}',
'id' => '{string}',
'partition' => '{string}',
'owner' => '{string}',
'face' => '{string}',
'externalId' => '{string}',
'pageSize' => '{integer}',
'skip' => '{integer}',
'sourceLanguage' => 'English',
'language' => 'English',
'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 = {
}
params = urllib.urlencode({
# Request parameters
'query': '{string}',
'textScope': '{string}',
'privacy': '{string}',
'id': '{string}',
'partition': '{string}',
'owner': '{string}',
'face': '{string}',
'externalId': '{string}',
'pageSize': '{integer}',
'skip': '{integer}',
'sourceLanguage': 'English',
'language': 'English',
'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 = {
}
params = urllib.parse.urlencode({
# Request parameters
'query': '{string}',
'textScope': '{string}',
'privacy': '{string}',
'id': '{string}',
'partition': '{string}',
'owner': '{string}',
'face': '{string}',
'externalId': '{string}',
'pageSize': '{integer}',
'skip': '{integer}',
'sourceLanguage': 'English',
'language': 'English',
'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
'query' => '{string}',
'textScope' => '{string}',
'privacy' => '{string}',
'id' => '{string}',
'partition' => '{string}',
'owner' => '{string}',
'face' => '{string}',
'externalId' => '{string}',
'pageSize' => '{integer}',
'skip' => '{integer}',
'sourceLanguage' => 'English',
'language' => 'English',
'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 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