Skip to main content
POST
获取或生成 YouTube 转写文本,包含带时间戳的片段、纯文本和 SRT 字幕。保存转写历史记录。返回精简的已保存结果引用;使用其中的 getAction 或 downloadAction 获取完整输出。

身份验证和权限

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

参数

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}$.
以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

幂等性

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

请求示例

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

响应

此操作在运行期间返回 HTTP 202。请保存 requestId,并使用该标识符和原始操作名称轮询 action_request_get。轮询状态包括 running、completed、failed 和 interrupted。已完成的结果可能指向独立的媒体任务;请继续使用该操作对应的状态或输出操作。 已保存的 YouTube 转写引用。完整 JSON 包含视频元数据、带时间信息的 segments、text、srt、createdAt 和可选的 language;对于 YouTube 原生字幕,可能会保留 source 标签。

结果字段

恢复并轮询此请求

即使连接丢失,也应使用同一标识符。如果 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 字符数。
  • 请使用 youtube.com、www.youtube.com、m.youtube.com、music.youtube.com 或 youtu.be 上的公开 HTTPS YouTube URL,且不得包含嵌入式凭据或显式端口。视频时长不得超过 2 小时。
  • 每个工具的每日成功生成限额:Beginner 5 次、Starter 15 次、Creator 30 次、Pro 60 次、Scale 100 次、Enterprise 100 次。此限额与对应的网页工具共享,并使用账户的工具重置窗口。
  • 所有套餐另有每天 12 次 YouTube 转写尝试的限制,包括失败的尝试。此限制可能低于成功生成限额。集成路径使用共享的每分钟集成速率限制。
  • 已保存的集成 JSON 在后续尽力保存 YouTube 转写文本历史记录之前捕获。因此,transcriptId 不包含在此持久化的完整输出中;需要时,请通过 youtube_transcript_history_list 查找网页工具历史记录。
  • 不使用预先上传的源文件。完整输出中转写片段的 startSeconds/endSeconds 以秒为单位,createdAt 则以毫秒为单位。

用量

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

错误