Skip to main content
synclabs/sync-3 的 API 参考,由 Comfy Router 从 Synclabs 提供。

快速开始

在你的 Comfy 工作区中创建密钥,并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段是通过原生 HTTP 发起的同一调用。 模型 ID: synclabs/sync-3 端点: POST https://api.comfy.org/v2/models/synclabs/sync-3
相同的请求体,发送到 POST https://api.comfy.org/v2/models/synclabs/sync-3/requests。一旦运行被接纳,Router 就会返回 201 和 request_id,结果就绪后即可从当前进程或另一个进程收集。队列交付 介绍了状态、取消和收集。

Schema

Input

object
附加到 Sync Labs 生成请求的配音参数
integer
来源视频中的说话人数;0 表示启用自动检测
string
必填
用于配音的提供商(例如 elevenlabs)
string
来源语言代码;默认为 auto
string
必填
配音的目标语言代码
object[]
必填
输入项;恰好一个视觉输入(视频或图像)和一个音频或文本输入
string
Sync Labs 媒体库中资产的 ID
object
用于 Sync Labs 文本输入的文本转语音提供商配置
string
必填
TTS 提供商名称(例如 elevenlabs)
string
必填
用于生成的脚本
number
AI 应多大程度贴近原始声音格式:double
number
声音稳定性;较低的值会带来更宽的情感范围格式:double
string
必填
Sync 语音 id(从 Studio 克隆的声音)或 ElevenLabs 语音 ID
string
用于将此输入关联到片段定义的引用标识符
integer[][]
弃用 - 请改用顶层的 segments 数组
number[][]
弃用 - 请改用顶层的 segments 数组
string
必填
输入类型(video、image、audio 或 text)
string
用于生成的媒体的 URL
string
用于生成的模型名称;仅支持 sync-3。在 Comfy Router 路由 POST /v2/models/synclabs/{model} 上,该字段由路径提供,可以省略。
object
可用于 Sync Labs 生成的附加选项
object
活跃说话人检测配置
boolean
是否自动检测并将生成应用于活跃说话人
integer[][]
检测到的人脸逐帧边界框数组 [x1, y1, x2, y2]
string
包含边界框的 JSON 文件的 URL
integer[]
由 frame_number 标识的来源视频帧中的像素坐标 [x, y]
integer
与所提供的坐标对应的帧索引,用于手动选择说话人
boolean
是否使用 ASD v3
string
模型的编辑区域(lips、face、head);仅适用于 react-1
boolean
是否在生成期间检测遮挡
string
情感提示词;仅适用于 react-1
string
如何处理视频与音频之间的时长不匹配(bounce、loop、cut_off、silence、remap)
number
口型同步的表现力程度,0 到 1格式:double
string
已生成输出的基础文件名,不含扩展名
string
可选:将此生成附加到 Sync Labs 项目
object[]
将不同音频输入应用到不同视频片段的片段定义
object
必填
特定片段的音频输入配置
number
可选,用于裁剪所引用音频的结束时间(秒)格式:double
string
必填
用于此片段的音频/文本转语音输入的引用 ID
number
可选,用于裁剪所引用音频的开始时间(秒)格式:double
number
必填
片段结束时间(秒)格式:double
object
覆盖特定片段的生成选项
object
活跃说话人检测配置
boolean
是否自动检测并将生成应用于活跃说话人
integer[][]
检测到的人脸逐帧边界框数组 [x1, y1, x2, y2]
string
指向包含边界框的 JSON 文件的 URL
integer[]
由 frame_number 标识的来源视频帧中的像素坐标 [x, y]
integer
与手动选择说话人时提供的坐标相对应的帧索引
boolean
是否使用 ASD v3
boolean
为此片段覆盖遮挡检测设置
string
为此片段覆盖同步模式
number
为此片段覆盖 temperature(0-1)格式:double
number
必填
片段开始时间,单位为秒格式:double
string
用于接收生成状态更新的 Webhook URL
根据 Router 在 GET /v2/models/synclabs/sync-3/openapi.json 提供的 schema 生成,该文档也是请求到达提供商之前用于校验调用的同一份文档。

输出

string
生成内容的创建日期和时间
string
生成失败时的报错信息
string
生成失败时的稳定、机器可读的错误代码
string
生成的唯一标识符
object[]
用于生成的输入项
string
Sync Labs 媒体库中资源的 ID
object
Sync Labs 文本输入的文本转语音提供商配置
string
必填
TTS 提供商名称(例如 elevenlabs)
string
必填
用于生成的脚本
number
AI 应多接近原始声音格式:double
number
声音稳定性;较低的值会带来更丰富的情感范围格式:double
string
必填
Sync 声音 ID(从 Studio 克隆的声音)或 ElevenLabs 声音 ID
string
用于将此输入关联到分段定义的引用标识符
integer[][]
已弃用:请改用顶层的 segments 数组
number[][]
已弃用:请改用顶层的 segments 数组
string
必填
输入类型(video、image、audio 或 text)
string
用于生成的媒体的 URL
string
用于生成的模型名称
object
Sync Labs 生成可用的附加选项
object
活跃说话人检测配置
boolean
是否自动检测并将生成应用到活跃说话人
integer[][]
检测到的人脸逐帧边界框数组 [x1, y1, x2, y2]
string
包含边界框的 JSON 文件的 URL
integer[]
由 frame_number 标识的源视频帧中的像素坐标 [x, y]
integer
与所提供的坐标对应的帧索引,用于手动选择说话人
boolean
是否使用 ASD v3
string
模型的编辑区域(嘴唇、面部、头部);仅适用于 react-1
boolean
是否在生成过程中检测遮挡
string
情感提示词;仅适用于 react-1
string
如何处理视频与音频之间的时长不匹配(bounce、loop、cut_off、silence、remap)
number
口型同步的表现力程度,0 到 1格式:double
number
输出媒体的时长,单位为秒格式:double
string
应用于输出媒体的已清理文件名
string
输出媒体的 URL
string
此生成所关联的项目 ID
string
分段输出媒体的 URL
object[]
生成的分段
object
必填
特定分段的音频输入配置
number
用于裁剪所引用音频的可选结束时间,单位为秒格式:double
string
必填
用于此分段的音频/文本转语音输入的引用 ID
number
用于裁剪所引用音频的可选开始时间,单位为秒格式:double
number
必填
分段结束时间,单位为秒格式:double
object
覆盖特定分段的生成选项
object
活跃说话人检测配置
boolean
是否自动检测并将生成应用于当前说话人
integer[][]
检测到的人脸在每一帧的边界框数组 [x1, y1, x2, y2]
string
指向包含边界框的 JSON 文件的 URL
integer[]
由 frame_number 标识的源视频帧中的像素坐标 [x, y]
integer
用于手动选择说话人的、与所提供坐标对应的帧索引
boolean
是否使用 ASD v3
boolean
覆盖此片段的遮挡检测设置
string
覆盖此片段的同步模式
number
覆盖此片段的 temperature (0-1)格式:double
number
必填
片段开始时间,单位为秒格式:double
string
生成的状态 (PENDING、PROCESSING、COMPLETED、FAILED、REJECTED)
string
由文本 (TTS) 输入合成的音频 URL
string
webhook 端点的 URL

示例

输入

输出

发布前须知

SDK 会生成 Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。 请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入,413 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载,因为结果 URL 会过期。 上文任何字段描述中提到的尺寸限制,都是提供商对该字段自身的限定,引自提供商的规范。Router 会对整个请求体另行设置上限,base64 编码的媒体内容也计入其中:参见请求体大小。 本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 comfy-sdk / @comfyorg/sdk 包还提供第二个客户端,用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图:Comfy(api_key=...) / new Comfy({ apiKey }),并带有 client.workflows、client.assets 和 client.jobs。请参阅 Comfy SDKs。

请求头

身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。

使用 Router API

模型发现、验证错误、重试与计费。

限制

Router 目前不支持的功能,以及替代方案。