AI MediaKit
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Authorization | String | 是 | Bearer {Your_API_Key} |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
video_url | String | 否 | https://example.com/your_video.mp4 | 待编辑视频源 URL。与 audio_url 二选一,必须且只能提供其中一个。
|
audio_url | String | 否 | https://example.com/your_audio.mp3 | 待编辑音频源 URL。与 video_url 二选一,必须且只能提供其中一个。
|
edits | Array of Object | 是 | 见下方请求示例 | |
media_output_destination | String | 否 | tos://<您的桶名> | 指定处理产物的目标存储位置。AI MediaKit 支持将处理产物存储至您的火山引擎视频点播(VOD)空间或对象存储(TOS)桶。
设置本参数后,任务结果中的 url 相关字段将返回形如 vod:// 或 tos:// 格式的资源地址,不再返回临时下载地址。 说明 首次使用此功能前,您需要先前往 AI MediaKit 控制台基础配置 > 授权管理页面,授权 AI MediaKit 将文件写入您的 VOD 空间或 TOS 桶。更多信息,请参阅开发指南处理产物存储至 VOD 或 TOS。 |
client_token | String | 否 | your_unique_request_id_135 | |
callback_args | String | 否 | your_custom_callback_args | |
callback_url | String | 否 | https://example.com/callback | 用于接收该任务结果回调的 URL 地址。如提供此参数,其优先级高于控制台配置的全局回调地址。地址必须以 http:// 或 https:// 开头。不传时使用控制台全局回调地址;若均未配置则不发送回调。请参考事件回调了解回调接收机制和回调消息结构。 |
queue_id | String | 否 | q00a9731598092652e4a95292434198 | 任务提交的目标队列 ID。如不传,默认会使用系统自动创建的队列 ID。您可以将不同业务或优先级的任务提交到不同的队列,以实现按队列对应的项目进行分账。您可以在 AI MediaKit 控制台队列管理页面创建和管理队列,系统会自动分配一个队列 ID。详情请参考按项目或 API Key 分账。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
instruction | String | 是 | 把'喝酒'替换成'喝茶' | 自然语言编辑指令。当前仅支持固定“两段式替换”语义,即将音频中出现的原文片段替换为新文案片段。推荐指令格式:
编写规范:
效果不佳的写法示例:
如同一段“原文”在音频中多次出现,建议配合 search_range 限定搜索时间范围以提升命中准确性。 |
search_range | Object | 否 | {"start_time": 5, "end_time": 12} |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
start_time | Number | 是 | 5 | 搜索起始时间,单位为秒。取值范围为 ≥ 0,且须小于 end_time。 |
end_time | Number | 是 | 12 | 搜索结束时间,单位为秒。取值范围为 ≥ 0,且须大于 start_time。 |
参数 | 类型 | 描述 |
success | Boolean | 任务是否成功提交。
|
task_id | String | 任务的唯一标识符。仅在 success 为 true 时返回有效值,用于后续查询任务进度和结果。 |
request_id | String | 本次 API 请求的唯一标识符,可用于问题排查。 |
error | Object | 错误详情对象,仅在 success 为 false 时返回。详见下方 Error 对象。 |
参数 | 类型 | 描述 |
code | String | |
type | String | 错误的宏观类型。例如 BadRequest。 |
message | String | 对错误的详细描述,可用于开发调试。 |
param | String | (可选)指出导致错误的具体参数。 |
参数 | 类型 | 示例 | 描述 |
video_url | String | https://example.volcvideo.com/edit_speech_output.mp4?auth_key=... | 编辑后视频的下载地址,仅视频输入时返回。地址类型根据请求时是否设置 media_output_destination 而不同:
|
audio_url | String | https://example.volcvideo.com/edit_speech_output.mp3?auth_key=... | 编辑后音频的下载地址,仅音频输入时返回。地址类型根据请求时是否设置 media_output_destination 而不同:
|
duration | Number | 60.5 | 计费时长,单位为秒。 |
input_duration | Number | 60.5 | 输入媒体时长,单位为秒。 |
edited_duration | Number | 3.2 | 实际编辑的音频时长,单位为秒;编辑多处时为各处求和。 |