Skip to main content
POST
在获得明确授权后,使用 1–3 个当前账户拥有的已上传音频创建临时音色克隆预览。消耗应用的克隆试用限额。请在预览过期前保存,以保留所选音色。

身份验证和权限

string
必填
在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP,此 REST 端点不接受 OAuth 访问令牌。
所需权限: voices:write. 需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。

参数

string
在传输层可选:如果省略,服务器会在验证前注入标识符。请自行提供稳定的 UUID v4,以便在响应丢失后安全恢复。格式: “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}$.
string
必填
文本值。最小长度: 1. 最大长度: 80.
array
必填
值列表。项目结构请参阅完整输入架构。最少项目数: 1. 最多项目数: 3.
boolean
必填
请确认你有权克隆每个样本中人物的音色。指定值: true.
boolean
布尔值。默认值: false.
string
文本值。最大长度: 35. 匹配模式: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.
以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

幂等性

为每次修改操作在 requestId 或 Idempotency-Key HTTP 请求头中提供 UUID v4。网络故障后,请使用相同标识符和完全相同的参数重试。如果同时提供这两个值,它们必须一致。重放已保存的请求不会重复执行操作,也不会再次扣除月度调用次数。失败或中断的请求不会自动重新执行。 对于每次修改操作,如果重试时发现同一请求仍在运行,即使首次执行通常为同步操作,也可能返回 HTTP 202。如果执行已完成但 resultStored 为 false,重试会返回 HTTP 200 和已保存的请求状态,而非原始结果。请通过对应领域的历史记录、结果或下载操作获取输出。

请求示例

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

响应

此操作在运行期间返回 HTTP 202。请保存 requestId,并使用该标识符和原始操作名称轮询 action_request_get。轮询状态包括 running、completed、failed 和 interrupted。已完成的结果可能指向独立的媒体任务;请继续使用该操作对应的状态或输出操作。 所有有效且未保存的音色预览和更新后的创建限额,包括新的克隆候选音色。

结果字段

恢复并轮询此请求

即使连接丢失,也应使用同一标识符。如果 resultStored 为 false,请通过相应的历史记录、结果或下载操作获取输出。切勿仅为查看进度而启动第二次生成。
HTTP 200

操作说明

  • 为此写入操作使用 UUID v4 格式的 requestId,重试时使用相同参数复用该 ID。长时间运行的操作首先返回 running 请求;此示例是可通过 action_request_get 获取的已完成处理程序结果。
  • 上传 1–3 个当前账户拥有的音频样本,并使用其已完成上传的 fileKey 值。支持的样本格式为 MP3、WAV、M4A、OGG 和 Opus;每个文件必须非空,且最大为 20 MiB(20,971,520 字节)。远程 URL 和其他账户的上传文件均会被拒绝。
  • 样本的可读取音频总时长必须至少为 10 秒,最多为 120 秒。trimToMaxDuration 默认为 false;设为 true 可按比例裁剪总时长超过 120 秒的样本。
  • hasPermission 必须为 JSON 布尔值 true,以确认每个样本均已获授权。字符串值(如 “true”)会被拒绝。
  • name 去除首尾空白后必须包含 1–80 个字符。可选的 language 支持 2–3 个字母的代码,可带子标签,最长为 35 个字符。
  • 使用账户终身仅限一次的克隆预览试用。创建此预览不会保存可复用的 TTS 音色,也不会占用已保存音色槽位。
  • 新克隆候选项的 kind: clone,有效期为 24 小时。其播放时长限制为约 10 秒。
  • 响应包含所有有效且尚未保存的预览。使用 voices_preview_get 刷新播放地址,然后在付费套餐中使用 voices_save_preview 保留选中的候选项。
  • 存在受支持的脚本时,language 用于选择预览脚本;它并不表示请求翻译已上传的样本。
  • 语音历史记录和自定义音色归已认证账户所有。使用团队计费并不授予访问其他成员语音或音色的权限。

用量

每次成功调用消耗一次月度 API/MCP 调用额度。媒体额度和操作本身的生成限额也适用。

错误