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

# Openai

> Python API reference for the openai text-to-speech plugin.

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

## OpenAITTS

OpenAI Text-to-Speech provider plugin.

Wraps the OpenAI TTS API to synthesize speech from text, supporting both
streaming and non-streaming output.  The default model (`gpt-4o-mini-tts`)
offers prompt-driven voice control: accent, emotion, intonation, and speed
can all be shaped via a plain-English voice instruction in addition to the
`speed` multiplier.

### Constructor

```python theme={null}
OpenAITTS(*, api_key: 'str | None' = None, voice: 'str' = 'ash', model: 'OpenAITTSModel | str' = 'gpt-4o-mini-tts', sample_rate: 'int' = 24000, speed: 'Optional[float]' = None, stream: 'bool' = True, **kwargs) -> 'None'
```

<ParamField path="api_key" type="str | None">
  OpenAI API key.  Falls back to the `OPENAI_API_KEY` environment variable when `None`.
</ParamField>

<ParamField path="voice" type="str" default="ash">
  Built-in voice name to use for synthesis.  Defaults to `"ash"`.  Available voices: `alloy`, `ash`, `ballad`, `cedar`, `coral`, `echo`, `fable`, `marin`, `nova`, `onyx`, `sage`, `shimmer`, `verse` `marin` and `cedar` are recommended for the highest quality. Older models (`tts-1`, `tts-1-hd`) support only `alloy`, `ash`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, and `shimmer`.
</ParamField>

<ParamField path="model" type="OpenAITTSModel | str" default="gpt-4o-mini-tts">
  TTS model identifier.  Defaults to `"gpt-4o-mini-tts"`. Options: `"gpt-4o-mini-tts"`: newest, most capable; supports prompt-driven voice control (emotion, accent, intonation). `"tts-1"`: lower latency, reduced quality. `"tts-1-hd"`: higher quality, increased latency.
</ParamField>

<ParamField path="sample_rate" type="int" default="24000">
  Output audio sample rate in Hz.  Defaults to `24000`.
</ParamField>

<ParamField path="speed" type="Optional[float]">
  Speaking speed multiplier.  `None` uses the provider default (1.0).  Range is 0.25 – 4.0.
</ParamField>

<ParamField path="stream" type="bool" default="True">
  When `True` (default), audio is returned as a streaming response; `False` requests the full audio before playback.
</ParamField>

### aclose

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

Release any resources held by the provider.

### emit

```python theme={null}
def emit(self, event: 'T', *args: 'Any') -> 'None'
```

Emit an event, invoking all registered handlers with the given arguments.

Handlers are called in registration order. Coroutine handlers are
scheduled on the running event loop. If the emitter is closed, the call
is a no-op.

<ParamField path="event" type="T" required>
  The event to emit.
</ParamField>

### interrupt

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

Interrupt and cancel the current synthesis for the active session, if any.

### off

```python theme={null}
def off(self, event: 'T', callback: 'Callable[..., Any]') -> 'None'
```

Remove a previously registered handler for an event.

If the handler is not registered for the event, the call is a no-op.

<ParamField path="event" type="T" required>
  The event the handler was registered for.
</ParamField>

<ParamField path="callback" type="Callable[..., Any]" required>
  The handler to remove.
</ParamField>

### on

```python theme={null}
def on(self, event: 'T', callback: 'Callable[..., Any] | None' = None) -> 'Callable[..., Any]'
```

Register a handler for an event.

Can be used directly by passing a callback, or as a decorator when
`callback` is omitted.

<ParamField path="event" type="T" required>
  The event to listen for.
</ParamField>

<ParamField path="callback" type="Callable[..., Any] | None">
  The handler to invoke when the event is emitted. If `None`, a decorator is returned that registers the decorated function.
</ParamField>

<ResponseField name="returns" type="Callable[..., Any]">
  The registered callback when `callback` is provided, otherwise a decorator that registers and returns the function it wraps.
</ResponseField>

### on\_first\_audio\_byte

```python theme={null}
def on_first_audio_byte(self, callback: "'Callable[[int, int], Awaitable[None] | None]'") -> 'None'
```

Register the callback invoked when the first audio byte is produced.

<ParamField path="callback" type="'Callable[[int, int], Awaitable[None] | None]'" required>
  A callable, optionally async, invoked with synthesis timing information when the first audio byte is emitted.
</ParamField>

### synthesize

```python theme={null}
def synthesize(self, text: 'Any', **kwargs: 'Any') -> 'None'
```

Synthesize the given text into speech.

Implementations should convert the text to audio. The default behavior
forwards the text to the active session for playback when one is present.

<ParamField path="text" type="Any" required>
  The text to synthesize; coerced to a string if needed.
</ParamField>

***

## OpenAITTSModel

```python theme={null}
OpenAITTSModel = typing.Literal['gpt-4o-mini-tts', 'tts-1', 'tts-1-hd']
```