Operations

API change history

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

Create Language Model

Creates a language model. There are two ways to upload files in the body using form-data.

  1. Key will be the file name and value will be the file.
  2. Key will be the file name and value will be a URL to txt file.

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

    Model name

  • string

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

  • 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

Request body

Responses

404 Not Found

Account not found

Representations

400 Bad Request

Invalid input

Representations

200 OK

Return the created model

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}/Customization/Language?modelName={modelName}&language={language}&accessToken={accessToken}"

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


            var uri = "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Customization/Language?modelName={modelName}&language={language}&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}/Customization/Language?modelName={modelName}&language={language}&accessToken={accessToken}");


            URI uri = builder.build();
            HttpPost request = new HttpPost(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
        };
      
        $.ajax({
            url: "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Customization/Language?modelName={modelName}&language={language}&accessToken={accessToken}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
            },
            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}/Customization/Language?modelName={modelName}&language={language}&accessToken={accessToken}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // 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}/Customization/Language?modelName={modelName}&language={language}&accessToken={accessToken}');
$url = $request->getUrl();

$headers = array(
    // Request headers
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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 = {
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.videoindexer.ai')
    conn.request("POST", "/{location}/Accounts/{accountId}/Customization/Language?modelName={modelName}&language={language}&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 = {
}

params = urllib.parse.urlencode({
})

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


request = Net::HTTP::Post.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