In Beta Phase
This feature is in the Beta phase. If you have any questions, ideas or suggestions please reach out to us at email@example.com.
This section contains step-by-step instructions on how to get started with using the Trackers API. For details on API descriptions, see API Documentation.
Step 1: Create Trackers using
The first step is to create a Tracker with a set of phrases and keywords. Create a Tracker by sending a
POST request to the Create Trackers API endpoint:
You can define the phrases and keywords in the vocabulary of the request body as shown below:
This POST request creates a Tracker and returns the following response. Note that every Tracker has a unique
After creating the Tracker, you can:
Step 2: Process files using Async API with
When you send a recorded audio, video or text file using Async API, set enableAllTrackers=True and POST the file to Symbl.
Given below is an example of a POST request to Async Audio API for processing an audio recording with
enableAllTrackers set to
Specifying the "enableAllTrackers" field in the request
enableAllTrackers parameter will enable detection of all the Trackers maintained for a Symbl’s account by the Management API.
enableAllTrackers accepts a boolean value which must be passed in the Async APIs as the following:
|As a query-param||Async Audio File API, Async Video File API.|
|In Request Body||Async Audio URL API, Async Video URL API, Async Text API.|
You can now get the Trackers for the conversation using the
conversation_id with a
The Trackers APIs can be consumed via the Management API, which takes the onus of maintaining these entities from the developer and shifts it to Symbl’s backend. The Management API provides an easy-to-consume REST interface for managing these entities.
Click here to read about the capabilities of Management APIs.
|Create Trackers in Bulk|
|Get Tracker with ID|
|Get Tracker with name|