Configuration
To enable live transcripts, you need to configure thelive_transcription_required field when creating a bot.
Webhook Configuration
WebSocket Configuration
Live Audio Streaming
For live audio streaming, configure thelive_audio_required field:
Webhook Payload Format
When using webhooks, your endpoint will receive POST requests with the following payload structure:Payload Fields
| Field | Type | Description |
|---|---|---|
speakerName | string | Name or identifier of the speaker |
timestamp | string | ISO 8601 timestamp when the transcript was generated |
transcript | string | The transcribed text for this segment |
words | array | Array of word-level details with timing and confidence scores |
Word Object Fields
| Field | Type | Description |
|---|---|---|
word | string | The original word |
start | number | Start time of the word in seconds |
end | number | End time of the word in seconds |
confidence | number | Confidence score for the word (0-1) |
speaker | string | Speaker identifier for the word |
punctuated_word | string | Word with punctuation |
speech_confidence | number | Speech confidence score for the word (0-1) |
WebSocket Message Format
When using WebSocket connections, you’ll receive messages in the same format as the webhook payload:Example Bot Creation with Live Transcripts
Webhook Endpoint Requirements
Your webhook endpoint should:- Accept POST requests
- Return a 200 status code to acknowledge receipt
- Handle the payload format described above
- Be publicly accessible (HTTPS required)
- Respond within 5 seconds
WebSocket Connection Requirements
Your WebSocket server should:- Accept WSS (secure WebSocket) connections
- Handle the message format described above
- Maintain persistent connections
- Implement proper error handling and reconnection logic
Error Handling
If your webhook endpoint is unavailable or returns an error:- The system will retry failed deliveries
- Failed deliveries are logged for debugging
- Consider implementing a fallback mechanism
Security Considerations
- Use HTTPS for webhook URLs
- Use WSS for WebSocket connections
- Implement authentication if needed
- Validate incoming payloads
- Rate limit your endpoints to prevent abuse