Free Sign Up

Async API

Async API Documentation

The Async API provides a REST interface that helps you to submit any recorded or saved conversations to Symbl. When you submit a conversation, you'll receive a Conversation ID (conversationId), which is unique to your conversation.

Async API Diagram

:::caution
You must wait for the job to complete processing before you proceed with getting the Conversation Intelligence. If you immediately make a GET request to Conversation API, it is possible that you'll receive incomplete insights. Therefore, ensure that you wait for the job to complete.
:::

Conversation ID #

conversationId helps you with: #

  1. Helps you append the transcription of an existing file using PUT (also known as append file) Async APIs.
  2. Using Conversation API you can receive Speech to Text data and conversational insights.

Async API Types #

Text API #

The Async Text API allows you to process any text payload.

It can be useful for any use case where you have access to textual content and want to extract insights and other conversational attributes supported by Symbl's Conversation API.

Audio API #

The Async Audio API allows you to process an audio file.

It can be useful 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.

Audio File Endpoints #

Audio URL Endpoints #

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 a video file of any type of conversation, and you want to extract the insightful items supported by the Conversation API.

Video File Endpoints #

Video URL Endpoints #

Endpoints #

Text API #

Method Endpoint
POST https://api.symbl.ai/v1/process/text Reference
PUT https://api.symbl.ai/v1/process/text/{conversationId} Reference

Audio API #

Method Endpoint
POST https://api.symbl.ai/v1/process/audio Reference
POST https://api.symbl.ai/v1/process/audio/url Reference
PUT https://api.symbl.ai/v1/process/audio/{conversationId} Reference
PUT https://api.symbl.ai/v1/process/audio/url/{conversationId} Reference

Video API #

Method Endpoint
POST https://api.symbl.ai/v1/process/video Reference
POST https://api.symbl.ai/v1/process/video/url Reference
PUT https://api.symbl.ai/v1/process/video/{conversationId} Reference
PUT https://api.symbl.ai/v1/process/video/url/{conversationId} Reference