Interface: SynthesizeSpeechRequest
@kortexya/reasoninglayer / SynthesizeSpeechRequest
Interface: SynthesizeSpeechRequest
Section titled “Interface: SynthesizeSpeechRequest”Defined in: src/types/speech.ts:117
Body of POST /api/v1/speech/synthesize — synthesize speech.
Properties
Section titled “Properties”description?
Section titled “description?”
optionaldescription?:string|null
Defined in: src/types/speech.ts:121
VoiceDesign: describe the desired voice in words. Optional.
engine?
Section titled “engine?”
optionalengine?:string|null
Defined in: src/types/speech.ts:123
Engine to render with ("qwen3-tts", "chatterbox"). Defaults to "qwen3-tts". Optional.
format?
Section titled “format?”
optionalformat?:string|null
Defined in: src/types/speech.ts:125
Output encoding: "wav" (default), "pcm_s16le", "pcm_f32le". Optional.
instruction?
Section titled “instruction?”
optionalinstruction?:string|null
Defined in: src/types/speech.ts:127
Style instruction accompanying speaker. Optional.
language?
Section titled “language?”
optionallanguage?:string|null
Defined in: src/types/speech.ts:129
Language hint. Optional.
maxDurationS?
Section titled “maxDurationS?”
optionalmaxDurationS?:number|null
Defined in: src/types/speech.ts:131
Cap on generated audio length in seconds. Optional.
refAudioBase64?
Section titled “refAudioBase64?”
optionalrefAudioBase64?:string|null
Defined in: src/types/speech.ts:119
Ad-hoc zero-shot clone from a base64 reference clip. Optional.
refText?
Section titled “refText?”
optionalrefText?:string|null
Defined in: src/types/speech.ts:133
Transcript of refAudioBase64, enabling the higher-quality ICL clone path. Optional.
optionalseed?:number|null
Defined in: src/types/speech.ts:135
Sampling seed; fixing it makes synthesis reproducible. Optional.
speaker?
Section titled “speaker?”
optionalspeaker?:string|null
Defined in: src/types/speech.ts:137
A checkpoint preset speaker name (see listEngines). Optional.
text:
string
Defined in: src/types/speech.ts:139
Text to speak.
voiceId?
Section titled “voiceId?”
optionalvoiceId?:string|null
Defined in: src/types/speech.ts:141
A voice enrolled through enrollVoice, by its OSFKB id. Optional.