byteplus/dreamina-seedance-2-5-260628 的 API 参考文档,由 Comfy Router 从 BytePlus 提供。
快速开始
在 你的 Comfy 工作区 中创建一个密钥,并将其导出为COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 发出的相同调用。
模型 ID: byteplus/dreamina-seedance-2-5-260628
端点: POST https://api.comfy.org/v2/models/byteplus/dreamina-seedance-2-5-260628
- Wait for the result
- Queue and collect later
数据结构
输入
string (uri)
本次生成任务结果的回调通知地址格式:
uriobject[]
必填
供模型生成视频的输入内容
object
输入音频对象。仅 Seedance 2.5、2.0 和 2.0 fast 支持音频输入。Seedance 2.0 和 2.0 fast 不能单独使用音频:必须至少包含 1 张图像或 1 段视频;Seedance 2.5 支持仅音频输入。
string
必填
音频 URL、Base64 编码或 Asset ID。
音频 URL:音频的公开 URL(wav、mp3)。
Base64:格式为 data:audio/<format>;base64,<content>
Asset ID:格式为 asset://<ASSET_ID>
object
string
必填
用于图生视频生成的图像内容(当 type 为 “image_url” 时)
图像 URL:请确保该图像 URL 可访问。
Base64 编码内容:格式必须为 data:image/<format>;base64,<content>
Asset ID:格式为 asset://<ASSET_ID>
string
内容项的角色/位置。
对于图像:first_frame、last_frame 或 reference_image。
对于视频:reference_video(仅 Seedance 2.5、2.0 和 2.0 fast)。
对于音频:reference_audio(仅 Seedance 2.5、2.0 和 2.0 fast)。可选值:
first_frame、last_frame、reference_image、reference_video、reference_audiostring
供模型使用的输入文本信息。包括文本提示词和可选参数。文本提示词(必填):使用中文和英文字符对要生成的视频进行的描述。参数(可选):在文本提示词后添加 —[parameters] 以控制视频规格:
- —resolution(—rs):480p、720p、1080p(默认:720p)
- —ratio(—rt):21:9、16:9、4:3、1:1、3:4、9:16、9:21、adaptive(默认:16:9 或 adaptive)
- —duration(—dur):3-12 秒(默认:5)
- —framepersecond(—fps):24(默认:24)
- —watermark(—wm):true/false(默认:false)
- —seed(—seed):-1 到 2^32-1(默认:-1)
- —camerafixed(—cf):true/false(默认:false)
content 是一个数组,整个文档由每次请求的请求体上限来约束。执行该限制的是 Comfy Router(/v2/models/byteplus/{model});在直接调用 v1 /proxy 时,则由 BytePlus 自有的校验器来判定。该值设置得远高于真实流量,因此它不会对真正的提示词做出裁定,如果调用方需要更大值,可以提高它。string
必填
输入内容的类型可选值:
text、image_url、video_url、audio_urlobject
输入视频对象。仅 Seedance 2.5、2.0 和 2.0 fast 支持视频输入。
string
必填
视频 URL 或 Asset ID。
视频 URL:视频的公开 URL(mp4、mov)。
Asset ID:格式为 asset://<ASSET_ID>
`-1` | object
视频时长,单位为秒。Seedance 2.5:[4,30] 或 -1(自动;视频编辑任务仅支持 -1)。Seedance 2.0 和 2.0 fast:[4,15] 或 -1(自动)。Seedance 1.5 pro:[4,12] 或 -1。Seedance 1.0:[2,12]。范围:
2 到 30integer
任务超时阈值,单位为秒。默认 172800(48 小时)。范围:[3600, 259200]。范围:
3600 到 259200boolean
默认值:"true"
Seedance 2.5、2.0、2.0 fast 和 1.5 pro 支持。生成的视频是否包含与画面同步的音频。
是(true):模型输出带有同步音频的视频。
否(false):模型输出无声视频。
string
要调用的模型 ID。支持的模型:seedance-1-5-pro-251215、seedance-1-0-pro-250528、seedance-1-0-pro-fast-251015、dreamina-seedance-2-0-260128、dreamina-seedance-2-0-fast-260128、dreamina-seedance-2-0-mini 和 dreamina-seedance-2-5-260628。直接以 v1 调用 POST /proxy/byteplus/api/v3/contents/generations/tasks 时必须提供该字段:代理会拒绝任何其他值,若省略该字段则返回 400。它不在本 schema 的
required 列表中,因为 Comfy Router 会从 /v2/models/byteplus/{model} 的 {model} 路径段填充该值,所以 Router 调用方会省略它。string
默认值:"\"mp4\""
仅 Seedance 2.5 支持。输出视频的容器格式。
mp4:通用容器(H.264/AAC,yuv420p),兼容性广,文件大小更小。
mov:专业容器(H.264 High 4:4:4 Predictive/PCM,yuv444p),色彩精度高,适合后期制作;文件大小更大。可选值:
mp4、movstring
已生成视频的比例。Seedance 2.0 和 2.0 fast、1.5 pro 默认:adaptive。可选值:
16:9、4:3、1:1、3:4、9:16、21:9、9:21、adaptivestring
视频分辨率。Seedance 2.5、2.0 和 2.0 fast、1.5 pro、1.0 lite 默认:720p。Seedance 1.0 pro 和 pro-fast 默认:1080p。
注意:Seedance 2.0 和 2.0 fast 不支持 1080p。Seedance 2.5 支持 480p、720p 和 1080p。可选值:
480p、720p、1080p、4kboolean
默认值:"false"
是否返回已生成视频的尾帧图像。
是:返回已生成视频的尾帧图像。将此参数设置为 true 后,您可以通过调用「查询视频生成任务信息」获取尾帧图像。尾帧图像为 PNG 格式,其像素宽度和高度与已生成视频一致,且不含水印。使用该参数可以生成多个连续视频:将前一个已生成视频的尾帧作为下一个视频任务的首帧,从而快速生成多个连续视频。
否:不返回已生成视频的尾帧图像。
integer
用于控制随机性的种子整数。范围:[-1, 2^32-1]。-1 表示使用随机种子。范围:
-1 到 4294967295string
用于处理的服务层级。Seedance 2.5、2.0 与 2.0 fast 不支持 flex(离线推理)。可选值:
default、flexboolean
默认值:"false"
已生成视频是否包含水印。
GET /v2/models/byteplus/dreamina-seedance-2-5-260628/openapi.json 处提供的 schema 生成,这也是它在请求到达提供商之前用于校验调用的同一份文档。
输出
object
视频生成任务完成后的输出,包含输出视频的下载 URL,并且在 BytePlus 返回时还包含其最后一帧的下载 URL。
video_url 和 last_frame_url 都会被重新托管到 Comfy 存储上;此处的其他所有字段均来自 BytePlus。可为空:BytePlus 会在任务完成 24 小时后清除这些 URL,因此在这之后轮询到的成功文档可能不带 content,或其值为 null。string
已生成视频最后一帧的下载 URL,当请求中设置了
return_last_frame 时返回。不要根据此 URL 推断图像格式:BytePlus 在请求侧将最后一帧记录为 PNG,而 Router 会重新托管它收到的任意字节,并根据上游的 Content-Type 或内容嗅探来判定其类型,只有当两者都失败时才会以 image/jpeg 作为最后手段。Router 会把最后一帧重新托管到 Comfy 存储上并重写此字段,因此它通常是一个有效期为 24 小时的 Comfy 签名 URL。该 URL 在签发时签名 24 小时,并从一份 23 小时的记录中重放,因此稍后轮询返回的 URL 可能只剩 1 小时有效期。当无法执行重新托管时,此字段会保留 BytePlus 自己的 URL,而 BytePlus 会在任务完成 24 小时后将其清除。无论哪种情况,连线都会过期,因此请下载该帧,而不要保存 URL。string
已生成视频的容器格式(mp4 或 mov),当 BytePlus 将其嵌套在
content 内时返回。Seedance 模型更常将其作为 content 的顶层同级字段返回,请参见顶层的 output_format 字段。Router 会读取两者中存在的那个。string
输出视频的下载 URL。Router 会把视频重新托管到 Comfy 存储上并重写此字段,因此它通常是一个有效期为 24 小时的 Comfy 签名 URL。该 URL 在签发时签名 24 小时,并从一份 23 小时的记录中重放,因此稍后轮询返回的 URL 可能只剩 1 小时有效期。当无法执行重新托管时,此字段会保留 BytePlus 自己的 URL,而 BytePlus 会在任务完成 24 小时后将其清除,并在某些模型上将下载次数限制为 100 次。无论哪种情况,连线都会过期,因此请下载视频,而不要保存 URL。
integer
任务创建的时间。该值为 UNIX 时间戳,单位为秒。
number
已生成视频的时长,单位为秒。这里声明为 number 而非 integer,是因为 BytePlus 对此并不一致:视频任务曾出现返回整数秒的情况,而 BytePlus 的其他同类接口会返回带小数的时长,因此客户端不能假定其为整数值。该字段属于 BytePlus,在成功的视频任务上返回并原样转发。
object
错误信息。如果任务成功,则返回 null。如果任务失败,则返回错误信息。
string
错误码
string
报错信息
string
视频生成任务的 ID
string
任务所使用的模型名称和版本
string
已生成视频的容器格式(mp4 或 mov),在顶层作为
content 的同级字段返回,Seedance 视频任务查询就是在这里返回该字段。该字段属于 BytePlus,原样转发。string
已生成视频的分辨率,例如
1080p。该字段属于 BytePlus,在成功的视频任务上返回并原样转发。integer
该任务实际使用的生成种子。该字段属于 BytePlus,在成功的视频任务上返回并原样转发。格式:
int64string
任务的状态可能的值:
queued、running、cancelled、succeeded、failed、expiredinteger
任务最后更新的时间。该值为 UNIX 时间戳,单位为秒。
object
该请求的 token 用量
integer
模型生成的 token 数量
integer
对于视频生成模型,不计算输入 token 数量,默认为 0。因此,total_tokens = completion_tokens。
示例
输入
输出
发布前须知
SDK 会生成Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。
请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入,413 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载,因为结果 URL 会过期。
上文任何字段描述中提到的尺寸限制,都是提供商对该字段自身的限定,引自提供商的规范。Router 会对整个请求体另行设置上限,base64 编码的媒体内容也计入其中:参见请求体大小。
请求头
身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
使用 Router API
模型发现、验证错误、重试与计费。
限制
Router 目前不支持的功能,以及替代方案。