Overview
This plugin allows you to use Soniox as an STT provider for your voice agents.
Quick reference
This section provides a quick reference for the Soniox STT plugin. For more information, see Additional resources.
Installation
Install the plugin from PyPI:
uv add "livekit-agents[soniox]~=1.3"
Authentication
The Soniox plugin requires an API key from the Soniox console.
Set SONIOX_API_KEY in your .env file.
Usage
Use Soniox STT in an AgentSession or as a standalone transcription service. For example, you can use this STT in the Voice AI quickstart.
Set STT options for Soniox using the params argument:
from livekit.plugins import sonioxsession = AgentSession(stt=soniox.STT(params=soniox.STTOptions(model="stt-rt-v3",language_hints=["en"])),# ... llm, tts, etc.)
Parameters
The soniox.STT constructor takes an STTOptions object as the params argument. This section describes some of the available options. See the STTOptions reference for a complete list.
stringOptionalDefault: stt-rt-v3The Soniox STT model to use. See documentation for a complete list of supported models.
stringOptionalDefault: NoneFree-form text that provides additional context or vocabulary to bias transcription towards domain-specific terms.
booleanOptionalDefault: trueWhen true, the Soniox attempts to identify the language of the input audio.
Additional resources
The following resources provide more information about using Soniox with LiveKit Agents.