Skip to main content

API 参考

VoiceCheap API 使用标准 HTTP 方法和状态码。大多数端点返回 JSON;转录导出也可以返回 SRT 或 VTT。 账户设置、团队管理、媒体工具和其他工作流请使用操作目录。这些工作流也可通过账户 MCP 服务器使用,但 Webhook 签名密钥的创建和轮换需要使用 REST。在集成中管理凭据,并查看使用限制。

基础 URL

所有 API 请求都应发送至:

身份验证

私有 REST 调用请使用 x-api-key 或 Authorization: Bearer 中的 API 密钥进行身份验证。OpenAPI 文档是公开的。有关限定权限范围的凭据和 MCP 的 OAuth,请参阅身份验证。

JSON 操作 API

账户、团队、项目、语音和媒体工具各节分别说明每项 JSON 操作。这些路由均使用 POST,包括读取和删除;请在 JSON 请求体中发送参数。下方的文件上传和现有项目路由保留各自的 HTTP 方法。 创建具有 account:read 权限的 API 密钥,设置 VOICECHEAP_API_KEY 环境变量,然后尝试以下只读请求:
操作完成后返回 HTTP 200,结果位于 data 中。耗时操作返回 HTTP 202 和 requestId;请查询请求状态以获取结果。操作请求完成后,媒体任务仍可能继续运行。 浏览按领域分类的全部操作,或查看密钥获准使用的操作和结构定义。每个页面均列出权限、参数、示例和错误。

内容类型

  • 请求:文件上传使用 multipart/form-data,其他请求使用 application/json
  • 响应:JSON 端点返回 application/json。转录导出也可以返回 SRT 或 VTT 文本。

文件上传和现有项目路由

转录媒体

POST /v1/transcribe将上传的文件转录为 JSON、SRT 或 VTT 格式。

导出项目转录

POST /v1/projects/{projectId}/transcript检索原始或翻译后的项目转录。

创建项目

POST /v1/projects上传视频或音频文件,仅启动转录。

开始翻译

POST /v1/translate上传视频或音频文件并启动翻译项目。

为项目配音

POST /v1/projects/{projectId}/dub使用您自己的译文 SRT,为已转录的项目配音。

获取翻译状态

GET /v1/translate/{projectId}/status检查翻译项目的状态并检索结果。

获取项目详情

GET /v1/projects/{projectId}检索翻译版本历史、口型同步历史和项目状态。

删除项目

DELETE /v1/translate/{projectId}永久删除翻译项目及其资产。

翻译工作流程

翻译视频的典型工作流程如下:

响应格式

下方现有的文件上传和项目路由保留各自端点的响应格式。 成功响应的字段取决于端点。创建项目和启动配音会返回 success、message 和 projectId。状态和项目详情请求会返回项目状态;转录请求会返回 JSON、SRT 或 VTT。请查看各端点页面了解确切字段。 错误会返回包含 code 和 message 的 JSON 对象,有时还包含 details。请参阅错误代码。

HTTP 状态代码