POST https://mediakit.cn-beijing.volces.com/api/v1/tools/video-ocr

本 API 用于提交一个异步的视频字幕识别（OCR）任务，能够识别输入的视频画面中的字幕信息，输出为一份带时间戳的结构化文本数据。

请求参数

Header 参数

参数	类型	是否必选	示例值	描述
Authorization	String	是	Bearer {Your_API_Key}	格式为 Bearer {Your_API_Key}。请参考基础概念及准备工作获取 API Key。

Body 参数

参数	类型	是否必选	示例值	描述
video_url	String	是	https://example.com/media.mp4	待识别的视频 URL。视频来源：支持公网 HTTP/HTTPS URL、本地上传 (mediakit://)、来源于火山引擎视频点播 (vod://) 和火山引擎对象存储 (tos://) 四种输入协议。关于各协议的具体说明和使用示例，请参阅多源媒体输入与本地上传。支持格式：mp4, flv, ts, avi, mov, wmv, mkv 等主流视频格式。视频时长：单文件时长不得超过 10 分钟。输入视频分辨率：支持 240p～4k。
mode	String	否	Subtitle	工作模式，默认为 Subtitle。 Subtitle：字幕识别模式。仅识别视频画面中符合字幕特征的文本。适用于快速提取视频对白、生成字幕稿等场景。 Detailed：详细识别模式。识别画面中更详细的文本信息。包括字幕、水印、台标、标题等。该模式的返回结果会额外包含以下字段，方便进行深入分析： text_label: 将文本分类为 Subtitle（字幕）或Others（其他文字）。 text_location: 提供文本在画面中的精确坐标。
client_token	String	否	your_unique_request_id_134	用户请求凭证，用于幂等控制。大小写敏感，不超过 64 个 ASCII 码可打印字符。详情请参考幂等性控制。
callback_args	String	否	your_custom_callback_args	自定义回调参数。您提供的内容将在任务完成时，通过事件回调原样返回，方便您关联业务。字段长度最大为 512 字节。
callback_url	String	否	https://example.com/callback	用于接收该任务结果回调的 URL 地址。如果提供此参数，其优先级将高于在控制台配置的全局回调地址。地址必须以 http:// 或 https:// 开头。请参考事件回调了解回调接收机制和回调消息结构。
queue_id	String	否	q00a9731598092652e4a95292434198	任务提交的目标队列 ID。如不传，默认会使用系统自动创建的队列 ID。您可以将不同业务或优先级的任务提交到不同的队列，以实现按队列对应的项目进行分账。您可以在 AI MediaKit 控制台队列管理页面创建和管理队列，系统会自动分配一个队列 ID。详情请参考按项目或 API Key 分账。

请求示例

以下示例演示了如何识别一个视频中的字幕内容。

响应说明

调用 API 提交任务后，接口会立即返回一个同步响应，表明任务是否成功进入后台处理队列。

响应参数

参数	类型	描述
success	Boolean	任务是否提交成功。 true：任务已成功提交到后台处理队列。 false：请求存在错误，任务提交失败。请检查 error 字段以获取详细信息。
task_id	String	任务的唯一标识符。仅在 success 为 true 时返回有效值，可用于后续查询任务进度和结果。
request_id	String	本次请求的唯一标识，可用于问题排查。
error	Object	错误详情对象，仅在 success 为 false 时返回。详见下文 Error 对象。

Error 对象

参数	类型	描述
code	String	具体的错误码。关于各错误码的详细信息，请参阅错误码。
type	String	错误的宏观类型，例如 BadRequest。
message	String	对错误的详细描述，可用于开发调试。
param	String	（可选）指出导致错误的具体参数。

响应示例

成功响应

失败响应

异步任务结果

视频字幕识别是一个异步任务，任务的执行状态和最终结果不会在提交时同步返回。您可以通过以下两种方式获取任务结果：

方法一（轮询查询）：使用提交任务时获取的 task_id，定期调用查询任务信息 API，直到 status 字段变为 completed 或 failed。

方法二（事件回调）：在 AI MediaKit 控制台预先配置一个接收回调的 URL，或在提交任务时通过 callback_url 参数为单次任务指定回调地址。任务完成后，系统会将包含最终结果的详细信息 POST 到您指定的地址。详情请参阅事件回调。

当任务成功完成后，您获取到的任务信息中的 result 字段将包含以下内容。

Result 对象

参数	类型	描述
subtitles	Array	字幕片段列表。每个元素是一个包含字幕文本和时间戳的对象，详见下文Subtitle 对象。
duration	Number	输入视频的总时长（单位：秒）。

Subtitle 对象

参数	类型	描述
subtitle_text	String	识别出的字幕文本。
text_label	String	文本类别标签（仅 mode 为 Detailed 模式返回）。 Subtitle：字幕文本。 Others：画面中的其他文字（如水印、台标、贴片等非字幕内容）。
text_location	Object	文本在画面中的像素坐标区域（仅 mode 为 Detailed 模式返回）。详见下文Text location 对象。
start_time	Number	该字幕片段的起始时间（单位：秒）。
end_time	Number	该字幕片段的结束时间（单位：秒）。

Text location 对象

参数	类型	描述
top_left_x	Integer	文本框左上角横坐标，单位 px。
top_left_y	Integer	文本框左上角纵坐标，单位 px。
bottom_right_x	Integer	文本框右下角横坐标，单位 px。
bottom_right_y	Integer	文本框右下角纵坐标，单位 px。

最终的完整任务信息示例（Detailed 模式）

AI MediaKit