Skip to main content
POST
重命名项目,或更改翻译指令、校对就绪状态、语音、背景音频或字幕偏好。只能更改明确支持的客户设置。

身份验证和权限

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

参数

string
必填
文本值。最小长度: 1. 最大长度: 200. 匹配模式: ^[^/\\]+$.
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}$.
object
必填
JSON 对象。嵌套字段请参阅完整输入架构。
以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

幂等性

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

请求示例

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

响应

首次执行成功时返回 HTTP 200,操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应,并未包含所有可选字段。 更新明确提供的客户设置后,返回刷新的公开项目详情。

结果字段

恢复并轮询此请求

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

操作说明

  • changes 必须包含至少一个受支持的字段。未列出的属性会被拒绝。省略的字段保持不变。
  • changes 对象支持 projectName、translationInstructions、isReadyForDubbing、voiceCloning、keepBackgroundMusic、keepOriginalVoice、originalVoiceVolume、activeSpeakerDetectionEnabled、smartSync、voiceIsolatorOption、voiceCloningSettings 和 subtitles。
  • originalVoiceVolume 的范围为 1 至 70。voiceCloningSettings 必须同时包含 stability 和 similarity,取值均为 0 至 1;subtitles 必须同时包含 isEnable 和 source。
  • 此操作更新偏好和校对就绪状态,本身不会重新生成先前已完成的媒体。结果使用与 projects_get 相同的公开字段集合。
  • 已保存的失败返回 VoiceCheap 错误代码和固定消息。请根据代码和资源的当前状态决定如何恢复。

用量

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

错误