GuidesAPI ReferenceSDKsIntegrationsWhat's New?

Summarize bookmarks

Suggest Edits

This page describes how to get a summary of one bookmark or summaries of multiple bookmarks from a conversation.

For more information about Symbl.ai’s Summary feature, see Summary.

For more information about the Bookmarks feature, see Bookmarks.

Bookmarks - Async API

This section provides basic examples of how to get a summary of one bookmark or summaries of multiple bookmarks at one time using the Async API. This request requires a conversation ID. You receive a conversation ID when you process a conversation with the Symbl.ai APIs.

Authentication

These requests require an access token, as described in Authenticate.

Get a summary of a bookmark

To get a summary of a bookmark in a conversation, use the GET /v1/conversations/{conversationId}/bookmarks/{bookmarkId}/summary operation.

import fetch from 'node-fetch';

const accessToken = '<ACCESS_TOKEN>';
const conversationId = '<CONVERSATION_ID>';
const bookmarkId = '<BOOKMARK_ID>';


const fetchResponse = await fetch(`https://api.symbl.ai/v1/conversations/${conversationId}/bookmarks/${bookmarkId}/summary`, {
  method: get,
  headers: {
    'Authorization': `Bearer ${accessToken}`,
    'Content-Type': 'application/json'
  }
});

const responseBody = await fetchResponse.json();

console.log(responseBody);

Where:

  • <ACCESS_TOKEN> is a valid API access token.
  • <CONVERSATION_ID> is the ID of a conversation that you previously processed.
  • <BOOKMARK_ID> is the ID of a bookmark that you previously created.

Response

The following table describes the response body that is returned by this request.

FieldDescription
summaryAn object that contains the ID and content of the summary.
summary.idThe unique identifier of the summary.
summary.textA summary of the bookmark content.

For more information about Symbl.ai’s Summary feature, see Summary.
summary.messageRefsA list of the messages that occurred during the duration of the bookmark and were used to generate the summary. The objects in the list are formatted as "id": "<MESSAGE_ID>".
summary.bookmarkReferenceAn object that contains the ID of the summarized bookmark.
summary.bookmarkReference.idThe ID of the summarized bookmark.

Example response

{
  "summary": [
    {
      "id": "3498579583479",
      "text": "Anil, Kim and Jen need to focus more on the Dev team and on the product. In order to focus on the sales hires, Kim needs to know which geographies they should focus on.",
      "messageRefs": [
        {
          "id": "6549253137629184"
        },
        {
          "id": "6219894493282304"
        }
      ],
      "bookmarkReference": {
        "id": "5650380957417472"
      }
    }
  ]
}

Get summaries of multiple bookmarks

To get summaries of multiple bookmarks in a conversation, use the GET /v1/conversations/{conversationId}/bookmarks-summary operation.

import fetch from 'node-fetch';

const accessToken = '<ACCESS_TOKEN>';
const conversationId = '<CONVERSATION_ID>';


const fetchResponse = await fetch(`https://api.symbl.ai/v1/conversations/${conversationId}/bookmarks-summary`, {
  method: get,
  headers: {
    'Authorization': `Bearer ${accessToken}`,
    'Content-Type': 'application/json'
  }
});

const responseBody = await fetchResponse.json();

console.log(responseBody);

Where:

  • <ACCESS_TOKEN> is a valid API access token.
  • <CONVERSATION_ID> is the ID of a conversation that you previously processed.

Optional query parameters

The following table describes the optional query parameters that can be used with this request.

ParameterDescription
filterSpecified in RSQL format, bookmarks are only returned if they match the filter.

You can filter bookmarks by any combination of bookmark properties. See the following example filters:

Filter by label:
filter=bookmark.label=="pain point"

Filter by user property:
filter=bookmark.user.userId=="[email protected]"

Filter by label and user property:
filter=bookmark.label=="pain point";bookmark.user.userId=="[email protected]"

Filter by time offset:
filter=bookmark.beginTimeOffset>30

Example URL with query parameters

https://api.symbl.ai/v1/conversations/${conversationId}/bookmarks-summary?filter=bookmark.label%3D%3D%22pain%20point%22

Response

The following table describes the response body that is returned by this request.

FieldDescription
bookmarksSummaryA list of objects, one for each bookmark returned by the request. Each object contains a bookmarkId and the corresponding summary.
bookmarkIdThe ID of a bookmark returned by the request.
summaryThe summary for the bookmark identified by bookmarkId.

For the response fields specific to an individual summary, see Get a Summary of a Bookmark.

Example response

{
  "bookmarksSummary": [
    {
      "bookmarkId": "6428584355823616",
      "summary": [
        {
          "id": "3498579583479",
          "text": "Anil, Kim and Jen need to focus more on the Dev team and on the product. In order to focus on the sales hires, Kim needs to know which geographies they should focus on.",
          "messageRefs": [
            {
              "id": "6549253137629184"
            },
            {
              "id": "6219894493282304"
            }
          ],
          "bookmarkReference": {
            "id": "6428584355823616"
          }
        }
      ]
    },
    {
      "bookmarkId": "5128574352833111",
      "summary": [
        {
          "id": "2532579583171",
          "text": "Anil and Jen will schedule a meeting with Kim after the hiring effort next week.",
          "messageRefs": [
            {
              "id": "1458484963311473"
            },
            {
              "id": "2535034753613139"
            }
          ],
          "bookmarkReference": {
            "id": "5128574352833111"
          }
        }
      ]
    }
  ]
}

Updated 4 months ago