You need to enable JavaScript to run this app.
文档中心
视频点播

视频点播

复制全文
下载 pdf
媒体处理
StartExecution - 提交媒体处理任务
复制全文
下载 pdf
StartExecution - 提交媒体处理任务

调用 StartExecution 接口提交媒体处理任务,对指定文件进行媒体处理。

使用说明

  • 调用本接口可实现以下媒体处理任务:

    • 高光分析:详细功能介绍和使用流程请见短剧高光智剪。
    • 巨量广告预审:详细功能介绍和使用流程请见巨量广告预审。
    • 大模型理解:详细功能介绍和使用流程请见大模型视频理解。
    • 音频分离:可从用户输入的音频或视频中分离人声和背景音乐。
    • 语音转写:可将用户输入的音频或视频中的语音转写为文本。输入文件时长不得超过 3 个小时。
    • 故事线分析:可对用户输入的单个或多个长视频(包括电影、电视剧、综艺、短剧、微电影等)进行分析理解,并输出故事线信息。单个输入文件时长不得超过 2.5 个小时。
    • 场景切分:可依据转场情况对用户输入的视频进行切分,并输出切片。输入文件时长不得超过 2 个小时。
    • 视频分段摘要:依托 ASR 识别结果,借助大模型自动提取并概括分段视频的摘要,帮助用户快速定位感兴趣的视频片段,适用于教学课程、新闻、演讲等视频场景。
  • 成功提交后,系统将生成异步执行的媒体处理任务。您可通过以下方式获取媒体处理结果:

注意事项

  • 高光分析、巨量广告审核、音频分离、语音转写、故事线分析、场景切分为白名单功能。使用前请提交工单联系火山引擎技术支持团队申请开通。
  • 若您已按照添加对象存储 Bucket中的说明挂载 TOS,则不支持进行故事线分析任务。
  • 提交媒体处理任务会产生视频 AI 费用,具体参见视频 AI 应用计费。
  • 本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。

请求说明

  • 请求方式:POST
  • 请求地址:https://vod.volcengineapi.com?Action=StartExecution&Version=2023-07-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数
类型
是否必选
示例值
描述
Action
String
是
StartExecution
接口名称。当前 API 的名称为 StartExecution。
Version
String
是
2023-07-01
接口版本。当前 API 的版本为 2023-07-01。

Body

参数
类型
是否必选
示例值
描述
Input
Object
否
-

输入文件信息。

注意

您必须设置 Input 或 MultiInputs 参数之一,但不能同时设置这两个参数。

Type
String
是
Vid

输入文件类型。取值如下:

  • Vid:Vid 模式。此模式下,您还需设置 Vid 参数。

  • DirectUrl:DirectUrl 模式。此模式下,您还需设置 DirectUrl 参数。

  • FileId: FileId 模式。此模式下,您还需设置 FileId 参数。

注意

当前仅巨量广告预审任务支持 FileId 模式。

Vid
String
否
v0ccfeg7007acsg***fog65ubr7niqng

视频 ID。音视频上传至视频点播服务后,您可通过媒资上传完成事件获取 Vid。

注意

您必须设置 Vid、DirectUrl 或 FileId 参数之一,但不能同时设置这三个参数。

DirectUrl
Object
否
-

DirectUrl 模式下的文件存储信息。

注意

您必须设置 Vid、DirectUrl 或 FileId 参数之一,但不能同时设置这三个参数。

SpaceName
String
是
test
空间名称。可调用 ListSpace 获取当前账号下所有空间的信息。
FileName
String
是
example.mp4
文件路径。音视频上传至视频点播服务后,您可通过媒资上传完成事件获取 FileName。
BucketName
String
否
tos-cn-v-cd3a11
存储桶名称。可调用 ListSpace 获取空间所绑定的存储桶名称。
FileId
Object
否
-

转码产物 ID 信息。

注意

您必须设置 Vid、DirectUrl 或 FileId 参数之一,但不能同时设置这三个参数。

Vid
String
是
v0ccfeg7007acsg***fog65ubr7niqng
视频 ID。音视频上传至视频点播服务后,您可通过媒资上传完成事件获取 Vid。
FileId
String
是
v02b69g10***ldb8vjafvmg
转码产物文件 ID。可通过 GetMediaInfos 接口从返回参数 TranscodeInfos 中获取转码产物的文件 ID。
Tag
String
否
ImageSet
标识输入的类型,例如在 OCR 任务中可设置为 ImageSet 表示图集。
Operation
Object
是
-
媒体处理操作配置。
Type
String
是
Task

处理类型。取值如下:

  • Template:单模板任务。
  • Task:单任务。
  • Workflow: 工作流任务。
Task
Object
否
-
单任务配置。当 Type 为 Task 时需要设置此参数。
Type
String
是
Highlight

任务类型:

  • Highlight: 高光分析任务。
  • AdAudit: 巨量广告预审任务。
  • AudioExtract: 人声背景音分离任务。
  • Vision: 大模型视频理解任务。
  • Asr: ASR 语音转写任务。
  • Storyline: 故事线分析任务。
  • Segment: 场景切分任务。
  • Ocr: OCR 文本识别任务。
  • Erase: 精细化字幕擦除任务。
  • FileDelete: 文件删除任务。
  • VideoSummary: 视频分段摘要任务。
Highlight
Object
否
-
高光分析任务配置。当 Type 为 Highlight 时需要设置此参数。
Mode
String
否
Clips

高光分析模式:

  • Clips:(默认)高光片段模式
  • StorylineCuts:(推荐)故事线混剪模式,是在高光片段模式的基础上融入故事线信息的升级版本
StorylineCuts
Object
否
-
故事线混剪配置。仅当 mode 取值为 StorylineCuts 时有效。
MinDuration
Double
否
60
输出高光片段的最短时长,单位为秒,默认大于 0。
MaxDuration
Double
否
180
输出高光片段的最大时长,单位为秒。默认由算法自动判断。若用户指定最大时长,则会将混剪结果截断至合适长度,可能不会使用全部输入视频片段。
MaxNumber
Double
否
5
输出高光片段的最多片段数,默认为 1。
Vision
Object
否
-
大模型视频理解任务配置。当 Type 为 Vision 时需要设置此参数。
Prompt
String
是
# 角色\n你是一个视频理解的专家,擅长理解和分析视频。\n\n# 任务\n输入的内容是从爆火网络视频中总结的视频分段描述文本和视频音频转译的文本,请根据输入的内容理解视频,并详细描述一下视频的内容.\n\n# 视频分段描述文本\n{{PLACEHOLDER_VIDEO_CLIP_RESULT}}\n\n# 视频转音频文本\n{{PLACEHOLDER_ASR_RESULT}}

大模型提示词。使用 UTF-8 编码。长度不可超过 2000 个字符。根据 Model 参数所配置的视频理解模式,提示词中需包含相应占位符:

  • VLM + LLM 模式:需包含以下两个占位符
    • {{PLACEHOLDER_ASR_RESULT}}:控制是否启用 ASR(语音识别)。
    • {{PLACEHOLDER_VIDEO_CLIP_RESULT}}:控制是否进行视频切片。
  • 仅 VLM 或仅 LLM 模式:只需包含 {{PLACEHOLDER_ASR_RESULT}} 占位符。
Model
Object
是
-

大模型配置。您可通过此参数配置对视频的理解模式。支持以下三种模式:

  • 纯视觉理解(仅 VLM):适用于需要分析视频画面内容的场景(如不超过 10 分钟的短视频)。会进行视频截图,建议截图分辨率设为 240p 以获得更多截图。推荐使用支持 128k 及以上上下文的模型(如 doubao-seed-1.6-thinking)。
  • 纯音频理解(仅LLM):适用于无需理解视频画面内容的场景(如演讲视频等)。
  • 多模态理解(VLM+LLM):适用于长视频理解(最长支持 2 小时)。会将长视频切分成多个片段,使用 VLM 分别理解每个片段,最后用 LLM 汇总各片段理解结果。
DoubaoVisionEndpoint
String
否
ep-202412***75335-cg2p7

豆包 VLM (Vision Language Model) 模型的推理接入点 ID。具体请见开通豆包大模型并获取 Endpoint ID。

注意

DoubaoVisionEndpoint 和 DoubaoTextEndpoint 二选一必填。

AsrAppId
String
是
3500***054
语音识别 (ASR) 产品的 APP ID。具体请见开通大模型流式语音识别服务并获取 APP ID.
AsrAppType
String
是
volc.bigasr.sauc.duration

语音识别 (ASR) 产品中流式语音识别大模型的类型,需与您开通的服务类型保持一致。取值如下:

  • volc.bigasr.sauc.duration: 小时版
  • volc.bigasr.sauc.concurrent: 并发版
DoubaoTextEndpoint
String
否
ep-202412***75335-cg2p7

豆包 LLM (Large Language Model) 模型的推理接入点 ID。具体请见开通豆包大模型并获取 Endpoint ID。

注意

DoubaoVisionEndpoint 和 DoubaoTextEndpoint 二选一必填。

Segment
Object
否
-
视频分段理解配置。用于指定大模型视频理解任务的起始和结束时间。若不设置 Start,则默认从视频开头开始;若不设置 End,则默认到视频结尾结束。End 要大于 Start。
Start
Double
否
100
起始时间,单位为秒。
End
Double
否
200
结束时间,单位为秒。
SnapshotParam
Object
否
-
截图策略配置。视频理解处理过程中会对视频进行截图。默认截图策略为均匀时间间隔截图最多 50 张。若您需要更改截图策略,可传入此参数。
Resolution
String
是
720p

视频截图的分辨率,取值如下:

  • 240p
  • 360p
  • 480p
  • 720p
  • 1080p
Fps
Double
是
1
每秒截取的帧数。
Area
Object
否
-
截图区域配置。
TopLeftX
Double
否
0
框选区域左上角相对于视频左上角在 X 轴上的偏移,取值范围为 [0,1]。
TopLeftY
Double
否
0
擦除框左上角相对于视频左上角在 Y 轴上的偏移,取值范围为 [0,1]。
BottomRightX
Double
否
0
框选区域右下角相对于视频左上角在 X 轴上的偏移比例,取值范围为 [0,1],其中 0 表示无偏移(与视频左边缘对齐),1 表示完全偏移(与视频右边缘对齐)。
BottomRightY
Double
否
0
框选区域右下角相对于视频左上角在 Y 轴上的偏移比例,取值范围为 [0,1],其中 0 表示无偏移(与视频上边缘对齐),1 表示完全偏移(与视频下边缘对齐)。
AdAudit
Object
否
-
巨量广告预审任务配置。当 Type 为 AdAudit 时需要设置此参数。
AdvertiserId
String
是
18202155***64928
广告主 ID。
BusinessType
String
是
ad

广告投放渠道:

AudioExtract
Object
否
-
人声背景音分离任务配置。当 Type 为 AudioExtract 时需要设置此参数。
Voice
Boolean
是
true
是否提取人声。
Asr
Object
否
-
ASR 语音转写任务配置。当 Type 为 Asr 时需要设置此参数。
Type
String
是
speech

识别类型,取值如下:

  • speech: 对话
  • singing: 歌唱
Language
String
否
cmn-Hans-CN

识别提示语言,取值如下:

  • cmn-Hans-CN: 简体中文
  • cmn-Hant-CN: 繁体中文
  • eng-US: 英语
  • jpn-JP: 日语
  • kor-KR: 韩语
  • rus-RU: 俄语
  • fra-FR: 法语
  • por-PT: 葡萄牙语
  • spa-ES: 西班牙语
  • vie-VN: 越南语
  • mya-MM: 缅甸语
  • nld-NL: 荷兰语
  • deu-DE: 德语
  • ind-ID: 印尼语
  • ita-IT: 意大利语
  • pol-PL: 波兰语
  • tha-TH: 泰语
  • tur-TR: 土耳其语
  • ara-SA: 阿拉伯语
  • msa-MY: 马来语
  • ron-RO: 罗马尼亚语
  • fil-PH: 菲律宾语
  • hin-IN: 印地语
WithSpeakerInfo
Boolean
否
true
是否开启使说话人识别功能。开启后,会通过返回参数 speaker 返回说话人信息。
WithConfidence
Boolean
否
true
是否返回置信度。如设为 true,会通过返回参数 Confidence 返回置信度。
Mode
String
否
Lite
工作模式。当前仅支持设为 Lite,使用前请提交工单联系火山引擎技术支持团队申请开通白名单。
Storyline
Object
否
-
故事线分析任务配置。当 Type 为 Storyline 时需要设置此参数。
WithSnapshot
Boolean
否
true

是否开启视频截图。取值如下:

  • true:开启。
  • false:(默认)关闭。
ClipDuration
Double
否
60
视频片段预期时长,取值范围为 10 至 90 秒。若未填写此值,默认时长为 30 秒。最终输出的片段会尽量趋近于所设定的值。
Ocr
Object
否
-
OCR 文本识别任务配置。当 Type 为 Ocr 时需要设置此参数。
WithImageSet
Boolean
否
true

当输入为 Vid 时,是否对视频中的图集进行 OCR 识别。若视频中无图集,则返回空的识别结果。

注意

使用前请提交工单联系火山引擎技术支持团队申请开通白名单。

Mode
String
否
Lite

工作模式。当前仅支持设为 Lite。

注意

使用前请提交工单联系火山引擎技术支持团队申请开通白名单。

Erase
Object
否
-
精细化字幕擦除任务配置。当 Type 为 Erase 时需要设置此参数。
Mode
String
是
Auto

字幕擦除模式,取值如下:

  • Auto:自动擦除模式。在此模式下,系统将启用 OCR 识别,并依据检测结果进行擦除操作。
  • Manual:(Beta) 手动擦除模式。在此模式下,系统不会启用 OCR 识别,仅擦除白色字幕内容。

说明

不同模式的用途及适用场景说明如下:

  • 一般情况下,可将 Mode 设置为 Auto,再将 Auto.Type 设置为 Subtitle(仅字幕)或 Text(字幕和其它渲染文本),以擦除指定类型的文本。
  • 若您对擦除区域有特殊需求,可通过设置 Locations 来指定擦除框,仅擦除框内经 OCR 识别的文本。
  • 在需要擦除中英文外的小语种字幕的场景中,可将 Mode 设置为 Manual,并设置 Locations 来指定擦除框。
Auto
Object
否
-
自动擦除模式配置
Type
String
是
Subtitle

文本擦除类型:

  • Subtitle: 擦除 OCR 检测为字幕的文本
  • Text: (Beta) 擦除除场景文字(如宫殿门牌匾等)以外的字幕及其他文本(如人物介绍等)。
Locations
Object[]
否
-
擦除框数组。添加擦除框后,系统仅擦除框内文本。
RatioLocation
Object
否
-

擦除框位置信息

说明

关于设置擦除框参数的详细介绍,请见提交精细化字幕擦除任务。

TopLeftX
Double
否
0
框选区域左上角相对于视频左上角在X轴上的偏移比例,取值范围为[0,1],其中 0 表示无偏移(与视频左边缘对齐),1 表示完全偏移(与视频右边缘对齐)。
TopLeftY
Double
否
0
框选区域左上角相对于视频左上角在 Y 轴上的偏移比例,取值范围为 [0,1],其中 0 表示无偏移(与视频上边缘对齐),1 表示完全偏移(与视频下边缘对齐)。
BottomRightX
Double
否
0
框选区域右下角相对于视频左上角在 X 轴上的偏移比例,取值范围为 [0,1],其中 0 表示无偏移(与视频左边缘对齐),1 表示完全偏移(与视频右边缘对齐)。
BottomRightY
Double
否
0
框选区域右下角相对于视频左上角在 Y 轴上的偏移比例,取值范围为 [0,1],其中 0 表示无偏移(与视频上边缘对齐),1 表示完全偏移(与视频下边缘对齐)。
Manual
Object
否
-
手动擦除模式配置
Locations
Object[]
否
-
擦除框数组。添加擦除框后,系统仅擦除框内文本。
RatioLocation
Object
否
-

擦除框位置信息

说明

关于设置擦除框参数的详细介绍,请见提交精细化字幕擦除任务。

TopLeftX
Double
否
0
框选区域左上角相对于视频左上角在X轴上的偏移比例,取值范围为[0,1],其中 0 表示无偏移(与视频左边缘对齐),1 表示完全偏移(与视频右边缘对齐)。
TopLeftY
Double
否
0
框选区域左上角相对于视频左上角在 Y 轴上的偏移比例,取值范围为 [0,1],其中 0 表示无偏移(与视频上边缘对齐),1 表示完全偏移(与视频下边缘对齐)。
BottomRightX
Double
否
0
框选区域右下角相对于视频左上角在 X 轴上的偏移比例,取值范围为 [0,1],其中 0 表示无偏移(与视频左边缘对齐),1 表示完全偏移(与视频右边缘对齐)。
BottomRightY
Double
否
0
框选区域右下角相对于视频左上角在 Y 轴上的偏移比例,取值范围为 [0,1],其中 0 表示无偏移(与视频上边缘对齐),1 表示完全偏移(与视频下边缘对齐)。
WithEraseInfo
Boolean
否
true
是否返回擦除信息详情
Segment
Object
否
-
场景切分任务配置。当 Type 为 Segment 时需要设置此参数。
NoFile
Boolean
否
true

是否生成切片文件:

  • true: 不生成切片文件
  • false:(默认)生成切片文件
FileDelete
Object
否
-
文件删除任务配置。当 Type 为 FileDelete 时需要设置此参数。
SkipError
Boolean
否
true
在多输入的情况下,当单个文件删除失败时,是否忽略错误继续删除剩余文件。默认值为 false,即终止文件删除并返回错误。
VideoSummary
Object
否
-
视频分段摘要任务配置。当 Type 为 VideoSummary 时需要设置此参数。
OnlyTimeline
Boolean
否
true
是否仅输出时间线。默认为 false,生成的视频分段摘要中,将包含时间、阶段主题、阶段摘要、阶段细节信息。若 OnlyTimeline 设置为 true,则结果中仅返回时间段信息,即大模型仅进行分段,不生成摘要。
ExtraDescription
String
否
本视频为医学教学视频,按照相关知识点对视频进行分段
补充任务提示词。默认为空。建议您在效果不达预期时,通过本字段在任务 Prompt 中补充信息。不超过 1000 字符。
BestSegmentDuration
Integer
否
180

期望的大模型视频分段时长,单位为秒,默认值为 180。

说明

最终输出的分段视频时长可能不会与您所设置的 BestSegmentDuration 严格相符。

Template
Object
否
-
单模板任务配置。当 Type 为 Template 时需要设置此参数。
Type
String
是
TranscodeVideo

单模板任务类型。取值如下:

  • TranscodeVideo:视频转码模板任务。
  • ByteHD:极智超清模板任务。
  • TranscodeAudio:音频转码模板任务。
  • Enhance:画质增强模板任务。
TranscodeVideo
Object
否
-
视频转码模板任务配置。当 Type 取值为 TranscodeVideo 时,需要设置此参数。
TemplateId
String
是
ddc7d66386***6056a
视频转码模板 ID。可在视频点播控制台创建模板并获取模板 ID,详见视频转码模板。
WatermarkTemplateId
String
否
v0dc24g10***c1cepmu6g
水印贴片模板 ID。若设置此参数,系统会在转码过程中将不同形式的水印以数据元素的形式和原视频画面融合和拼接,输出带水印的新视频文件。可在视频点播控制台创建模板并获取模板 ID,详见水印贴片模板。
ByteHD
Object
否
-
极智超清模板任务配置。当 Type 取值为 ByteHD 时,需要设置此参数。
TemplateId
String
是
ddc66386***6056a
极智超清模板 ID。可在视频点播控制台创建模板并获取模板 ID,详见极智超清模板。
WatermarkTemplateId
String
否
v0dc24g10***c1cepmu6g
水印贴片模板 ID。若设置此参数,系统会在转码过程中将不同形式的水印以数据元素的形式和原视频画面融合和拼接,输出带水印的新视频文件。可在视频点播控制台创建模板并获取模板 ID,详见水印贴片模板。
TranscodeAudio
Object
否
-
音频转码模板任务配置。当 Type 取值为 TranscodeAudio 时,需要设置此参数。
TemplateId
String
是
ddc7d66386***6056a
音频转码模板 ID。可在视频点播控制台创建模板并获取模板 ID,详见音频转码模板。
Enhance
Object
否
-
画质增强模板任务配置。当 Type 取值为 Enhance 时,需要设置此参数。
TemplateId
String
是
ddc7d66386***6056a
画质增强模板 ID。可在视频点播控制台创建模板并获取模板 ID,详见画质增强模板。
Workflow
Object
否
-
工作流任务配置。当 Type 为 Workflow 时需要设置此参数。
Nodes
Object[]
是
-
工作流节点定义。
Name
String
是
FileDelete
节点名称。工作流中的节点不能有重复命名。
Input
Object
否
-
媒体处理任务的输入文件信息。
Type
String
是
Vid

输入文件类型。取值如下:

  • Vid:Vid 模式。此模式下,您还需设置 Vid 参数。

  • DirectUrl:DirectUrl 模式。此模式下,您还需设置 DirectUrl 参数。

  • FileId: FileId 模式。此模式下,您还需设置 FileId 参数。

注意

当前仅巨量广告预审任务支持 FileId 模式。

Vid
String
否
v0ccfeg7007acsg***fog65ubr7niqng

视频 ID。音视频上传至视频点播服务后,您可通过媒资上传完成事件获取 Vid。

注意

您必须设置 Vid、DirectUrl 或 FileId 参数之一,但不能同时设置这三个参数。

DirectUrl
Object
否
-

DirectUrl 模式下的文件存储信息。

注意

您必须设置 Vid、DirectUrl 或 FileId 参数之一,但不能同时设置这三个参数。

SpaceName
String
是
test
空间名称。可调用 ListSpace 获取当前账号下所有空间的信息。
FileName
String
是
example.mp4
文件路径。音视频上传至视频点播服务后,您可通过媒资上传完成事件获取 FileName。
BucketName
String
否
tos-cn-v-cd3a11
存储桶名称。可调用 ListSpace 获取空间所绑定的存储桶名称。
FileId
Object
否
-

转码产物 ID 信息。

注意

您必须设置 Vid、DirectUrl 或 FileId 参数之一,但不能同时设置这三个参数。

Vid
String
是
v0ccfeg7007acsg***fog65ubr7niqng
视频 ID。音视频上传至视频点播服务后,您可通过媒资上传完成事件获取 Vid。
FileId
String
是
v02b69g10***ldb8vjafvmg
转码产物文件 ID。可通过 GetMediaInfos 接口从返回参数 TranscodeInfos 中获取转码产物的文件 ID。
Tag
String
否
ImageSet
标识输入的类型,例如在 OCR 任务中可设置为 ImageSet 表示图集。
MultiInputs
Object[]
否
-

媒体处理任务的输入文件信息数组。

注意

您必须设置 Input 或 MultiInputs 参数之一,但不能同时设置这两个参数。

Type
String
是
Vid

输入文件类型。取值如下:

  • Vid:Vid 模式。此模式下,您还需设置 Vid 参数。

  • DirectUrl:DirectUrl 模式。此模式下,您还需设置 DirectUrl 参数。

  • FileId: FileId 模式。此模式下,您还需设置 FileId 参数。

注意

当前仅巨量广告预审任务支持 FileId 模式。

Vid
String
否
v0ccfeg7007acsg***fog65ubr7niqng

视频 ID。音视频上传至视频点播服务后,您可通过媒资上传完成事件获取 Vid。

注意

您必须设置 Vid、DirectUrl 或 FileId 参数之一,但不能同时设置这三个参数。

DirectUrl
Object
否
-

DirectUrl 模式下的文件存储信息。

注意

您必须设置 Vid、DirectUrl 或 FileId 参数之一,但不能同时设置这三个参数。

SpaceName
String
是
test
空间名称。可调用 ListSpace 获取当前账号下所有空间的信息。
FileName
String
是
example.mp4
文件路径。音视频上传至视频点播服务后,您可通过媒资上传完成事件获取 FileName。
BucketName
String
否
tos-cn-v-cd3a11
存储桶名称。可调用 ListSpace 获取空间所绑定的存储桶名称。
FileId
Object
否
-

转码产物 ID 信息。

注意

您必须设置 Vid、DirectUrl 或 FileId 参数之一,但不能同时设置这三个参数。

Vid
String
是
v0ccfeg7007acsg***fog65ubr7niqng
视频 ID。音视频上传至视频点播服务后,您可通过媒资上传完成事件获取 Vid。
FileId
String
是
v02b69g10***ldb8vjafvmg
转码产物文件 ID。可通过 GetMediaInfos 接口从返回参数 TranscodeInfos 中获取转码产物的文件 ID。
Tag
String
否
ImageSet
标识输入的类型,例如在 OCR 任务中可设置为 ImageSet 表示图集。
Operation
Object
是
-

媒体处理操作配置。

注意

工作流任务当前仅支持 ASR 语言转写、OCR 文本识别和文件删除任务。

Dependencies
String[]
否
["Ocr","Asr"]
所依赖的节点名称。
Policy
Object
否
-
节点执行策略配置。
NodeFail
String
否
Abort

前置节点失败时的处理策略,默认值为 Abort。支持的取值如下:

  • Abort:前置节点失败,终止运行。
  • Ignore:忽略前置节点错误。
Control
Object
否
-
任务控制配置。
ClientToken
String
否
QqS3o5L4BLFCDxGZ&b
用户请求凭证,用于区分不同请求。大小写敏感,不超过 64 个 ASCII 码可打印字符。默认情况下,视频点播转码服务在接收到触发工作流请求后,会执行幂等行为。这意味着,如果判定当前请求与之前发送的请求相同,则不会重复执行该请求。关于幂等行为、目的和条件,请参考工作流幂等说明。若您希望跳过幂等行为,例如修改了某一工作流所绑定的媒体处理模板中的配置,想要对同一个 Vid 重新执行相同的工作流,则可以设置此参数。
CallbackArgs
String
否
Example
自定义字段,将在媒体处理任务执行完成事件中透传返回。字段长度最大为 512 字节。
MultiInputs
Object[]
否
-

输入文件信息数组。

注意

  • 您必须设置 Input 或 MultiInputs 参数之一,但不能同时设置这两个参数。
  • 仅高光分析和长视频故事线分析任务支持多个输入文件。
  • 单次任务最多输入 30 个文件。
  • 多个输入文件的类型必须保持一致。
    • 若为 Vid 类型,这些文件需来自同一个空间。
    • 若为 DirectUrl 类型,文件则需来自同一个空间和存储桶。
Type
String
是
Vid

输入文件类型。取值如下:

  • Vid:Vid 模式。此模式下,您还需设置 Vid 参数。

  • DirectUrl:DirectUrl 模式。此模式下,您还需设置 DirectUrl 参数。

Vid
String
否
v0ccfeg7007acsg***fog65ubr7niqng

视频 ID。音视频上传至视频点播服务后,您可通过媒资上传完成事件获取 Vid。

注意

您必须设置 Vid 或 DirectUrl 参数之一,但不能同时设置这两个参数。

DirectUrl
Object
否
-

DirectUrl 模式下的文件存储信息。

注意

您必须设置 Vid 或 DirectUrl 参数之一,但不能同时设置这两个参数。

SpaceName
String
是
test
空间名称。可调用 ListSpace 获取当前账号下所有空间的信息。
FileName
String
是
example.mp4
文件路径。音视频上传至视频点播服务后,您可通过媒资上传完成事件获取 FileName。
BucketName
String
否
tos-cn-v-cd3a11
存储桶名称。可调用 ListSpace 获取空间所绑定的存储桶名称。
Tag
String
否
ImageSet
标识输入的类型,例如在 OCR 任务中可设置为 ImageSet 表示图集。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数
类型
示例值
描述
RunId
String
hb:c5cacd4946bd***a5fd9f74159b03ae8
媒体处理任务执行 ID。

请求示例

高光分析

通过 Vid 提交高光分析任务:

POST https://vod.volcengineapi.com?Action=StartExecution&Version=2023-07-01
{
  "MultiInputs": [
    {
      "Type": "Vid",
      "Vid": "v0d399g10001d0vavaaljht2b2ut25hg"
    },
    {
      "Type": "Vid",
      "Vid": "v0d399g10001d0vavaaljhtdla347kr0"
    },
    {
      "Type": "Vid",
      "Vid": "v03399g10001d0vavaaljht5539pchbg"
    }
  ],
  "Operation": {
    "Type": "Task",
    "Task": {
      "Type": "Highlight",
      "Highlight": {
        "Mode": "StorylineCuts",
        "StorylineCuts": {
          "MinDuration": 60,
          "MaxDuration": 180,
          "MaxNumber": 2
        }
      }
    }
  }
}

巨量广告预审

POST https://vod.volcengineapi.com?Action=StartExecution&Version=2023-07-01
{
  "Input": {
    "Type": "Vid",
    "Vid": "v0d25cg10001cu7jcvqljht8dj05mde0"
  },
  "Operation": {
    "Type": "Task",
    "Task": {
      "Type": "AdAudit",
      "AdAudit": {
        "AdvertiserId": "1812496***000731",
        "BusinessType": "ad"
      }
    }
  }
}

大模型视频理解

POST https://vod.volcengineapi.com?Action=StartExecution&Version=2023-07-01
{
  "Input": {
    "Type": "Vid",
    "Vid": "v0d25cg10001cu7jcvqljht8dj05mde0"
  },
  "Operation": {
    "Type": "Task",
    "Task": {
      "Type": "Vision",
      "Vision": {
        "Prompt": "基于输入的视频抽帧图片信息和音频转译文本,深度理解视频内容。首先,撰写一段视频总结,需涵盖视频的核心主题、主要情节、关键人物及其关系及核心观点或情感;其次,抽取能精准概括视频内容、突出视频特色的主要标签。",
        "Model": {
          "DoubaoVisionEndpoint": "ep-202412***175335-cg2p7",
          "AsrAppId": "3500***054",
          "AsrAppType": "volc.bigasr.sauc.duration"
        }
      }
    }
  }
}

音频分离

通过 Vid 提交音频分离任务

POST https://vod.volcengineapi.com?Action=StartExecution&Version=2023-07-01
{
  "Input": {
    "Type": "Vid",
    "Vid": "v0d25cg10001cu7jcvqljht8dj05mde0"
  },
  "Operation": {
    "Type": "Task",
    "Task": {
      "Type": "AudioExtract",
      "AudioExtract": {
        "Voice": true
      }
    }
  }
}

语音转写

通过 Vid 提交语音转写任务:

POST https://vod.volcengineapi.com?Action=StartExecution&Version=2023-07-01
{
  "Input": {
    "Type": "Vid",
    "Vid": "v0325cg10001cuvvh4qljht4om9gitmg"
  },
  "Operation": {
    "Type": "Task",
    "Task": {
      "Type": "Asr",
      "Asr": {
        "Type": "speech",
        "WithSpeakerInfo": true,
        "WithConfidence": true
      }
    }
  }
}

故事线分析

基于多个 Vid 类型输入文件提交故事线分析任务:

POST https://vod.volcengineapi.com?Action=StartExecution&Version=2023-07-01
{
  "MultiInputs": [
    {
      "Type": "Vid",
      "Vid": "v0ccfeg7007acu3qlm7og65tu3orai10"
    },
    {
      "Type": "Vid",
      "Vid": "v0ccfeg7007acu3qlm7og65tu3orai11"
    },
    {
      "Type": "Vid",
      "Vid": "v0ccfeg7007acu3qlm7og65tu3orai12"
    }
  ],
  "Operation": {
    "Type": "Task",
    "Task": {
      "Type": "Storyline",
      "Storyline": {
        "WithSnapshot": true
      }
    }
  },
  "Control": {
    "ClientToken": "12345654321"
  }
}

视频分段摘要

POST https://vod.volcengineapi.com?Action=StartExecution&Version=2023-07-01

场景切分

通过 Vid 提交场景切分任务:

POST https://vod.volcengineapi.com?Action=StartExecution&Version=2023-07-01
{
  "Input": {
    "Type": "Vid",
    "Vid": "v028adg10003d04b0j2ljhtfnjj11q80"
  },
  "Operation": {
    "Type": "Task",
    "Task": {
      "Type": "Segment",
      "Segment": {}
    }
  },
  "Control": {
    "ClientToken": "1235"
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110420****100232280022D31",
    "Action": "StartExecution",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "RunId": "hb:c5cacd4946bd***a5fd9f74159b03ae8"
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

视频点播为 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API。本接口仅 VOD SDK 2.0 支持,详见 V2.0 SDK 介绍与迁移说明。

最近更新时间:2026.08.28 17:50:35
这个页面对您有帮助吗?
有用
有用
无用
无用