Operations

The 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

Indicates whether to re-translate the video and overwrite existing translation for the given language or leave existing translation.

includeStreamingUrls(optional)

boolean

Indicates whether to include streaming urls in the video index.

accessToken(optional)

string

Required for private videos
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 Video, with Read)
Note that Access tokens expire within 1 hour
See more details here

Request headers

x-ms-client-request-id(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.

Ocp-Apim-Subscription-Key

string

Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Video index retrieved successfully

Response headers

x-ms-request-id(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.

400 Bad Request

Response headers

x-ms-request-id(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

401 Unauthorized

Response headers

x-ms-request-id(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

500 Internal Server Error

Response headers

x-ms-request-id(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

429 Too many requests

Too many requests were sent, use Retry-After response header to decide when to send the next request

Response headers

Retry-After(optional)

integer

A non-negative decimal integer indicating the seconds to delay after the response is received

x-ms-request-id(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

x-ms-request-id(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.