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

# Deepgram

> TypeScript API reference for the deepgram speech-to-text provider.

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

## DeepgramSTT

Create an STT instance configured for Deepgram.

```ts theme={null}
import { DeepgramSTT } from '@zeroruntime/js-sdk/inference';  // same fields, through the gateway, no vendor key
import { DeepgramSTT } from '@zeroruntime/js-sdk/plugins';  // direct to the vendor, with your key
```

### Options

<ParamField path="model" type="string" default="nova-2" />

<ParamField path="language" type="string" default="en-US" />

<ParamField path="interim_results" type="boolean" default="true" />

<ParamField path="punctuate" type="boolean" default="true" />

<ParamField path="smart_format" type="boolean" default="true" />

<ParamField path="sample_rate" type="number" default="48000" />

<ParamField path="endpointing" type="number" default="50" />

<ParamField path="filler_words" type="boolean" default="true" />

<ParamField path="keywords" type="string[] | null" default="null" />

<ParamField path="keyterm" type="string[] | null" default="null" />

<ParamField path="profanity_filter" type="boolean" default="false" />

<ParamField path="numerals" type="boolean" default="false" />

<ParamField path="tag" type="string | string[] | null" default="null" />

<ParamField path="enable_diarization" type="boolean" default="false" />

<ParamField path="base_url" type="string" default="wss://api.deepgram.com/v1/listen" />

***

## DeepgramSTTV2

Initialize the Deepgram STT plugin (Flux / v2 API).

```ts theme={null}
import { DeepgramSTTV2 } from '@zeroruntime/js-sdk/plugins';  // direct to the vendor, with your key
```

### Options

<ParamField path="model" type="string" default="flux-general-en" />

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

<ParamField path="target_sample_rate" type="number" default="16000" />

<ParamField path="eager_eot_threshold" type="number" default="0.6" />

<ParamField path="eot_threshold" type="number" default="0.8" />

<ParamField path="eot_timeout_ms" type="number" default="7000" />

<ParamField path="keyterm" type="string[] | null" default="null" />

<ParamField path="language_hint" type="string[] | null" default="null" />

<ParamField path="tag" type="string | string[] | null" default="null" />

<ParamField path="base_url" type="string" default="wss://api.deepgram.com/v2/listen" />

<ParamField path="enable_preemptive_generation" type="boolean" default="false" />
