AI MediaKit
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Authorization | String | 是 | Bearer {Your_API_Key} |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
video_urls | Array | 是 | ["https://example.com/video1.mp4", "https://example.com/video2.mp4"] | 待处理的短剧原片视频源 URL 列表。
|
mode | String | 否 | narrate | 解说视频生成模式,默认为 text。
|
narrate_bgm_url | String | 否 | https://example.com/audio.mp3 | 旁白解说模式下使用的背景音乐音频 URL。如不传,则生成的解说视频不添加背景音乐。
|
max_count | Integer | 否 | 2 | 单次任务期望生成的解说视频数量上限。默认为 3,取值范围为 [1, 100]。建议结合输入的片源时长和目标输出视频的时长范围合理设置生产解说视频个数上限。 |
min_duration | Number | 否 | 50 | 每个解说视频的时长下限,单位为秒。默认为 30,取值范围为 [1, 7200]。 |
max_duration | Number | 否 | 150 | 每个解说视频的时长上限,单位为秒。默认为 180,取值范围为 [1, 7200]。 |
opening_hook | String | 否 | force | 精彩片段前置策略,默认为 auto。
|
enable_return_poster | Boolean | 否 | true | 是否在任务结果中返回解说视频的封面图 URL。默认为 false。
|
narrate_options | Object | 否 | - | |
text_options | Object | 否 | - | |
edit_param | Object | 否 | - | |
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。详情请参考项目与队列管理。 |
参数 | 类型 | 是否必选 | 描述 |
narrate_ratio | Number | 否 | 解说浓度,用于控制旁白解说时长占生成视频的时长的比例。默认为 0.3,取值范围为 [0, 1],值越大解说越密集,建议不要超过 0.5。 |
enable_narrate_bgm | Boolean | 否 | 是否在旁白解说视频中添加背景音乐,默认为 true。
|
erase_subtitle_mode | String | 否 | 原片字幕擦除模式,默认为 mosaic。
|
参数 | 类型 | 是否必选 | 描述 |
font_type | String | 否 | 文字字体类型。可选值:
|
font_size | Integer | 否 | 文字字号,单位 px。不传时将根据视频分辨率自动计算(短边 / 24,例如 720p 默认 30,1080p 默认 45)。不得小于 1。 |
font_color | String | 否 | 文字颜色,格式为 #RRGGBBAA。默认值为 #FFFFF290。 |
align_type | String | 否 | 文字对齐方式。可选值:
|
is_bold | Boolean | 否 | 文字是否加粗。默认值为 false。
|
is_italic | Boolean | 否 | 文字是否斜体。默认值为 true。
|
is_underline | Boolean | 否 | 文字是否添加下划线。默认值为 false。
|
shadow_color | String | 否 | 文字阴影颜色,格式为 #RRGGBBAA。默认值为 #00000080。 |
border_width | Integer | 否 | 文字描边宽度,单位 px,建议不超过字号的 0.1 倍。默认值为 2。 |
border_color | String | 否 | 文字描边颜色,格式为 #RRGGBBAA。默认值为 #00000080。 |
inner_padding | Integer | 否 | 文字内边距,单位 px。默认值为 1。 |
参数 | 类型 | 是否必选 | 描述 |
mode | String | 否 | 成片剪辑模式。默认为 BasicEdit。
|
template_edit | Object | 否 | 短剧模板剪辑参数,当 edit_param.mode 为 TemplateEdit 时生效。详见下文 template_edit 结构。 |
参数 | 类型 | 是否必选 | 描述 |
template | String | 否 | “短剧三要素”视觉模板名称,决定了剧名、角标、提示语的位置和样式。支持的取值如下:
|
title | String | 否 | 短剧名称。在解说视频画面上展示剧名,用于品牌识别和引导用户搜索。不得超过 22 个字。 |
hint | String | 否 | 短剧提示语。画面左右两侧的一行文字,可以是概括视频核心冲突或亮点的引导性文字,也可以是类似“影视效果 请勿模仿 无不良价值观引导”的免责声明。不得超过 20 个字。 |
参数 | 类型 | 描述 |
success | Boolean | 任务是否成功提交。
|
task_id | String | 任务的唯一标识符。仅在 success 为 true 时返回有效值。您可以使用此 ID 来查询任务状态和结果。 |
request_id | String | 本次 API 请求的唯一标识符,可用于问题排查。 |
error | Object | 错误详情对象,仅在 success 为 false 时返回。详见下文 Error 对象。 |
参数 | 类型 | 描述 |
code | String | |
type | String | 错误的宏观类型。例如 BadRequest。 |
message | String | 对错误的详细描述,可用于开发调试。 |
param | String | (可选)指出导致错误的具体参数。 |
参数 | 类型 | 描述 |
input_duration | Number | 输入视频的总时长,单位为秒。 |
output_duration | Number | 输出的所有解说视频的总时长,单位为秒。 |
mode | String | 解说视频生成模式:
|
video_urls | Array | 所有生成的解说视频的地址列表。地址类型根据请求时是否设置 media_output_destination 而不同:
|
video_infos | Array |
参数 | 类型 | 描述 |
duration | Number | 该条解说视频的时长,单位为秒。 |
size | Integer | 该条解说视频的文件大小,单位为字节。 |
poster_url | String | 该条解说视频对应的封面图 URL。如果未生成或请求时 enable_return_poster 为 false,则此字段为空字符串。 |
video_url | String | 该条解说视频的地址。地址类型根据请求时是否设置 media_output_destination 而不同:
|