This API is a part of the Symbl Labs. Symbl Labs is our experimental wing designed to share our bleeding edge AI research on human conversations with anyone who wants to explore its limits.
You can access the Labs features using your Symbl App Id and Secret. If you don't already have it, sign up on our platform to get your credentials.
Note: The usage of data for Labs projects is stored for enhancing our research. We may continue to build, iterate, mutate or discontinue any of the below given features on the sole discretion of our team as deemed necessary.
For any queries or feedback, please contact us at firstname.lastname@example.org.
This API allows you to get a Summary of important contextual messages in a conversation.
Currently, the Summary can be enabled with Async APIs. Support for Summarization in real-time will be added soon. However, if you are using Streaming or Telephony API, you can use the
refresh parameter to generate the Summary after the conversation has ended. To read about how to use it, see the Refresh Parameter section below.
This API works best on audio/video conversations that are at least 10 mins in duration. For text conversations, there must be more than 60 lines of conversation for the Summary to get generated.
|Mandatory||This header must contain the MIME Type |
If you are using
x-api-key we recommend that you use
Authorization header instead as
x-api-key is deprecated.
You can use the
refresh query parameter in the Summary API for any of the following use-cases:
- Regenerating the Summary (Async APIs)
Summaries can be generated again when you have new discussion items. Use
refresh=truein Summary API as a query param. This will delete the previous Summary and will create a new one.
- Creating Summary (Telephony and Streaming APIs)
If you are using Telephony or Streaming API, after the conversation has ended, use the
refresh=trueparameter in the Summary API to generate the Summary.
|The identifier of the Summary within the scope of the conversation.|
|The identifier of each message that makes up a Summary.|
|The text of the Summary.|
In case of Streaming API and Telephony API, if a conversation is still in-progress or in case of Async API, the job is still in-progress while this API is invoked, it would treat it as “Not Found” error by returning
404 Not Found HTTP status code with a message indicating that it is in progress.
For example, if a conversation with
conversationId ‘48948598475’ is still in progress, the Summary for it can be generated only after the conversation is complete. Please call this API after the conversation has ended. If you need more help, reach out to us at email@example.com.