For AI agents: a documentation index is available at /llms.txt. Markdown versions of all pages can be requested by appending `.md` to the URL, or by setting the `Accept` header to `text/markdown`.
Skip to main content
Speech to TextAgent STT

Agent STT configuration

Configuration is passed in StartRecognition and is split across two levels of the payload: audio_format at the top level, and transcription_config.

Agent STT is in Preview.

Audio format

Only pcm_s16le at 8000 Hz or 16000 Hz is supported. Other encodings such as pcm_f32le and mulaw, and other sample rates such as 44100 Hz, may be silently accepted by the API but will not produce correct output.

FieldNotes
typeMust be raw
encodingMust be pcm_s16le (16-bit signed little-endian PCM)
sample_rateMust be 8000 or 16000

For example:

{ "type": "raw", "encoding": "pcm_s16le", "sample_rate": 16000 }

Transcription config

The transcription_config object accepts the following fields.

FieldDefaultNotes
languageenAll supported languages
output_localeOutput locale, for example en-US
additional_vocabCustom vocabulary entries
punctuation_overridesCustom punctuation rules
domainDomain-specific tuning, for example medical
enable_entitiesfalseEntity detection
enable_partialstrueEmit partial segments during speech
diarizationspeakerSpeaker diarization; set to none to disable
volume_thresholdMinimum audio volume to process

For the languages available, see Transcription languages. For the medical domain, see Medical domain.

Speaker diarization config

The transcription_config.speaker_diarization_config object accepts the following fields. All of them require diarization to be set to speaker.

FieldDefaultNotes
max_speakersMaximum number of speakers to track
speaker_sensitivitySensitivity of speaker separation
prefer_current_speakerBias toward the most recently active speaker
known_speakersPre-enrolled speaker identifiers for cross-session recognition

For how to obtain and use known_speakers, see Speaker focus and identification.

Unsupported fields

The following fields are rejected if present in an agent STT request.

FieldNotes
translation_configNot supported on agent endpoints
audio_events_configNot supported on agent endpoints