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.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Standard | All Power Automate regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Standard | All Power Apps regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Microsoft |
| URL | Microsoft LogicApps Support Microsoft Power Automate Support Microsoft Power Apps Support |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://vi.microsoft.com |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Delete Video |
This operation deletes the specified video and all related insights found when the video was indexed. |
| Delete Video Source File |
This operation deletes the video source file, but does not delete the insights found when the video was indexed. |
| Get Account |
This operation returns the details of the user's account. |
| Get Account Access Token |
Gets an account access token (expires after an hour). |
| Get Accounts |
This operation returns the details of the user's accounts. |
| Get Video Captions |
This operation returns the captions extracted when the video was indexed. |
| Get Video ID by External ID |
This operation retrieves the video ID corresponding to the external ID. |
| Get Video Index |
This operation gets a video and its insights. |
| Get Video Thumbnail |
Get thumbnail image of a video. |
| List Videos |
This operation gets a list of all videos in the account. |
| Re-index Video |
This operation re-indexes the given video. |
| Search Videos |
This operation performs a search for text, keywords, and visual content. |
| Update Face Name |
This operation updates the name of the given face and trains the face model to recognize that face in future videos. |
| Update Video Transcript |
Updates the transcript of the video. |
| Upload video and index |
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). |
Delete Video
This operation deletes the specified video and all related insights found when the video was indexed.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | True | string |
Indicates the Azure region to which the call should be routed. |
|
Account ID
|
accountId | True | uuid |
Account ID is a globally unique identifier (GUID) for the account. |
|
Video ID
|
videoId | True | string |
The video ID. |
|
Access Token
|
accessToken | True | string |
An account access token with write permissions. |
Delete Video Source File
This operation deletes the video source file, but does not delete the insights found when the video was indexed.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | True | string |
Indicates the Azure region to which the call should be routed. |
|
Account ID
|
accountId | True | uuid |
Account ID is a globally unique identifier (GUID) for the account. |
|
Video ID
|
videoId | True | string |
The video ID. |
|
Access Token
|
accessToken | True | string |
An account access token with write permissions. |
Get Account
This operation returns the details of the user's account.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | True | string |
Indicates the Azure region to which the call should be routed. |
|
Account ID
|
accountId | True | uuid |
Account ID is a globally unique identifier (GUID) for the account. |
|
Access Token
|
accessToken | True | string |
An account access token with read permissions. |
Returns
Get Account Access Token
Gets an account access token (expires after an hour).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | True | string |
Indicates the Azure region to which the call should be routed. |
|
Account ID
|
accountId | True | uuid |
Account ID is a globally unique identifier (GUID) for the account. |
|
Allow Edit
|
allowEdit | True | boolean |
Determines whether the token has write permissions. |
Returns
The access token.
- response
- tokenResponse
Get Accounts
This operation returns the details of the user's accounts.
Returns
Get Video Captions
This operation returns the captions extracted when the video was indexed.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | True | string |
Indicates the Azure region to which the call should be routed. |
|
Account ID
|
accountId | True | uuid |
Account ID is a globally unique identifier (GUID) for the account. |
|
Video ID
|
videoId | True | string |
The video ID. |
|
Access Token
|
accessToken | True | string |
An account access token with read permissions. |
|
Format
|
format | True | string |
The captions format (e.g. vtt). |
|
Captions Language
|
language | string |
The language of the captions. |
Returns
List of extracted captions.
- List of extracted captions
- string
Get Video ID by External ID
This operation retrieves the video ID corresponding to the external ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | True | string |
Indicates the Azure region to which the call should be routed. |
|
Account ID
|
accountId | True | uuid |
Account ID is a globally unique identifier (GUID) for the account. |
|
External ID
|
externalId | True | string |
The external ID. |
|
Access Token
|
accessToken | True | string |
An account access token with read permissions. |
Returns
The video ID.
- Video ID
- string
Get Video Index
This operation gets a video and its insights.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | True | string |
Indicates the Azure region to which the call should be routed. |
|
Account ID
|
accountId | True | uuid |
Account ID is a globally unique identifier (GUID) for the account. |
|
Video ID
|
videoId | True | string |
The video ID. |
|
Access Token
|
accessToken | True | string |
An account access token with read permissions. |
|
Captions Language
|
language | string |
The language of the captions. |
Returns
- Body
- GetIndexResponse
Get Video Thumbnail
Get thumbnail image of a video.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | True | string |
Indicates the Azure region to which the call should be routed. |
|
Account ID
|
accountId | True | uuid |
Account ID is a globally unique identifier (GUID) for the account. |
|
Video ID
|
videoId | True | string |
The video ID. |
|
Thumbnail ID
|
thumbnailId | True | uuid |
The thumbnail ID. |
|
Access Token
|
accessToken | True | string |
An account access token with read permissions. |
Returns
List Videos
This operation gets a list of all videos in the account.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | True | string |
Indicates the Azure region to which the call should be routed. |
|
Account ID
|
accountId | True | uuid |
Account ID is a globally unique identifier (GUID) for the account. |
|
Access Token
|
accessToken | True | string |
An account access token with read permissions. |
|
Page Size
|
pageSize | integer |
The number of results to return. |
|
|
Skip
|
skip | integer |
The number of pages to skip. |
Returns
Re-index Video
This operation re-indexes the given video.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | True | string |
Indicates the Azure region to which the call should be routed. |
|
Account ID
|
accountId | True | uuid |
Account ID is a globally unique identifier (GUID) for the account. |
|
Video ID
|
videoId | True | string |
The video ID. |
|
Access Token
|
accessToken | True | string |
An account access token with write permissions. |
|
Indexing Preset
|
indexingPreset | string |
The indexing preset to use. |
|
|
Streaming Preset
|
streamingPreset | string |
The streaming preset to use. |
|
|
Callback URL
|
callbackUrl | string |
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. |
|
|
Priority
|
priority | string |
Index priority (Low, Normal and High). Can be used in paid regions only. |
|
|
Brands Categories
|
brandsCategories | string |
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. |
|
|
Source Language
|
sourceLanguage | string |
The language to set set as the source language of the video, to be used when generating the transcript. |
Search Videos
This operation performs a search for text, keywords, and visual content.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | True | string |
Indicates the Azure region to which the call should be routed. |
|
Account ID
|
accountId | True | uuid |
Account ID is a globally unique identifier (GUID) for the account. |
|
Query Text
|
query | string |
Free text to search for. |
|
|
Text Scope
|
textScope | string |
The text scope to search in. |
|
|
Privacy
|
privacy | string |
The video privacy. |
|
|
Video ID
|
id | string |
A video ID to search for. |
|
|
Partition
|
partition | string |
A partition to search videos by. |
|
|
Owner
|
owner | string |
A video owner to search for. |
|
|
Face Name
|
face | string |
Search for people or celebrities. |
|
|
External ID
|
externalId | string |
An external ID (associated with the video at upload). |
|
|
Page Size
|
pageSize | integer |
The number of results to return. |
|
|
Skip
|
skip | integer |
The number of results to skip (used for paging). |
|
|
Source Language
|
sourceLanguage | string |
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. |
|
|
Language
|
language | string |
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. |
|
|
Access Token
|
accessToken | True | string |
An account access token with read permissions. |
Returns
Update Face Name
This operation updates the name of the given face and trains the face model to recognize that face in future videos.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | True | string |
Indicates the Azure region to which the call should be routed. |
|
Account ID
|
accountId | True | uuid |
Account ID is a globally unique identifier (GUID) for the account. |
|
Video ID
|
videoId | True | string |
The video ID. |
|
Face ID
|
faceId | True | integer |
The face ID. |
|
Access Token
|
accessToken | True | string |
An account access token with write permissions. |
|
New Face Name
|
newName | True | string |
A new name for the face. |
Update Video Transcript
Updates the transcript of the video.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | True | string |
Indicates the Azure region to which the call should be routed. |
|
Account ID
|
accountId | True | uuid |
Account ID is a globally unique identifier (GUID) for the account. |
|
Video ID
|
videoId | True | string |
The video ID. |
|
Access Token
|
accessToken | True | string |
An account access token with read permissions. |
|
Captions Language
|
language | True | string |
The language of the captions. |
|
Transcript
|
content | True | string |
The transcript to update. |
|
Callback URL
|
callbackUrl | string |
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. |
|
|
Set As Source Language
|
setAsSourceLanguage | boolean |
Determines whether the language parameter should be set as source language. |
|
|
Send Success Email
|
sendSuccessEmail | boolean |
Determines whether to send a success email upon completion. |
Upload video and index
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).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Location
|
location | True | string |
Indicates the Azure region to which the call should be routed. |
|
Account ID
|
accountId | True | uuid |
Account ID is a globally unique identifier (GUID) for the account. |
|
Access Token
|
accessToken | True | string |
An account access token with write permissions. |
|
Video Name
|
name | True | string |
The title of the video. |
|
Description
|
description | string |
The video description. |
|
|
Partition
|
partition | string |
A partition to search videos by. |
|
|
External ID
|
externalId | string |
An external ID (associated with the video at upload). |
|
|
Callback URL
|
callbackUrl | string |
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. |
|
|
Metadata
|
metadata | string |
Metadata to associate with the video (will be returned in queries). |
|
|
Video Language
|
language | string |
The video language, used when generating the transcript. |
|
|
Video URL
|
videoUrl | string |
A public URL of the video/audio file (URL encoded). If not specified, the file should be passed as a multipart/form body content. |
|
|
File Name
|
fileName | string |
The uploaded file name. |
|
|
Indexing Preset
|
indexingPreset | string |
The indexing preset to use. |
|
|
Streaming Preset
|
streamingPreset | string |
The streaming preset to use. |
|
|
Linguistic Model ID
|
linguisticModelId | string |
Linguistic model ID as received by 'create linguistic model' call. |
|
|
Privacy
|
privacy | string |
The video privacy. |
|
|
External URL
|
externalUrl | string |
An external URL to associate with the video (can be searched for later). |
|
|
Body
|
body | file |
If a video URL is not specified, the file should be passed as a multipart/form body content. |
|
|
Asset ID
|
assetId | string |
Azure media services asset id. Used to index from existing assets in your connected Azure media services account. (Paid only). |
|
|
Priority
|
priority | string |
Index priority (Low, Normal and High). Can be used in paid regions only. |
|
|
Brands Categories
|
brandsCategories | string |
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. |
Returns
- Body
- UploadResponse
Definitions
tokenResponse
Microsoft.VideoIndexer.Common.ContractsV2.PlaylistSearchResultV2
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of Microsoft.VideoIndexer.Common.ContractsV2.SinglePlaylistSearchResultV2 |
The search results. |
|
nextPage
|
nextPage | Microsoft.VideoIndexer.Common.ContractsV2.SearchPage |
UploadResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Video ID
|
id | string |
The video ID. |
Microsoft.VideoIndexer.Common.ContractsV2.SinglePlaylistSearchResultV2
| Name | Path | Type | Description |
|---|---|---|---|
|
Account ID
|
accountId | uuid |
The account ID. |
|
Video ID
|
id | string |
The video ID. |
|
Partition
|
partition | string |
The partition of the video. |
|
External ID
|
externalId | string |
The external ID associated with the video. |
|
Metadata
|
metadata | string |
Metadata. |
|
Name
|
name | string |
The name of the video. |
|
Description
|
description | string |
The description of the video. |
|
Created
|
created | date-time |
When the video was created. |
|
Last Modified
|
lastModified | date-time |
When the video was last modified. |
|
Last Indexed
|
lastIndexed | date-time |
When the video was last indexed. |
|
Privacy
|
privacyMode | string |
The privacy mode of the video (public or private). |
|
User Name
|
userName | string |
The username of the video owner. |
|
Is Owned
|
isOwned | boolean |
Indicates whether the video is owned by the user who made the call. |
|
Is Base
|
isBase | boolean |
Indicates whether the video is a base video. |
|
State
|
state | string |
The processing state of the video. (Uploaded / Processing / Processed / Failed / Quarantined). |
|
Processing Progress
|
processingProgress | string |
Progress percentage of the video, if it’s being processed. |
|
Duration In Seconds
|
durationInSeconds | integer |
The duration of the video in seconds. |
|
Thumbnail Video ID
|
thumbnailVideoId | string |
The ID of the video containing the original thumbnail. |
|
Thumbnail ID
|
thumbnailId | uuid |
The thumbnail ID. |
|
Search Matches
|
searchMatches |
Search matches and their details (json string). |
|
|
Indexing Preset
|
indexingPreset | string |
The indexing preset of the video index. |
|
Streaming Preset
|
streamingPreset | string |
The streaming preset of the video index. |
|
Source Language
|
sourceLanguage | string |
The source language of the video. |
Microsoft.VideoIndexer.Common.ContractsV2.SearchPage
| Name | Path | Type | Description |
|---|---|---|---|
|
Page Size
|
pageSize | integer |
Page size of the search results. |
|
Skip
|
skip | integer |
Number of results to skip (used for paging). |
|
Done
|
done | boolean |
Indicates whether the search is done. |
GetIndexResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Account ID
|
accountId | uuid |
The account ID. |
|
Video ID
|
id | string |
The video ID. |
|
Video Partition
|
partition | string |
The partition of the video. |
|
Name
|
name | string |
The name of the video. |
|
Description
|
description | string |
The description of the video. |
|
User Name
|
userName | string |
The username of the video owner. |
|
Created
|
created | date-time |
The creation time of the video. |
|
Privacy
|
privacyMode | string |
The privacy mode of the video. |
|
State
|
state | string |
The processing state of the video. (Uploaded / Processing / Processed / Failed / Quarantined). |
|
Is Owned
|
isOwned | boolean |
Indicates whether the video is owned by a user. |
|
Is Editable
|
isEditable | boolean |
Whether the request to get the video had a token with write permission. |
|
Is Base
|
isBase | boolean |
Indicates whether the video is a base video. |
|
Duration In Seconds
|
durationInSeconds | integer |
The duration of the video in seconds. |
|
Videos Insights
|
videos | array of object |
Videos insights taken from the video index (json string). |
|
Video Ranges
|
videosRanges |
The ranges of the videos in this index (json string). |
Microsoft.VideoIndexer.Common.ContractsV2.AccountContractSlim
| Name | Path | Type | Description |
|---|---|---|---|
|
Account ID
|
id | uuid |
Account ID. |
|
Account Name
|
name | string |
The account name. |
|
Account Location
|
location | string |
Account location. |
|
Account Type
|
accountType | string |
Account type. |
|
Account URL
|
url | string |
API calls should be made to account URL + account location. |
Microsoft.VideoIndexer.Common.ContractsV2.ThumbNail
| Name | Path | Type | Description |
|---|---|---|---|
|
The content-type.
|
$content-type | string |
The content-type. |
|
The content.
|
$content | string |
The content. |
string
This is the basic data type 'string'.