> ## 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.

# 获取音色预览

> 获取尚未保存的克隆或设计音色预览的可播放临时 URL。请在过期前使用 voices_save_preview 保留该音色。

获取尚未保存的克隆或设计音色预览的可播放临时 URL。请在过期前使用 voices\_save\_preview 保留该音色。

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

## 身份验证和权限

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

所需权限: `voices:read`.

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

## 参数

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

  格式: "uuid". 匹配模式: `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$`.
</ParamField>

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

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "previewId": {
        "type": "string",
        "format": "uuid",
        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$"
      }
    },
    "required": ["previewId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 请求示例

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

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

  ```javascript JavaScript theme={null}
  const input = {
    previewId: '44444444-4444-4444-8444-444444444444',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_preview_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/voices_preview_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"previewId": "44444444-4444-4444-8444-444444444444"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## 响应

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

一个有效且当前账户拥有的音色预览，附带刷新的临时播放 URL 及其过期时间。

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "id": "44444444-4444-4444-8444-444444444444",
      "kind": "clone",
      "name": "Studio narrator",
      "previewUrl": "https://files.example.com/narrator-preview.mp3",
      "expiresAt": 1792238400000,
      "durationSeconds": 10
    }
  }
  ```
</ResponseExample>

## 结果字段

| 字段 | 说明 |
| - | - |
| `data.id` | 用于 voices\_save\_preview 的候选项 UUID。 |
| `data.kind` | clone 或 design。 |
| `data.name` | 候选音色的显示名称。 |
| `data.previewUrl` | 新生成的临时可播放音频 URL。 |
| `data.expiresAt` | 候选音色的过期时间，采用 Unix 毫秒时间戳。 |
| `data.durationSeconds` | 预览音频时长，单位为秒。 |

## 操作说明

* previewId 是 voices\_preview\_clone、voices\_design 或 voices\_list 在 voicePreviews 中返回的候选音色 UUID。
* 仅显示状态为 ready、未保存且未过期的预览。保存后的候选音色会以 clone:\<previewId> 移至 voices\_list。已过期、已保存、不存在及非当前账户拥有的候选音色在此均返回 VOICE\_PREVIEW\_NOT\_FOUND。
* 该 URL 是临时地址，可能在 expiresAt 之前失效。请在预览本身过期前使用 voices\_save\_preview 保存所选候选音色。
* 语音历史记录和自定义音色归已认证账户所有。使用团队计费并不授予访问其他成员语音或音色的权限。

## 用量

每次成功调用消耗一次月度 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` | 已认证账户已不存在。 |
| 404 | `VOICE_PREVIEW_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.