PUT Video URL API

The Async Video URL API allows you to process an additional video file to the previous conversation, append the transcription and get conversational insights for updated conversation.

It can be useful in any use case where you have access to multiple recorded video stored publicly as URL 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 video. 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.

info

If there are multiple requests are submitted for the same conversationId, all the requests will be processed synchronously in order to maintain the order of the requests for the conversation.

HTTP REQUEST

PUT https://api.symbl.ai/v1/process/video/url/:conversationId

Example API call

cURL

curl --location --request PUT 'https://api.symbl.ai/v1/process/video/url/:conversationId?webhookUrl=<your_webhook_url>&entities= [{"customType": "Custom_Entity_Type", "text": "Custom Entity to be searched in transcript"}]' \

--header 'Content-Type: application/json' \

--header 'x-api-key: <generated_valid_token>' \

--data-raw '{

"url": "https://symbltestdata.s3.us-east-2.amazonaws.com/sample_video_file.mp4",

"confidenceThreshold": 0.6,

"timezoneOffset": 0

}'

Javascript

const request = require('request');

const fs = require('fs');

const accessToken = "<your_auth_token>";

const videoOption = {

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

headers: {

'x-api-key': accessToken,

'Content-Type': 'application/json'

},

qs: {

webhookUrl: `https://your_webhook_url`,

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

},

body: JSON.stringify({

"url": "https://symbltestdata.s3.us-east-2.amazonaws.com/sample_video_file.mp4",

"confidenceThreshold": 0.6,

"timezoneOffset": 0

})

};

request.put(videoOption, (err, response, body) => {

console.log(err, body);

});

Request Headers

Header Name	Required	Value
x-api-key	Yes	your_auth_token
Content-Type	Yes	Accepted values is application/json

Path Params

Parameter	value
conversationId	conversationId which is provided by the first request submitted using POST async video API

Request Body

Field	Required	Type
url	Yes	A valid url string. The URL must be a publicly accessible url.
customVocabulary	No	Contains a list of words and phrases that provide hints to the speech recognition task.
confidenceThreshold	No	Minimum required confidence for the insight to be recognized. The range is from 0.0 to 1.0 . Default value 0.5 .
detectPhrases	No	It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. Accepts true or false.
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)
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 url. 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