Skip to main content

GET Comprehensive Action Items (Labs)

Symbl Labs

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 labs@symbl.ai.

This API returns all the action items that are enriched with corresponding contexts.

HTTP Request#

GET https://api-labs.symbl.ai/v1/conversations/{conversationId}/comprehensive/action-items

Example API Call#

info

Before using the Conversation API you must get the authentication token (AUTH_TOKEN) from our authentication process.

curl "https://api-labs.symbl.ai/v1/conversations/$CONVERSATION_ID/comprehensive/action-items" \
-H "Authorization: Bearer $AUTH_TOKEN"

Response#

=======
:::note Symbl Labs
We at Symbl believe in building with continuous innovation, keeping simplicity and originality at the core. Labs at Symbl is our experimental wing designed to share our bleeding edge AI research on human conversations with anyone who wants to explore its limits.
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.
Please contact labs@symbl.ai if you wish to access these features.
:::
The Comprehensive Action Items API gives you a list of action items. The Action Items object contains the references to all the messages which are in scope. The text of the Action Items are a summary of all the messages.
### API Endpoint
**<font color="orange">GET</font> https://api-labs.symbl.ai/v1/conversations/{conversationId}/comprehensive/action-items**
### Request Header
Header Name | Required |Description
--------- | --------- | ---------
```Authorization``` (Recommended) | Mandatory | This header should contain a valid Bearer token generated using the `token:generate` API Endpoint by passing in the credentials. You can read more about authentication [here](/docs/developer-tools/authentication).
```Content-Type```| Mandatory| This header must contain the MIME Type `application/json`.
```X-API-KEY``` (Legacy)| Optional| Use the `Authorization` header. This has been deprecated. This header should contain a valid authentication token generated using the `token:generate` API Endpoint by passing in the credentials. These can be obtained by signing up on the [Platform](https://platform.symbl.ai/).
### Response Body Sample
```js
{
"actionItems": [
{
"id": "4875991597973504",
"text": "Stella and John need to shift their focus more towards dev. John will go ahead and set up a discussion with product.",
"text": "Anton wants to have all the data from his database in their database.",
"type": "action_item",
"score": 0.8735619108573252,
"messageRefs": [
{
"id": "5943054110294016"
},
{
"id": "4960777540730880"
}
],
"entities": [],
"phrases": [],
"from": {
"id": "10aa881e-4c70-4060-8886-66a5e5c9b788",
"name": "John",
"userId": "john@example.com"
},
"definitive": true,
"assignee": {
"id": "10aa881e-4c70-4060-8886-66a5e5c9b788",
"name": "John",
"email": "john@example.com"
}
}
]
}

Response Parameters#

FieldDescription
idUnique identifier of the comprehensive action item.
textText of the comprehensive action item.
typeResponse type. Default is action_item.
scoreConfidence score of the generated action item. Value from 0 - 1.
messageRefs.idUnique identifiers of the corresponding messages from where the action item was derived. You may get multiple message IDs here as Symbl identifies all the relevant messages in the conversation and generates the required action item accordingly.
entitiesList of detected entity objects in the insight with type - entity type and text - corresponding text.
definitiveBoolean indicating if the action item is definitive or not.
phrasesList of detected phrases with type - phrase type and text - corresponding text. The action_phrase type represents the actionable part of an insight.
assigneeThis field contains the name and email of the person to whom the action item is assigned.

Response Object#

FieldDescription
idUnique conversation identifier.
textText of the Conversation.
typeResponse type. Default is action_item.
scoreConfidence score of the generated topic. Value from 0 - 1.
messageIdsUnique message identifiers of the corresponding messages.
entitiesList of detected entity objects in the insight with type - entity type and text - corresponding text.
definitiveBoolean indicating if the action-item is definitive or not.
phrasesList of detected phrases with type - phrase type and text - corresponding text. The action_phrase type represents the actionable part of an insight.
assigneeThis field contains the name and email of the person assigned to the Action Item.