Skip to main content

Soniox STT plugin guide

How to use the Soniox STT plugin for LiveKit Agents.

Available in
Python

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:

pip install livekit-plugins-soniox

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.

from livekit.plugins import soniox
session = AgentSession(
stt=soniox.STT(),
# ... llm, tts, etc.
)

Parameters

This section describes some of the available parameters. See the plugin reference for a complete list of all available parameters.

modelstringOptionalDefault: stt-rt-preview

The Soniox STT model to use. See documentation for a complete list of supported models.

contextstringOptionalDefault: None

Free-form text that provides additional context or vocabulary to bias transcription towards domain-specific terms.

enable_language_identificationbooleanOptionalDefault: true

When 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.