> ## 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/voices_list
```

## 身份验证和权限

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

所需权限: `voices:read`.

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

## 参数

发送空 JSON 对象。此操作没有输入字段。

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

  ```json theme={null}
  {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  }
  ```
</Accordion>

## 请求示例

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

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

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

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

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

## 响应

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

可用的 TTS 音色库音色和当前账户拥有的已保存自定义音色、音色保存数量限额、有效且尚未保存的预览，以及音色创建限额。

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "voices": [
        {
          "accent": "original",
          "id": "clone:33333333-3333-4333-8333-333333333333",
          "name": "Studio narrator",
          "previewUrl": "https://files.example.com/saved-narrator.mp3",
          "source": "clone"
        },
        {
          "id": "933563129e564b19a115bedd57b7406a",
          "name": "Sarah",
          "accent": "english",
          "gender": "female",
          "style": "conversational",
          "previewFileName": "sarah-en.mp3",
          "source": "catalog"
        }
      ],
      "cloneUsage": {
        "canClone": true,
        "limit": 10,
        "remaining": 9,
        "used": 1
      },
      "voicePreviews": [
        {
          "id": "44444444-4444-4444-8444-444444444444",
          "kind": "clone",
          "name": "Studio narrator",
          "previewUrl": "https://files.example.com/narrator-preview.mp3",
          "expiresAt": 1792238400000,
          "durationSeconds": 10
        }
      ],
      "creationUsage": {
        "cloneTrial": {
          "limit": 1,
          "used": 1,
          "remaining": 0
        },
        "design": {
          "limit": 5,
          "used": 0,
          "remaining": 5,
          "resetsAt": 1792195200000
        },
        "previewExpiresAfterHours": 24
      }
    }
  }
  ```
</ResponseExample>

## 结果字段

| 字段 | 说明 |
| - | - |
| `data.voices` | 当前账户拥有的已保存 TTS 音色，后跟可用的音色库音色。 |
| `data.voices[].id` | 用于 tts\_generate 的 TTS 选择 ID；自定义值使用 clone:\<UUID>。 |
| `data.voices[].name` | 音色显示名称。 |
| `data.voices[].source` | catalog 或 clone。 |
| `data.voices[].accent` | 音色口音；自定义音色为 original。 |
| `data.voices[].gender` | 可选的音色库音色性别。 |
| `data.voices[].style` | 可选的音色库音色表达风格。 |
| `data.voices[].previewFileName` | 可选的内置音色目录预览文件名；它不是下载 URL。 |
| `data.voices[].previewUrl` | 可选的可播放 URL；自定义音色 URL 是临时的。 |
| `data.cloneUsage.canClone` | 当前套餐是否允许保存自定义 TTS 音色；请检查 remaining 了解可用名额。 |
| `data.cloneUsage.limit` | 套餐允许保存的自定义 TTS 音色槽位限额。 |
| `data.cloneUsage.used` | 已占用的 TTS 音色名额，包括已预留的创建操作。 |
| `data.cloneUsage.remaining` | 可用的已保存 TTS 音色槽位。 |
| `data.voicePreviews` | 此账户当前所有有效的未保存预览，包括先前请求中的候选音色。 |
| `data.voicePreviews[].id` | 用于 voices\_preview\_get 和 voices\_save\_preview 的预览 UUID v4。 |
| `data.voicePreviews[].kind` | clone 或 design。 |
| `data.voicePreviews[].name` | 预览显示名称；设计的候选音色会在请求名称后追加编号。 |
| `data.voicePreviews[].previewUrl` | 可播放的临时音频 URL。预览仍有效时，使用 voices\_preview\_get 请求新 URL。 |
| `data.voicePreviews[].expiresAt` | 预览过期时间，以 Unix 毫秒时间戳表示。 |
| `data.voicePreviews[].durationSeconds` | 预览音频时长，单位为秒。 |
| `data.creationUsage.cloneTrial` | 终身克隆预览试用限额，包含 limit、used 和 remaining。 |
| `data.creationUsage.design` | 每日音色设计限额，包含 limit、used、remaining，以及采用 Unix 毫秒时间戳的 resetsAt。 |
| `data.creationUsage.previewExpiresAfterHours` | 未保存预览的有效期，以小时为单位，当前为 24。 |

## 操作说明

* 示例音色库已缩减。该操作返回可用的 TTS 音色库，已保存的自定义音色排在音色库条目前。
* 在 tts\_generate 中使用 voices\[].id。已保存音色使用 clone:\<UUID>；音色库 ID 是不透明的。这些 ID 与 dubbing\_voices\_list 中的 ID 不同。
* 音色库条目包含 accent、gender、style 和 previewFileName；previewUrl 为可选项。已保存的自定义条目包含 accent: original、source: clone 和临时 previewUrl。
* canClone 表示套餐是否支持保存自定义 TTS 音色；remaining 表示空闲槽位数。预留的创建操作可能计入 used。
* voicePreviews 仅包含当前账户拥有的、未保存、已就绪且未过期的候选音色。预览有效期为 24 小时；其可播放 URL 可能更早过期。
* cloneTrial 是终身限一次克隆预览的限额。付费套餐每天（UTC）可提交五次音色设计请求；每次成功设计会创建两个候选音色。creationUsage 报告当前限额和重置时间。
* 语音历史记录和自定义音色归已认证账户所有。使用团队计费并不授予访问其他成员语音或音色的权限。

## 用量

每次成功调用消耗一次月度 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 | `USER_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.