模型 API 接入文档
Volcengine Video Lip Sync API 接入文档
通过 Rivya Public API v1 调用 Volcengine Video Lip Sync,包含模型 ID volcengine-video-lip-sync、输入类型、参数、Files API 规则、积分和响应示例。
API 可调用可用状态视频
API 模型 ID
volcengine-video-lip-sync
输入类型
file
Files API
参考素材模式需要
基础积分
per_input_second · default=8 · ⌈total⌉
能力类型
视频
计费方式
METERED
提示词上限
未配置提示词上限
请求字段
模型 ID 放在顶层字段。模型专属控制项放入 params。
| Key | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| model | string | 是 | volcengine-video-lip-sync | 使用 volcengine-video-lip-sync 作为 API 模型 ID。 |
| prompt | string | 否 | - | 支持文本输入的模型使用这个字段传入提示词。 |
| params | object | 是 | - | 模型专属参数对象。可用 key 见下方参数表。 |
| client_request_id | string | 否 | - | 可选客户端请求 ID,便于你在自己的系统中追踪请求。 |
模型参数
| Key | 类型 | 必填 | 默认值 | 范围 | 枚举值 | 说明 |
|---|---|---|---|---|---|---|
| mode | select | 是 | lite | - | lite, basic | Lite 适合正对镜头的单人画面;Basic 支持更复杂的单人场景。 |
| separate_vocal | select | 否 | false | - | false, true | 当目标音频含有需要抑制的背景声音时,可开启人声分离。 |
| open_scenedet | select | 否 | false | - | false, true | 仅在 Basic 模式下可用,用于场景分段和说话人识别。 |
| align_audio | select | 否 | true | - | true, false | 仅在 Lite 模式下可用。当音频长于源画面时,循环播放视频。 |
| align_audio_reverse | select | 否 | false | - | false, true | 仅在 Lite 模式下可用,并且必须先开启音频对齐。 |
| templ_start_seconds | number | 否 | 0 | min 0 | - | 仅在 Lite 模式下可用。在源视频中选择一个非负的开始时间。 |
上传策略
先上传参考文件,再把返回的 URL 和 durationToken 放入 params.referenceMediaItems。
参考素材规则
源视频和目标音频: 上传恰好一个 MP4 或 MOV 视频,大小不超过 95 MB,以及一条 MP3、M4A、WAV、AAC 或 OGG 人声轨道,大小不超过 10 MB。
最大文件数
2
支持文件类型
video, audio
Duration token
视频和音频参考素材需要时长校验时,应携带 /api/v1/files 返回的 durationToken。
| kind | 大小上限 | MIME 类型 |
|---|---|---|
| video | 95 MB | video/mp4, video/quicktime |
| audio | 10 MB | audio/mpeg, audio/mp4, audio/wav, audio/x-wav, audio/aac, audio/ogg |
最小请求
{
"model": "volcengine-video-lip-sync",
"params": {
"mode": "lite",
"separate_vocal": "false",
"open_scenedet": "false",
"align_audio": "true",
"align_audio_reverse": "false",
"templ_start_seconds": 0
}
}参考文件请求
{
"model": "volcengine-video-lip-sync",
"params": {
"mode": "lite",
"separate_vocal": "false",
"open_scenedet": "false",
"align_audio": "true",
"align_audio_reverse": "false",
"templ_start_seconds": 0,
"referenceMediaItems": [
{
"url": "https://cdn.example.com/reference-video.mp4",
"kind": "video",
"name": "reference-video.mp4",
"mimeType": "video/mp4",
"durationSeconds": 8,
"durationToken": "video_duration_token_from_files_api",
"width": 1280,
"height": 720,
"sizeBytes": 8388608,
"framesPerSecond": 30,
"videoBitrateMbps": 8,
"videoMetadataToken": "video_metadata_token_from_original_files_api_upload_response"
},
{
"url": "https://cdn.example.com/reference-audio.wav",
"kind": "audio",
"name": "reference-audio.wav",
"mimeType": "audio/wav",
"durationSeconds": 12,
"durationToken": "audio_duration_token_from_files_api"
}
]
}
}创建响应
创建接口会返回公开任务 ID。继续轮询状态接口,直到任务成功或失败。
{
"id": "task_volcengine_video_lip_sync_example",
"status": "queued",
"model": "volcengine-video-lip-sync",
"reserved_credits": 8,
"final_credits": 0,
"settlement_status": "RESERVED",
"created_at": "2026-05-11T00:00:00.000Z",
"updated_at": "2026-05-11T00:00:00.000Z",
"result": null,
"error": null
}常见错误
validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found
部分模式需要通过 Files API 上传参考素材。