byteplus/dreamina-seedance-2-0-mini の 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-mini
エンドポイント: POST https://api.comfy.org/v2/models/byteplus/dreamina-seedance-2-0-mini
- 結果を待つ
- キューに入れて後で取得
同じボディを
POST https://api.comfy.org/v2/models/byteplus/dreamina-seedance-2-0-mini/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: オーディオ(wav、mp3)の公開 URL。
Base64: 形式 data:audio/<format>;base64,<content>
アセット ID: 形式 asset://<ASSET_ID>
object
Seedance 2.5 のみ。最終ビデオとしてレンダリングするドラフトタスク。唯一のコンテンツ項目である必要があります。
最終ビデオはドラフトタスクの prompt、入力アセット、duration、ratio、seed、generate_audio、omni_reference_task_type を再利用するため、これらを再送信しないでください。resolution のデフォルトは 1080p で、1080p のみをサポートします。
string
必須
draft を true に設定してドラフトビデオを作成したときに返されるタスク 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: ビデオ(mp4、mov)の公開 URL。
アセット ID: 形式 asset://<ASSET_ID>
boolean
デフォルト:"false"
Seedance 2.5 のみ。480p のドラフトビデオを生成します。resolution は 480p である必要があります。
返されたタスク ID を
draft_task コンテンツ項目で渡すと、最終的な 1080p ビデオをレンダリングします。ドラフトタスク 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 に設定した後、ビデオ生成タスクに関する情報の照会を呼び出すことで最終フレーム画像を取得できます。最終フレーム画像は 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-mini/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に呼び出しを検証する際に使用されるものと同じドキュメントです。
出力
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 時間しかない URL が返ることがあります。再ホストを実行できなかった場合、このフィールドは 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 時間しかない URL が返ることがあります。再ホストを実行できなかった場合、このフィールドは 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 が現在対応していないことと、代替手段。