Skip to main content

Update Tracker

In Beta Phase

This feature is in the Beta phase. If you have any questions, ideas or suggestions please reach out to us at devrelations@symbl.ai.

The Update Tracker API updates a Tracker entity against the trackerId which can be consumed in Symbl APIs.

API Endpoint#

PUT https://api.symbl.ai/v1/manage/tracker/{trackerId}

info

Currently, the Tracker entities can be consumed in the Async APIs only. Support for other APIs will be added soon.

Request Headers#

Header NameRequiredDescription
AuthorizationYesBearer <token> The token you get from our authentication process.
Content-Type Yesapplication/json
x-api-keyNoDEPRECATED. The JWT token you get from our authentication process.

Request Parameter#

The following request parameter (query-param) is accepted in the URI: trackerId - The unique identifier of the Tracker to be updated.

Sample Request Body#

{
"id": "4476908732794496",
"name": "COVID-19",
"vocabulary": [
"covid",
"cover your mouth with a mask",
"coughing",
"social distancing",
"vaccine"
]
}

Request Body Parameters#

ParameterDescription
idThe id is the unique identifier of the Tracker entity being updated.
nameThe name acts as a unique identifier assigned to the Tracker. It is case-sensitive, which means that a Tracker can be created with the same name but with different cases.
vocabularyThe vocabulary contains a set of phrases/keywords which signify the context of the Tracker. In other words, these are a set of sentences that are commonly used while talking about the said Tracker in different contexts.
caution

The vocabulary cannot have duplicate phrases/keywords.

info

This API accepts a request body size up to 1MB. Sizes exceeding this limit will result in the error 413 - Request Entity Too Large.

Sample Response Body#

{
"tracker":{
"id":"4476908732794496",
"name":"COVID-19",
"vocabulary":[
"covid",
"cover your mouth with a mask",
"coughing",
"social distancing",
"vaccine"
]
}
}

tracker#

This is the wrapper JSON Object which additionally also contains a unique id associated with the Tracker entity that can be later used to instruct Symbl APIs to enhance tracking of the keywords/phrases in that conversation.

Error Codes#

In case of unsuccessful responses, the following error codes will be returned from the API:

Error CodeDescriptionResolution
409 - ConflictThe 409 response code specifies that the Tracker with that specific name already exists.Modify the name of the Tracker or update the name of the existing Tracker with that name to resolve the error.
404 - Not FoundThe 404 response code specifies that the Tracker with that specific trackerId does not exist.Check the trackerId and ensure that it is valid and exists.
429 - Too many requestsThe 429 response code specifies that the number of concurrent requests surpassed the limit for the API (which is 1 API call at a time).Ensure that your system doesn’t make concurrent API calls that exceed this limit.
400 - Bad RequestThe 400 response code specifies that the request body or the parameters have incorrect key names or their values have types that are different than the ones expected.Please read the message returned in the response to fix this error.
413 - Request Entity Too LargeThe 413 response code specifies that the size of the request body exceeds that of the maximum limit the API supports (which is 1 MB).Please ensure that the size of the request body is under this limit to resolve this error.500 - Internal Server Error
502 - Bad GatewayThe 502 response code specifies that the server failed to acknowledge the request. This may happen due to multiple reasons.Please reach out to support@symbl.ai if it persists even after multiple attempts.
504 - Gateway TimeoutThe 504 response code specifies that the server failed to respond within the timeout duration.Please reach out to support@symbl.ai if it persists even after multiple attempts.