Client
Import and initialize the client:Text to Speech
convert()
Generate speech from text.request (TTSRequest), model? (Backends) Returns:
Promise<ReadableStream<Uint8Array>>
convertRealtime()
Realtime streaming TTS over WebSocket.request (TTSRequest with text: ""), textStream (AsyncIterable<string>), backend? (Backends) Returns:
RealtimeConnection (EventEmitter-like connection) emitting RealtimeEvents
Speech to Text
convert()
Transcribe audio to text.request (STTRequest) Returns:
STTResponse
Voices
search()
List/search available voice models.request? (ModelListRequest) Returns:
ModelListResponse
get()
Get model details.voiceId (string) Returns:
ModelEntity
ivc.create()
Create a new voice model from audio samples.request (ModelCreateRequest) Returns:
ModelEntity
update()
Update model metadata.voiceId (string), request (UpdateModelRequest) Returns:
UpdateVoiceResponse
delete()
Delete a model.voiceId (string) Returns:
DeleteVoiceResponse
User
get_api_credit()
Check API credit balance.APICreditResponse
get_package()
Get subscription package details.PackageResponse
Request Classes
TTSRequest
Text-to-speech parameters.text, reference_id, references, format, mp3_bitrate, opus_bitrate, sample_rate, prosody, latency, chunk_length, normalize, temperature, top_p
STTRequest
Speech-to-text parameters.audio, language?, ignore_timestamps?
ReferenceAudio
Reference audio for voice cloning.audio, text
Prosody
Speed and volume control.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 byconvertRealtime connections.
| Event | Meaning |
|---|---|
OPEN | Connection established |
AUDIO_CHUNK | Audio chunk received |
ERROR | Error occurred |
CLOSE | Connection closed |
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”)

