Create Trackers with Async API (Archived)

🚧

This content is outdated

This content is from an older version of the Symbl.ai documentation. We recommend you use the latest version at Trackers

🚧

In Beta

This feature is in Beta. If you have questions or comments, email [email protected].

Symbl provides a set of Async APIs based on audio, video, or text content. For more details see Async API.

The Trackers, once processed by the request, try to detect Trackers in the Conversation. Once the job is complete, you can fetch the Trackers from the Conversation API through the /trackers endpoint described in this article.

Creating Trackers with Management API

While you can create Trackers with Async or Streaming APIs, We recommended creating Trackers using the Management API so Trackers can be saved and can be reused.

Async Audio File API

The Tracker entities should be passed as a query parameter in the Async Audio API’s URL as shown below.

📘

  • Before creating the Trackers, read Best Practices - Trackers to learn about creating a Trackers vocabulary.

  • If you want to create multiple trackers, use Create Trackers in Bulk. The Trackers Management API handles all the Trackers you have created at your account level and makes it easy to maintain them.

Authentication

Before using the API, ensure that you have your Authentication Token (AUTH_TOKEN) handy. To learn about how to get your auth token, see the step-by-step instructions in Authenticate.

API Endpoint

"https"://api.symbl.ai/v1/process/audio?trackers=[
   {
      "name":"COVID-19",
      "vocabulary":[
         "social distancing",
         "cover your face with mask",
         "vaccination"
      ]
   }
]

Async Audio URL API

Pass the Tracker entities in the request body of the Async Audio URL API as follows:

API Endpoint

POST <https://api.symbl.ai/v1/process/audio/url>

Request Header

Header NameRequiredDescription
AuthorizationYesBearer <token> The token you get after completing the Authenticate process.
Content-TypeYesapplication/json
x-api-keyNoDEPRECATED.

Request Body

{
    "url": "<PUBLIC_AUDIO_FILE_URL>",
    "confidenceThreshold": 0.6,
    "timezoneOffset": 0,
    "trackers": [
        {
            "name": "Promotion Mention",
            "vocabulary": [
                "We have a special promotion going on if you book this before",
                "I can offer you a discount of 10 20 percent you being a new customer for us",
                "We have our month special this month",
                "We have a sale right now on"
            ]
        }
    ]
}

Notice that the trackers member follows the same structure as mentioned in the Trackers section above.

Response

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

Async Video File API

Pass the Tracker entities as a query parameter in the Async Video API URL as follows:

API Endpoint

"https"://api.symbl.ai/v1/process/video?trackers=[
   {
      "name":"COVID-19",
      "vocabulary":[
         "social distancing",
         "cover your face with mask",
         "vaccination"
      ]
   }
]

Request Header

Header NameRequiredDescription
AuthorizationYesBearer <token> The token you get after completing the Authenticate process.
Content-TypeYesapplication/json
x-api-keyNoDEPRECATED.

Notice that the trackers query parameter follows the same structure as mentioned in the Trackers section above.

Response

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

Async Video URL API

The Tracker entities should be passed in as a member of the request body of the Async Video URL API like shown below:

API Endpoint

POST <https://api.symbl.ai/v1/process/video/url>

Request Headers

Header NameRequiredDescription
AuthorizationYesBearer <token> The token you get after completing the Authenticate process.
Content-TypeYesapplication/json
x-api-keyNoDEPRECATED.

Request Body

{
    "url": "<PUBLIC_VIDEO_FILE_URL>",
    "confidenceThreshold": 0.6,
    "timezoneOffset": 0,
    "trackers": [
        {
            "name": "Promotion Mention",
            "vocabulary": [
                "We have a special promotion going on if you book this before",
                "I can offer you a discount of 10 20 percent you being a new customer for us",
                "We have our month special this month",
                "We have a sale right now on"
            ]
        }
    ]
}

Notice that the trackers member follow the same structure as mentioned in the Trackers section above.

Response

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

Async Text API

Pass the Tracker entities as a member of the request body of the Async Text API as shown :

API Endpoint

POST <https://api.symbl.ai/v1/process/text>

Request Headers

Header NameRequiredDescription
AuthorizationYesBearer <token> The token you get after completing the Authenticate process.
Content-TypeYesapplication/json
x-api-keyNoDEPRECATED.

Request Body

{
    "name": "My Sales Conversation",
    "conversationType": [
        "sales"
    ],
    "messages": [
        {
            "payload": {
                "content": "<CONVERSATION_PAYLOAD>",
                "contentType": "text/plain"
            },
            "from": {
                "name": "John",
                "userId": "[email protected]"
            }
        }
    ],
    "trackers": [
        {
            "name": "Promotion Mention",
            "vocabulary": [
                "We have a special promotion going on if you book this before",
                "I can offer you a discount of 10 20 percent you being a new customer for us",
                "We have our month special this month",
                "We have a sale right now on"
            ]
        }
    ]
}

Notice that the trackers member follows the same structure as the Trackers section above.

Response

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

Related Documents

Trackers Tutorials (Archived):

Reference:


Did this page help you?