You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /视频点播/API 参考/媒体处理/StartExecution - 提交媒体处理任务
StartExecution - 提交媒体处理任务
最近更新时间：2025.03.28 15:24:02首次发布时间：2025.03.11 21:22:49
我的收藏
有用
有用
无用
无用

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

使用说明

本接口当前可实现以下媒体处理任务：

  • 高光分析任务。详细功能介绍和使用流程请见短剧高光视频智能生成。
  • 巨量广告预审任务。详细功能介绍和使用流程请见巨量广告预审。
  • 大模型理解任务。详细功能介绍和使用流程请见大模型视频理解。
  • 音频提取任务，可从用户输入的音频或视频中分离人声和背景音乐。
  • 语音转写任务，可将用户输入的音频或视频中的语音转写为文本。输入文件时长不可超过 3 小时。

注意事项

  • 高光分析、巨量广告审核、音频提取、语音转写为白名单功能。使用前请提交工单联系火山引擎技术支持团队申请开通。
  • 本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。

请求说明

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

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

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

Body

参数
类型
是否必选
示例值
描述
Input
Object
是
-
输入文件信息。
Type
String
是
Vid

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

  • Vid：Vid 模式。此模式下，您还需设置 Vid 参数。

  • DirectUrl：DirectUrl 模式。此模式下，您还需设置 DirectUrl 参数。

  • 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。
Operation
Object
是
-
媒体处理操作配置。
Type
String
是
Task
处理类型。当前仅支持 Task（单任务）。
Task
Object
否
-
任务配置。当 Type 为 Task 时需要设置此参数。
Type
String
是
Highlight

任务类型：

  • Highlight: 高光分析任务。
  • AdAudit: 巨量广告预审任务。
  • AudioExtract: 音频提取任务。
  • Vision: 大模型视频理解任务。
  • Asr: 语音转写任务。
Highlight
Object
否
-
高光分析任务配置。当 Type 为 Highlight 时需要设置此参数。当前为预留参数，暂不生效，可传入空对象。
Vision
Object
否
-
大模型视频理解任务配置。当 Type 为 Vision 时需要设置此参数。
Prompt
String
是
请根据输入的视频抽帧图片信息以及音频转译文本，撰写视频内容梗概。要求涵盖视频主要情节、关键人物以及核心事件，语言简洁流畅，逻辑清晰。
大模型提示词。使用 UTF-8 编码。长度不可超过 400 个字符。
Model
Object
是
-
大模型配置。
DoubaoVisionEndpoint
String
是
ep-202412***75335-cg2p7
豆包 Doubao-vision 模型的推理接入点 ID。具体请见开通豆包 Doubao-vision 模型并获取 Endpoint ID。
AsrAppId
String
是
3500***054
语音识别 (ASR) 产品的 APP ID。具体请见开通大模型流式语音识别服务并获取 APP ID.
AsrAppType
String
是
volc.bigasr.sauc.duration

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

  • volc.bigasr.sauc.duration: 小时版
  • volc.bigasr.sauc.concurrent: 并发版
AdAudit
Object
否
-
巨量广告预审任务配置。当 Type 为 AdAudit 时需要设置此参数。
AdvertiserId
String
是
18202155***64928
广告主 ID。
BusinessType
String
是
ad

广告投放渠道：

AudioExtract
Object
否
-
音频提取任务配置。当 Type 为 AudioExtract 时需要设置此参数。
Voice
Boolean
是
true
是否提取人声。
Asr
Object
否
-
语音转写任务配置。
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 返回置信度。
Control
Object
否
-
任务控制配置。
ClientToken
String
否
QqS3o5L4BLFCDxGZ&b
用户请求凭证，用于区分不同请求。大小写敏感，不超过 64 个 ASCII 码可打印字符。默认情况下，视频点播转码服务在接收到触发工作流请求后，会执行幂等行为。这意味着，如果判定当前请求与之前发送的请求相同，则不会重复执行该请求。关于幂等行为、目的和条件，请参考工作流幂等说明。若您希望跳过幂等行为，例如修改了某一工作流所绑定的媒体处理模板中的配置，想要对同一个 Vid 重新执行相同的工作流，则可以设置此参数。
CallbackArgs
String
否
Example
自定义字段，将在媒体处理任务执行完成事件中透传返回。字段长度最大为 512 字节。

返回参数

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

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

请求示例

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

POST https://vod.volcengineapi.com?Action=StartExecution&Version=2023-07-01
{
  "Input": {
    "Type": "Vid",
    "Vid": "v0ccfeg7007acsg***fog65ubr7niqng"
  },
  "Operation": {
    "Type": "Task",
    "Task": {
      "Type": "Highlight",
      "Highlight": {}
    }
  },
  "Control": {
    "ClientToken": "1234567891012345678901234"
  }
}

返回示例

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

错误码

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