Skip to main content
POST
根据描述创建候选音色,消耗音色设计限额。使用 voices_preview_get 试听,然后保存选中的预览。

身份验证和权限

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.
string
必填
文本值。最小长度: 1. 最大长度: 2000.
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 获取的已完成处理程序结果。
  • name 去除首尾空白后须包含 1–80 个字符。description 去除首尾空白后须包含 1–2,000 个字符。可选的 language 接受 2–3 个字母的代码,可附带子标签,最长 35 个字符。
  • 成功的设计请求会创建两个 kind: design 的候选音色,名称带编号,并消耗一次每日设计请求。付费套餐每天(UTC)允许五次请求;请查看 creationUsage.design 以获取当前计数和重置时间。
  • 候选项有效期为 24 小时,不是已保存的可复用 TTS 音色。使用 voices_preview_get 试听,然后通过 voices_save_preview 保存选中的候选项。
  • 响应同时包含此前有效的预览和新候选项。候选项保存前不会占用已保存音色名额。
  • 语音历史记录和自定义音色归已认证账户所有。使用团队计费并不授予访问其他成员语音或音色的权限。

用量

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

错误