Operations

API change history

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

Render Project (PREVIEW)

This API is a preview API subject to preview terms available here. It’s not final and might change.
Renders a media file for an existing project. If the project is already rendered the response body will include the last render operation result, otherwise an asynchronous render operation will start and a 202 Accepted response will be returned and then you can poll for the operation's status by using the API to get a project's render operation.
A project can have a single ongoing render operation at a time, therefore requesting a project render is not allowed if there's already an ongoing render operation. Additionally, while a project is ongoing rendering it's not allowed to update its video ranges, you can use the cancellation API to cancel an ongoing render operation in order to be allowed to update the project's video ranges.

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

  • 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)
    boolean

    An indication whether to send a mail when the render operation completes, whether it completed successfully or with failure or it was canceled.

Request body

Responses

200 OK

Project already rendered

Representations

{
  "state": "Succeeded",
  "result": {
    "videoRanges": [
      {
        "videoId": "3984929386",
        "range": {
          "start": "00:00:00",
          "end": "00:01:00"
        }
      }
    ]
  },
  "error": null
}

202 Accepted

Project render started and is in progress

Representations

{
  "state": "InProgress",
  "result": null,
  "error": null
}

400 Bad Request

The project doesn't have video ranges therefore can't be rendered

Representations

{
  "errorType": "INVALID_INPUT",
  "message": "The project 'sampleProjectId' is empty (doesn't have video ranges) therefore can't be rendered"
}

404 Not Found

Account or project not found

Representations

{
  "errorType": "BREAKDOWN_NOT_FOUND",
  "message": "The project doesn't exist"
}

409 Conflict

Project render already in progress

Representations

{
  "errorType": "PROJECT_RENDER_IN_PROGRESS",
  "message": "he project 'sampleProjectId' is already in progress of rendering, please wait for render to complete"
}

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}/Projects/{projectId}/render?accessToken={accessToken}?sendCompletionEmail=False"

--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["sendCompletionEmail"] = "False";
            var uri = "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Projects/{projectId}/render?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}/Projects/{projectId}/render?accessToken={accessToken}");

            builder.setParameter("sendCompletionEmail", "False");

            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
            "sendCompletionEmail": "False",
        };
      
        $.ajax({
            url: "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Projects/{projectId}/render?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}/Projects/{projectId}/render?accessToken={accessToken}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"sendCompletionEmail=False",
                      ];
    
    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}/Projects/{projectId}/render?accessToken={accessToken}');
$url = $request->getUrl();

$headers = array(
    // Request headers
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'sendCompletionEmail' => 'False',
);

$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({
    # Request parameters
    'sendCompletionEmail': 'False',
})

try:
    conn = httplib.HTTPSConnection('api.videoindexer.ai')
    conn.request("POST", "/{location}/Accounts/{accountId}/Projects/{projectId}/render?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({
    # Request parameters
    'sendCompletionEmail': 'False',
})

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

query = URI.encode_www_form({
    # Request parameters
    'sendCompletionEmail' => 'False'
})
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 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