API 集成

您的第一份转录

转录在后台进行。创建任务后会立即响应；请持续查询状态，直到结果就绪。

1. 1

   创建任务

   通过 POST /transcripts 发送可直接公开访问的媒体网址。请保留返回的 id。

2. 2

   查看进度

   每隔 15–30 秒轮询 GET /transcripts/{id}，直到 status 为 complete 或 error。

3. 3

   使用转录结果

   从 data 读取 JSON；如果请求 SRT 或 VTT，则通过 export_url 下载文件。

任务状态

其他状态均视为处理中。未来可能添加中间状态。

身份验证

每次请求时，请在 Authorization 标头中发送 API 密钥，内容须与创建时显示的完全一致。

Authorization: <your api key>

请勿添加 Bearer 前缀。

新密钥以 tp_live_ 开头。完整密钥仅在创建时显示一次。如果遗失，请撤销该密钥并创建新密钥；已撤销的密钥会立即失效。

需要有效订阅及具备所需权限的 API 密钥。

创建转录

为公开网址上的媒体文件启动转录任务。任务加入队列后即返回响应，状态为 status: "initializing"。

Taption 会直接下载文件。Google Drive 或 Dropbox 预览页面等分享页面链接无法使用。

media_urlstring必填

媒体文件的直接下载链接。

最多 2048 个字符

extensionstring必填

媒体文件格式。

mp3wavm4aaacflacwmaopusmp4

languagestring必填

以语言标签指定媒体使用的语言。请参阅语言参考资料。

查看语言标签

namestring

转录的显示名称。默认为 `media_url` 中的文件名。较长的名称会截断至 200 个字符。

最多 200 个字符

export_typestring

输出格式。默认为 json，在 data 中返回已解析的转录内容。srt 和 vtt 则在 export_url 中返回文件链接。

jsonsrtvtt

默认值：json

max_charinteger

每段字幕的字符上限。中文、日文、韩文和粤语默认为 `16`，其他语言为 `65`。超出 1-200 的值会被忽略，改用默认值。

1–200

响应

获取转录

获取转录的当前状态和结果。任务进行时，请每隔 15–30 秒轮询一次。

对于 json 或未指定导出类型的请求，完成的结果会出现在 data 中。对于 srt 或 vtt，请通过 export_url 下载文件。

idstring必填

由 POST /transcripts 返回的转录 ID。最多 256 个字符

响应

转录对象

创建任务和查询状态的请求会返回 JSON 对象。其字段描述任务，以及就绪后的输出结果。

idstring

转录 ID，搭配 `GET /transcripts/{id}` 使用。

statusstring

任务当前状态：`initializing`、`transcribing`、`complete` 或 `error`。其他值均视为处理中。

dataJSON

对于 json 或省略 export_type 的请求，结果就绪时提供已解析的 JSON 导出内容；否则为空字符串。

export_urlstring

srt 或 vtt 导出文件的下载链接，就绪前为空。若格式为 json 或省略 export_type，状态响应会省略此字段。

messagestring

当前状态的补充信息。在 `transcribing` 期间，可能为 `ANALYZING` 或 `FINALIZING` 等进度阶段。当 `status` 为 `error` 时，描述失败原因。此内容供人阅读，请勿用程序解析。

error_codestring

可选的机器可读代码，表示提交限制错误。

limitinteger

此次适用的账户上限，在 HTTP 429 响应中提供。

错误与重试

请根据 HTTP 状态码决定下一步。message 字段供人阅读，措辞可能会变动。

API 响应包含 X-Request-Id 标头。就某个请求联系支持团队时，请提供该值。