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

# Fishaudio

> Python API reference for the fishaudio speech-to-text provider.

## FishAudioSTT

Realtime speech-to-text with Fish Audio's transcribe-stream-1, using your own Fish
Audio key. Server-side turn detection tells the user apart from noise and
backchannels.

Authenticates with FISH\_API\_KEY from your environment, or an explicit
`api_key`.

```python theme={null}
from zeroruntime.plugins import FishAudioSTT  # direct to the vendor, with your key
from zeroruntime.inference import FishAudioSTT  # same fields, through the gateway, no vendor key
```

### Fields

**model** `str` (default: UNSET)

Realtime transcription model. "transcribe-stream-1" (Preview) is the only one. Defaults to 'transcribe-stream-1'.

**turn\_detection** `Literal['auto', 'vad', 'manual']` (default: UNSET)

How a turn ends: "auto" lets Fish Audio judge when the user has finished, "vad" ends it on fixed silence, "manual" only on flush. Defaults to 'auto'.

**silence\_timeout\_ms** `int | None` (default: UNSET)

Silence that ends a turn, in milliseconds. Leave unset for the mode's default: 5000 in auto (a safety net), 700 in vad, 60000 in manual. Defaults to None (not set).

**terms** `list[str] | None` (default: UNSET)

Up to 100 names, products and jargon terms (32 characters each) to recognize, e.g. \["Fish Audio"]. Defaults to None (not set).

**enable\_preemptive\_generation** `bool` (default: UNSET)

Start the reply on Fish Audio's eager end-of-turn signal, about half a second before the turn is committed. Auto mode only; set False to wait for the committed transcript. Defaults to False.

**input\_sample\_rate** `int | None` (default: UNSET)

Override the detected input sample rate. Leave unset in normal use. Defaults to None (not set).

**input\_channels** `int | None` (default: UNSET)

Override the detected input channel count. Leave unset in normal use. Defaults to None (not set).

**base\_url** `str` (default: UNSET)

WebSocket endpoint of Fish Audio realtime speech-to-text. Change only for a proxy. Defaults to 'wss\://api.fish.audio/v1/asr/realtime'.

**interim\_results** `bool` (default: UNSET)

Set to True to also send live partial transcripts to the client. Defaults to False.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.