byteplus/dreamina-seedance-2-0-fast-260128 の 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-0-fast-260128
エンドポイント: POST https://api.comfy.org/v2/models/byteplus/dreamina-seedance-2-0-fast-260128
- 結果を待つ
- キューに送信して後で収集
同じボディを
POST https://api.comfy.org/v2/models/byteplus/dreamina-seedance-2-0-fast-260128/requests に送信します。Router は実行が受け付けられ次第 201 と request_id を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。キュー配信では、ステータス、キャンセル、結果の収集について説明します。スキーマ
入力
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: オーディオの公開 URL(wav、mp3)。
Base64: 形式 data:audio/<format>;base64,<content>
アセット ID: 形式 asset://<ASSET_ID>
object
Seedance 2.5 のみ。最終ビデオとしてレンダリングする Draft タスク。唯一のコンテンツ項目である必要があります。
最終ビデオは Draft タスクの prompt、入力アセット、duration、ratio、seed、generate_audio、omni_reference_task_type を再利用します。これらを再度送信しないでください。resolution はデフォルトで 1080p となり、1080p のみをサポートします。
string
必須
draft を true に設定して Draft ビデオを作成したときに返されるタスク ID。object
string
必須
画像から動画を生成するための画像コンテンツ(type が “image_url” の場合)
画像 URL: 画像 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
モデルへの入力テキスト情報。テキストプロンプトと任意のパラメータが含まれます。テキストプロンプト(必須): 中国語および英語の文字を使用して生成するビデオの説明。パラメータ(任意): テキストプロンプトの後に —[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_url、draft_taskobject
入力ビデオオブジェクト。ビデオ入力に対応しているのは Seedance 2.5、2.0、2.0 fast のみです。
string
必須
ビデオ URL またはアセット ID。
ビデオ URL: ビデオの公開 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。POST /proxy/byteplus/api/v3/contents/generations/tasks への直接 v1 呼び出しでは必ずこれを指定する必要があります。プロキシは他の値や省略された値を 400 で拒否します。これがこのスキーマの
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 に設定すると、ビデオ生成タスクの情報を照会する API を呼び出すことで最終フレーム画像を取得できます。最終フレーム画像は 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/dreamina-seedance-2-0-fast-260128/openapi.json で Router が提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用するドキュメントと同じものです。
出力
object
ビデオ生成タスクの完了後の出力です。出力ビデオのダウンロード URL と、BytePlus が返す場合はその最終フレームのダウンロード URL を含みます。
video_url と last_frame_url はどちらも Comfy ストレージに再ホストされます。ここにある他のフィールドはすべて BytePlus 自身のものです。Null 許容: BytePlus はタスクの24時間後に URL をクリアするため、その後でポーリングした成功ドキュメントでは content が存在しないか null になることがあります。string
生成されたビデオの最終フレームのダウンロード URL で、リクエストで
return_last_frame を設定したときに返されます。この URL から画像形式を推測しないでください。BytePlus はリクエスト側で最終フレームを PNG として規定していますが、Router は渡されたバイト列をそのまま再ホストし、上流の Content-Type またはコンテンツスニッフィングから型を判定します。image/jpeg はその両方が失敗したときの最後の手段のフォールバックにすぎません。Router は最終フレームを Comfy ストレージに再ホストしてこのフィールドを書き換えるため、通常は最大24時間有効な Comfy 署名付き URL になります。発行時に24時間で署名され、23時間のメモから再生されるため、後でポーリングすると残り1時間しかないものが返ることがあります。再ホストを実行できなかった場合、このフィールドには BytePlus 自身の URL がそのまま入り、BytePlus はタスクの24時間後にそれをクリアします。いずれにしてもリンクは失効するため、URL を保存するのではなくフレームをダウンロードしてください。string
生成されたビデオのコンテナ形式 (mp4 または mov) で、BytePlus が
content の中に入れ子にして返す場合のものです。Seedance モデルでは content のトップレベルの兄弟として返すことのほうが多く、その場合はトップレベルの output_format フィールドを参照してください。Router はどちらか存在する方を読み取ります。string
出力ビデオのダウンロード URL。Router はビデオを Comfy ストレージに再ホストしてこのフィールドを書き換えるため、通常は最大24時間有効な Comfy 署名付き URL になります。発行時に24時間で署名され、23時間のメモから再生されるため、後でポーリングすると残り1時間しかないものが返ることがあります。再ホストを実行できなかった場合、このフィールドには BytePlus 自身の URL がそのまま入り、BytePlus はタスクの24時間後にそれをクリアし、一部のモデルではダウンロード回数が100回に制限されます。いずれにしてもリンクは失効するため、URL を保存するのではなくビデオをダウンロードしてください。
integer
タスクが作成された時刻。値は UNIX タイムスタンプ (秒) です。
number
生成されたビデオの再生時間 (秒)。BytePlus がこの点で一貫していないため、整数ではなく数値として宣言されています。ビデオタスクでは秒単位の整数が返されることが確認されており、同系列の BytePlus の他のサーフェスでは小数の再生時間が報告されるため、クライアントは整数値だと仮定してはいけません。BytePlus 自身のフィールドで、成功したビデオタスクで返され、そのまま転送されます。
object
エラー情報。タスクが成功した場合は null が返されます。タスクが失敗した場合はエラー情報が返されます。
string
上流の ModelArk エラーコード。SensitiveContentDetected、InputTextSensitiveContentDetected、InputImageSensitiveContentDetected、InputVideoSensitiveContentDetected、InputAudioSensitiveContentDetected、OutputTextSensitiveContentDetected、OutputImageSensitiveContentDetected、OutputVideoSensitiveContentDetected、OutputAudioSensitiveContentDetected はコンテンツポリシーによる拒否を示します。ファミリーには、InputImageSensitiveContentDetected.PrivacyInformation、OutputVideoSensitiveContentDetected.PolicyViolation、OutputImageSensitiveContentDetected.DeepFake のように、ドット区切りの理由が付くことがあります。これは enum ではなくオープンな文字列です。他のコードは検証やプロバイダーの失敗を表します。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
リクエストのトークン使用量
integer
モデルが生成したトークン数
integer
ビデオ生成モデルでは入力トークン数は計算されず、デフォルトで 0 になります。したがって、total_tokens = completion_tokens です。
例
入力
出力
出荷前の確認
SDK はIdempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。
リクエストが失敗すると、Router は理由を説明する X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、413 はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。
上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。リクエスト本文のサイズ を参照してください。
このページは、Comfy Router 経由で呼び出す 1 つのパートナーモデルについて説明しています。同じ comfy-sdk / @comfyorg/sdk パッケージには、Comfy Cloud 上で ComfyUI のワークフローグラフ全体を実行するための 2 つ目のクライアントも含まれています: Comfy(api_key=...) / new Comfy({ apiKey })、および client.workflows、client.assets、client.jobs。Comfy SDKs を参照してください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。