Async API - Quick Reference

Getting Started
#1

They Async API Collection is made of the following APIs:

  • [POST] Async Text API
  • [PUT] Async Text API
  • [POST] Audio API
  • [PUT] Audio API
  • [POST] Audio URL API
  • [PUT] Audio URL API
  • [POST] Async Video API
  • [PUT] Async Video API
  • [POST] Async Video URL API
  • [PUT] Async Video URL API
  • [GET] Job Status

================================

(POST) Async Text API
The Async Text API allows you to process any text payload. This API is useful for when you want to extract Conversation Insights from textual content.

An Access Token is required to call this API.

This is a POST API call which references the following API Endpoint:

The Body must contain a JSON structured payload that will be further broken down by the Async Text API.

This will return a unique "conversationId" && “jobId”.

For more information, please refer to the following Symbl documentation:

================================

(PUT) Async Text API
The PUT Async Text API allows you to process any text payload to append the transcription of the previous conversation. It can be useful in cases where you have new information like chats, emails or messages which keep generating for single entity. Using this API, you can add all the new entity data to the existing “Conversation ID”.

An Access Token is required to call this API. A Conversation ID is required to call this API.

This is a PUT API call which references the following API Endpoint:

This will return both the same “conversationId” that was passed in, & a unique “jobId”.

For more information, please refer to the following Symbl documentation:

================================

(POST) Audio API
The Async Audio API allows you to process an audio file. It can be utilized for any use case where you have access to recorded audio and want to extract insights and other conversational attributes supported by Symbl’s Conversation API.

An Access Token is required to call this API.

This is a POST API call which references the following API Endpoint:

This will return a unique "conversationId" && “jobId”.

For more information, please refer to the following Symbl documentation:

================================

(PUT) Audio API
The Async Audio API allows you to process an additional audio 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 audio files of any type of conversation, and you want to extract the insightful items supported by the Conversation API.

An Access Token is required to call this API. A Conversation ID is required to call this API.

This is a PUT API call which references the following API Endpoint:

This will return both the same “conversationId” that was passed in, & a unique “jobId”.

For more information, please refer to the following Symbl documentation:

================================

(POST) Audio URL API
The Async Audio URL API accepts a URL to an audio file of which you want to process. It can be utilized for any use case where you have access to recorded audio stored publicly as URL and want to extract insights and other conversational attributes supported by Symbl’s Conversation API.

An Access Token is required to call this API.

The URL provided must be a publicly available URL. Currently, we do not support any redirected links, shortened links (e.g. bit.ly), YouTube, Vimeo, or links from any audio/video platforms.

This is a POST API call which references the following API Endpoint:

This will return a unique "conversationId" && “jobId”.

For more information, please refer to the following Symbl documentation:

================================

(PUT) Audio URL API
The Async Audio URL API allows you to append an additional audio URL to the previous conversation, append the transcription and get conversational insights for the updated conversation. It can be useful in any use case where you have access to multiple recorded audio stored publicly as a URL and you want to extract the insightful items supported by the Conversation API.

An Access Token is required to call this API. A Conversation ID is required to call this API.

The URL provided must be a publicly available URL. Currently, we do not support any redirected links, shortened links (e.g. bit.ly), YouTube, Vimeo, or links from any audio/video platforms.

This is a PUT API call which references the following API Endpoint:

This will return both the same “conversationId” that was passed in, & a unique “jobId”.

For more information, please refer to the following Symbl documentation:

================================

(POST) Async 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.

An Access Token is required to call this API.

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

This is a POST API call which references the following API Endpoint:

This will return a unique "conversationId" && “jobId”.

For more information, please refer to the following Symbl documentation:

================================

(PUT) Async Video API
The Async Video API allows you to append an additional audio to the previous conversation, append the transcription and get conversational insights for the updated conversation. It can be useful in any use case where you have access to multiple video files of any type of conversation from which you want to extract insightful items supported by the Conversation API.

An Access Token is required to call this API. A Conversation ID is required to call this API.

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

This is a PUT API call which references the following API Endpoint:

This will return both the same “conversationId” that was passed in, & a unique “jobId”.

For more information, please refer to the following Symbl documentation:

================================

(POST) Async Video URL API
The Async Video URL API allows you to process video files (.mp4 format) 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 a URL and want to extract insights and other conversational attributes supported by Symbl’s Conversation API.

An Access Token is required to call this API.

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

The URL provided must be a publicly available URL. Currently we do not support any redirected links, shortened links (e.g. bit.ly), YouTube, Vimeo, or links from any audio/video platforms.

This is a POST API call which references the following API Endpoint:

This will return a unique "conversationId" && “jobId”.

For more information, please refer to the following Symbl documentation:

================================

(PUT) Async 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 the 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.

An Access Token is required to call this API. A Conversation ID is required to call this API.

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

The URL provided must be a publicly available URL. Currently, we do not support any redirected links, shortened links (e.g. bit.ly), YouTube, Vimeo, or links from any audio/video platforms.

This is a PUT API call which references the following API Endpoint:

This will return both the same “conversationId” that was passed in, & a unique “jobId”.

For more information, please refer to the following Symbl documentation:

================================

(GET) Job Status
The Job Status API is used to retrieve the status of an ongoing Async API request. You will need to reference the “jobId” that was sent in the response of the initial Async API call.

An Access Token is required to call this API. A Job ID is required to call this API.

This is a PUT API call which references the following API Endpoint:

This will return both the same “jobId” that was passed in, & a “status”.

The possible “status” conditions are:

  • in_progress
  • completed
  • failed

For more information, please refer to the following Symbl API Documentation: