Documentation

Quick Start API Reference WebSocket Protocol SDKs

WebSocket Protocol

Connect to the WebSocket URL returned when creating a session.

Client → Server Messages

audio

Send audio data (PCM16, 16kHz):

{
  "type": "audio",
  "seq": 1,
  "data": "base64-encoded-pcm16",
  "sampleRate": 16000
}

speech_start

Notify that user started speaking:

{ "type": "speech_start" }

speech_end

Notify that user stopped speaking:

{ "type": "speech_end" }

interrupt

Stop AI response (barge-in):

{ "type": "interrupt" }

Server → Client Messages

transcript

{
  "type": "transcript",
  "text": "Hello",
  "isFinal": true
}

response_text

{
  "type": "response_text",
  "text": "Hi there!",
  "isFinal": false
}

audio

{
  "type": "audio",
  "seq": 1,
  "data": "base64-encoded-pcm16"
}