> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取配音音色

> 获取一个音色库音色或当前账户拥有的自定义配音音色的元数据和可播放示例。

获取一个音色库音色或当前账户拥有的自定义配音音色的元数据和可播放示例。

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/dubbing_voices_get
```

## 身份验证和权限

<ParamField header="x-api-key" type="string" required>
  在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP，此 REST 端点不接受 OAuth
  访问令牌。
</ParamField>

所需权限: `voices:read`.

需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。

## 参数

<ParamField body="voiceId" type="string" required>
  文本值。

  最小长度: 1. 最大长度: 255. 匹配模式: `^[A-Za-z0-9_-]+$`.
</ParamField>

<ParamField body="locale" type="string">
  文本值。

  允许的值: "en", "fr", "es", "de", "it", "pt", "pl", "zh", "ja". 默认值: "en".
</ParamField>

<Accordion title="完整输入架构">
  以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "voiceId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 255,
        "pattern": "^[A-Za-z0-9_-]+$"
      },
      "locale": {
        "default": "en",
        "type": "string",
        "enum": ["en", "fr", "es", "de", "it", "pt", "pl", "zh", "ja"]
      }
    },
    "required": ["voiceId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 请求示例

请将示例资源标识符和媒体键替换为账户返回的值。重试同一次修改操作时，请保持请求标识符不变。

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/dubbing_voices_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"voiceId":"dubbing_voice_R8q3k9Yp","locale":"en"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    voiceId: 'dubbing_voice_R8q3k9Yp',
    locale: 'en',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/dubbing_voices_get', {
    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);
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.post(
      "https://api.voicecheap.ai/v1/actions/dubbing_voices_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"voiceId": "dubbing_voice_R8q3k9Yp", "locale": "en"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## 响应

首次执行成功时返回 HTTP 200，操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应，并未包含所有可选字段。

一个音色库配音音色或当前账户拥有的自定义配音音色，包含其公开元数据和可选的可播放示例。

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "id": "dubbing_voice_R8q3k9Yp",
      "name": "Studio narrator",
      "source": "custom",
      "previewUrl": "https://files.example.com/dubbing-narrator.mp3"
    }
  }
  ```
</ResponseExample>

## 结果字段

| 字段 | 说明 |
| - | - |
| `data.id` | 不透明的配音音色 ID；用于配音操作，不适用于 tts\_generate。 |
| `data.name` | 有本地化元数据时，按请求的区域语言返回音色显示名称。 |
| `data.source` | 当前账户拥有的已保存配音音色使用 custom，音色库音色使用 catalog。 |
| `data.previewUrl` | 可选的可播放示例绝对 URL。 |
| `data.language` | 可选的音色库语言代码。自定义音色通常不含语言元数据。 |
| `data.languages` | 可选的音色库语言代码列表。 |
| `data.accent` | 可选的音色目录本地化口音。 |
| `data.description` | 可选的本地化音色库描述。 |
| `data.age` | 可选的音色目录本地化年龄描述。 |
| `data.gender` | 可选的本地化音色库性别描述。 |
| `data.useCase` | 可选的本地化音色库使用场景。 |
| `data.category` | 可选的本地化音色库分类。 |

## 操作说明

* 使用 dubbing\_voices\_list 返回的 voiceId。它是不透明 ID，长度为 1–255 个字符，只包含字母、数字、下划线和连字符。
* locale 的默认值和可接受值与 dubbing\_voices\_list 相同。音色库音色可以包含已本地化的 language、accent、description、age、gender、useCase 和 category 元数据。
* 当前账户拥有的自定义音色返回 source: custom 和可选的 previewUrl；不包含音色目录中的语言字段。原始克隆响应中的 audioExampleUrl 在此表示为 previewUrl。
* 语音历史记录和自定义音色归已认证账户所有。使用团队计费并不授予访问其他成员语音或音色的权限。

## 用量

每次成功调用消耗一次月度 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` | 找不到实际生效的团队所有者账户。 |
| 404 | `DUBBING_VOICE_NOT_FOUND` | 该音色不在可用音色库中，也不在已认证账户保存的配音音色中。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 请等待月度额度重置，或更改套餐。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | 如果提供了 Retry-After，请等待其指定的时间，并采用退避重试。 |
| 500 | `INTERNAL_ERROR` | 在决定是否重试修改操作前，请检查已保存的请求状态和资源历史记录。 |
| 503 | `SERVER_RESTARTING` | 服务器正在重启。请稍后重试；对于修改操作，请保持请求标识符不变。 |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["voices:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.