AI MediaKit
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Authorization | String | 是 | Bearer {Your_API_Key} |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
video_urls | Array | 是 | ["https://example.com/video1.mp4", "https://example.com/video2.mp4"] | 待处理的短剧原片视频 URL 列表。
|
mode | String | 是 | StorylineCuts | 短剧高光智剪模式。当前版本固定为 StorylineCuts(故事线混剪模式)。 |
enable_generate_video | Boolean | 否 | true | 是否生成高光混剪视频。默认为 true。
|
enable_return_poster | Boolean | 否 | true | 是否在任务结果中返回混剪视频的封面图 URL。默认为 false。
|
edit_param | Object | 否 | - | 高光视频剪辑配置,用于控制最终输出视频的视觉风格。如果 enable_generate_video 为 false,此参数将被忽略。通过此参数,您可以选择是仅进行基础剪辑,还是应用包含剧名、角标等元素的“短剧三要素”视觉模板。如果留空,则默认使用基础剪辑模式。详见下文 edit_param 结构。 |
highlight_cuts_param | Object | 否 | - | 高光智剪参数配置,用于控制最终输出视频的时长与个数。通过此参数,您可以定义输出视频的总时长和个数、剪辑模式(顺剪或混剪),以及是否需要输出详细的分镜信息。如果留空,则默认使用热门短剧1模板。详见下文 highlight_cuts_param 结构。 |
opening_hook_param | Object | 否 | - | 精彩前置(开场钩子)功能参数配置,用于控制是否在视频开头添加一个极具吸引力的“钩子”片段来留住观众。您可以通过此参数开启或关闭该功能,并设置钩子片段的时长及筛选标准。如果留空,则默认在视频开头添加精彩前置片段。详见下文 opening_hook_param 结构。 |
video_ending_mode | String | 否 | SmartSelect | 高光智剪视频结尾选取模式。可选值:
|
enable_segment_tag | Boolean | 否 | true | 是否在任务结果中为高光片段和分镜返回标签。默认为 false。
|
media_output_destination | String | 否 | vod://my-space | 指定处理产物的目标存储位置。AI MediaKit 支持将处理产物存储至您的火山引擎视频点播(VOD)空间或对象存储(TOS)桶。
设置本参数后,任务结果中的 url 相关字段将返回形如 vod:// 或 tos:// 格式的资源地址,不再返回临时下载地址。 说明 首次使用此功能前,您需要先前往 AI MediaKit 控制台基础配置 > 授权管理页面,授权 AI MediaKit 将文件写入您的 VOD 空间或 TOS 桶。更多信息,请参阅开发指南处理产物存储至 VOD 或 TOS。 |
client_token | String | 否 | your_unique_request_id_131 | |
callback_args | String | 否 | your_unique_callback_args | |
callback_url | String | 否 | https://example.com/callback | 用于接收该任务结果回调的 URL 地址。如果提供此参数,其优先级将高于在控制台配置的全局回调地址。地址必须以 http:// 或 https:// 开头。请参考事件回调了解回调接收机制和回调消息结构。 |
queue_id | String | 否 | q00a9731598092652e4a95292434198 | 任务提交的目标队列 ID。如不传,默认会使用系统自动创建的队列 ID。您可以将不同业务或优先级的任务提交到不同的队列,以实现按队列对应的项目进行分账。您可以在 AI MediaKit 控制台队列管理页面创建和管理队列,系统会自动分配一个队列 ID。详情请参考项目与队列管理。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
mode | String | 否 | TemplateEdit | 成片剪辑模式,决定是否使用视觉模板。默认为 BasicEdit。
|
template_edit | Object | 否 | - |
参数 | 类型 | 是否必选 | 描述 |
template | String | 否 | “短剧三要素”视觉模板名称,决定剧名、角标、提示语的样式和位置。默认为 热门短剧1。支持取值:
说明 |
title | String | 否 | 短剧名称,将显示在视频画面中。不超过 22 个字符。 |
hint | String | 否 | 短剧提示语,将显示在画面左侧或右侧。不超过 20 个字符。 |
参数 | 类型 | 是否必选 | 描述 |
enable_storyboard | Boolean | 否 | 是否在任务结果中输出详细的分镜信息(storyboard_info)。默认为 false。 |
min_duration | Number | 否 | 期望输出高光视频的最小时长(单位:秒)。默认为 30。 注意 算法最终输出的高光时长会尽量趋近于您设置的 min_duration 和 max_duration 范围,实际时长与设定值可能存在几秒钟的微小误差。 |
max_duration | Number | 否 | 期望输出高光视频的最大时长(单位:秒)。默认为 180。 |
max_number | Integer | 否 | 最多输出的高光视频数量。默认为 6。 |
cut_mode | String | 否 | 剪辑模式。默认为 Mixed。
|
highlight_segment_prompt | String | 否 | |
highlight_start_prompt | String | 否 | |
highlight_ending_prompt | String | 否 | |
user_preferred_segments | Array | 否 | 用户期望优先选用的原片内容或片段。仅在混剪模式(cut_mode 为 Mixed)下生效。支持填写多个。详见下文 user_preferred_segments 结构。例如 user_preferred_segments 为 {"episode": 4, "start_time": 0, "end_time": 10} 表示优先选用输入第 5 个视频中的 0-10 秒的片段。具体使用方式可参阅精细化引导混剪模式的高光选取。 |
参数 | 类型 | 是否必选 | 描述 |
enable_opening_hook | Boolean | 否 | 是否启用精彩前置(开场钩子)功能。默认为 true。 |
min_duration | Number | 否 | 开场钩子片段的最小时长(单位:秒)。默认为 5。 |
max_duration | Number | 否 | 开场钩子片段的最大时长(单位:秒)。默认为 15。 |
min_clip_duration | Number | 否 | 构成开场钩子的单个高光片段的最小持续时长(单位:秒)。默认为 5。 |
min_score | Number | 否 | 构成开场钩子的单个高光片段所需达到的最低高光分。范围 [1, 5],默认为 3。 |
opening_hook_prompt | String | 否 |
参数 | 类型 | 是否必选 | 描述 |
episode | Integer | 是 | 优先选用的输入视频序号,从 0 开始计数。仅含 episode 表示整集优先。 |
start_time | Number | 否 | 优先片段在该输入视频中的起始时间(单位:秒)。与 end_time 一并提供时,表示该集指定时间区间优先。 |
end_time | Number | 否 | 优先片段在该输入视频中的结束时间(单位:秒)。 |
参数 | 类型 | 描述 |
success | Boolean | |
task_id | String | 任务的唯一标识,用于后续查询任务状态和结果。 |
request_id | String | 本次请求的唯一标识,可用于问题排查。 |
参数 | 类型 | 描述 |
duration | Number | 输入视频的总时长(单位:秒)。 |
video_urls | Array | 最终生成的混剪视频地址列表。地址类型根据请求时是否设置 media_output_destination 而不同:
|
mixvideo_info | Array | |
storyboard_info | Array |
参数 | 类型 | 描述 |
mixvideo_index | Integer | 混剪视频的索引,与 video_urls 数组中的位置一一对应,从 0 开始。 |
duration | Number | 该混剪视频的时长,单位为秒。 |
size | Integer | 该混剪视频的文件大小,单位为字节。 |
poster_url | String | 该混剪视频对应的封面图 URL。仅当请求中 enable_return_poster 为 true 且算法成功生成封面时返回。 |
video_url | String | 该项对应的混剪视频地址。如果 enable_generate_video 为 false 或底层未产生成片,此字段为空。地址类型根据请求时是否设置 media_output_destination 而不同:
|
clips | Array |
参数 | 类型 | 描述 |
clip_type | String | 片段类型。取值如下:
|
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 | 片段在最终混剪视频中的结束时间(单位:秒)。 |
tags | Array | 高光片段的标签,例如 ["争吵", "暴力冲突"]。仅当请求中 enable_segment_tag 为 true 时返回。标签可用于内容检索与推荐、Agent/开发者基于片段标签灵活进行二次创编等场景。 |
参数 | 类型 | 描述 |
source_video_index | Integer | 该分镜来源于输入视频列表中的索引位置,从 0 开始。 |
start_time | Number | 分镜在原始视频中的起始时间(单位:秒)。 |
end_time | Number | 分镜在原始视频中的结束时间(单位:秒)。 |
score | Number | 分镜的高光分数,范围 [1, 5]。 |
ocr | String | 识别出的画面字幕文本。 |
description | String | 算法生成的画面描述信息。 |
tags | Array | 分镜的标签,例如 ["争吵", "威胁"]。仅当请求中 enable_segment_tag 为 true 时返回。标签可用于内容检索与推荐、Agent/开发者基于片段标签灵活进行二次创编等场景。 |