Skip to main content
POST
将公开可直接访问的 HTTPS 音频或视频 URL 导入账户。不接受重定向或私有网络地址;文件和时长限制仍适用。请在生成操作中使用返回的 fileKey。

身份验证和权限

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

参数

string
必填
文本值。最大长度: 4096. 格式: “uri”.
string
文本值。最小长度: 1. 最大长度: 255. 匹配模式: ^[^/\\\r\n\0]+$.
string
必填
文本值。允许的值: “transcription”, “video_to_srt”, “add_subtitles”, “animated_captions”, “project”.
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。已完成的结果可能指向独立的媒体任务;请继续使用该操作对应的状态或输出操作。 已导入且属于调用者的媒体引用,包含已验证的大小、时长、媒体类型和读取 URL。这是轮询后获得的已完成操作输出。

结果字段

恢复并轮询此请求

即使连接丢失,也应使用同一标识符。如果 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 和参数不变。返回缓存结果不会再次消耗每月调用次数。
  • 上传前缀决定所需权限。tools 使用 transcription:write,subtitles 使用 subtitles:write,projects 使用 projects:write,voices 使用 voices:write。
  • 对于工具、字幕和项目,kind 接受 transcription、video_to_srt、add_subtitles、animated_captions 或 project。所选 kind 决定工作流限制;前缀不会强制指定 kind。
  • 所选 kind 适用各自的限制:transcription 为 200 MiB;video_to_srt 和 add_subtitles 为 300 MiB;animated_captions 为 250 MiB 且仅限音频;project 使用套餐上传上限(Beginner 5 GiB、Starter 10 GiB、Creator 20 GiB、Pro 30 GiB、Scale 40 GiB、Enterprise 60 GiB)。独立媒体最长为 2 小时。字幕在 Beginner 套餐下最长为 30 分钟,在更高的公开套餐下为 60 分钟,另允许 2 秒的容器时长容差。项目时长最长为 2 小时,Enterprise 套餐为 3 小时。
  • 此操作异步运行。使用其操作名称和原始 requestId 轮询 action_request_get,直至完成后再从结果中获取 fileKey。
  • 使用公开 HTTPS 音频/视频文件的直接 URL。不接受重定向、凭据、片段标识符、非 443 端口和非公开 DNS 地址。YouTube 观看页面不是直接媒体 URL;请使用专用的 YouTube 操作。
  • 当 URL 路径以受支持的媒体文件名结尾时,filename 可选。已保存的文件名会经过清理。服务器会在返回 fileKey 前探测实际时长。
  • 导入会准备媒体,并计入一次成功的每月集成调用;每日工具生成限额仅在后续生成时消耗。

用量

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

错误