| text |
Text to synthesize. Required. Max 20,000 Unicode characters. Supports plain text, SSML (set enable_ssml to true), and LaTeX formulas per Alibaba documentation. |
string |
是 |
- |
| voice |
System or cloned voice ID for cosyvoice-v3-flash. Full official CosyVoice voice catalog (use only voices listed under cosyvoice-v3-flash for system voices): https://help.aliyun.com/zh/model-studio/cosyvoice-voice-list . Do not mix Plus and Flash system voices. Cloned or designed voice IDs are also accepted. Sample system voices (not exhaustive): longanyang, longhuhu_v3, longpaopao_v3, longshanshan_v3, longjiaxin_v3, loongkyong_v3, longfei_v3, longyingxiao_v3, longyingxun_v3, longxiaochun_v3, longantai_v3, longmiao_v3, longjiqi_v3, longanran_v3, longshuo_v3. |
string |
是 |
- |
| aigc_propagate_id |
AIGC PropagateID. Only effective when enable_aigc_tag is true. |
string |
否 |
- |
| aigc_propagator |
AIGC ContentPropagator. Only effective when enable_aigc_tag is true. |
string |
否 |
- |
| hot_fix |
Text hot-fix before synthesis. Optional object with pronunciation (custom pinyin for Chinese words) and replace (text substitution) arrays per Alibaba HTTP API. |
object |
否 |
- |
| instruction |
Optional speaking-style instruction for Instruct-capable system voices. Enforced weighted length ≤100 (CJK ideographs / Han count as 2; other characters count as 1). Alibaba requires fixed Chinese formats from the CosyVoice voice list for system voices. |
string |
否 |
- |
| bit_rate |
Audio bit rate in kbps. Optional. Range 6 to 510. Only supported when format is opus; do not use for mp3, pcm, or wav. |
integer |
否 |
- |
| enable_aigc_tag |
Embed AIGC invisible watermark into wav/mp3/opus output. Supported on cosyvoice-v3-plus and cosyvoice-v3-flash. |
boolean |
否 |
true, false |
| enable_ssml |
Whether to parse text as SSML. Default false. When true, text must follow Alibaba CosyVoice SSML rules. |
boolean |
否 |
true, false |
| format |
Audio encoding format. Default mp3. |
string |
否 |
mp3, pcm, wav, opus |
| language_hint |
Target language hint for pronunciation (numbers, symbols, minor languages). |
string |
否 |
zh, en, fr, de, ja, ko, ru, pt, th, id, vi, es, it, ms, fil, ar |
| pitch |
Pitch multiplier. Default 1.0. Range 0.5 (lower) to 2.0 (higher). |
number |
否 |
- |
| rate |
Speech rate multiplier. Default 1.0. Range 0.5 (slow) to 2.0 (fast). |
number |
否 |
- |
| sample_rate |
Audio sample rate in Hz. Default 22050. |
integer |
否 |
8000, 16000, 22050, 24000, 44100, 48000 |
| seed |
Random seed for reproducible synthesis when text, voice, and other parameters are identical. Default 0. Range 0 to 65535. |
integer |
否 |
- |
| volume |
Output volume. Default 50. Range 0 (silent) to 100 (maximum). |
integer |
否 |
- |
| enable_markdown_filter |
Filter Markdown markers before synthesis. Only supported on cosyvoice-v3-flash with cloned voices. |
boolean |
否 |
true, false |