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

# SttModel

> A speech-to-text model that can transcribe audio.

## Constructor

```typescript
SttModel(): SttModel
```

### Returns

`SttModel`

## Properties

<ResponseField name={"name"} type={"string"} required>
  The wire-level model identifier sent in the request body.
</ResponseField>

## Methods

### availableAliases()

```typescript
availableAliases(): string[]
```

Every STT model alias accepted by `byAlias` on this machine, deduplicated
and sorted alphabetically. Use to discover what aliases the loaded config
(bundled defaults plus any user provider files) advertises.

#### Returns

`string[]`

### byAlias()

```typescript
byAlias(alias: string): SttModel
```

Resolve a model alias against the loaded config (e.g.
`"whisper_large_v3_turbo"`, `"whisper_large_v3"`, or any alias declared
by a user provider). Throws if the alias is unknown.

#### Parameters

<ResponseField name={"alias"} type={"string"} required />

#### Returns

`SttModel`

### checkAuth()

```typescript
checkAuth(): void
```

Check that the API key works. Throws if it doesn't.

Call right after creating the model so a bad key fails fast,
before any UI automation has had a chance to steal focus:

```ts
try { model.checkAuth() } catch { process.exit(1) }
```

### default()

```typescript
default(): SttModel
```

First STT model advertised by the first STT provider in the loaded
config. Throws if no provider in the loaded config advertises an STT
service.

#### Returns

`SttModel`

### transcribe()

```typescript
transcribe(audio: SamplesBuffer): string
```

Transcribe a single audio chunk and return the recognised text.

#### Parameters

<ResponseField name={"audio"} type={"SamplesBuffer"} required />

#### Returns

`string`

### whisperLargeV3()

```typescript
whisperLargeV3(): SttModel
```

Whisper Large V3 — highest accuracy. Convenience shim for the bundled
`whisper_large_v3` alias.

#### Returns

`SttModel`

### whisperLargeV3Turbo()

```typescript
whisperLargeV3Turbo(): SttModel
```

Whisper Large V3 Turbo — fast, slightly less accurate. Convenience
shim for the bundled `whisper_large_v3_turbo` alias.

#### Returns

`SttModel`