Video (URL) - Submit New Conversation

POST {{base_url}}/v1/process/video/url

About this API:

The Async Video URL API allows you to process a mp4 video and return the full text transcript along with conversational insights. It can be utilized for any use case where you have access to recorded video stored publicly as URL and want to extract insights and other conversational attributes supported by Symbl's Conversation API.

HTTP REQUEST

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

Request Headers

|Header Name |Required|Value |

|x-api-key |Yes |yourauthtoken |
|Content-Type |Yes |Accepted value application/json |

Request Body

|Field | Required|Type |Description |

|url |Yes |String|A valid url string. The URL must be a publicly accessible url. |
|customVocabulary |No |list |Contains a list of words and phrases that provide hints to the speech recognition task. |
|confidenceThreshold|No |double|Minimum required confidence for the insight to be recognized. |

Query Params

|Parameter |Required|Value

|webhookUrl |No | Webhook url on which job updates to be sent. (This should be post API)

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.

Response Object on Success

|Field |Description |

|conversationId |ID to be used with Conversation API|
|jobId |ID to be used with Job API |

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 ])|

For more: https://docs.symbl.ai/?shell#video-api (Please find POST Asnyc Video URL API in Table of Contents)

Request Params

Request Body

{"url"=>"https://symbltestdata.s3.us-east-2.amazonaws.com/sample_video_file.mp4", "name"=>"Postman Default Meeting", "customVocabulary"=>["Customer", "Sales", "Targets"], "enableAllTrackers"=>true, "enableSummary"=>true, "detectEntities"=>true, "detectPhrases"=>true, "languageCode"=>"en-US", "mode"=>"default", "timezoneOffset"=>0, "confidenceThreshold"=>0.6, "trackers"=>[{"name"=>"COVID-19", "vocabulary"=>["social distancing", "cover your face with mask", "vaccination"]}], "enableSpeakerDiarization"=>true, "diarizationSpeakerCount"=>2, "startTime"=>"2023-01-17T17:26:12", "features"=>{"featureList"=>["insights", "callScore"]}, "conversationType"=>"sales", "metadata"=>{"salesStage"=>"general", "prospectName"=>"Audio File LLC"}}

HEADERS