Skip to main content

CosyVoice HTTP API

API HTTP sintesis ucapan non-real-time CosyVoice, mencakup panggilan non-streaming dan SSE, parameter permintaan, serta bidang respons.

Endpoint

Ganti YOUR_WORKSPACE_ID dengan ID ruang kerja wilayah tersebut dan gunakan kunci API dari wilayah yang sama.
  • Tiongkok (Beijing)
POST https://YOUR_WORKSPACE_ID.cn-beijing.maas.aliyuncs.com/api/v1/services/audio/tts/SpeechSynthesizer

Header permintaan

ParameterJenisWajibDeskripsi
AuthorizationstringWajibToken autentikasi dalam format Bearer <your_api_key>.
Content-TypestringWajibTetapkan ke application/json.
X-DashScope-SSEstringOpsionalTetapkan ke enable untuk keluaran streaming. Jika tidak disertakan, hasil lengkap dikembalikan.

Contoh panggilan

  • Non-streaming
  • Streaming
curl -X POST "https://YOUR_WORKSPACE_ID.cn-beijing.maas.aliyuncs.com/api/v1/services/audio/tts/SpeechSynthesizer" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "cosyvoice-v3-flash",
  "input": {
    "text": "我家的后面有一个很大的花园。",
    "voice": "longanyang",
    "format": "wav",
    "sample_rate": 24000
  }
}'
Satu peristiwa SSE dapat memuat beberapa baris data:. Gabungkan seluruh baris data: per peristiwa sebelum mengurai JSON. Dekode Base64 dan gabungkan potongan audio sesuai urutan peristiwa. Bingkai akhir memiliki output.finish_reason=stop dan mengembalikan URL audio lengkap.

Isi permintaan

ParameterJenisWajibDefaultDeskripsi
modelstringWajib—ID model sintesis ucapan. Lihat model dan wilayah pada Sintesis ucapan non-real-time.
inputobjectWajib—Objek parameter masukan.
input.textstringWajib—Teks yang akan disintesis. Untuk SSML, tetapkan enable_ssml=true. LaTeX tidak memerlukan pengaturan tambahan. Lihat SSML dan LaTeX untuk cakupan, tag, dan sintaks.
input.voicestringWajib—ID suara. Lihat daftar suara untuk suara sistem. Buat suara kustom melalui kloning suara atau desain suara, lalu gunakan model tujuan yang terikat.
input.formatstringOpsionalmp3Pengodean audio. Nilai: mp3, pcm, wav, opus.
input.sample_rateintegerOpsional22050Laju sampel audio dalam Hz. Nilai: 8000, 12000, 16000, 22050, 24000, 44100, 48000. Jika format=opus, hanya 8000, 12000, 16000, 24000, 48000 yang didukung.
input.volumeintegerOpsional50Volume. Rentang: [0, 100].
input.ratefloatOpsional1.0Kecepatan berbicara. Rentang: [0.5, 2.0].
input.bit_rateintegerOpsional32Bitrate audio dalam kbps. Rentang: [6, 510]. Hanya berlaku jika format=opus.
input.pitchfloatOpsional1.0Nada. Rentang: [0.5, 2.0].
input.enable_ssmlbooleanOpsional—Apakah SSML diaktifkan. Lihat batas penggunaan untuk batas model, suara, dan antarmuka.
input.word_timestamp_enabledbooleanOpsionalfalseApakah stempel waktu per kata dikembalikan. Hanya untuk streaming. Mendukung suara hasil kloning cosyvoice-v3.5-plus, cosyvoice-v3.5-flash, cosyvoice-v3-flash, cosyvoice-v3-plus, cosyvoice-v2 dan suara sistem yang ditandai pada daftar suara. Suara hasil kloning model lain tidak didukung.
input.seedintegerOpsional0Seed acak. Rentang: [0, 65535]. Dengan versi model, teks, suara, serta parameter lain yang sama, seed yang sama mereproduksi hasil sintesis yang sama.
input.language_hintsarray[string]Opsional—Bahasa tujuan sintesis. Hanya elemen pertama array yang diproses. Parameter ini terpisah dari bahasa sumber sampel kloning. Gunakan jika pelafalan angka, singkatan, simbol, atau bahasa yang lebih jarang digunakan tidak sesuai harapan. Kode bahasa tercantum di bawah. Untuk bahasa sumber kloning, lihat API kloning suara.
input.instructionstringOpsional—Instruksi pengendali dialek, emosi, atau peran. Lihat Kontrol instruksi untuk model, suara, dan penggunaannya.
input.enable_aigc_tagbooleanOpsionalfalseApakah pengenal AIGC tak terlihat disisipkan ke audio WAV, MP3, atau Opus.Hanya didukung cosyvoice-v3-flash, cosyvoice-v3-plus, dan cosyvoice-v2.
input.aigc_propagatorstringOpsionalUID Alibaba CloudBidang ContentPropagator yang mengidentifikasi distributor. Hanya berlaku dengan enable_aigc_tag=true.Hanya didukung cosyvoice-v3-flash, cosyvoice-v3-plus, dan cosyvoice-v2.
input.aigc_propagate_idstringOpsionalRequest ID permintaan iniBidang PropagateID yang mengidentifikasi operasi distribusi ini. Hanya berlaku dengan enable_aigc_tag=true.Hanya didukung cosyvoice-v3-flash, cosyvoice-v3-plus, dan cosyvoice-v2.
input.hot_fixobjectOpsional—Konfigurasi perbaikan teks. pronunciation menyesuaikan pelafalan kata tertentu. replace mengganti teks tertentu sebelum sintesis.Tidak didukung cosyvoice-v2.
input.enable_markdown_filterbooleanOpsionalfalseApakah penanda Markdown difilter sebelum sintesis. Hanya didukung suara hasil kloning cosyvoice-v3-flash.

Kode bahasa

  • zh: Mandarin
  • en: Inggris
  • fr: Prancis
  • de: Jerman
  • ja: Jepang
  • ko: Korea
  • ru: Rusia
  • pt: Portugis
  • th: Thai
  • id: Indonesia
  • vi: Vietnam
  • es: Spanyol
  • it: Italia
  • ms: Melayu
  • fil: Filipina
  • ar: Arab
Contoh konfigurasi perbaikan teks:
{
  "hot_fix": {
    "pronunciation": [
      {
        "天气": "tian1 qi4"
      }
    ],
    "replace": [
      {
        "今天": "金天"
      }
    ]
  }
}

Isi respons

ParameterJenisDeskripsi
request_idstringPengenal unik permintaan.
outputobjectKeluaran model.
output.finish_reasonstringAlasan berhenti. null berarti sintesis berlangsung; stop berarti sintesis selesai.
output.typestringHanya dikembalikan pada streaming. sentence-begin menandai awal kalimat; sentence-synthesis menandai potongan audio, dengan beberapa potongan per kalimat; sentence-end menandai akhir beserta penggunaan. Potongan audio dan bingkai data berkorespondensi satu per satu. Tambahkan potongan ke berkas yang sama secara berurutan.
output.original_textstringKalimat hasil segmentasi teks masukan. Bidang ini dapat tidak ada pada kalimat terakhir.
output.sentenceobjectInformasi kalimat.
output.sentence.indexintegerIndeks kalimat, dimulai dari 0.
output.sentence.wordsarrayKata dalam kalimat dan informasi stempel waktunya.
output.sentence.words[].textstringSebuah kata atau karakter.
output.sentence.words[].begin_indexintegerPosisi awal dalam kalimat, dimulai dari 0.
output.sentence.words[].end_indexintegerPosisi akhir dalam kalimat, dimulai dari 1.
output.sentence.words[].begin_timeintegerStempel waktu awal audio kata, dalam milidetik.
output.sentence.words[].end_timeintegerStempel waktu akhir audio kata, dalam milidetik.
output.audioobjectAudio hasil sintesis.
output.audio.datastringPotongan audio Base64 untuk streaming. Kosong untuk non-streaming.
output.audio.urlstringURL berkas audio lengkap, berlaku 24 jam.
output.audio.idstringPengenal audio hasil sintesis.
output.audio.expires_atintegerStempel waktu kedaluwarsa url.
usageobjectInformasi penggunaan.
usage.charactersintegerJumlah kumulatif karakter yang ditagih.
  • Non-streaming
  • Streaming
{
  "output": {
    "audio": {
      "data": "",
      "id": "audio_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "expires_at": 1792079570,
      "url": "https://example.com/output.wav"
    },
    "finish_reason": "stop"
  },
  "usage": {
    "characters": 27
  },
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}