Skip to main content
POST
将字幕渲染并嵌入上传的视频。可提供现有 SRT,或由 VoiceCheap 转写。保存渲染后的视频 URL 及其字幕历史记录。返回精简的已保存结果引用;使用其中的 getAction 或 downloadAction 获取完整输出。

身份验证和权限

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

参数

string
必填
已完成上传或媒体导入返回的、当前账户拥有的 fileKey。每次生成都会消耗其上传源文件。最小长度: 1. 最大长度: 1024.
string
文本值。最小长度: 1. 最大长度: 255. 匹配模式: ^[^/\\\r\n\0]+$.
array
值列表。项目结构请参阅完整输入架构。最多项目数: 100.
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 对象。嵌套字段请参阅完整输入架构。
string
文本值。最小长度: 1. 最大长度: 2097152.
string
文本值。最小长度: 2. 最大长度: 60.
object
JSON 对象。嵌套字段请参阅完整输入架构。
以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

幂等性

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

请求示例

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

响应

此操作在运行期间返回 HTTP 202。请保存 requestId,并使用该标识符和原始操作名称轮询 action_request_get。轮询状态包括 running、completed、failed 和 interrupted。已完成的结果可能指向独立的媒体任务;请继续使用该操作对应的状态或输出操作。 已保存的字幕渲染结果引用。其完整 JSON 包含 srt、sourceSrt、subtitledVideoUrl,以及可选的 detectedLanguage。

结果字段

恢复并轮询此请求

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

操作说明

  • 需要付费订阅和操作权限。执行时会重新检查调用者的个人工具套餐;已保存的工具和上传引用均属于该调用者,包括凭据与团队关联时。
  • 成功操作会消耗一次 API/MCP 共用的每月调用次数。Beginner 每月 500 次、Starter 5,000 次、Creator 25,000 次;Pro、Scale 和 Enterprise 无每月上限。每分钟限制仍然适用,分别为 30、60、120、180、300 和 600 次。工具生成限额单独计算。
  • 使用 UUID v4 格式的 requestId,或值与其相同的 Idempotency-Key 请求头,并在重试时保持操作、ID 和参数不变。返回缓存结果不会再次消耗每月调用次数。
  • 这是一个异步操作。初始传输结果是带有 pollAction 的 running 请求;使用此操作名称和原始 requestId 轮询 action_request_get。此处显示的已完成操作结果是精简的已保存输出引用,不是生成的正文。
  • 完整输出会按照经过身份验证的归属关系保存到加密存储中,独立于有界的操作轮询缓存。使用 resultId 和 includeContent: true 调用返回的 getAction,以获取结构化 JSON;或使用 resultId 调用 downloadAction,以获取 JSON 文本。若仅知道原始请求,可通过 listAction 找回结果。
  • 已保存的 JSON 最大为 32 MiB。元数据绝不会公开其存储加密密钥或无需身份验证的转写文本下载 URL。
  • 生成成功后会结算一次个人工具限额。生成失败通常会释放工具预留额度。如果无法确定输出是否已保存,请在再次生成前检查同一请求和已保存结果的历史记录;服务器会保留预留额度以防止重复使用。
  • 没有每月集成调用上限的高级套餐仍受以下工具每日限额和媒体限制约束。这些独立操作消耗相应工具限额,而不是配音分钟数或 TTS 字符数。
  • 请使用归属于当前账户且已完成上传或导入的 fileKey,并将其视为一次性资源。媒体处理开始后,无论处理成功还是失败,清理流程都会删除源文件。处理开始前的验证失败或限额拒绝可能会保留源文件。在启动另一次生成前,请复用原始 requestId,恢复已受理的生成请求。
  • 源文件必须包含视频,最大为 300 MiB,时长不超过 2 小时。可在 srtContent 中提供现有 SRT,或省略以从音轨生成字幕。未提供 SRT 时,源文件还必须包含音频。
  • subtitleStyle 是完整对象:fontFamily 为 sans/serif/mono,fontSize 为 small/medium/large,textColor 为 white/yellow/cyan,backgroundStyle 为 outline/box/shadow,position 为 bottom/middle。subtitleLayout 必须包含两个受支持的布局字段。
  • 每个工具的每日成功生成限额:Beginner 5 次、Starter 15 次、Creator 30 次、Pro 60 次、Scale 100 次、Enterprise 100 次。此限额与对应的网页工具共享,并使用账户的工具重置窗口。
  • subtitles_burn 和 subtitles_burn_youtube 共享添加字幕工具的限额。使用所提供的字幕进行渲染仍占用一次生成。渲染会创建单独的输出视频,并尽力保存一条字幕烧录历史记录。
  • 此操作只返回其已保存 JSON 中的四个字幕/输出字段。要刷新视频读取 URL,请使用 subtitles_burn_history_list/get 和 subtitles_burn_download。

用量

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

错误