POST https://mediakit.cn-beijing.volces.com/api/v1/tools/generate-highlights-minigame

本 API 用于提交一个异步的小游戏高光智剪任务。它能识别小游戏录屏视频中的核心玩法与高光事件（如连击、通关、极限操作等），快速生成用于买量推广的视频素材。您可以通过提供游戏名称、玩法描述、高光定义等信息，来辅助模型更精准地识别精彩内容。

请求参数

Header 参数

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

Body 参数

参数	类型	是否必选	示例值	描述
video_urls	Array	是	["https://example.com/video1.mp4"]	待处理的小游戏视频 URL 列表。视频来源：支持公网 HTTP/HTTPS URL、本地上传 (mediakit://)、来源于火山引擎视频点播 (vod://) 和火山引擎对象存储 (tos://) 四种输入协议。关于各协议的具体说明和使用示例，请参阅多源媒体输入与本地上传。支持格式：mp4, flv, ts, avi, mov, wmv, mkv 等主流视频格式。数量限制：当前单次任务仅支持输入单个视频文件。时长限制：输入文件的时长不得超过 10 分钟。输入分辨率限制：最高支持 1080p。
mode	String	是	HighlightExtract	高光提取模式。当前版本固定为 HighlightExtract。
minigame_info	Object	否	-	小游戏的相关描述信息，建议填写以辅助模型更精准地识别高光内容。详见下文 minigame_info 结构。
enable_generate_video	Boolean	否	false	是否生成高光混剪视频。默认为 true。 true：生成并输出高光混剪视频。 false：不生成高光混剪视频。
media_output_destination	String	否	vod://my-space	指定处理产物的目标存储位置。AI MediaKit 支持将处理产物存储至您的火山引擎视频点播（VOD）空间或对象存储（TOS）桶。存储至 VOD：设为 vod://<您的空间名> 存储至 TOS：设为 tos://<您的桶名> 设置本参数后，任务结果中的 url 相关字段将返回形如 vod:// 或 tos:// 格式的资源地址，不再返回临时下载地址。说明首次使用此功能前，您需要先前往 AI MediaKit 控制台基础配置 > 授权管理页面，授权 AI MediaKit 将文件写入您的 VOD 空间或 TOS 桶。更多信息，请参阅开发指南处理产物存储至 VOD 或 TOS。
client_token	String	否	your_unique_request_id_131	用户请求凭证，用于幂等控制。大小写敏感，不超过 64 个 ASCII 码可打印字符。详情请参考幂等性控制。
callback_args	String	否	your_unique_callback_args	自定义回调参数。您提供的内容将在任务完成时，通过事件回调原样返回，方便您关联业务。字段长度最大为 512 字节。
callback_url	String	否	https://example.com/callback	用于接收该任务结果回调的 URL 地址。如果提供此参数，其优先级将高于在控制台配置的全局回调地址。地址必须以 http:// 或 https:// 开头。请参考事件回调了解回调接收机制和回调消息结构。
queue_id	String	否	q00a9731598092652e4a95292434198	任务提交的目标队列 ID。如不传，默认会使用系统自动创建的队列 ID。您可以将不同业务或优先级的任务提交到不同的队列，以实现按队列对应的项目进行分账。您可以在 AI MediaKit 控制台队列管理页面创建和管理队列，系统会自动分配一个队列 ID。详情请参考项目与队列管理。

Minigame info 对象

参数	类型	是否必选	描述
name	String	否	游戏名称，用于标识游戏内容。
play_definition	String	否	游戏的玩法规则或核心特点描述。
highlight_definition	String	否	游戏中的高光时刻或精彩瞬间的定义描述（例如：“一次消除多个方块”、“躲避所有障碍物通关”等）。

请求示例

以下示例演示了如何为一个跑酷小游戏视频提取高光片段。

响应说明

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

响应参数

参数	类型	描述
success	Boolean	任务是否成功提交。 true：任务已成功提交到后台处理队列。 false：请求存在错误，任务提交失败。请检查 error 字段以获取详细信息。
task_id	String	任务的唯一标识符。仅在 success 为 true 时返回有效值。您可以使用此 ID 来查询任务状态和结果。
request_id	String	本次 API 请求的唯一标识符，可用于问题排查。
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 字段将包含以下内容。

参数	类型	描述
duration	Number	输入视频的总时长（单位：秒）。
video_urls	Array	最终生成的高光混剪视频地址列表。如果请求中 enable_generate_video 设置为 false，该字段不返回。地址类型根据请求时是否设置 media_output_destination 而不同：默认情况（未设置 media_output_destination）：返回一个 HTTPS 临时下载链接，有效期为 24 小时，请及时下载保存。设置 media_output_destination 后：返回存储地址，格式为 vod://<空间名>/<媒资ID> 或 tos://<桶名>/<对象Key>。
mixvideo_info	Array	高光混剪视频信息列表，每一项包含构成该混剪的高光片段。详见下文mixvideo_info 结构。

Mixvideo info 对象

参数	类型	描述
mixvideo_index	Integer	混剪视频索引，与 video_urls 数组中的位置一一对应，从 0 开始。
video_url	String	该项对应的混剪视频地址。如果请求中 enable_generate_video 设置为 false，该字段不返回。地址类型根据请求时是否设置 media_output_destination 而不同：默认情况（未设置 media_output_destination）：返回一个 HTTPS 临时下载链接，有效期为 24 小时，请及时下载保存。设置 media_output_destination 后：返回存储地址，格式为 vod://<空间名>/<媒资ID> 或 tos://<桶名>/<对象Key>。
clips	Array	构成该混剪视频的高光片段对象列表。详见下文clips 结构

Clip 对象

参数	类型	描述
clip_type	String	片段类型。取值为 HighlightClip（普通高光片段）。
score	Number	高光分数，范围 [1, 5]。分数越高，代表片段越精彩。
source_video_index	Integer	该片段来源于输入视频列表中的索引位置。由于小游戏高光智剪任务仅支持输入单个视频，该值固定为 0。
source_start_time	Number	片段在原始视频中的起始时间（单位：秒）。
source_end_time	Number	片段在原始视频中的结束时间（单位：秒）。
cut_start_time	Number	片段在最终混剪视频中的起始时间（单位：秒）。
cut_end_time	Number	片段在最终混剪视频中的结束时间（单位：秒）。

以下是一个任务执行完成后的完整任务信息示例：

AI MediaKit