CosyVoice

List cloned voices

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": "list_voice",
    "prefix": "myvoice",
    "page_size": 10,
    "page_index": 0
  }
}'

{
  "output": {
    "voice_list": [
      {
        "voice_id": "cosyvoice-v3-plus-myvoice-xxxxxx",
        "gmt_create": "2024-12-11 13:38:02",
        "gmt_modified": "2024-12-11 13:38:02",
        "status": "OK"
      }
    ]
  },
  "usage": {
    "count": 1
  },
  "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 list_voice.

Available options:list_voice

Example:list_voice

string

Filter voices by name prefix.

Example:myvoice

integer

default0

Page number (0-indexed).

Example:0

integer

default10

Results per page.

Example:10

Response

200-application/json

object

Show child attributes

object[]

Array of voice objects.

Show child attributes

string

Voice ID.

Example:cosyvoice-v3-plus-myvoice-xxxxxx

string

Creation timestamp.

Example:2024-12-11 13:38:02

string

Last modified timestamp.

Example:2024-12-11 13:38:02

enum<string>

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

Available options:DEPLOYING,OK,UNDEPLOYED

Example:OK

object

Show child attributes

integer

Fixed as 1.

Example:1

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": "list_voice",
    "prefix": "myvoice",
    "page_size": 10,
    "page_index": 0
  }
}'

{
  "output": {
    "voice_list": [
      {
        "voice_id": "cosyvoice-v3-plus-myvoice-xxxxxx",
        "gmt_create": "2024-12-11 13:38:02",
        "gmt_modified": "2024-12-11 13:38:02",
        "status": "OK"
      }
    ]
  },
  "usage": {
    "count": 1
  },
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}