Video Indexer (Preview)
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) |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 1200 | 60 seconds |
Actions
| Delete video and its insights |
This operation deletes the uploaded video and if deleteInsights=true, then deletes the generated insights as well. |
| Get accounts |
Returns the details of the user's accounts. |
| Get processing state |
This operation retrieves the processing state of the given breakdown id and if processing it returns the progress (e.g. 30%). |
| Get the insights widget url |
This operation returns a url to the cognitive insights widget, including an access token. |
| Get the insights widget url (using the external id) |
This operation returns a url to the cognitive insights widget, including an access token, based on a given external id. |
| Get the player widget url |
This operation returns a url to the player widget, including an access token. |
| Get the transcript (VTT) url |
This operation returns an a url to a VTT file with the given breakdown's captions. |
| Get video breakdown |
This operation returns the full details of the the given breakdown including all the insights (transcript, OCR, people, etc). |
| Re-index video breakdown |
This operation re-indexes the given breakdown. |
| Re-index video breakdown (using the external id) |
This operation re-indexes the video of the given external id. |
| Search text or face |
This operation performs search and returns the results. If available, returns the matches of the search filters in the results. |
| Update face name |
This operation updates the name of the given face and trains the face model to recognize that face in future videos. |
| Upload video and index |
This operation uploads the given video, starts indexing it and returns a new breakdown id. |
| Upload video and index (using a URL) |
This operation uploads the given video, starts indexing it and returns a new breakdown id. |
Delete video and its insights
This operation deletes the uploaded video and if deleteInsights=true, then deletes the generated insights as well.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Video Id
|
id | True | string |
Id associated with the video and its breakdown. |
|
Delete Insights
|
deleteInsights | boolean |
Whether to delete the generated insights as well (True or False). |
Returns
- response
- object
Get accounts
Returns the details of the user's accounts.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Account Id
|
id | string | |
|
Account Name
|
name | string |
Get processing state
This operation retrieves the processing state of the given breakdown id and if processing it returns the progress (e.g. 30%).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Video Id
|
id | True | string |
Id associated with the video and its breakdown. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
State
|
state | string |
Uploaded, processing, processed, or failed. |
|
Progress
|
progress | string |
Percentage of the video if state is processing. |
Get the insights widget url
This operation returns a url to the cognitive insights widget, including an access token.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Video Id
|
id | True | string |
The id associated with the video and its breakdown. |
|
Widget Type
|
widgetType | string |
People, sentiments, keywords or search. |
Returns
Url of cognitive insights widget.
- Url
- string
Get the insights widget url (using the external id)
This operation returns a url to the cognitive insights widget, including an access token, based on a given external id.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
External Id
|
externalId | True | string |
An external id to search for (associated with a video of this subscription at upload). |
|
Widget Type
|
widgetType | string |
A type of a sub-widget to include (People, Sentiments, Keywords, Search). |
Returns
Url of cognitive insights widget.
- Url
- string
Get the player widget url
This operation returns a url to the player widget, including an access token.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Video Id
|
id | True | string |
The video breakdown id. |
Returns
Url of player widget.
- Url
- string
Get the transcript (VTT) url
This operation returns an a url to a VTT file with the given breakdown's captions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Video Id
|
id | True | string |
The id associated with the video and its breakdown. |
|
Language
|
language | string |
The requested language of the text. |
Returns
Url of the VTT file of the video.
- Url
- string
Get video breakdown
This operation returns the full details of the the given breakdown including all the insights (transcript, OCR, people, etc).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Video Id
|
id | True | string |
Breakdown id, returned by the upload or search APIs. |
|
Language
|
language | string |
Requested language of the text. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Account Id
|
accountId | string |
Unique id associated with the account. |
|
Video Id
|
id | string |
Unique id associated with the video and its breakdown. |
|
Partition
|
partition | string |
Partition of the video. |
|
Name
|
name | date-time |
Name of the video. |
|
Description
|
description | string |
Description of the video. |
|
User Name
|
userName | string |
User name of the account of the video. |
|
Create Time
|
createTime | date-time |
Time of creation of the video. |
|
Organization
|
organization | string |
Organization account belongs to. |
|
Privacy Mode
|
privacyMode | string |
Privacy mode of the video. |
|
State
|
state | string |
Uploaded, processing, processed, or failed). |
|
Is Owned
|
isOwned | boolean |
True if the video is owned by a user. |
|
Is Base
|
isBase | boolean |
True if the video is a base video. |
|
Summarized Insights
|
summarizedInsights | string |
Summary of insights taken from the breakdowns of the video |
|
Breakdowns Array
|
breakdowns | string |
Array of the breakdowns of the video. |
|
Liked By User
|
social.likedByUser | boolean |
True if the video has been liked by a user. False otherwise. |
|
Likes
|
social.likes | integer |
Number of likes on the video. |
|
Views
|
social.views | integer |
Number of views of the video. |
Re-index video breakdown
This operation re-indexes the given breakdown.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Video Id
|
id | True | string |
The video breakdown id. |
|
Callback Url
|
callbackUrl | string |
A url to notify when re-indexing is completed. |
Returns
- response
- object
Re-index video breakdown (using the external id)
This operation re-indexes the video of the given external id.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
External Id
|
externalId | True | string |
An external id (which was associated with a video of this subscription at upload). |
|
Callback Url
|
callbackUrl | string |
A url to notify when re-indexing is completed. |
Returns
- response
- object
Search text or face
This operation performs search and returns the results. If available, returns the matches of the search filters in the results.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Face Query
|
face | string |
A face to search for. |
|
|
Text Query
|
query | string |
Free text to search for. |
|
|
Search Public Account
|
searchInPublicAccount | string |
True to look in a public account. |
|
|
Privacy
|
privacy | string |
Private, organization or public. |
|
|
Text Scope
|
textScope | string |
Scope to search in. |
|
|
Language
|
language | string |
To search in. |
|
|
Video Id
|
id | string |
Video breakdown id to search for. |
|
|
Partition
|
partition | string |
Partition to search for. |
|
|
Owner
|
owner | string |
An owner to search for. |
|
|
Page Size
|
pageSize | number |
Number of results to return. |
|
|
Skip
|
skip | number |
Number of results to skip (used for paging). |
|
|
External ID
|
externalId | string |
An external id to search for (associated with the video at upload). |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Results
|
results | array of object | |
|
Account Id
|
results.accountId | string |
Of the account that uploaded video. |
|
Video Id
|
results.id | string |
Id associated with the video and its breakdown. |
|
Partition
|
results.partition | string |
Partition of the video. |
|
External Id
|
results.externalId | string |
External id of the video (user provided at upload). |
|
Metadata
|
results.metadata | string |
Metadata of the video. |
|
Name
|
results.name | string |
Name of the video. |
|
Description
|
results.description | string |
Description of the video. |
|
Create Time
|
results.createTime | date-time |
Time of creation of the video. |
|
Organization
|
results.organization | string |
Organization account belongs to. |
|
Privacy Mode
|
results.privacyMode | string |
Organization account belongs to. |
|
Username
|
results.userName | string |
Username of the account of the video. |
|
Is Owned
|
results.isOwned | boolean |
True if the video is owned by a user. |
|
Is Base
|
results.isBase | boolean |
True if the video is a base video. |
|
State
|
results.state | string |
Uploaded, processing, processed, or failed. |
|
Processing Progress
|
results.processingProgress | string |
Progress percentage of the video if state is processing. |
|
Duration In Seconds
|
results.durationInSeconds | integer |
Duration of the video in seconds. |
|
Thumbnail Url
|
results.thumbnailUrl | string |
Thumbnail url of the video. |
|
Liked By User
|
results.social.likedByUser | boolean |
True if the video has been liked by the user. False otherwise. |
|
Likes
|
results.social.likes | integer |
Number of likes of the video. |
|
Views
|
results.social.views | integer |
Number of views of the video. |
|
Search Matches
|
results.searchMatches | string |
Array of matches to the search and details of the matches. |
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 |
|---|---|---|---|---|
|
Video Id
|
id | True | string |
The video breakdown id. |
|
Face Id
|
faceId | True | number |
The face id (from the video's json). |
|
New Name
|
newName | True | string |
The new name for the face (use 'Unknown #1/2/3...' to make anonymous). |
Returns
- response
- object
Upload video and index
This operation uploads the given video, starts indexing it and returns a new breakdown id.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File Content
|
fileContent | True | binary |
The video in multipart form. |
|
Language
|
language | string |
The language of the video, to be used when generating the transcript. |
|
|
External Id
|
externalId | string |
An external id to associate with the video (can be searched for later). |
|
|
Metadata
|
metadata | string |
Metadata to associate with the video (will be returned in queries). |
|
|
Description
|
description | string |
The video description. |
|
|
Partition
|
partition | string |
A partition to partition videos by (used for searching a specific partition). |
|
|
Video Name
|
name | True | string |
The video name. |
|
Privacy
|
privacy | True | string |
Private, organization or public. |
|
Callback Url
|
callbackUrl | string |
A url to notify when indexing is completed. |
Returns
The id associated with the video and its breakdown.
- response
- videoResponse
Upload video and index (using a URL)
This operation uploads the given video, starts indexing it and returns a new breakdown id.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Video Url
|
videoUrl | True | string |
A public url of the video. |
|
Language
|
language | string |
The language of the video, to be used when generating the transcript. |
|
|
External Id
|
externalId | string |
An external id to associate with the video (can be searched for later). |
|
|
Metadata
|
metadata | string |
Metadata to associate with the video (will be returned in queries). |
|
|
Description
|
description | string |
The video description. |
|
|
Partition
|
partition | string |
A partition to partition videos by (used for searching a specific partition). |
|
|
Video Name
|
name | True | string |
The video name. |
|
Privacy
|
privacy | True | string |
Private, organization or public. |
|
Callback Url
|
callbackUrl | string |
A url to notify when indexing is completed. |
Returns
The id associated with the video and its breakdown.
- response
- videoResponse
Definitions
videoResponse
The id associated with the video and its breakdown.
The id associated with the video and its breakdown.
- Video Id
- string
object
This is the type 'object'.
string
This is the basic data type 'string'.