Session Methods
tts()
Generate speech from text.request
(TTSRequest), backend
(str, default “speech-1.5”)
Returns: Generator[bytes]
asr()
Transcribe audio to text.request
(ASRRequest)
Returns: ASRResponse
list_models()
List available voice models.page_size
, page_number
, title
, tag
, self_only
, author_id
, language
, sort_by
Returns: PaginatedResponse[ModelEntity]
get_model()
Get model details.model_id
(str)
Returns: ModelEntity
create_model()
Create a new voice model.title
, voices
, texts
, description
, visibility
, tags
, enhance_audio_quality
Returns: ModelEntity
update_model()
Update model metadata.model_id
, title
, description
, visibility
, tags
Returns: None
delete_model()
Delete a model.model_id
(str)
Returns: None
get_api_credit()
Check API credit balance.get_package()
Get subscription package details.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
ASRRequest
Speech-to-text parameters.audio
(bytes), language
(str), ignore_timestamps
(bool)
ReferenceAudio
Reference audio for voice cloning.audio
(bytes), text
(str)
Prosody
Speed and volume control.speed
(0.5-2.0), volume
(-20 to 20)
Response Classes
ASRResponse
Transcription result.ASRSegment
Timestamped text segment. Fields:text
(str), start
(float, seconds), end
(float, seconds)
ModelEntity
Voice model information. Fields:id
, title
, description
, visibility
, created_at
, updated_at
, tags
PaginatedResponse
Paginated list response. Fields:items
(list), total
(int), page_size
(int), page_number
(int)
APICreditEntity
API credit balance. Fields:balance
(float)
PackageEntity
Subscription package. Fields:name
(str), expires_at
(str)
WebSocket Classes
WebSocketSession
Synchronous WebSocket client.apikey
, base_url
, max_workers
(default 10)
AsyncWebSocketSession
Asynchronous WebSocket client.apikey
, base_url
Event Classes
StartEvent
Stream start event. Fields:event
(“start”), request
(TTSRequest)
TextEvent
Text chunk event. Fields:event
(“text”), text
(str)
CloseEvent
Stream close event. Fields:event
(“stop”)