- 文档首页
视频点播
视频 AI 应用
StartExecution - 提交媒体处理任务
提交 OCR 提取字幕任务
StartExecution - 提交媒体处理任务
提交 OCR 提取字幕任务
提交 OCR 提取字幕任务
本文为您详细介绍如何调用 StartExecution 接口提交异步的 OCR 提取字幕任务。该接口利用光学字符识别技术,自动识别并提取视频帧中的视觉文本(如硬字幕、演职员表、公告文字等),输出带有时间轴信息的结构化文本结果,助力视频内容的深度分析、搜索推荐及合规审核。详细功能介绍和使用流程请见 OCR 提取字幕。 - 调用准备:在调用本接口前,建议您先阅读如何调用 OpenAPI 文档,以了解 OpenAPI 的通用调用流程,包括在线调试、获取 curl 命令、请求签名等基础操作。
- QPS 限制:本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
请求说明
- 请求地址:https://vod.volcengineapi.com?Action=StartExecution&Version=2025-01-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。 Action String 必选 示例值:StartExecution
接口名称。当前 API 的名称为 StartExecution。
Version String 必选 示例值:2025-01-01
接口版本。当前 API 的版本为 2025-01-01。
Input Object 可选 示例值:-
输入文件信息。
Type String 必选 示例值:Vid
输入文件类型。取值如下:
- Vid:Vid 模式。此模式下,您还需设置 Vid 参数。
- DirectUrl:DirectUrl 模式。此模式下,您还需设置 DirectUrl 参数。
Vid String 可选 示例值:v0ccfeg7007acsg***fog65ubr7niqng
待处理视频的 Vid。您需要在调用本接口前,通过任一方式将视频上传至点播空间,并获取其 Vid。 注意
您必须设置 Vid 或 DirectUrl参数之一,但不能同时设置这两个参数。
DirectUrl Object 可选 示例值:-
通过 DirectUrl 模式指定待处理视频的信息。您需要在调用本接口前,通过任一方式将视频上传至点播空间,并获取其相关信息。 注意
您必须设置 Vid 或 DirectUrl参数之一,但不能同时设置这两个参数。
SpaceName String 必选 示例值:test
FileName String 必选 示例值:example.mp4
文件路径。音视频上传至视频点播服务后,您可通过媒资上传完成事件获取 FileName。 BucketName String 可选 示例值:tos-cn-v-cd3a11
Tag String 可选 示例值:ImageSet
标识输入的类型,用于区分不同场景下的输入内容。支持的取值如下:
- ImageSet:OCR 提取字幕任务中表示输入为图集。
Operation Object 必选 示例值:-
媒体处理操作配置。
Type String 必选 示例值:Task
处理类型。取值如下:
Task Object 可选 示例值:-
单任务配置。当 Type 为 Task 时需要设置此参数。
Type String 必选 示例值:Ocr
任务类型:
Ocr Object 可选 示例值:-
OCR 提取字幕任务配置。当 Type 为 Ocr时需要设置此参数。
WithImageSet Boolean 可选 示例值:true
当输入为 Vid 时,是否对视频中的图集进行 OCR 识别。若视频中无图集,则返回空的识别结果。
注意
使用前请提交工单联系火山引擎技术支持团队申请开通白名单。 Mode String 可选 示例值:-
工作模式。决定了 OCR 识别结果的输出粒度和维度。OCR 算法会自动识别视频画面中的所有文本,并将其分类为“字幕”或“其它”(如 LOGO、水印、场景文字等)。支持的取值如下:
- Subtitle(默认):字幕模式。仅在任务结果中返回被识别为“字幕”类型的文本内容。适用于快速提取对话的场景。
- Detailed:详细模式。在任务结果中输出所有被识别到的文本(包含“字幕”和“其它”全部类型)。此外,该模式还会额外输出每文本的类别标签及在画面中的位置信息。适用于内容安全审核、画面深度分析等精细化场景。
注意
使用其它模式需提交工单联系火山引擎技术支持团队申请。 Control Object 可选 示例值:-
任务控制配置。
ClientToken String 可选 示例值:QqS3o5L4BLFCDxGZ&b
用户请求凭证,用于区分不同请求。大小写敏感,不超过 64 个 ASCII 码可打印字符。默认情况下,视频点播转码服务在接收到触发工作流请求后,会执行幂等行为。这意味着,如果判定当前请求与之前发送的请求相同,则不会重复执行该请求。关于幂等行为、目的和条件,请参考工作流幂等说明。若您希望跳过幂等行为,例如修改了某一工作流所绑定的媒体处理模板中的配置,想要对同一个 Vid 重新执行相同的工作流,则可以设置此参数。 CallbackArgs String 可选 示例值:Example
返回参数
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。 RunId String 示例值:hb:c5cacd4946bd***a5fd9f74159b03ae8
媒体处理任务执行 ID。
通过 Vid 提交 OCR 提取字幕任务。
错误码
服务端 SDK
视频点播为 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API。本接口仅 VOD SDK 2.0 支持,详见 V2.0 SDK 介绍与迁移说明。
最近更新时间:2026.09.18 21:46:18