API Documentation
Schemas
- Egress
- Export
- Websocket
- Webhook
- HTTP Gateway
- Errors
Authentication
Gateway
Webhooks
Export
Stream configuration
Processor
Audio intelligence response
Broad response aggregating audio intelligence data
Transcription response
Transcription text
Transcription words
The word. It may contain white characters and punctuation marks. All the words can be joined without any space to form the transcription.
The start time of the word in milliseconds
The end time of the word in milliseconds
The confidence of the word
The language of the word
Utterances diarized by speakers in the audio
List of speaker ids. The length will always be at least 1. In case of overlapping, the array may contain multiple speakers
Indicates and overlap
The channel name in the input audio the utterance associated to
The start time of the current speaker(s) turn in milliseconds
The end time of the current speaker(s) turn in milliseconds
Transcription text
Transcription words
The word. It may contain white characters and punctuation marks. All the words can be joined without any space to form the transcription.
The start time of the word in milliseconds
The end time of the word in milliseconds
The confidence of the word
The language of the word
Ask anything response for each given prompt. The key is the prompt id, and the value is the response.
Ask Anything response
The id of the prompt used to generate this response
The response content
LLM response format specification used for the current prompt. 'null' means either no custom format was specified or it was configured to be excluded.
Sentiment analysis response
Sentiment analysis segments
The analyzed text
The sentiment of the text
negative, neutral, positive The channel number of the analyzed text
The start time in milliseconds of the analyzed text
The end time in milliseconds of the analyzed text
The sentiment score of the analyzed text between -1 and 1, where -1 is negative, 0 is neutral and 1 is positive
Sentiment Analysis Summary DTO
The channel number of the analyzed text
The channel number of the analyzed text
The number of negative sentiment
The number of positive sentiment
The number of neutral sentiment
The average sentiment score
The sentiment of the text
negative, neutral, positive The number of negative sentiment
The number of positive sentiment
The number of neutral sentiment
The average sentiment score
The sentiment of the text
negative, neutral, positive {
"transcription": {
"text": "<string>",
"words": [
{
"word": "<string>",
"start": 123,
"end": 123,
"confidence": 123,
"language": "<string>",
"metadata": {}
}
]
},
"utterances": [
{
"speakerIds": [
"<string>"
],
"overlap": true,
"channel": "<string>",
"start": 123,
"end": 123,
"text": "<string>",
"words": [
{
"word": "<string>",
"start": 123,
"end": 123,
"confidence": 123,
"language": "<string>",
"metadata": {}
}
]
}
],
"summary": {
"content": "<string>"
},
"askAnything": {},
"sentimentAnalysis": {
"segments": [
{
"text": "<string>",
"sentiment": "negative",
"channel": 123,
"startTime": 123,
"endTime": 123,
"score": 123
}
],
"summary": {
"channels": [
{
"channel": 123,
"negativeCount": 123,
"positiveCount": 123,
"neutralCount": 123,
"averageScore": 123,
"sentiment": "negative"
}
],
"negativeCount": 123,
"positiveCount": 123,
"neutralCount": 123,
"averageScore": 123,
"sentiment": "negative"
}
}
}