| header | object | (required) |
| header.action | string | (required) The command type. Set to run-task. |
| header.task_id | string | (required) A client-generated task ID in UUID format. This ID correlates subsequent events and must match the task_id in the continue-task and finish-task commands. |
| header.streaming | string | (required) Set to duplex. |
| payload | object | (required) |
| payload.task_group | string | (required) The task group. Set to audio. |
| payload.task | string | (required) The task type. Set to tts. |
| payload.function | string | (required) The function type. Set to SpeechSynthesizer. |
| payload.model | string | (required) The model name. |
| payload.input | object | (required) Set to an empty object {}. Send the text to synthesize through the continue-task command. |
| payload.parameters | object | (required) Speech synthesis parameters. |
| payload.parameters.text_type | string | (required) Set to PlainText. |
| payload.parameters.voice | string | (required) The voice used for speech synthesis. - System voices: See CosyVoice Voice list
- Cloned voices: Custom voices created through voice cloning
- Custom voices: Custom voices created through voice design
|
| payload.parameters.format | string | (optional) The audio encoding format. Valid values: |
| payload.parameters.sample_rate | integer | (optional) The audio sample rate in Hz. Valid values: 8000, 16000, 22050 (default), 24000, 44100, 48000. |
| payload.parameters.volume | integer | (optional) The volume level. Default value: 50. Valid values: [0, 100]. |
| payload.parameters.rate | float | (optional) The speech rate. Default value: 1.0. Valid values: [0.5, 2.0]. |
| payload.parameters.pitch | float | (optional) The pitch. Default value: 1.0. Valid values: [0.5, 2.0]. |
| payload.parameters.bit_rate | integer | (optional) The audio bit rate in kbps. When the audio format is mp3 or opus, use bit_rate to adjust the bit rate. Default value: 32. Valid values: [6, 510]. |
| payload.parameters.enable_ssml | boolean | (optional) Specifies whether to enable SSML. Default value: false. When set to true, only one continue-task command is allowed. For the SSML usage restrictions (supported models, voices, and APIs), see Limitations. |
| payload.parameters.word_timestamp_enabled | boolean | (optional) Specifies whether to enable word-level timestamps. Default value: false. Available only in streaming output mode. Supported voices: cloned voices of cosyvoice-v3.5-plus, cosyvoice-v3.5-flash, cosyvoice-v3-flash, cosyvoice-v3-plus, cosyvoice-v2, and system voices marked as supported in CosyVoice Voice list. Cloned voices of other models do not support this feature. |
| payload.parameters.seed | integer | (optional) A random seed for controlling variation in the synthesis output. When the model version, text, voice, and other parameters are unchanged, using the same seed produces identical results. Default value: 0. Valid values: [0, 65535]. |
| payload.parameters.language_hints | array[string] | (optional) Tip: - This parameter is an array, but the current version only processes the first element. Pass a single value. - This parameter specifies the target language for speech synthesis. It's unrelated to the language of the audio sample used in voice cloning. To set the source language for a cloning task, see the voice cloning API reference.
Specifies the target language for speech synthesis to improve output quality. When digit pronunciation, abbreviation expansion, symbol reading, or minority-language synthesis doesn't meet expectations, use this parameter. For example: - Unexpected digit pronunciation: "hello, this is 110" is read as "hello, this is one zero" instead of the expected Chinese pronunciation
- Inaccurate symbol pronunciation: "@" is read as the Chinese equivalent instead of "at"
- Poor minor language synthesis quality with unnatural results
- zh: Chinese
- en: English
- fr: French
- de: German
- ja: Japanese
- ko: Korean
- ru: Russian
- pt: Portuguese
- th: Thai
- id: Indonesian
- vi: Vietnamese
- es: Spanish
- it: Italian
- ms: Malaysian
- fil: Filipino
- ar: Arabic
|
| payload.parameters.instruction | string | (optional) Sets an instruction to control dialect, emotion, or voice character during synthesis. For detailed usage, see Instruction control. |
| payload.parameters.enable_aigc_tag | boolean | (optional) Specifies whether to embed an AIGC watermark in the generated audio. When set to true, the watermark is embedded in audio files of supported formats (wav/mp3/opus). Default value: false. Note: Only cosyvoice-v3-flash, cosyvoice-v3-plus, cosyvoice-v2 support this feature. |
| payload.parameters.aigc_propagator | string | (optional) Sets the ContentPropagator field in the AIGC watermark, identifying the content propagator. Takes effect only when enable_aigc_tag is true. Default value: QwenCloud account ID. Note: Only cosyvoice-v3-flash, cosyvoice-v3-plus, cosyvoice-v2 support this feature. |
| payload.parameters.aigc_propagate_id | string | (optional) Sets the PropagateID field in the AIGC watermark, uniquely identifying a specific propagation action. Takes effect only when enable_aigc_tag is true. Default value: The request ID of the current speech synthesis request. Note: Only cosyvoice-v3-flash, cosyvoice-v3-plus, cosyvoice-v2 support this feature. |
| payload.parameters.hot_fix | object | (optional) Configures pronunciation corrections and text replacements applied before synthesis. Note: This feature isn't supported by cosyvoice-v2. Parameters: - pronunciation: Custom pronunciation. Specifies pinyin annotations for words to correct inaccurate default pronunciations.
- replace: Text replacement. Replaces specified words with target text before synthesis. The replaced text is used as the actual synthesis input.
Example: |
| payload.parameters.enable_markdown_filter | boolean | (optional) Note: Only cloned voices of cosyvoice-v3-flash support this feature. Specifies whether to enable Markdown filtering. When enabled, the system automatically strips Markdown markup symbols from the input text before synthesis, preventing them from being read aloud. Default value: false. Valid values: - true: Enable Markdown filtering
- false: Disable Markdown filtering
|