GuidesAPI ReferenceSDKsIntegrationsWhat's New?

Get summary using Async API

Suggest Edits

This tutorial provides step-by-step instructions for generating a Summary using Async APIs.

If you are using the Speaker Separation feature, the Summary uses temporary labels to assign speakers. For example, it assigns the speakers with labels such as Speaker 1, Speaker 2 and so on. In this case, Symbl.ai recommends that you update the labels with actual names using the Speaker Events API to get a more personalized summary.

Step 1: Process conversations with Async API using enableSummary=true parameter

When you process a text, video, or audio conversation using Async API, you must enable the Summarization feature. To do this, set the parameter enableSummary=true in the query params as shown here.

This example uses the Text Async API. You can use the same syntax for Audio and Video Async APIs.

Request

POST https://api.symbl.ai/v1/process/text?enableSummary=true

Response

{
  "conversationId": "5815170693595136",
  "jobId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"
}

The Async API call returns a conversationId. Use the Conversation ID to get the Summary in the next Step.
You must wait for the job to complete before you can get the Summary.

Step 2: Get Summary with Summary API

Once you have the conversationId, you can send a GET request to the Summary API endpoint as shown here:

Request

GET https://api.symbl.ai/v1/conversations/{conversationId}/summary

Example

GET https://api.symbl.ai/v1/conversations/5815170693595136/summary

Response

The response return the Summary as follows:

{
  "summary": [
    {
      "id": "3498579583479",
      "text": "John, Mark and Paul need to focus more on the Dev team and on the 
      product. In order to focus on the sales hires, Paul needs to know which 
      geographies they should focus on.",
      "messageRefs": [
        {
          "id": "248594875984"
        },
        {
          "id": "948538959348"
        },
        {
          "id": "538598359838"
        },
        {
          "id": "242948723984"
        },
        {
          "id": "234794875984"
        },
        {
          "id": "248545375984"
        },
        {
          "id": "244394875984"
        },
        {
          "id": "248232875984"
        },
        {
          "id": "248595675984"
        },
        {
          "id": "357194875984"
        },
        {
          "id": "236394875984"
        },
        {
          "id": "457594875984"
        }
      ],
      "startTime": "2022-08-23T01:13:21.784Z",
      "endTime": "2022-08-23T01:14:55.304Z",
    },
    {
      "id": "4385738475683",
      "text": "Mark and Tim will create a link, it will work on their environment 
      and use the same API. The video placement will use a cookie. The idea is to 
      eliminate effort on the consultancy team. Mark suggests a negation using 
      cookies. Rob and Tim agree that it simplifies things on their end.",
      "startTime": "2022-08-23T01:14:56.199Z",
      "endTime": "2022-08-23T01:15:43.721Z",
      "messageRefs": [
        {
          "id": "938475984357"
        },
        {
          "id": "458375843755"
        },
        {
          "id": "565375984357"
        },
        {
          "id": "932342454357"
        },
        {
          "id": "913434441357"
        },
        {
          "id": "234235235155"
        },
        {
          "id": "134235322465"
        },
        {
          "id": "235235346223"
        },
        {
          "id": "134245723252"
        },
        {
          "id": "458434533646"
        },
        {
          "id": "346346356124"
        },
        {
          "id": "356346346365"
        },
        {
          "id": "645123434625"
        },
        {
          "id": "346635642223"
        },
       {
          "id": "342342352523"
        },
       {
          "id": "324334534622"
        },
       {
          "id": "673546246245"
        },
       {
          "id": "235252456842"
        },
       {
          "id": "246734574683"
        },
       {
          "id": "735773463571"
        },
       {
          "id": "682352246362"
        },
       {
          "id": "574535734242"
        },

      ],
      "startTime": "2022-08-23T01:13:21.784Z",
      "endTime": "2022-08-23T01:14:55.304Z",
    }
  ]
}

Response fields

ParameterDescription
idThe identifier of this summary within the scope of the conversation.
textThe text of the summary.
messageRefs.idThe identifier of each message that makes up the summary.
startTimeThe timestamp indicating when the conversation started.
endTime.The timestamp indicating when the conversation ended.

Summary guide

For more information about the Summary request and response parameters, see the Summary guide.

Updated 9 months ago