Skip to main content
POST
从已上传的 fileKey 创建项目,完成转录和翻译后合成语音。支持提供的 SRT、声音、字幕及可选唇形同步。使用常规媒体积分。可选的 webhookUrl 可接收处理事件。请查询 projects_status。

身份验证和权限

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

参数

string
必填
文本值。最小长度: 1. 最大长度: 1024.
string
必填
文本值。允许的值: “afrikaans”, “albanian”, “amharic”, “arabic”, “armenian”, “assamese”, “azerbaijani”, “basque”, “belarusian”, “bengali”, “bosnian”, “bulgarian”, “catalan”, “croatian”, “czech”, “danish”, “dutch”, “english”, “british english”, “estonian”, “finnish”, “french”, “french canadian”, “galician”, “german”, “greek”, “gujarati”, “hebrew”, “hindi”, “hungarian”, “icelandic”, “indonesian”, “irish”, “italian”, “japanese”, “kannada”, “kazakh”, “khmer”, “korean”, “lao”, “latvian”, “lithuanian”, “macedonian”, “malay”, “malayalam”, “mandarin”, “marathi”, “mongolian”, “nepali”, “norwegian”, “persian”, “polish”, “portuguese”, “brazilian portuguese”, “pt_brazil”, “punjabi”, “romanian”, “russian”, “serbian”, “slovak”, “slovenian”, “spanish”, “swahili”, “swedish”, “tagalog”, “tamil”, “telugu”, “thai”, “turkish”, “ukrainian”, “urdu”, “vietnamese”, “welsh”, “yoruba”, “zulu”.
string
文本值。允许的值: “af”, “sq”, “am”, “ar”, “hy”, “as”, “ast”, “az”, “ba”, “eu”, “be”, “bn”, “bs”, “br”, “bg”, “my”, “ca”, “ceb”, “zh”, “hr”, “cs”, “da”, “nl”, “en”, “eo”, “at”, “et”, “fil”, “fo”, “fi”, “fr”, “fr-CA”, “fy”, “ff”, “gd”, “gl”, “lg”, “ka”, “de”, “el”, “gu”, “ht”, “ha”, “haw”, “he”, “hi”, “hu”, “is”, “ig”, “ilo”, “id”, “ia”, “ga”, “it”, “ja”, “jv”, “kea”, “kn”, “kk”, “km”, “kur”, “kir”, “ko”, “lo”, “la”, “luo”, “lv”, “lb”, “ln”, “lt”, “mk”, “mg”, “ms”, “ml”, “mt”, “mi”, “mr”, “mo”, “mn”, “ne”, “no”, “nn”, “nso”, “nya”, “oc”, “or”, “pa”, “ps”, “fa”, “pl”, “pt”, “ro”, “ru”, “sa”, “sr”, “sn”, “sd”, “si”, “sk”, “sl”, “so”, “es”, “su”, “sw”, “ss”, “sv”, “tl”, “tg”, “ta”, “tt”, “te”, “th”, “bo”, “tn”, “tr”, “tk”, “ug”, “uk”, “umb”, “ur”, “uz”, “vi”, “cy”, “wo”, “xh”, “yi”, “yo”, “zu”, “cmn”, “yue”, “en-GB”, “en-US”, “en-AU”, “auto-detect”.
string
文本值。最小长度: 1. 最大长度: 200.
string
文本值。允许的值: “1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “10”, “11”, “12”, “13”, “14”, “15”, “16”, “17”, “18”, “19”, “20”, “21”, “22”, “23”, “24”, “25”, “26”, “27”, “28”, “29”, “30”, “31”, “32”, “auto-detect”.
array
值列表。项目结构请参阅完整输入架构。最多项目数: 1000.
boolean
布尔值。
string
文本值。最大长度: 1000000.
string
文本值。最大长度: 2048. 格式: “uri”.
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}$.
boolean
布尔值。
boolean
布尔值。
number
数值。最小值: 1. 最大值: 70.
string
文本值。允许的值: “cloning”, “custom”.
string
文本值。最小长度: 1. 最大长度: 128.
boolean
布尔值。
string
文本值。允许的值: “translated”, “original”.
string
文本值。允许的值: “studio”, “realistic”.
string
文本值。允许的值: “standard”, “pro”, “studio”.
boolean
布尔值。
object
JSON 对象。嵌套字段请参阅完整输入架构。
array
值列表。项目结构请参阅完整输入架构。最多项目数: 100.
string
文本值。最大长度: 1000000.
以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

幂等性

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

请求示例

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

响应

首次执行成功时返回 HTTP 200,操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应,并未包含所有可选字段。 在启动转写及后续翻译和语音生成,或启动使用所提供译文的配音后,返回新的项目标识符。

结果字段

已提供并接受 translatedSrt。

相同的结果字段用于确认对所提供目标文本的配音。
HTTP 200

恢复并轮询此请求

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

操作说明

  • 已完成上传的 fileKey 必须属于已认证的调用者。服务器会测量已存储媒体的时长和大小。
  • 可选的 sourceSrt 需要显式提供 originalLanguage。同时提供 translatedSrt 时,两份 SRT 的字幕条目数量必须相同;提供的译文会按字幕条目索引配对。
  • 提供 translatedSrt 时,工作流会对该文本配音,并返回针对所提供翻译的确认响应。提供 sourceSrt 时,按索引对齐字幕条目;未提供 sourceSrt 时,使用自动转写的时间轴。
  • 创建结果不含 workId 或 translatedVersionId。它们存在后,请通过 projects_status 或 projects_get 获取。
  • voiceMode 默认为 cloning。使用 voiceMode custom 时,请选择目录中的音色或经过身份验证的账户保存的自定义音色,不要提供 voiceCloningSettings。团队计费不会授予访问其他成员已保存音色的权限。
  • 可选的 subtitles、lipSyncMode 和 translationTimeSkips 需要视频输入。跳过区间必须位于媒体时长范围内,keepBackgroundMusic 必须为 true,keepOriginalVoice 必须为 false。
  • lipSyncMode 接受 standard、pro 或 studio,取决于套餐并须通过常规媒体额度检查。每月 API 调用不限量并不意味着语音和口型同步免费。
  • 轮询 projects_status 跟踪媒体工作流;使用 projects_get 获取所有语言版本。
  • originalLanguage 使用 fr 或 en 等源语言代码(在允许时也可使用 auto-detect);targetLanguage 使用 english 等受支持的目标语言名称。

用量

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

错误