Video(URL) - Append to existing Conversation

PUT {{base_url}}/v1/process/video/url/{{conversation_id}}

About this 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.

HTTP REQUEST

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

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.

Path Params

|Parameter |value|

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

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 PUT Async Video URL API in Table of Contents)

Request Body

{"url"=>"https://symbltestdata.s3.us-east-2.amazonaws.com/sample_video_file.mp4", "confidenceThreshold"=>0.6, "timezoneOffset"=>0}

HEADERS