CosyVoice

Query a designed voice

POST

/services/audio/tts/customization

cURL

curl -X POST https://dashscope-intl.aliyuncs.com/api/v1/services/audio/tts/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "model": "voice-enrollment",
  "input": {
    "action": "query_voice",
    "voice_id": "cosyvoice-v3-plus-vd-announcer-xxxxxx"
  }
}'

{
  "output": {
    "voice_id": "cosyvoice-v3-plus-vd-announcer-xxxxxx",
    "gmt_create": "2025-12-10 14:54:09",
    "gmt_modified": "2025-12-10 17:47:48",
    "target_model": "cosyvoice-v3-plus",
    "status": "OK",
    "voice_prompt": "A composed middle-aged male announcer with a deep, rich voice",
    "preview_text": "Dear listeners, hello everyone"
  },
  "usage": {},
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Authorizations

string

header

required

DashScope API key. Get one at API key.

Body

application/json

enum<string>

required

Fixed to voice-enrollment.

Available options:voice-enrollment

Example:voice-enrollment

object

required

Show child attributes

enum<string>

required

Fixed to query_voice.

Available options:query_voice

Example:query_voice

string

required

The voice ID to query.

Example:cosyvoice-v3-plus-vd-announcer-xxxxxx

Response

200-application/json

object

Show child attributes

string

Voice ID.

Example:cosyvoice-v3-plus-vd-announcer-xxxxxx

string

Voice creation timestamp.

Example:2025-12-10 14:54:09

string

Last modification timestamp.

Example:2025-12-10 17:47:48

string

Speech synthesis model bound to this voice.

Example:cosyvoice-v3-plus

enum<string>

Voice status: DEPLOYING (under review), OK (approved, usable), or UNDEPLOYED (not approved).

Available options:DEPLOYING,OK,UNDEPLOYED

Example:OK

string

Voice description text.

Example:A composed middle-aged male announcer with a deep, rich voice

string

Preview text used when the voice was created.

Example:Dear listeners, hello everyone

object

Usage info.

string

Request ID for troubleshooting.

Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

cURL

curl -X POST https://dashscope-intl.aliyuncs.com/api/v1/services/audio/tts/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "model": "voice-enrollment",
  "input": {
    "action": "query_voice",
    "voice_id": "cosyvoice-v3-plus-vd-announcer-xxxxxx"
  }
}'

{
  "output": {
    "voice_id": "cosyvoice-v3-plus-vd-announcer-xxxxxx",
    "gmt_create": "2025-12-10 14:54:09",
    "gmt_modified": "2025-12-10 17:47:48",
    "target_model": "cosyvoice-v3-plus",
    "status": "OK",
    "voice_prompt": "A composed middle-aged male announcer with a deep, rich voice",
    "preview_text": "Dear listeners, hello everyone"
  },
  "usage": {},
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}