curl --request POST 'https://api.voicecheap.ai/v1/actions/dubbing_voices_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"locale":"en","language":"en","search":"Studio narrator"}'
const input = {
locale: 'en',
language: 'en',
search: 'Studio narrator',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/dubbing_voices_list', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/dubbing_voices_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"locale": "en", "language": "en", "search": "Studio narrator"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"voices": [
{
"id": "dubbing_voice_R8q3k9Yp",
"name": "Studio narrator",
"source": "custom",
"previewUrl": "https://files.example.com/dubbing-narrator.mp3"
}
],
"cloneUsage": {
"limit": 7,
"used": 1,
"remaining": 6
}
}
}
配音音色
列出配音音色
浏览与应用相同的配音音色库,以及已保存的自定义配音音色,包括可播放示例和音色数量限额。这些 ID 用于视频配音;独立的文本转语音音色库由 voices_list 提供。
POST
/
v1
/
actions
/
dubbing_voices_list
curl --request POST 'https://api.voicecheap.ai/v1/actions/dubbing_voices_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"locale":"en","language":"en","search":"Studio narrator"}'
const input = {
locale: 'en',
language: 'en',
search: 'Studio narrator',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/dubbing_voices_list', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/dubbing_voices_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"locale": "en", "language": "en", "search": "Studio narrator"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"voices": [
{
"id": "dubbing_voice_R8q3k9Yp",
"name": "Studio narrator",
"source": "custom",
"previewUrl": "https://files.example.com/dubbing-narrator.mp3"
}
],
"cloneUsage": {
"limit": 7,
"used": 1,
"remaining": 6
}
}
}
浏览与应用相同的配音音色库,以及已保存的自定义配音音色,包括可播放示例和音色数量限额。这些 ID 用于视频配音;独立的文本转语音音色库由 voices_list 提供。
所需权限:
POST https://api.voicecheap.ai/v1/actions/dubbing_voices_list
身份验证和权限
string
必填
在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP,此 REST 端点不接受 OAuth
访问令牌。
voices:read.
需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。
参数
string
文本值。允许的值: “en”, “fr”, “es”, “de”, “it”, “pt”, “pl”, “zh”, “ja”. 默认值: “en”.
string
文本值。最小长度: 2. 最大长度: 35.
string
文本值。最大长度: 100.
完整输入架构
完整输入架构
以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。
{
"type": "object",
"properties": {
"locale": {
"default": "en",
"type": "string",
"enum": ["en", "fr", "es", "de", "it", "pt", "pl", "zh", "ja"]
},
"language": {
"type": "string",
"minLength": 2,
"maxLength": 35
},
"search": {
"type": "string",
"maxLength": 100
}
},
"additionalProperties": false
}
请求示例
请将示例资源标识符和媒体键替换为账户返回的值。重试同一次修改操作时,请保持请求标识符不变。curl --request POST 'https://api.voicecheap.ai/v1/actions/dubbing_voices_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"locale":"en","language":"en","search":"Studio narrator"}'
const input = {
locale: 'en',
language: 'en',
search: 'Studio narrator',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/dubbing_voices_list', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/dubbing_voices_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"locale": "en", "language": "en", "search": "Studio narrator"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
响应
首次执行成功时返回 HTTP 200,操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应,并未包含所有可选字段。 匹配的目录视频配音音色和当前账户拥有的自定义视频配音音色,以及当前可保存配音音色的限额。{
"data": {
"voices": [
{
"id": "dubbing_voice_R8q3k9Yp",
"name": "Studio narrator",
"source": "custom",
"previewUrl": "https://files.example.com/dubbing-narrator.mp3"
}
],
"cloneUsage": {
"limit": 7,
"used": 1,
"remaining": 6
}
}
}
结果字段
| 字段 | 说明 |
|---|---|
data.voices | 先返回匹配的当前账户拥有的自定义配音音色,再返回音色库中的配音音色。 |
data.voices[].id | 不透明的配音音色 ID;用于配音操作,不适用于 tts_generate。 |
data.voices[].name | 有本地化元数据时,按请求的区域语言返回音色显示名称。 |
data.voices[].source | 当前账户拥有的已保存配音音色使用 custom,音色库音色使用 catalog。 |
data.voices[].previewUrl | 可选的可播放示例绝对 URL。 |
data.voices[].language | 可选的音色库语言代码。自定义音色通常不含语言元数据。 |
data.voices[].languages | 可选的音色库语言代码列表。 |
data.voices[].accent | 可选的音色目录本地化口音。 |
data.voices[].description | 可选的本地化音色库描述。 |
data.voices[].age | 可选的音色目录本地化年龄描述。 |
data.voices[].gender | 可选的本地化音色库性别描述。 |
data.voices[].useCase | 可选的本地化音色库使用场景。 |
data.voices[].category | 可选的本地化音色库分类。 |
data.cloneUsage.limit | 当前套餐可保存的自定义配音音色数量限制。 |
data.cloneUsage.used | 已保存的自定义配音音色数量。 |
data.cloneUsage.remaining | 剩余可保存的自定义配音音色数量。 |
操作说明
- 这是视频配音音色库。独立的 TTS 音色库和 clone:<UUID> 选项请使用 voices_list。
- locale 默认为 en,支持 en、fr、es、de、it、pt、pl、zh 和 ja。缺少本地化文本时,会回退到英语或其他可用译文。
- 可选的 search 会在音色名称和本地化描述中进行不区分大小写的子字符串匹配,去除首尾空白后最多为 100 个字符。
- 可选的 language 长度为 2–35 个字符,与音色库的 language 或 languages 元数据精确匹配。不含语言元数据的音色(包括自定义音色)仍会保留在结果中。
- 该列表不分页。音色库音色和自定义音色具有不同的可选元数据。克隆槽位用量仅计算已保存的自定义配音音色。
- 此示例筛选出一个当前账户拥有的自定义音色。列表中的字段名为 previewUrl;克隆操作通过 audioExampleUrl 返回同一音频示例。
- 语音历史记录和自定义音色归已认证账户所有。使用团队计费并不授予访问其他成员语音或音色的权限。
用量
每次成功调用消耗一次月度 API/MCP 调用额度。媒体额度和操作本身的生成限额也适用。错误
| HTTP 状态 | 代码 | 含义或恢复方式 |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | 凭证通过 access_token 或 api_key 查询参数提供。请在标头中发送凭证。 |
| 400 | VALIDATION_ERROR | 输入不符合操作架构;请查看 details 了解字段错误。 |
| 401 | API_KEY_EXPIRED | API 密钥已过期。 |
| 401 | INVALID_API_KEY | 请提供有效且未过期的 API 密钥。 |
| 401 | INVALID_CREDENTIAL | Authorization 标头格式错误或与 x-api-key 冲突。 |
| 401 | MISSING_CREDENTIAL | 未提供可用的请求头凭据,或其长度超过 4096 个字符。 |
| 401 | USER_NOT_FOUND | 该凭据对应的账户已不存在。 |
| 403 | AMBIGUOUS_TEAM_API_KEY | 此凭据对应的用户属于多个团队,因此计费上下文不明确。 |
| 403 | INSUFFICIENT_SCOPE | 请授予全部所需权限,或选择其他凭据。 |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | 无法验证该账户的集成限制。 |
| 403 | SUBSCRIPTION_REQUIRED | 请使用有效的付费订阅。 |
| 403 | TEAM_OWNER_NOT_FOUND | 找不到实际生效的团队所有者账户。 |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | 请等待月度额度重置,或更改套餐。 |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | 如果提供了 Retry-After,请等待其指定的时间,并采用退避重试。 |
| 500 | INTERNAL_ERROR | 在决定是否重试修改操作前,请检查已保存的请求状态和资源历史记录。 |
| 503 | SERVER_RESTARTING | 服务器正在重启。请稍后重试;对于修改操作,请保持请求标识符不变。 |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["voices:read"]
}
}
此页面对您有帮助吗?

