The Async Video API allows you to process a video file.

It can be useful in any use case where you have access to the video file of any type of conversation, and you want to extract the insightful items supported by the Conversation API.


This API supports only mp4 file formats. If you have any other type of file, you need to first convert the file to the supported format in order to use the API.



Example API call#

curl --location --request POST '<your_webhook_url>&entities= [{"customType": "Custom_Entity_Type", "text": "Custom Entity to be searched in transcript"}]' \
--header 'Content-Type: video/mp4' \
--header 'x-api-key: <generated_valid_token>' \
--data-binary '@/file/location/your_video.mp4'

Request Headers#

Header NameRequiredValue
Content-TypeYesDescribes the format and codec of the provided video. Accepted value video/mp4

Query Params#

nameNoYour meeting name. Default name set to conversationId.
webhookUrlNoWebhook url on which job updates to be sent. (This should be post API)
customVocabularyNoContains a list of words and phrases that provide hints to the speech recognition task.
detectPhrasesNoAccepted values are true & false. It shows Actionable Phrases in each sentence of conversation. These sentences can be found in the Conversation's Messages API.
entitiesNoInput custom entities which can be detected in your conversation using Entities' API. For example, check the sample code on right.
languageCodeNoWe accept different languages. Please check language Code as per your requirement.

webhookUrl will be used to send the status of job created for uploaded video. Every time the status of the job changes it will be notified on the WebhookUrl

Webhook Payload#

jobIdID to be used with Job API.
statusCurrent status of the job. (Valid statuses - [ scheduled, in_progress, completed, failed ])


"conversationId": "5815170693595136",
"jobId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"

Response Object#

conversationIdID to be used with Conversation API
jobIdID to be used with Job API

Response on reaching limit#

Payload{ "message" : "Too Many Requests" }
Header{ "statusCode" : 429 }