POST Video API

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.

info

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.

HTTP REQUEST

POST https://api.symbl.ai/v1/process/video

Example API call

cURL

curl --location --request POST 'https://api.symbl.ai/v1/process/video?webhookUrl=<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'

Javascript

const request = require('request');

const fs = require('fs');

const accessToken = "<your_auth_token>";

const videoFileStream = fs.createReadStream('/file/location/video.mp4');

const videoOption = {

url: 'https://api.symbl.ai/v1/process/video',

headers: {

'x-api-key': accessToken,

'Content-Type': 'video/mp4'

},

qs: {

webhookUrl: `https://your_webhook_url`,

entities: [{"customType": "Custom_Entity_Type", "text": "Custom Entity to be searched in transcript"}]

},

json: true,

};

videoFileStream.pipe(request.post(videoOption, (err, response, body) => {

console.log(err, body);

}));

Request Headers

Header Name	Required	Value
x-api-key	Yes	your_auth_token
Content-Type	Yes	Describes the format and codec of the provided video. Accepted value video/mp4

Query Params

Parameter	Required	Value
name	No	Your meeting name. Default name set to conversationId.
webhookUrl	No	Webhook url on which job updates to be sent. (This should be post API)
customVocabulary	No	Contains a list of words and phrases that provide hints to the speech recognition task.
detectPhrases	No	Accepted values are true & false. It shows Actionable Phrases in each sentence of conversation. These sentences can be found in the Conversation's Messages API.
entities	No	Input custom entities which can be detected in your conversation using Entities' API. For example, check the sample code on right.
languageCode	No	We 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

Field	Description
jobId	ID to be used with Job API.
status	Current status of the job. (Valid statuses - [ scheduled, in_progress, completed, failed ])

Response

{

"conversationId": "5815170693595136",

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

}

Response Object

Field	Description
conversationId	ID to be used with Conversation API
jobId	ID to be used with Job API

Response on reaching limit

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