> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zeroruntime.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Ultravox

> Python API reference for the ultravox realtime models plugin.

<Card title="Usage guide" icon="book" href="/plugins/realtime/ultravox" horizontal>
  Setup, environment variables, and Python/JavaScript/Go usage examples.
</Card>

## UltravoxRealtime

Realtime speech-to-speech integration for Ultravox.

Wraps an Ultravox model so it can be used as a full speech-to-speech
provider within the runtime. Configuration is supplied through an
`UltravoxLiveConfig` instance and resolved into a flat parameter
map for the runtime.

### Constructor

```python theme={null}
UltravoxRealtime(*, api_key: 'str | None' = None, config: 'UltravoxLiveConfig | None' = None, **kwargs)
```

<ParamField path="api_key" type="str | None">
  Ultravox API key. When omitted, the value of the `ULTRAVOX_API_KEY` environment variable is used.
</ParamField>

<ParamField path="config" type="UltravoxLiveConfig | None">
  Provider configuration. When omitted, a default `UltravoxLiveConfig` is used.
</ParamField>

### aclose

```python theme={null}
def aclose(self) -> 'None'
```

Release any resources held by the integration.

This implementation performs no work and exists so the integration
can be used interchangeably with providers that require teardown.

### cleanup

```python theme={null}
def cleanup(self) -> 'None'
```

Clean up the integration by delegating to `aclose`.

***

## UltravoxLiveConfig

### Fields

<ParamField path="model" type="str" default="fixie-ai/ultravox" />

<ParamField path="voice" type="Optional[str]" />

<ParamField path="language_hint" type="str" default="en" />

<ParamField path="temperature" type="Optional[float]" />

<ParamField path="max_duration" type="Optional[str]" />

<ParamField path="time_exceeded_message" type="Optional[str]" />

<ParamField path="input_sample_rate" type="int" default="48000" />

<ParamField path="output_sample_rate" type="int" default="24000" />

<ParamField path="client_buffer_size_ms" type="int" default="30000" />

<ParamField path="vad_turn_endpoint_delay_ms" type="Optional[int]" default="800" />

<ParamField path="vad_minimum_turn_duration_ms" type="Optional[int]" default="600" />

<ParamField path="vad_minimum_interruption_duration_ms" type="Optional[int]" />

<ParamField path="vad_frame_activation_threshold" type="Optional[float]" default="0.4" />

<ParamField path="first_speaker" type="Optional[str]" default="FIRST_SPEAKER_USER" />

<ParamField path="enable_greeting_prompt" type="bool" default="False" />

<ParamField path="base_url" type="Optional[str]" />