Connectors Reference

Video Indexer

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: 1.0

 

Actions:

Name

Summary

UploadVideo (string videoUrl, [advanced][Optional]string language, [advanced][Optional]string externalId, [advanced][Optional]string metadata, [advanced][Optional]string description, [advanced][Optional]string partition, string name, string privacy, [advanced][Optional]string callbackUrl)

Upload video and index (using a URL)

UploadVideoFileContent (string fileContent, [advanced][Optional]string language, [advanced][Optional]string externalId, [advanced][Optional]string metadata, [advanced][Optional]string description, [advanced][Optional]string partition, string name, string privacy, [advanced][Optional]string callbackUrl)

Upload video and index

GetProcessingState (string id)

Get processing state

Search ([Optional]string face, [Optional]string query, [Optional]string searchInPublicAccount, [Optional]string privacy, [Advanced][Optional]string textScope, [Advanced][Optional]string language, [Advanced][Optional]string id, [Advanced][Optional]string partition, [Advanced][Optional]string owner, [Advanced][Optional]number pageSize, [Advanced][Optional]number skip, [Advanced][Optional]string externalId)

Search text or face

GetBreakdown (string id, [advanced][Optional]string language)

Get video breakdown

DeleteBreakdown (string id, [Optional]boolean deleteInsights)

Delete video and its insights

GetInsightsWidgetUrl (string id, [advanced][Optional]string widgetType)

Get the insights widget url

GetPlayerWidgetUrl (string id)

Get the player widget url

GetVttUrl (string id, [advanced][Optional]string language)

Get the transcript (VTT) url

GetInsightsWidgetUrlByExternalId (string externalId, [Optional]string widgetType)

Get the insights widget url (using the external id)

GetAccounts ()

Get accounts

Re-IndexBreakdown (string id, [advanced][Optional]string callbackUrl)

Re-index video breakdown

Re-IndexBreakdownByExternalId (string externalId, [advanced][Optional]string callbackUrl)

Re-index video breakdown (using the external id)

UpdateFaceName (string id, number faceId, string newName)

Update face name

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

DeleteBreakdownResponse

 

GetAccountsResponseItem

 

GetBreakdownResponse

 

GetProcessingStateResponse

 

Re-IndexBreakdownByExternalIdResponse

 

Re-IndexBreakdownResponse

 

SearchResponse

 

UpdateFaceNameResponse

 

 

Actions:

UploadVideo

Summary: Upload video and index (using a URL)

Description: This operation uploads the given video, starts indexing it and returns a new breakdown id.

 

Syntax:

VideoIndexer.UploadVideo (string videoUrl, [advanced][Optional]string language, [advanced][Optional]string externalId, [advanced][Optional]string metadata, [advanced][Optional]string description, [advanced][Optional]string partition, string name, string privacy, [advanced][Optional]string callbackUrl)

 

Parameters:

Name

Type

Summary

Required

Related Action

videoUrl

string

(Video Url)

A public url of the video.

True

language

string

(Language)Values: [English, Spanish, Russian, Japanese, German, French, Portuguese, Italian, Chinese]

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

False

externalId

string

(External Id)

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

False

metadata

string

(Metadata)

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

False

description

string

(Description)

The video description.

False

partition

string

(Partition)

A partition to partition videos by (used for searching a specific partition).

False

name

string

(Video Name)

The video name.

True

privacy

string

(Privacy)Values: [Private, Public]

Private, organization or public.

True

callbackUrl

string

(Callback Url)

A url to notify when indexing is completed.

False

 

Returns:

          Type:stringVideo Id

Title: Video Id

          Description: The id associated with the video and its breakdown.

 

UploadVideoFileContent

Summary: Upload video and index

Description: This operation uploads the given video, starts indexing it and returns a new breakdown id.

 

Syntax:

VideoIndexer.UploadVideoFileContent (string fileContent, [advanced][Optional]string language, [advanced][Optional]string externalId, [advanced][Optional]string metadata, [advanced][Optional]string description, [advanced][Optional]string partition, string name, string privacy, [advanced][Optional]string callbackUrl)

 

Parameters:

Name

Type

Summary

Required

Related Action

fileContent

string(binary)

(File Content)

The video in multipart form.

True

language

string

(Language)Values: [English, Spanish, Russian, Japanese, German, French, Portuguese, Italian, Chinese]

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

False

externalId

string

(External Id)

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

False

metadata

string

(Metadata)

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

False

description

string

(Description)

The video description.

False

partition

string

(Partition)

A partition to partition videos by (used for searching a specific partition).

False

name

string

(Video Name)

The video name.

True

privacy

string

(Privacy)Values: [Private, Public]

Private, organization or public.

True

callbackUrl

string

(Callback Url)

A url to notify when indexing is completed.

False

 

Returns:

          Type:stringVideo Id

Title: Video Id

          Description: The id associated with the video and its breakdown.

 

GetProcessingState

Summary: Get processing state

Description: This operation retrieves the processing state of the given breakdown id and if processing it returns the progress (e.g. 30%).

 

Syntax:

VideoIndexer.GetProcessingState (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Video Id)

Id associated with the video and its breakdown.

True

 

Returns:

          Type:GetProcessingStateResponse

 

Search

Summary: Search text or face

Description: This operation performs search and returns the results. If available, returns the matches of the search filters in the results.

 

Syntax:

VideoIndexer.Search ([Optional]string face, [Optional]string query, [Optional]string searchInPublicAccount, [Optional]string privacy, [Advanced][Optional]string textScope, [Advanced][Optional]string language, [Advanced][Optional]string id, [Advanced][Optional]string partition, [Advanced][Optional]string owner, [Advanced][Optional]number pageSize, [Advanced][Optional]number skip, [Advanced][Optional]string externalId)

 

Parameters:

Name

Type

Summary

Required

Related Action

face

string

(Face Query)

A face to search for.

False

query

string

(Text Query)

Free text to search for.

False

searchInPublicAccount

string

(Search Public Account)

True to look in a public account.

False

privacy

string

(Privacy)Values: [Private, Organization, Public]

Private, organization or public.

False

textScope

string

(Text Scope)Values: [Transcript, Ocr]

Scope to search in.

False

language

string

(Language)Values: [English, Spanish, Russian, Japanese, German, French, Portuguese, Italian, Chinese]

To search in.

False

id

string

(Video Id)

Video breakdown id to search for.

False

partition

string

(Partition)

Partition to search for.

False

owner

string

(Owner)

An owner to search for.

False

pageSize

number

(Page Size)

Number of results to return.

False

skip

number

(Skip)

Number of results to skip (used for paging).

False

externalId

string

(External ID)

An external id to search for (associated with the video at upload).

False

 

Returns:

          Type:SearchResponse

 

GetBreakdown

Summary: Get video breakdown

Description: This operation returns the full details of the the given breakdown including all the insights (transcript, OCR, people, etc).

 

Syntax:

VideoIndexer.GetBreakdown (string id, [advanced][Optional]string language)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Video Id)

Breakdown id, returned by the upload or search APIs.

True

language

string

(Language)Values: [English, Spanish, Russian, Japanese, German, French, Portuguese, Italian, Chinese]

Requested language of the text.

False

 

Returns:

          Type:GetBreakdownResponse

 

DeleteBreakdown

Summary: Delete video and its insights

Description: This operation deletes the uploaded video and if deleteInsights=true, then deletes the generated insights as well.

 

Syntax:

VideoIndexer.DeleteBreakdown (string id, [Optional]boolean deleteInsights)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Video Id)

Id associated with the video and its breakdown.

True

deleteInsights

boolean

(Delete Insights)

Whether to delete the generated insights as well (True or False).

False

 

Returns:

          Type:DeleteBreakdownResponse

 

GetInsightsWidgetUrl

Summary: Get the insights widget url

Description: This operation returns a url to the cognitive insights widget, including an access token.

 

Syntax:

VideoIndexer.GetInsightsWidgetUrl (string id, [advanced][Optional]string widgetType)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Video Id)

The id associated with the video and its breakdown.

True

widgetType

string

(Widget Type)Values: [People, Sentiments, Keywords, Search]

People, sentiments, keywords or search.

False

 

Returns:

          Type:stringUrl

Title: Url

          Description: Url of cognitive insights widget.

 

GetPlayerWidgetUrl

Summary: Get the player widget url

Description: This operation returns a url to the player widget, including an access token.

 

Syntax:

VideoIndexer.GetPlayerWidgetUrl (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Video Id)

The video breakdown id.

True

 

Returns:

          Type:stringUrl

Title: Url

          Description: Url of player widget.

 

GetVttUrl

Summary: Get the transcript (VTT) url

Description: This operation returns an a url to a VTT file with the given breakdown's captions.

 

Syntax:

VideoIndexer.GetVttUrl (string id, [advanced][Optional]string language)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Video Id)

The id associated with the video and its breakdown.

True

language

string

(Language)Values: [English, Spanish, Russian, Japanese, German, French, Portuguese, Italian, Chinese]

The requested language of the text.

False

 

Returns:

          Type:stringUrl

Title: Url

          Description: Url of the VTT file of the video.

 

GetInsightsWidgetUrlByExternalId

Summary: Get the insights widget url (using the external id)

Description: This operation returns a url to the cognitive insights widget, including an access token, based on a given external id.

 

Syntax:

VideoIndexer.GetInsightsWidgetUrlByExternalId (string externalId, [Optional]string widgetType)

 

Parameters:

Name

Type

Summary

Required

Related Action

externalId

string

(External Id)

An external id to search for (associated with a video of this subscription at upload).

True

widgetType

string

(Widget Type)Values: [People, Sentiments, Keywords, Search]

A type of a sub-widget to include (People, Sentiments, Keywords, Search).

False

 

Returns:

          Type:stringUrl

Title: Url

          Description: Url of cognitive insights widget.

 

GetAccounts

Summary: Get accounts

Description: Returns the details of the user's accounts.

 

Syntax:

VideoIndexer.GetAccounts ()

 

Returns:

          Type:array of (GetAccountsResponseItem)

 

Re-IndexBreakdown

Summary: Re-index video breakdown

Description: This operation re-indexes the given breakdown.

 

Syntax:

VideoIndexer.Re-IndexBreakdown (string id, [advanced][Optional]string callbackUrl)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Video Id)

The video breakdown id.

True

callbackUrl

string

(Callback Url)

A url to notify when re-indexing is completed.

False

 

Returns:

          Type:Re-IndexBreakdownResponse

 

Re-IndexBreakdownByExternalId

Summary: Re-index video breakdown (using the external id)

Description: This operation re-indexes the video of the given external id.

 

Syntax:

VideoIndexer.Re-IndexBreakdownByExternalId (string externalId, [advanced][Optional]string callbackUrl)

 

Parameters:

Name

Type

Summary

Required

Related Action

externalId

string

(External Id)

An external id (which was associated with a video of this subscription at upload).

True

callbackUrl

string

(Callback Url)

A url to notify when re-indexing is completed.

False

 

Returns:

          Type:Re-IndexBreakdownByExternalIdResponse

 

UpdateFaceName

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.UpdateFaceName (string id, number faceId, string newName)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Video Id)

The video breakdown id.

True

faceId

number

(Face Id)

The face id (from the video's json).

True

newName

string

(New Name)

The new name for the face (use 'Unknown #1/2/3...' to make anonymous).

True

 

Returns:

          Type:UpdateFaceNameResponse

 


 

DeleteBreakdownResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetAccountsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 


 

GetBreakdownResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

accountId

string

 

Unique id associated with the account.

id

string

 

Unique id associated with the video and its breakdown.

partition

string

 

Partition of the video.

name

string(date-time)

 

Name of the video.

description

string

 

Description of the video.

userName

string

 

User name of the account of the video.

createTime

string(date-time)

 

Time of creation of the video.

organization

string

 

Organization account belongs to.

privacyMode

string

 

Privacy mode of the video.

state

string

 

Uploaded, processing, processed, or failed).

isOwned

boolean

 

True if the video is owned by a user.  Values: [, true, false]

isBase

boolean

 

True if the video is a base video.  Values: [, true, false]

durationInSeconds

integer(int32)

 

Time duration of the video in seconds.

summarizedInsights

string

 

Summary of insights taken from the breakdowns of the video

breakdowns

string

 

Array of the breakdowns of the video.

social

Social

 

 

 

Social

Summary:

Description:

 

          Properties:

Name

Type

Summary

likedByUser

boolean

 

True if the video has been liked by a user. False otherwise.  Values: [, true, false]

likes

integer(int32)

 

Number of likes on the video.

views

integer(int32)

 

Number of views of the video.

 


 

GetProcessingStateResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

state

string

 

Uploaded, processing, processed, or failed.

progress

string

 

Percentage of the video if state is processing.


 

Re-IndexBreakdownByExternalIdResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Re-IndexBreakdownResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

SearchResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

results

array of (ResultsItem)

 

 

nextPage

NextPage

 

Next page of search results.

 

ResultsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

accountId

string

 

Of the account that uploaded video.

id

string

 

Id associated with the video and its breakdown.

partition

string

 

Partition of the video.

externalId

string

 

External id of the video (user provided at upload).

metadata

string

 

Metadata of the video.

name

string

 

Name of the video.

description

string

 

Description of the video.

createTime

string(date-time)

 

Time of creation of the video.

organization

string

 

Organization account belongs to.

privacyMode

string

 

Organization account belongs to.

userName

string

 

Username of the account of the video.

isOwned

boolean

 

True if the video is owned by a user.

isBase

boolean

 

True if the video is a base video.

state

string

 

Uploaded, processing, processed, or failed.

processingProgress

string

 

Progress percentage of the video if state is processing.

durationInSeconds

integer(int32)

 

Duration of the video in seconds.

thumbnailUrl

string

 

Thumbnail url of the video.

social

Social

 

 

searchMatches

string

 

Array of matches to the search and details of the matches.

 

Social

Summary:

Description:

 

          Properties:

Name

Type

Summary

likedByUser

boolean

 

True if the video has been liked by the user. False otherwise.

likes

integer(int32)

 

Number of likes of the video.

views

integer(int32)

 

Number of views of the video.

 

NextPage

Summary:

Description: Next page of search results.

 

          Properties:

Name

Type

Summary

pageSize

integer(int32)

 

Page size of the search results.

skip

integer(int32)

 

Number of results to skip (used for paging).

done

boolean

 

Whether search is done (True or False).

 


 

UpdateFaceNameResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary