assistant-ui logo/Docs/API Reference
Voice

Speech and Dictation

Connect speech synthesis and dictation adapters to assistant-ui voice and composer workflows.

API Reference

DictationAdapter

DictationAdapter
listen : () => DictationAdapter.Session

disableInputDuringDictation ?: boolean

DictationState

DictationState
status : DictationAdapter.Status

type : "starting" | "running"

transcript ?: string

inputDisabled ?: boolean

SpeechSynthesisAdapter

SpeechSynthesisAdapter
speak : (text: string) => SpeechSynthesisAdapter.Utterance

WebSpeechDictationAdapter

WebSpeechDictationAdapter
constructor ?: (options: { language?: string; continuous?: boolean; interimResults?: boolean; } = {}) => WebSpeechDictationAdapter

static isSupported ?: () => boolean

listen ?: () => DictationAdapter.Session

WebSpeechSynthesisAdapter

WebSpeechSynthesisAdapter
speak ?: (text: string) => SpeechSynthesisAdapter.Utterance