Skip to main content

Client

Import and initialize the client:

Text to Speech

convert()

Generate speech from text.
Parameters: request (TTSRequest), model? (Backends)
Returns: Promise<ReadableStream<Uint8Array>>

convertRealtime()

Realtime streaming TTS over WebSocket.
Parameters: request (TTSRequest with text: ""), textStream (AsyncIterable<string>), backend? (Backends)
Returns: RealtimeConnection (EventEmitter-like connection) emitting RealtimeEvents

Speech to Text

convert()

Transcribe audio to text.
Parameters: request (STTRequest)
Returns: STTResponse

Voices

List/search available voice models.
Parameters: request? (ModelListRequest)
Returns: ModelListResponse

get()

Get model details.
Parameters: voiceId (string)
Returns: ModelEntity

ivc.create()

Create a new voice model from audio samples.
Parameters: request (ModelCreateRequest)
Returns: ModelEntity

update()

Update model metadata.
Parameters: voiceId (string), request (UpdateModelRequest)
Returns: UpdateVoiceResponse

delete()

Delete a model.
Parameters: voiceId (string)
Returns: DeleteVoiceResponse

User

get_api_credit()

Check API credit balance.
Returns: APICreditResponse

get_package()

Get subscription package details.
Returns: PackageResponse

Request Classes

TTSRequest

Text-to-speech parameters.
Fields: text, reference_id, references, format, mp3_bitrate, opus_bitrate, sample_rate, prosody, latency, chunk_length, normalize, temperature, top_p

STTRequest

Speech-to-text parameters.
Fields: audio, language?, ignore_timestamps?

ReferenceAudio

Reference audio for voice cloning.
Fields: audio, text

Prosody

Speed and volume control.
Fields: speed (0.5–2.0), volume (-20 to 20)

Backends

The backend model to use.

Response Classes

STTResponse

Transcription result.

ASRSegment

Timestamped text segment. Fields: text (string), start (number, seconds), end (number, seconds)

ModelEntity

Voice model information. Fields: _id, title, description, visibility, created_at, updated_at, tags

ModelListResponse

List response for voices. Fields: items (ModelEntity[]), total (number)

APICreditResponse

API credit information. Fields: _id (string), user_id (string), credit (string), created_at (string), updated_at (string), has_phone_sha256 (boolean), has_free_credit? (boolean)

PackageResponse

Subscription package details. Fields: user_id (string), type (string), total (number), balance (number), created_at (string), updated_at (string), finished_at (string)

WebSocket Classes

RealtimeEvents

Events emitted by convertRealtime connections.

Event Classes

StartEvent

Stream start event. Fields: event (“start”), request (TTSRequest)

TextEvent

Text chunk event. Fields: event (“text”), text (string)

FlushEvent

Flush text chunks event. Fields: event (“flush”)

CloseEvent

Stream close event. Fields: event (“stop”)

Exceptions

FishAudioError

Generic error with status code, body, rawResponse.

FishAudioTimeoutError

Connection timeout error.