Manage conversations

As you work with the Symbl.ai APIs, you need to manage your conversations.

The Conversations API provides the following management operations:

• To get a list of your conversations, see Get all conversations.
• To get information about a specific conversation, see Get a conversation.
• To add or change conversation metadata, see Update conversation metadata.
• To permanently delete a conversation and related data, see Delete a conversation.

Note that Symbl.ai also provide a separate API to manage conversation groups, custom entities, and trackers. For more information, see the Management API guide.

Get a conversation

This request returns conversation data such as the meeting name, member names and emails, start and end time of the meeting, meeting type, meeting ID, and any custom conversation metadata that you added.

Authentication

This request requires an access token, as described in Authenticate.

Conversation ID

This request requires a conversation ID, generated when you Process a Conversation.

To get a information about a specific conversation, use the operation:

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

To make this request from the API reference, see Get conversation.

Get all conversations

This request returns a list of your conversations. By default, up to 20 conversations are returned. You can use the optional request parameters to filter and change the number of results.

Request parameters include a limit on the number of conversations returned, a number of conversations to skip before applying the limit, sort order, start time range, and end time range.

Authentication

This request requires an access token, as described in Authenticate.

To get a list of your conversations, use the operation:

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

To make this request from the API reference, see Get conversations.

Update conversation metadata

Use this API request to add or change conversation metadata. Conversation metadata is a collection of custom key-value pairs that you can use to label the conversation. Conversation metadata is also used to include conversations in Conversation groups.

Authentication

This request requires an access token, as described in Authenticate.

Conversation ID

This request requires a conversation ID, generated when you Process a Conversation.

To add or change the metadata for a conversation, use the operation:

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

To make this request from the API reference, see Update conversation.

Delete a conversation

This request deletes a conversation and all data directly associated with the conversation ID, such as messages, action items, topics, summary, and so on. When you delete a conversation, it cannot be recovered and the conversation ID no longer works for any other API request.

If you need to purge a conversation and all related data, this operation accomplishes the purge immediately. The operation cannot be reversed and the conversation cannot be recovered.

If you have the original conversation saved outside the Symbl.ai environment, you could process it again to get a new conversation ID and generate similar data.

Authentication

This request requires an access token, as described in Authenticate.

Conversation ID

This request requires a conversation ID, generated when you Process a Conversation.

To delete a conversation, use the operation:

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

To make this request from the API reference, see Delete conversation.