Operations

API change history

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

Cancel Project Render Operation (PREVIEW)

This API is a preview API subject to preview terms available here. It’s not final and might change.
Cancels the ongoing render operation of an existing project. If the project's render operation's state isn't 'InProgress', the request won't do anything.
If the render operation's state is 'InProgress' it will transition to state 'Cancelling' from which it usually reaches the 'Canceled' state but can reach another terminal state if the render operation already completed by the time cancellation was acknowledged. The API to get a project's render operation has documentation that explains possible render operation states in detail.

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

  • (optional)
    string

    Required. Should be given as parameter in URL query string or in Authorization header as Bearer token, and match the authorization scope of the call (Account or Project, with Write)
    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

Project render operation already completed

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

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

202 Accepted

Project render is being cancelled

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

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

404 Not Found

Account or project or project's render operation not found

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": "PROJECT_RENDER_OPERATION_NOT_FOUND",
  "Message": "Render operation not found for project 'sampleProjectId' in account 'sampleAccountId'"
}

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 PUT "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Projects/{projectId}/renderoperation/cancel?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["accessToken"] = "{string}";
            var uri = "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Projects/{projectId}/renderoperation/cancel?" + 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.PutAsync(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}/renderoperation/cancel");

            builder.setParameter("accessToken", "{string}");

            URI uri = builder.build();
            HttpPut request = new HttpPut(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
            "accessToken": "{string}",
        };
      
        $.ajax({
            url: "https://api.videoindexer.ai/{location}/Accounts/{accountId}/Projects/{projectId}/renderoperation/cancel?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("x-ms-client-request-id","");
            },
            type: "PUT",
            // 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}/renderoperation/cancel";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"accessToken={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PUT"];
    // 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}/Projects/{projectId}/renderoperation/cancel');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'accessToken' => '{string}',
);

$url->setQueryVariables($parameters);

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

// 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
    'accessToken': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.videoindexer.ai')
    conn.request("PUT", "/{location}/Accounts/{accountId}/Projects/{projectId}/renderoperation/cancel?%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
    'accessToken': '{string}',
})

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

query = URI.encode_www_form({
    # Request parameters
    '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::Put.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