Get the current status of a running moderation request.
GET https://api.chatsight.ai/stream?convoid=<convoId>
HEADER x-chatsight-api-auth: <API-TOKEN>
HEADER x-chatsight-api: chatsightvoice
curl --location --request GET 'https://api.chatsight.ai/stream?convoid=pizzaChatRoom' \
--header 'x-chatsight-api: chatsightvoice' \
--header 'x-chatsight-api-auth: <YOUR_API_KEY>' \
Response
Responses are formatted as an array with three elements, a Boolean success indicator, the moderation status, and an error status element (null if there is no error).
[
true,
{
"convoId": "pizzaChatRoom",
"error": false,
"instanceId": "...",
"metadata": {
"operationId": "...",
"stopReason": "..."
},
"resourceClaim": "...",
"running": true,
"state": "transcribing",
"type": "job",
"uri": "https://storage.googleapis.com/public-warning-public/dragons-flac-16hz.flac"
},
null
]
Key | Value | Description |
---|---|---|
convoId | STRING | The conversation ID |
error | BOOLEAN | Boolean representing if an error has occurred in the moderation lifecycle. |
instanceId | STRING | The instance ID the resource is deployed on. |
metadata.operationId | STRING | The operation ID. Can be used to restart an interrupted moderation request. |
metadata.stopReason | STRING | A Stop code that informs you on what caused the request to stop. |
resourceClaim | STRING | An ID that ties this operation to a resource. |
running | STRING | Boolean representing the running status of the moderation lifecycle. |
state | STRING | A string representation of the current state of the moderation lifecycle. See a breakdown below for every type of status. |
type | STRING | The type of request, possible values are "job" and "stream". If the request is fetching media from a URL that is not live, this would be a "job" request. |
uri | STRING | The URI/URL that media is being fetched from. |