Create a Tagging Session

To request a tagging session, call the API path below. This process is automatic, and you do not have to perform any additional steps to start the session.

POST https://api.chatsight.ai/stream/tag

HEADER x-chatsight-api-auth: <API-TOKEN>
HEADER x-chatsight-api: chatsightvoice

curl --location --request POST 'https://api.chatsight.ai/stream/tag' \
--header 'x-chatsight-api-auth: <YOUR_API_KEY>' \
--header 'x-chatsight-api: chatsightvoice' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url":"https://pizzastream.com/stream.m3u8",
    "convoId":"Pizza_Party_avb3Dfcf",
    "webhook":"https://pizzastream.com/webhooks/results"
}'

Key	Value	Description
url	STRING	The pre-signed, or publicly available URL to a media stream. If the source is a video, we encourage you to provide a URL to a low-quality version (360p and below), to reduce turn around times and avoid OOM issues.
convoId	STRING	The Conversation Identifier for this session. We encourage you to use a collision-safe naming system, like UUID. Using standard words without unique elements will OVERWRITE the existing entry.
webhook	STRING	Explain below, provide a valid HTTP `POST` endpoint to receive results by webhook additionally.
seedSentence	STRING	A UTF-8 string of a textual seed sentence to improve tagging recommendations.

Webhooks

Instead of polling the query endpoint described below, we offer a "one-shot" webhook feature. This means that upon the completion of the session, a single webhook POST request will be made against the target URL of your choosing.

Your target URL must return a response that is exactly a HTTP 200 OK response.

The webhook payload that would be sent to the endpoint is structured like this:

{
  "sender": "chatsight-webhooks",
  "addon": "ssiQuery",
  "payload": {
    "tags": "Fun,Relaxed", // The resulting tags (explained in "Query a Tagging Session").
    "undocumentedTags": false, // Tags returned, that are not documented, (explained in "Query a Tagging Session").
    "convoId": "pizza_stream" // Conversation Identifier.
  },
  "time": 1620487495836, // Time of the request, in MS.
  "hmac": "ZdEWroII9eiNmfb0qtp2lcMhsvhjBaoejR7lwiVQcoQ=" // HMAC.
}