You need to enable JavaScript to run this app.
文档中心
AI MediaKit

AI MediaKit

复制全文
下载 pdf
剪辑工具 API
提交音视频合成任务 API
复制全文
下载 pdf
提交音视频合成任务 API
POST https://mediakit.cn-beijing.volces.com/api/v1/tools/mux-audio-video​
本 API 用于提交一个异步的音视频合成任务,将输入的音频流与视频流合并成一个新的视频文件。您可以选择保留或替换视频的原有音轨,并对时长不一致的音视频进行对齐处理。​
说明​
如需了解完整的使用流程和应用示例,请参阅音视频合成。​
请求参数​
Header 参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Authorization​
String​
是​
Bearer {Your_API_Key}​
格式为 Bearer {Your_API_Key}。请参考基础概念及准备工作获取 API Key。​
​
Body 参数​
​
参数​
类型​
是否必选​
示例值​
描述​
video_url​
String​
是​
"https://example.com/source.mp4"​
输入视频的 URL。​
  • 视频来源:支持公网 HTTP/HTTPS URL、本地上传 (mediakit://)、来源于火山引擎视频点播 (vod://) 和火山引擎对象存储 (tos://) 四种输入协议。关于各协议的具体说明和使用示例,请参阅多源媒体输入与本地上传。​
  • 支持格式:mp4, flv, ts, avi, mov, wmv, mkv 等主流视频格式。​
  • 文件大小建议:建议单个输入文件大小不超过 10 GB。​
  • 分辨率限制:输入视频最高支持 4K (3840×2160) 分辨率。​
audio_url​
String​
是​
"https://example.com/background.mp3"​
输入音频的 URL。​
  • 音频来源:支持公网 HTTP/HTTPS URL、本地上传 (mediakit://)、来源于火山引擎视频点播 (vod://) 和火山引擎对象存储 (tos://) 四种输入协议。关于各协议的具体说明和使用示例,请参阅多源媒体输入与本地上传。​
  • 支持格式:mp3, m4a, wav 等主流音频格式。​
  • 文件大小:建议单个输入文件大小不超过 10 GB。​
is_audio_reserve​
Boolean​
否​
false​
是否保留视频原音轨。​
  • true:(默认值)保留原音轨,新音频将与原音频混音。​
  • false:不保留原音轨,即用新音频替换原有音频。​
is_video_audio_sync​
Boolean​
否​
true​
是否对齐音视频时长。​
  • false:(默认值)不对齐。合成视频的时长以较长的媒体流为准。​
  • true:对齐。根据下方 sync_mode 和 sync_method 的配置进行处理。​
sync_mode​
String​
否​
video​
音视频时长对齐基准,仅在 is_video_audio_sync 为 true 时生效。​
  • video:(默认值)以视频时长为准。如果音频更长,则裁剪音频;如果音频更短,则根据 sync_method 处理。​
  • audio:以音频时长为准。如果视频更长,则裁剪视频;如果视频更短,则根据 sync_method 处理。​
sync_method​
String​
否​
trim​
时长对齐的具体方式,仅在 is_video_audio_sync 为 true 时生效。​
  • trim:(默认值)裁剪。将较长的媒体流从末尾裁剪,使其与较短的对齐。​
  • speed:变速。通过加速或减速的方式使两个媒体流时长一致。​
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_132​
用户请求凭证,用于幂等控制。大小写敏感,不超过 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。详情请参考项目与队列管理。​
​
请求示例​
以下示例演示了如何为一个无声视频添加背景音乐,并要求以视频时长为基准,裁剪背景音乐以实现对齐。​
​
curl -X POST 'https://mediakit.cn-beijing.volces.com/api/v1/tools/mux-audio-video' \​
-H 'Authorization: Bearer {Your_API_Key}' \​
-H 'Content-Type: application/json' \​
-d '{​
"video_url": "https://example.com/silent_video.mp4",​
"audio_url": "https://example.com/long_background_music.mp3",​
"is_audio_reserve": false,​
"is_video_audio_sync": true,​
"sync_mode": "video",​
"sync_method": "trim"​
}'​
​
响应说明​
任务提交后,接口会立即返回以下 JSON 对象。其中包含任务的唯一标识 task_id。请保存此 ID 用于后续查询。​
​
参数​
类型​
描述​
success​
Boolean​
任务是否提交成功。​
  • true:成功。​
task_id​
String​
任务的唯一标识,用于后续查询任务进度和结果。​
request_id​
String​
本次请求的唯一标识,可用于问题排查。​
​
响应示例:​
​
{​
"success": true,​
"task_id": "amk_tool_mux_audio_video_1501800",​
"request_id": "20260401100000C8EF6E46A8B2D06B9FF1"​
}​
​
异步任务结果​
音视频合成是一个异步任务,任务的执行状态和最终结果不会在提交时同步返回。您可以通过以下两种方式获取任务结果:​
  • 方法一(轮询查询):使用提交任务时获取的 task_id,定期调用查询任务信息 API,直到 status 字段变为 completed 或 failed。​
  • 方法二(事件回调):在 AI MediaKit 控制台预先配置一个接收回调的 URL,或在提交任务时通过 callback_url 参数为单次任务指定回调地址。任务完成后,系统会将包含最终结果的详细信息 POST 到您指定的地址。详情请参阅事件回调。​
当任务成功完成后,您获取到的任务信息中的 result 字段将包含以下内容。​
​
参数​
类型​
示例​
描述​
video_url​
String​
"https://example.volcvideo.com/output.mp4?auth_key=..."​
合成后的视频文件下载地址。文件格式为 MP4。地址类型根据请求时是否设置 media_output_destination 而不同:​
  • 默认情况(未设置 media_output_destination):返回一个 HTTPS 临时下载链接,有效期为 24 小时,请及时下载保存。​
  • 设置 media_output_destination 后:返回存储地址,格式为 vod://<空间名>/<媒资ID> 或 tos://<桶名>/<对象Key>。​
duration​
Number​
120.5​
输出视频的总时长(单位:秒)。​
resolution​
String​
"1080p"​
输出视频的分辨率。​
​
以下是一个任务执行完成后的完整任务信息示例:​
​
{​
"success": true,​
"task_id": "amk_tool_mux_audio_video_1501800",​
"request_id": "20260401100000C8EF6E46A8B2D06B9FF1",​
"result": {​
"video_url": "https://example.volcvideo.com/muxed_output.mp4?auth_key=1774880461-...",​
"duration": 120.5,​
"resolution": "1080p"​
},​
"expires_at": 1777464650,​
"created_at": 1777291767,​
"finished_at": 1777291851​
}​
​
错误处理​
当请求的参数或鉴权信息不正确时,任务将不会被创建,接口会返回一个同步的错误响应。详见错误码。示例如下:​
​
{​
"success": false,​
"task_id": "",​
"request_id": "20240521110000DDEEFF223344",​
"error": {​
"code": "InvalidParameter",​
"message": "The parameter `video_url` is required.",​
"param": "video_url",​
"type": "BadRequest"​
}​
}​
​
​
最近更新时间:2026.07.28 11:41:18
这个页面对您有帮助吗?
有用
有用
无用
无用