Streaming Speech-to-Text

GET /v2/realtime/ws

Streaming Speech-to-Text

cURL

curl --request GET \
  --url wss://api.assemblyai.com/v2/realtime/ws

Messages

UklGRtjIAABXQVZFZ

Authentication · string

Authentication string for the request.

sample_rate · integer · required

The sample rate of the streamed audio.

word_boost · string

Add up to 2500 characters of custom vocabulary. The parameter value must be a JSON encoded array of strings. The JSON must be URL encoded like other query string parameters.

encoding · enum · default: "pcm_s16le"

The encoding of the audio data. Allowed values:

pcm_s16le pcm_mulaw

token · string

Authenticate using a generated temporary token.

disable_partial_transcripts · boolean · default: "false"

Set to true to not receive partial transcripts.

enable_extra_session_information · boolean · default: "false"

Set to true to receive the SessionInformation message before the session ends.

Messages

UklGRtjIAABXQVZFZ