Connectors Reference

Video Indexer (V2)

Easily extract insights from your videos and quickly enrich your applications to enhance discovery and engagement. Use the Video Indexer connector to turn your videos into insights.

 

Status: Preview

Tier: Standard

Version: 2.0

 

Actions:

Name

Summary

Get-Account-Access-Token (string location, string accountId, boolean allowEdit)

Get Account Access Token

Get-Accounts ()

Get Accounts

List-videos (string location, string accountId, string accessToken, [advanced][Optional]integer pageSize, [advanced][Optional]integer skip)

List Videos

Upload-video (string location, string accountId, string accessToken, string name, [advanced][Optional]string description, [advanced][Optional]string partition, [advanced][Optional]string externalId, [advanced][Optional]string callbackUrl, [advanced][Optional]string metadata, [advanced][Optional]string language, [Optional]string videoUrl, [advanced][Optional]string fileName, [advanced][Optional]string indexingPreset, [advanced][Optional]string streamingPreset, [advanced][Optional]string linguisticModelId, [advanced][Optional]string privacy, [advanced][Optional]string externalUrl, [Optional]file body, [advanced][Optional]string assetId, [advanced][Optional]string priority, [advanced][Optional]string brandsCategories)

Upload video and index

Get-Video-Index (string location, string accountId, string videoId, string accessToken, [advanced][Optional]string language)

Get Video Index

Search-videos (string location, string accountId, [Optional]string query, [advanced][Optional]string textScope, [advanced][Optional]string privacy, [advanced][Optional]string id, [advanced][Optional]string partition, [advanced][Optional]string owner, [advanced][Optional]string face, [advanced][Optional]string externalId, [advanced][Optional]integer pageSize, [advanced][Optional]integer skip, [advanced][Optional]string sourceLanguage, [advanced][Optional]string language, string accessToken)

Search Videos

Delete-video (string location, string accountId, string videoId, string accessToken)

Delete Video

Delete-video-source-file (string location, string accountId, string videoId, string accessToken)

Delete Video Source File

Get-Account (string location, string accountId, string accessToken)

Get Account

Re-index-video (string location, string accountId, string videoId, string accessToken, [advanced][Optional]string indexingPreset, [advanced][Optional]string streamingPreset, [advanced][Optional]string callbackUrl, [advanced][Optional]string priority, [advanced][Optional]string brandsCategories, [advanced][Optional]string sourceLanguage)

Re-index Video

Get-video-id-by-external-id (string location, string accountId, string externalId, string accessToken)

Get Video ID by External ID

Update-face (string location, string accountId, string videoId, integer faceId, string accessToken, string newName)

Update Face Name

Get-video-captions (string location, string accountId, string videoId, string accessToken, string format, [advanced][Optional]string language)

Get Video Captions

Get-thumbnail (string location, string accountId, string videoId, string thumbnailId, string accessToken)

Get Video Thumbnail

Update-Transcript (string location, string accountId, string videoId, string accessToken, [advanced]string language, string content, [advanced][Optional]string callbackUrl, [advanced][Optional]boolean setAsSourceLanguage, [advanced][Optional]boolean sendSuccessEmail)

Update Video Transcript

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

file

Body

GetIndexResponse

 

Microsoft.VideoIndexer.Common.ContractsV2.AccountContractSlim

 

Microsoft.VideoIndexer.Common.ContractsV2.PlaylistSearchResultV2

 

Microsoft.VideoIndexer.Common.ContractsV2.SearchPage

 

Microsoft.VideoIndexer.Common.ContractsV2.SinglePlaylistSearchResultV2

 

UploadResponse

 

 

Actions:

Get-Account-Access-Token

Summary: Get Account Access Token

Description: Gets an account access token (expires after an hour).

 

Syntax:

VideoIndexer(V2).Get-Account-Access-Token (string location, string accountId, boolean allowEdit)

 

Parameters:

Name

Type

Summary

Required

Related Action

location

string

(Location)Values: [trial, westus2, eastasia, northeurope, westeurope, southeastasia, eastus2, australiaeast, southcentralus, japaneast, uksouth]

Indicates the Azure region to which the call should be routed.

True

accountId

string(uuid)

(Account ID)

Account ID is a globally unique identifier (GUID) for the account.

True

Get-Accounts

allowEdit

boolean

(Allow Edit)

Determines whether the token has write permissions.

True

 

Returns:

††††††††† Type:stringAccess Token

Title: Access Token

††††††††† Summary: Token

††††††††† Description: The access token.

 

Get-Accounts

Summary: Get Accounts

Description: This operation returns the details of the user's accounts.

 

Syntax:

VideoIndexer(V2).Get-Accounts ()

 

Returns:

††††††††† Type:array of (Microsoft.VideoIndexer.Common.ContractsV2.AccountContractSlim)

 

List-videos

Summary: List Videos

Description: This operation gets a list of all videos in the account.

 

Syntax:

VideoIndexer(V2).List-videos (string location, string accountId, string accessToken, [advanced][Optional]integer pageSize, [advanced][Optional]integer skip)

 

Parameters:

Name

Type

Summary

Required

Related Action

location

string

(Location)Values: [trial, westus2, eastasia, northeurope, westeurope, southeastasia, eastus2, australiaeast, southcentralus, japaneast, uksouth]

Indicates the Azure region to which the call should be routed.

True

accountId

string(uuid)

(Account ID)

Account ID is a globally unique identifier (GUID) for the account.

True

Get-Accounts

accessToken

string

(Access Token)

An account access token with read permissions.

True

pageSize

integer

(Page Size)

The number of results to return.

False

skip

integer

(Skip)

The number of pages to skip.

False

 

Returns:

††††††††† Type:Microsoft.VideoIndexer.Common.ContractsV2.PlaylistSearchResultV2

 

Upload-video

Summary: Upload video and index

Description: This operation uploads the given video, starts indexing it, and returns a new video index ID. The supported formats are listed here: https://docs.microsoft.com/azure/media-services/media-services-media-encoder-standard-formats).

 

Syntax:

VideoIndexer(V2).Upload-video (string location, string accountId, string accessToken, string name, [advanced][Optional]string description, [advanced][Optional]string partition, [advanced][Optional]string externalId, [advanced][Optional]string callbackUrl, [advanced][Optional]string metadata, [advanced][Optional]string language, [Optional]string videoUrl, [advanced][Optional]string fileName, [advanced][Optional]string indexingPreset, [advanced][Optional]string streamingPreset, [advanced][Optional]string linguisticModelId, [advanced][Optional]string privacy, [advanced][Optional]string externalUrl, [Optional]file body, [advanced][Optional]string assetId, [advanced][Optional]string priority, [advanced][Optional]string brandsCategories)

 

Parameters:

Name

Type

Summary

Required

Related Action

location

string

(Location)Values: [trial, westus2, eastasia, northeurope, westeurope, southeastasia, eastus2, australiaeast, southcentralus, japaneast, uksouth]

Indicates the Azure region to which the call should be routed.

True

accountId

string(uuid)

(Account ID)

Account ID is a globally unique identifier (GUID) for the account.

True

Get-Accounts

accessToken

string

(Access Token)

An account access token with write permissions.

True

name

string

(Video Name)

The title of the video.

True

description

string

(Description)

The video description.

False

partition

string

(Partition)

A partition to search videos by.

False

externalId

string

(External ID)

An external ID (associated with the video at upload).

False

callbackUrl

string

(Callback URL)

A URL to notify when indexing is complete. It should be a POST URL and Video Indexer will add 2 additional query string parameters to it: ID and state.

False

metadata

string

(Metadata)

Metadata to associate with the video (will be returned in queries).

False

language

string

(Video Language)Values: [Auto, English, Spanish, Russian, Japanese, German, French, Portuguese, Italian, Chinese, Arabic, ar-EG, de-DE, en-US, es-ES, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, ru-RU, zh-Hans]

The video language, used when generating the transcript.

False

videoUrl

string

(Video URL)

A public URL of the video/audio file (URL encoded). If not specified, the file should be passed as a multipart/form body content.

False

fileName

string

(File Name)

The uploaded file name.

False

indexingPreset

string

(Indexing Preset)Values: [Default, AudioOnly, DefaultWithNoiseReduction, VideoOnly]

The indexing preset to use.

False

streamingPreset

string

(Streaming Preset)Values: [Default, SingleBitrate, AdaptiveBitrate, NoStreaming]

The streaming preset to use.

False

linguisticModelId

string

(Linguistic Model ID)

Linguistic model ID as received by 'create linguistic model' call.

False

privacy

string

(Privacy)Values: [Private, Public]

The video privacy.

False

externalUrl

string

(External URL)

An external URL to associate with the video (can be searched for later).

False

body

file

(Body)

If a video URL is not specified, the file should be passed as a multipart/form body content.

False

assetId

string

(Asset ID)

Azure media services asset id. Used to index from existing assets in your connected Azure media services account. (Paid only).

False

priority

string

(Priority)Values: [Low, Normal, High]

Index priority (Low, Normal and High). Can be used in paid regions only.

False

brandsCategories

string

(Brands Categories)

List of brands categories delimited by comma. Video indexer will only take these categories in to account when indexing. If not specified all brands will be used.

False

 

Returns:

††††††††† Type:UploadResponse

 

Get-Video-Index

Summary: Get Video Index

Description: This operation gets a video and its insights.

 

Syntax:

VideoIndexer(V2).Get-Video-Index (string location, string accountId, string videoId, string accessToken, [advanced][Optional]string language)

 

Parameters:

Name

Type

Summary

Required

Related Action

location

string

(Location)Values: [trial, westus2, eastasia, northeurope, westeurope, southeastasia, eastus2, australiaeast, southcentralus, japaneast, uksouth]

Indicates the Azure region to which the call should be routed.

True

accountId

string(uuid)

(Account ID)

Account ID is a globally unique identifier (GUID) for the account.

True

Get-Accounts

videoId

string

(Video ID)

The video ID.

True

accessToken

string

(Access Token)

An account access token with read permissions.

True

language

string

(Captions Language)Values: [English, Spanish, Russian, Japanese, German, French, Portuguese, Italian, Chinese, Filipino, Arabic, ar-EG, en-US, es-ES, fr-FR, de-DE, it-IT, ja-JP, pt-BR, ru-RU, zh-Hans, fil-PH, Af-ZA, Bn-BD, Bs-Latn, Bg-BG, Ca-ES, Hr-HR, Cs-CZ, Da-DK, Nl-NL, En-FJ, En-GB, En-WS, Es-MX, Et-EE, Fi-FI, El-GR, Fr-HT, He-IL, Hi-IN, Hu-HU, Id-ID, Sw-KE, Ko-KR, Lv-LV, Lt-LT, Mg-MG, Ms-MY, Mt-MT, Nb-NO, Fa-IR, Pl-PL, Ro-RO, Sr-Cyrl-RS, Sr-Latn-RS, Sk-SK, Sl-SI, Sv-SE, Ta-IN, Th-TH, To-TO, Tr-TR, Uk-UA, Ur-PK, Vi-VN, Zh-Hant]

The language of the captions.

False

 

Returns:

††††††††† Type:GetIndexResponse

 

Search-videos

Summary: Search Videos

Description: This operation performs a search for text, keywords, and visual content.

 

Syntax:

VideoIndexer(V2).Search-videos (string location, string accountId, [Optional]string query, [advanced][Optional]string textScope, [advanced][Optional]string privacy, [advanced][Optional]string id, [advanced][Optional]string partition, [advanced][Optional]string owner, [advanced][Optional]string face, [advanced][Optional]string externalId, [advanced][Optional]integer pageSize, [advanced][Optional]integer skip, [advanced][Optional]string sourceLanguage, [advanced][Optional]string language, string accessToken)

 

Parameters:

Name

Type

Summary

Required

Related Action

location

string

(Location)Values: [trial, westus2, eastasia, northeurope, westeurope, southeastasia, eastus2, australiaeast, southcentralus, japaneast, uksouth]

Indicates the Azure region to which the call should be routed.

True

accountId

string(uuid)

(Account ID)

Account ID is a globally unique identifier (GUID) for the account.

True

Get-Accounts

query

string

(Query Text)

Free text to search for.

False

textScope

string

(Text Scope)Values: [Transcript, Ocr]

The text scope to search in.

False

privacy

string

(Privacy)Values: [Private, Public]

The video privacy.

False

id

string

(Video ID)

A video ID to search for.

False

partition

string

(Partition)

A partition to search videos by.

False

owner

string

(Owner)

A video owner to search for.

False

face

string

(Face Name)

Search for people or celebrities.

False

externalId

string

(External ID)

An external ID (associated with the video at upload).

False

pageSize

integer

(Page Size)

The number of results to return.

False

skip

integer

(Skip)

The number of results to skip (used for paging).

False

sourceLanguage

string

(Source Language)Values: [English, Spanish, Russian, Japanese, German, French, Portuguese, Italian, Chinese, Filipino, Arabic, ar-EG, en-US, es-ES, fr-FR, de-DE, it-IT, ja-JP, pt-BR, ru-RU, zh-Hans, fil-PH, Af-ZA, Bn-BD, Bs-Latn, Bg-BG, Ca-ES, Hr-HR, Cs-CZ, Da-DK, Nl-NL, En-FJ, En-WS, Et-EE, Fi-FI, El-GR, Fr-HT, He-IL, Hi-IN, Hu-HU, Id-ID, Sw-KE, Ko-KR, Lv-LV, Lt-LT, Mg-MG, Ms-MY, Mt-MT, Nb-NO, Fa-IR, Pl-PL, Ro-RO, Sr-Cyrl-RS, Sr-Latn-RS, Sk-SK, Sl-SI, Sv-SE, Ta-IN, Th-TH, To-TO, Tr-TR, Uk-UA, Ur-PK, Vi-VN, Zh-Hant]

Include only videos with the specified source language. You can specify multiple language parameters (e.g. $language=English&language=French) to search multiple languages. Leaving this parameter blank will search all languages.

False

language

string

(Language)Values: [English, Spanish, Russian, Japanese, German, French, Portuguese, Italian, Chinese, Filipino, Arabic, ar-EG, en-US, es-ES, fr-FR, de-DE, it-IT, ja-JP, pt-BR, ru-RU, zh-Hans, fil-PH, Af-ZA, Bn-BD, Bs-Latn, Bg-BG, Ca-ES, Hr-HR, Cs-CZ, Da-DK, Nl-NL, En-FJ, En-GB, En-WS, Es-MX, Et-EE, Fi-FI, El-GR, Fr-HT, He-IL, Hi-IN, Hu-HU, Id-ID, Sw-KE, Ko-KR, Lv-LV, Lt-LT, Mg-MG, Ms-MY, Mt-MT, Nb-NO, Fa-IR, Pl-PL, Ro-RO, Sr-Cyrl-RS, Sr-Latn-RS, Sk-SK, Sl-SI, Sv-SE, Ta-IN, Th-TH, To-TO, Tr-TR, Uk-UA, Ur-PK, Vi-VN, Zh-Hant]

The search language. You can specify multiple language parameters (e.g. $language=English&language=French) to search multiple languages. Leaving this parameter blank will search all languages.

False

accessToken

string

(Access Token)

An account access token with read permissions.

True

 

Returns:

††††††††† Type:Microsoft.VideoIndexer.Common.ContractsV2.PlaylistSearchResultV2

 

Delete-video

Summary: Delete Video

Description: This operation deletes the specified video and all related insights found when the video was indexed.

 

Syntax:

VideoIndexer(V2).Delete-video (string location, string accountId, string videoId, string accessToken)

 

Parameters:

Name

Type

Summary

Required

Related Action

location

string

(Location)Values: [trial, westus2, eastasia, northeurope, westeurope, southeastasia, eastus2, australiaeast, southcentralus, japaneast, uksouth]

Indicates the Azure region to which the call should be routed.

True

accountId

string(uuid)

(Account ID)

Account ID is a globally unique identifier (GUID) for the account.

True

Get-Accounts

videoId

string

(Video ID)

The video ID.

True

accessToken

string

(Access Token)

An account access token with write permissions.

True

 

Returns:

 

Delete-video-source-file

Summary: Delete Video Source File

Description: This operation deletes the video source file, but does not delete the insights found when the video was indexed.

 

Syntax:

VideoIndexer(V2).Delete-video-source-file (string location, string accountId, string videoId, string accessToken)

 

Parameters:

Name

Type

Summary

Required

Related Action

location

string

(Location)Values: [trial, westus2, eastasia, northeurope, westeurope, southeastasia, eastus2, australiaeast, southcentralus, japaneast, uksouth]

Indicates the Azure region to which the call should be routed.

True

accountId

string(uuid)

(Account ID)

Account ID is a globally unique identifier (GUID) for the account.

True

Get-Accounts

videoId

string

(Video ID)

The video ID.

True

accessToken

string

(Access Token)

An account access token with write permissions.

True

 

Returns:

 

Get-Account

Summary: Get Account

Description: This operation returns the details of the user's account.

 

Syntax:

VideoIndexer(V2).Get-Account (string location, string accountId, string accessToken)

 

Parameters:

Name

Type

Summary

Required

Related Action

location

string

(Location)Values: [trial, westus2, eastasia, northeurope, westeurope, southeastasia, eastus2, australiaeast, southcentralus, japaneast, uksouth]

Indicates the Azure region to which the call should be routed.

True

accountId

string(uuid)

(Account ID)

Account ID is a globally unique identifier (GUID) for the account.

True

Get-Accounts

accessToken

string

(Access Token)

An account access token with read permissions.

True

 

Returns:

††††††††† Type:Microsoft.VideoIndexer.Common.ContractsV2.AccountContractSlim

 

Re-index-video

Summary: Re-index Video

Description: This operation re-indexes the given video.

 

Syntax:

VideoIndexer(V2).Re-index-video (string location, string accountId, string videoId, string accessToken, [advanced][Optional]string indexingPreset, [advanced][Optional]string streamingPreset, [advanced][Optional]string callbackUrl, [advanced][Optional]string priority, [advanced][Optional]string brandsCategories, [advanced][Optional]string sourceLanguage)

 

Parameters:

Name

Type

Summary

Required

Related Action

location

string

(Location)Values: [trial, westus2, eastasia, northeurope, westeurope, southeastasia, eastus2, australiaeast, southcentralus, japaneast, uksouth]

Indicates the Azure region to which the call should be routed.

True

accountId

string(uuid)

(Account ID)

Account ID is a globally unique identifier (GUID) for the account.

True

Get-Accounts

videoId

string

(Video ID)

The video ID.

True

accessToken

string

(Access Token)

An account access token with write permissions.

True

indexingPreset

string

(Indexing Preset)Values: [Default, AudioOnly, DefaultWithNoiseReduction, VideoOnly]

The indexing preset to use.

False

streamingPreset

string

(Streaming Preset)Values: [Default, SingleBitrate, AdaptiveBitrate, NoStreaming]

The streaming preset to use.

False

callbackUrl

string

(Callback URL)

A URL to notify when indexing is complete. It should be a POST URL and Video Indexer will add 2 additional query string parameters to it: ID and state.

False

priority

string

(Priority)Values: [Low, Normal, High]

Index priority (Low, Normal and High). Can be used in paid regions only.

False

brandsCategories

string

(Brands Categories)

List of brands categories delimited by comma. Video indexer will only take these categories in to account when indexing. If not specified all brands will be used.

False

sourceLanguage

string

(Source Language)Values: [Auto, English, Spanish, Russian, Japanese, German, French, Portuguese, Italian, Chinese, ar-EG, en-US, es-ES, ru-RU, ja-JP, de-DE, fr-FR, pt-BR, it-IT, zh-CN, hi-IN, ko-KR]

The language to set set as the source language of the video, to be used when generating the transcript.

False

 

Returns:

 

Get-video-id-by-external-id

Summary: Get Video ID by External ID

Description: This operation retrieves the video ID corresponding to the external ID.

 

Syntax:

VideoIndexer(V2).Get-video-id-by-external-id (string location, string accountId, string externalId, string accessToken)

 

Parameters:

Name

Type

Summary

Required

Related Action

location

string

(Location)Values: [trial, westus2, eastasia, northeurope, westeurope, southeastasia, eastus2, australiaeast, southcentralus, japaneast, uksouth]

Indicates the Azure region to which the call should be routed.

True

accountId

string(uuid)

(Account ID)

Account ID is a globally unique identifier (GUID) for the account.

True

Get-Accounts

externalId

string

(External ID)

The external ID.

True

accessToken

string

(Access Token)

An account access token with read permissions.

True

 

Returns:

††††††††† Type:string

††††††††† Summary: Video ID

††††††††† Description: The video ID.

 

Update-face

Summary: Update Face Name

Description: This operation updates the name of the given face and trains the face model to recognize that face in future videos.

 

Syntax:

VideoIndexer(V2).Update-face (string location, string accountId, string videoId, integer faceId, string accessToken, string newName)

 

Parameters:

Name

Type

Summary

Required

Related Action

location

string

(Location)Values: [trial, westus2, eastasia, northeurope, westeurope, southeastasia, eastus2, australiaeast, southcentralus, japaneast, uksouth]

Indicates the Azure region to which the call should be routed.

True

accountId

string(uuid)

(Account ID)

Account ID is a globally unique identifier (GUID) for the account.

True

Get-Accounts

videoId

string

(Video ID)

The video ID.

True

faceId

integer

(Face ID)

The face ID.

True

accessToken

string

(Access Token)

An account access token with write permissions.

True

newName

string

(New Face Name)

A new name for the face.

True

 

Returns:

 

Get-video-captions

Summary: Get Video Captions

Description: This operation returns the captions extracted when the video was indexed.

 

Syntax:

VideoIndexer(V2).Get-video-captions (string location, string accountId, string videoId, string accessToken, string format, [advanced][Optional]string language)

 

Parameters:

Name

Type

Summary

Required

Related Action

location

string

(Location)Values: [trial, westus2, eastasia, northeurope, westeurope, southeastasia, eastus2, australiaeast, southcentralus, japaneast, uksouth]

Indicates the Azure region to which the call should be routed.

True

accountId

string(uuid)

(Account ID)

Account ID is a globally unique identifier (GUID) for the account.

True

Get-Accounts

videoId

string

(Video ID)

The video ID.

True

accessToken

string

(Access Token)

An account access token with read permissions.

True

format

string

(Format)Values: [vtt]

The captions format (e.g. vtt).

True

language

string

(Captions Language)Values: [English, Spanish, Russian, Japanese, German, French, Portuguese, Italian, Chinese, Filipino, Arabic, ar-EG, en-US, es-ES, fr-FR, de-DE, it-IT, ja-JP, pt-BR, ru-RU, zh-Hans, fil-PH, Af-ZA, Bn-BD, Bs-Latn, Bg-BG, Ca-ES, Hr-HR, Cs-CZ, Da-DK, Nl-NL, En-FJ, En-GB, En-WS, Es-MX, Et-EE, Fi-FI, El-GR, Fr-HT, He-IL, Hi-IN, Hu-HU, Id-ID, Sw-KE, Ko-KR, Lv-LV, Lt-LT, Mg-MG, Ms-MY, Mt-MT, Nb-NO, Fa-IR, Pl-PL, Ro-RO, Sr-Cyrl-RS, Sr-Latn-RS, Sk-SK, Sl-SI, Sv-SE, Ta-IN, Th-TH, To-TO, Tr-TR, Uk-UA, Ur-PK, Vi-VN, Zh-Hant]

The language of the captions.

False

 

Returns:

††††††††† Type:string

 

Get-thumbnail

Summary: Get Video Thumbnail

Description: Get thumbnail image of a video.

 

Syntax:

VideoIndexer(V2).Get-thumbnail (string location, string accountId, string videoId, string thumbnailId, string accessToken)

 

Parameters:

Name

Type

Summary

Required

Related Action

location

string

(Location)Values: [trial, westus2, eastasia, northeurope, westeurope, southeastasia, eastus2, australiaeast, southcentralus, japaneast, uksouth]

Indicates the Azure region to which the call should be routed.

True

accountId

string(uuid)

(Account ID)

Account ID is a globally unique identifier (GUID) for the account.

True

Get-Accounts

videoId

string

(Video ID)

The video ID.

True

thumbnailId

string(uuid)

(Thumbnail ID)

The thumbnail ID.

True

accessToken

string

(Access Token)

An account access token with read permissions.

True

 

Returns:

††††††††† Type:string

 

Update-Transcript

Summary: Update Video Transcript

Description: Updates the transcript of the video.

 

Syntax:

VideoIndexer(V2).Update-Transcript (string location, string accountId, string videoId, string accessToken, [advanced]string language, string content, [advanced][Optional]string callbackUrl, [advanced][Optional]boolean setAsSourceLanguage, [advanced][Optional]boolean sendSuccessEmail)

 

Parameters:

Name

Type

Summary

Required

Related Action

location

string

(Location)Values: [trial, westus2, eastasia, northeurope, westeurope, southeastasia, eastus2, australiaeast, southcentralus, japaneast, uksouth]

Indicates the Azure region to which the call should be routed.

True

accountId

string(uuid)

(Account ID)

Account ID is a globally unique identifier (GUID) for the account.

True

Get-Accounts

videoId

string

(Video ID)

The video ID.

True

accessToken

string

(Access Token)

An account access token with read permissions.

True

language

string

(Captions Language)Values: [English, Spanish, Russian, Japanese, German, French, Portuguese, Italian, Chinese, Filipino, Arabic, ar-EG, en-US, es-ES, fr-FR, de-DE, it-IT, ja-JP, pt-BR, ru-RU, zh-Hans, fil-PH, Af-ZA, Bn-BD, Bs-Latn, Bg-BG, Ca-ES, Hr-HR, Cs-CZ, Da-DK, Nl-NL, En-FJ, En-GB, En-WS, Es-MX, Et-EE, Fi-FI, El-GR, Fr-HT, He-IL, Hi-IN, Hu-HU, Id-ID, Sw-KE, Ko-KR, Lv-LV, Lt-LT, Mg-MG, Ms-MY, Mt-MT, Nb-NO, Fa-IR, Pl-PL, Ro-RO, Sr-Cyrl-RS, Sr-Latn-RS, Sk-SK, Sl-SI, Sv-SE, Ta-IN, Th-TH, To-TO, Tr-TR, Uk-UA, Ur-PK, Vi-VN, Zh-Hant]

The language of the captions.

True

content

string

 

 

True

callbackUrl

string

(Callback URL)

A URL to notify when indexing is complete. It should be a POST URL and Video Indexer will add 2 additional query string parameters to it: ID and state.

False

setAsSourceLanguage

boolean

(Set As Source Language)

Determines whether the language parameter should be set as source language.

False

sendSuccessEmail

boolean

(Send Success Email)

Determines whether to send a success email upon completion.

False

 

Returns:

 


 

file

Summary: Body

Description: If a video URL is not specified, the file should be passed as a multipart/form body content.

 

††††††††† Properties:

Name

Type

Summary


 

GetIndexResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

accountId

string(uuid)

Account ID

The account ID.

id

string

Video ID

The video ID.

partition

string

Video Partition

The partition of the video.

name

string

Name

The name of the video.

description

string

Description

The description of the video.

userName

string

User Name

The username of the video owner.

created

string(date-time)

Created

The creation time of the video.

privacyMode

string

Privacy

The privacy mode of the video.† Values: [Private, Public]

state

string

State

The processing state of the video. (Uploaded / Processing / Processed / Failed / Quarantined).† Values: [Uploaded, Processing, Processed, Failed, Quarantined]

isOwned

boolean

Is Owned

Indicates whether the video is owned by a user.

isEditable

boolean

Is Editable

Whether the request to get the video had a token with write permission.

isBase

boolean

Is Base

Indicates whether the video is a base video.

durationInSeconds

integer(int32)

Duration In Seconds

The duration of the video in seconds.

summarizedInsights

SummarizedInsights

Summarized Insights

Summary of insights taken from the video index (json string).

videos

array of (VideosItem)

Videos Insights

Videos insights taken from the video index (json string).

videosRanges

VideosRanges

Video Ranges

The ranges of the videos in this index (json string).

 

SummarizedInsights

Summary: Summarized Insights

Description: Summary of insights taken from the video index (json string).

 

††††††††† Properties:

Name

Type

Summary

 

VideosItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

 

VideosRanges

Summary: Video Ranges

Description: The ranges of the videos in this index (json string).

 

††††††††† Properties:

Name

Type

Summary

 


 

Microsoft.VideoIndexer.Common.ContractsV2.AccountContractSlim

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string(uuid)

Account ID

Account ID.

name

string

Account Name

The account name.

location

string

Account Location

Account location.

accountType

string

Account Type

Account type.

url

string

Account URL

API calls should be made to account URL + account location.


 

Microsoft.VideoIndexer.Common.ContractsV2.PlaylistSearchResultV2

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

results

array of (Microsoft.VideoIndexer.Common.ContractsV2.SinglePlaylistSearchResultV2)

Results

The search results.

nextPage

Microsoft.VideoIndexer.Common.ContractsV2.SearchPage

 

 


 

Microsoft.VideoIndexer.Common.ContractsV2.SearchPage

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

pageSize

integer(int32)

Page Size

Page size of the search results.

skip

integer(int32)

Skip

Number of results to skip (used for paging).

done

boolean

Done

Indicates whether the search is done.


 

Microsoft.VideoIndexer.Common.ContractsV2.SinglePlaylistSearchResultV2

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

accountId

string(uuid)

Account ID

The account ID.

id

string

Video ID

The video ID.

partition

string

Partition

The partition of the video.

externalId

string

External ID

The external ID associated with the video.

metadata

string

Metadata

Metadata.

name

string

Name

The name of the video.

description

string

Description

The description of the video.

created

string(date-time)

Created

When the video was created.

lastModified

string(date-time)

Last Modified

When the video was last modified.

lastIndexed

string(date-time)

Last Indexed

When the video was last indexed.

privacyMode

string

Privacy

The privacy mode of the video (public or private).† Values: [Private, Public]

userName

string

User Name

The username of the video owner.

isOwned

boolean

Is Owned

Indicates whether the video is owned by the user who made the call.

isBase

boolean

Is Base

Indicates whether the video is a base video.

state

string

State

The processing state of the video. (Uploaded / Processing / Processed / Failed / Quarantined).† Values: [Uploaded, Processing, Processed, Failed, Quarantined]

processingProgress

string

Processing Progress

Progress percentage of the video, if itís being processed.

durationInSeconds

integer(int32)

Duration In Seconds

The duration of the video in seconds.

thumbnailVideoId

string

Thumbnail Video ID

The ID of the video containing the original thumbnail.

thumbnailId

string(uuid)

Thumbnail ID

The thumbnail ID.

searchMatches

SearchMatches

Search Matches

Search matches and their details (json string).

indexingPreset

string

Indexing Preset

The indexing preset of the video index.

streamingPreset

string

Streaming Preset

The streaming preset of the video index.

sourceLanguage

string

Source Language

The source language of the video.

 

SearchMatches

Summary: Search Matches

Description: Search matches and their details (json string).

 

††††††††† Properties:

Name

Type

Summary

 


 

UploadResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

Video ID

The video ID.