Process a conversation with Symbl's Async API

Use the Async API to get speech-to-text transcription from audio or video and extract follow-ups, topics, action-items, questions and intents from them.

1. Process an audio file using Async API#

This guide uses cURL to send audio or video to Symbl's APIs for processing. If the audio or video has multiple speakers Symbl will process that and separate the transcript by speaker. Before you get started with this guide you must sign up as a developer for Symbl. This will allow you to get the API keys needed to authenticate with Symbl and start using our APIs.

For this example we've provided you an audio file for you to upload. You can view the audio file here.

Reminder that the AUTH_TOKEN variable is gotten from our authentication process in which you need to sign up as a developer for Symbl to use.

Process an audio file#

curl --location --request POST "https://api.symbl.ai/v1/process/audio/url?entities=%5B%7B%22customType%22%3A%20%22Custom_Entity_Type%22%2C%20%22text%22%3A%20%22Custom%20Entity%20to%20be%20searched%20in%20transcript%22%7D%5D" \
--header 'Content-Type: application/json' \
--header "x-api-key: $AUTH_TOKEN" \
--data-raw '{
"url": "https://symbltestdata.s3.us-east-2.amazonaws.com/sample_audio_file.wav",
"confidenceThreshold": 0.6,
"timezoneOffset": 0
}'

Example response#

{
"conversationId": "6690671572287488",
"jobId": "50c63f4f-8232-45d7-8ec5-5ad5d379f042"
}

2. How to get speech-to-text transcription from your conversations#

After you run execute the code above you should receive a Coversation ID (conversationId) in the response. A Conversation ID is the key to receiving conversational insights from any conversation. As an example, here's a simple API call which grabs the speech-to-text transcription from the conversation.

Grab speech-to-text transcription#

Remember to replace the conversationId in the API call with the Conversation ID you get from the previous API call.

curl "https://api.symbl.ai/v1/conversations/{conversationId}/messages" \
-H "x-api-key: $AUTH_TOKEN"

3. Grabbing other conversational insights using Conversation API#

Here's more data you can grab with our Conversation API:

View conversation topics
Summary topics provide a quick overview of the key things that were talked about in the conversation.

View action items
An action item is a specific outcome recognized in the conversation that requires one or more people in the conversation to take a specific action, e.g. set up a meeting, share a file, complete a task, etc.

View follow-ups
This is a category of action items with a connotation to follow-up a request or a task like sending an email or making a phone call or booking an appointment or setting up a meeting.

Don't forget to sign up as a developer for Symbl to receive your API keys!