byteplus/seedance-1-0-pro-250528 的 API 参考,由 Comfy Router 提供,来源为 BytePlus。
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 发起的同一调用。
模型 ID: byteplus/seedance-1-0-pro-250528
端点: POST https://api.comfy.org/v2/models/byteplus/seedance-1-0-pro-250528
- 等待结果
- 加入队列并稍后收集
将相同的请求体发送到
POST https://api.comfy.org/v2/models/byteplus/seedance-1-0-pro-250528/requests。运行一经受理,Router 就会立即返回 201 和 request_id;结果就绪后,可以从本进程或其他进程收集。队列投递 详细介绍了状态查询、取消和结果收集。Schema
输入
string (uri)
本次生成任务结果的回调通知地址格式:
uriobject[]
必填
模型生成视频所用的输入内容
object
输入音频对象。仅 Seedance 2.5、2.0 和 2.0 fast 支持音频输入。Seedance 2.0 和 2.0 fast 不能单独使用音频,必须至少包含 1 个图像或视频;Seedance 2.5 支持仅音频输入。
string
必填
音频 URL、Base64 编码或资产 ID。
音频 URL:音频的公开网址(wav、mp3)。
Base64:格式为 data:audio/<format>;base64,<content>
资产 ID:格式为 asset://<ASSET_ID>
object
仅 Seedance 2.5。要渲染为最终视频的 Draft 任务。它必须是唯一的内容项。
最终视频会复用 Draft 任务的 prompt、输入资产、时长、比例、种子、generate_audio 和 omni_reference_task_type,请勿再次提交这些内容。resolution 默认为 1080p,且仅支持 1080p。
string
必填
当 Draft 视频以
draft 设置为 true 创建时返回的任务 ID。object
string
必填
用于图生视频生成的图像内容(当 type 为 “image_url” 时)
图片网址:请确保图片网址可访问。
Base64 编码内容:格式必须为 data:image/<format>;base64,<content>
资产 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
模型的输入文本信息。包含文本提示词和可选参数。文本提示词(必填):使用中英文字符描述要生成的视频。参数(可选):在文本提示词之后添加 —[参数] 以控制视频规格:
- —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_url、draft_taskobject
输入视频对象。仅 Seedance 2.5、2.0 和 2.0 fast 支持视频输入。
string
必填
视频 URL 或资产 ID。
视频 URL:视频的公开网址(mp4、mov)。
资产 ID:格式为 asset://<ASSET_ID>
boolean
默认值:"false"
仅 Seedance 2.5。生成 480p 的 Draft 视频;resolution 必须为 480p。
将返回的任务 ID 传入
draft_task 内容项,以渲染最终的 1080p 视频。Draft 任务 ID 的有效期为 7 天。`-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。
Seedance 2.5 首帧/首尾帧生成:输出会跟随首帧的比例,因此仅接受
adaptive(或省略该字段);具体的比例会在派发前以 400 拒绝。在这些模式下,Seedance 2.0 接受具体的比例。可能的值: 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:返回已生成视频的最后一帧图像。将此参数设置为 true 后,您可以通过调用查询视频生成任务信息来获取最后一帧图像。最后一帧图像为 PNG 格式,其像素宽度和高度与已生成视频一致,且不包含水印。使用此参数可以生成多个连续视频:将前一个已生成视频的最后一帧用作下一个视频任务的首帧,从而快速生成多个连续视频。
false:不返回已生成视频的最后一帧图像。
integer
用于控制随机性的种子整数。范围:[-1, 2^32-1]。-1 使用随机种子。范围:
-1 到 4294967295string
用于处理的服务层级。Seedance 2.5、2.0 与 2.0 fast 不支持 flex(离线推理)。可能的值:
default, flexboolean
默认值:"false"
已生成视频是否包含水印。
GET /v2/models/byteplus/seedance-1-0-pro-250528/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 存储并重写该字段,因此它通常是 Comfy 签名的 URL,有效期最长 24 小时;签发时按 24 小时签名,并从 23 小时的缓存记录中重放,因此稍后的轮询可能返回一个只剩一小时有效期的链接。当无法执行重新托管时,该字段会保留 BytePlus 自己的 URL,而 BytePlus 会在任务完成 24 小时后将其清除。无论哪种情况,链接都会过期,因此请下载该帧,而不要存储 URL。string
生成视频的容器格式(mp4 或 mov),当 BytePlus 将其嵌套在
content 内时出现。Seedance 模型更常将其作为 content 的顶层同级字段返回,请参见顶层的 output_format 字段;Router 会读取两者中存在的那个。string
输出视频的下载 URL。Router 会将视频重新托管到 Comfy 存储并重写该字段,因此它通常是 Comfy 签名的 URL,有效期最长 24 小时;签发时按 24 小时签名,并从 23 小时的缓存记录中重放,因此稍后的轮询可能返回一个只剩一小时有效期的链接。当无法执行重新托管时,该字段会保留 BytePlus 自己的 URL,而 BytePlus 会在任务完成 24 小时后将其清除,并且某些模型上最多允许 100 次下载。无论哪种情况,链接都会过期,因此请下载该视频,而不要存储 URL。
integer
任务创建的时间。该值为 UNIX 时间戳,单位为秒。
number
生成视频的时长,单位为秒。之所以声明为 number 而不是 integer,是因为 BytePlus 对此并不一致:观察到视频任务返回整数秒,而同属 BytePlus 的其他接口会返回小数时长,因此客户端不应假定其为整数值。该字段属于 BytePlus 自身,在成功的视频任务中返回并原样转发。
object
错误信息。如果任务成功,则返回 null。如果任务失败,则返回错误信息。
string
上游 ModelArk 错误码。SensitiveContentDetected、InputTextSensitiveContentDetected、InputImageSensitiveContentDetected、InputVideoSensitiveContentDetected、InputAudioSensitiveContentDetected、OutputTextSensitiveContentDetected、OutputImageSensitiveContentDetected、OutputVideoSensitiveContentDetected 和 OutputAudioSensitiveContentDetected 表示内容策略拒绝。某一错误族可能带有以点分隔的原因,例如 InputImageSensitiveContentDetected.PrivacyInformation、OutputVideoSensitiveContentDetected.PolicyViolation 或 OutputImageSensitiveContentDetected.DeepFake。这是一个开放式字符串,而非枚举:其他错误码描述验证和提供商故障。Router 会在 HTTP 400 错误响应和 HTTP 200 任务失败响应中识别策略错误族,且不会覆盖传输层故障。
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 编码的媒体内容也计入其中:参见请求体大小。
本页记录的是通过 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 目前不支持的功能,以及替代方案。