byteplus/seedream-5-0-260128 の API リファレンスです。BytePlus より Comfy Router が提供しています。
入力: テキスト, 画像 · 出力: 画像
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk および npm install @comfyorg/sdk)を使用しています。cURL スニペットは同じ呼び出しを raw HTTP で行うものです。
モデル ID: byteplus/seedream-5-0-260128
エンドポイント: POST https://api.comfy.org/v2/models/byteplus/seedream-5-0-260128
- 結果を待つ
- キューに追加して後で取得
同じボディを
POST https://api.comfy.org/v2/models/byteplus/seedream-5-0-260128/requests に送信します。Router は実行が受け付けられ次第 201 と request_id を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得の詳細は キュー配信 を参照してください。スキーマ
入力
生成画像の背景を透明(アルファチャンネル)にするかどうかを制御します。seedream-5.0-pro、5.0-flash、および自身のスキーマでこのパラメータを定義している新しい Seedream モデルでサポートされます。
auto: モデルがプロンプトと output_format から判断します。output_format が jpeg の場合、出力は常に不透明になります。
transparent: 背景が透明な RGBA 画像を出力します。output_format が jpeg の場合はエラーを返します。
opaque: 背景が不透明な RGB 画像を出力します。seedream-5.0-pro のデフォルトです。
seedream-5.0-pro は、アルファチャンネルを持つ png 入力画像 1 枚を使用する画像から画像への変換でのみ、透明出力をサポートします。
レイヤー分離シナリオではサポートされません: layer_decomposition を有効にした状態で渡すとエラーが返ります。可能な値:
auto, transparent, opaque出力画像が入力プロンプトにどれだけ忠実に一致するかを制御します。範囲は [1, 10] です。値が大きいほどプロンプトへの追従性が高くなります。seedream-5.0-pro、5.0-lite、4.5、4.0 ではサポートされていません。範囲:
1 ~ 10形式: floatSeedream-5.0-pro、5.0-lite、4.5、4.0 がこのパラメータをサポートします。編集する画像の Base64 エンコーディングまたはアクセス可能な URL を入力します。Seedream-5.0-pro、5.0-lite、4.5、4.0 は単一画像または複数画像の入力に対応しています(複数画像のブレンド例を参照)。• 画像URL: 画像URLにアクセスできることを確認してください。
• Base64 エンコーディング: 形式は data:image/<image format>;base64,<Base64 encoding> である必要があります。注: <image format> は小文字である必要があります(例: data:image/png;base64,<base64_image>)。Comfy Router は、base64 の展開やすべての参照画像を含め、JSON リクエスト全体を 100 MiB に制限します。この転送制限を超える入力には URL を使用してください。入力画像は次の要件を満たす必要があります:
• 画像形式: jpeg、png(seedream-5.0-pro、5.0-lite、4.5、4.0 は webp、bmp、tiff、gif もサポート。seedream-5.0-pro は heic と heif もサポート)
• アスペクト比(幅/高さ): seedream-5.0-pro、5.0-lite、4.5、4.0 では [1/16, 16] の範囲
• 幅と高さ(px): 14 より大きい
• サイズ: 10 MB 以下(seedream-5.0-pro は 30 MB)
• 総ピクセル数: seedream-5.0-pro では 6000x6000(36,000,000 px)以下
• 参照画像は最大 14 枚(seedream-5.0-pro、5.0-flash、5.5 は 10 枚)レイヤー分離シナリオ(layer_decomposition 有効)では、image は必須であり、単一の入力画像のみがサポートされます(複数画像を渡すとエラーが返ります)。入力画像は png、jpeg、webp、bmp、tiff、gif のいずれかである必要があり(heic と heif はサポートされません)、最大 30 MB、総ピクセル数は [512x512, 6000x6000] の範囲、アスペクト比は [1/16, 16] の範囲である必要があります。
レイヤー分離を有効にするかどうかを制御します。このパラメータをサポートするのは seedream-5.0-pro、5.0-flash、5.5 のみです。
true: レイヤー分離モード。モデルは単一の入力画像を 1 つのベース画像と複数のレイヤー(最大 16、seedream-5.5 では最大 99)に分解し、生成された各レイヤーの位置とコンテンツ情報を返します。これにはスタッキング順序(z_index)、バウンディングボックス(bounding_box)、名前(name)、説明(description)が含まれます。
false: スタンダードな画像生成モード。レイヤー分離は行われません。
レイヤー分離モードに関する注意: 単一の入力画像のみがサポートされます(複数画像を渡すとエラーが返ります)。いずれか 1 つのレイヤーの生成に失敗すると、リクエスト全体が失敗します(部分的な成功はサポートされません)。返される画像は最大 17 枚です(ベース画像 1 枚 + レイヤー 16 枚)。seedream-5.5 は最大で layer_decomposition_options.max_images 枚の画像を返します(ベース画像 1 枚 + 最大 99 レイヤー)。sequential_image_generation、sequential_image_generation_options、tools、stream を渡すとエラーが返ります。
このリクエストが返す画像の最大総数で、ベース画像とレイヤーを合わせた数です。範囲: [2, 100]。プロンプトで画像の分割方法が指定されていない場合、モデルは max_images と入力画像の複雑さからレイヤーを計画します。値が大きいほど、通常はより細かいレイヤーになります。範囲:
2 ~ 100モデル識別子。サポートされるモデル: seedream-4-0-250828、seedream-4-5-251128、seedream-5-0-260128、seedream-5-0-pro-260628、seedream-5-0-flash-260915、seedream-5-5-261028。POST /proxy/byteplus/api/v3/images/generations への直接の v1 呼び出しでは必ずこれを指定する必要があります。プロキシはそれ以外の値、および省略された場合を 400 で拒否します。このスキーマの
required リストには含まれていません。Comfy Router が /v2/models/byteplus/{model} の {model} パスセグメントからこれを設定するため、Router の呼び出し元は省略します。プロンプト最適化機能の設定。このパラメータをサポートするのは seedream-5.0-pro/5.0-lite/4.5/5.5(スタンダードモードのみサポート。seedream-5.5 は fast を指定するとエラーを返します)と seedream-4.0 のみです。
プロンプト最適化機能のモードを設定します。standard = より高品質ですが生成時間が長くなります。fast = より高速ですが品質は平均的です。可能な値:
standard, fast出力画像の形式を指定します。このパラメータをサポートするのは seedream-5.0-pro、5.0-flash、5.0-lite、5.5 のみです。seedream-5.5 のデフォルトは png です。レイヤー分離シナリオでは、output_format はベース画像の形式のみを制御し、各レイヤーは常に png で出力されます。可能な値:
png、jpeg画像生成または変換のためのテキスト記述。
レイヤー分離シナリオ(seedream-5.0-pro、5.0-flash、または layer_decomposition が有効な 5.5)ではオプションです。プロンプトが提供された場合、モデルはプロンプトの意図に従って、指定した要素を認識して分離します。プロンプトが提供されない場合、モデルは画像内のすべての主要な要素を自動的に検出し、それらを独立したレイヤーに分離します。
画像生成の確率性を制御するランダムシード。範囲: [-1, 2147483647]。指定しない場合、シードは自動的に生成されます。同じ出力を再現するには、同じシード値を使用します。範囲:
-1 から 2147483647バッチ生成機能を無効にするかどうかを制御します。このパラメータは seedream-5.0-lite、4.5、4.0 でのみサポートされています(seedream-5.0-pro、5.0-flash、5.5 ではサポートされません)。有効な値:
auto: 自動モードでは、モデルはユーザーのプロンプトに基づいて、複数の画像を返すかどうか、および含まれる画像数を自動的に決定します。
disabled: バッチ生成機能を無効にします。モデルは 1 枚の画像のみを生成します。可能な値:
auto、disabledこのパラメータをサポートするのは seedream-5.0-lite、4.5、4.0 のみです(seedream-5.0-pro、5.0-flash、5.5 ではサポートされません)。
バッチ画像生成機能の設定。このパラメータは sequential_image_generation が auto に設定されている場合にのみ有効です。
“seedream-4-0-250828”: 生成画像の仕様を設定します。2 つの方法が利用できますが、併用はできません。
方法 1 | 解像度を指定します。オプションの値: 1K、2K、4K
方法 2 | 幅と高さをピクセル単位で指定します。デフォルト: 2048x2048、総ピクセル数: [1024x1024, 4096x4096]、アスペクト比: [1/16, 16]
“seedream-4-5-251128”: 2 つの方法が利用できます。
方法 1 | 解像度を指定します。オプションの値: 2K、4K
方法 2 | 幅と高さをピクセル単位で指定します。デフォルト: 2048x2048、総ピクセル数: [2560x1440, 4096x4096]、アスペクト比: [1/16, 16]
“seedream-5-0-260128”: 2 つの方法が利用できます。
方法 1 | 解像度を指定します。オプションの値: 2K、3K
方法 2 | 幅と高さをピクセル単位で指定します。デフォルト: 2048x2048、総ピクセル数: [2560x1440, ~3072x3072]、アスペクト比: [1/16, 16]
“seedream-5-0-pro-260628”: 2 つの方法が利用できます(併用はできません)。
方法 1 | 解像度を指定し、プロンプトで画像のアスペクト比、形状、または用途を記述します。最終的なサイズはモデルが決定します。オプションの値: 1K、2K
方法 2 | 幅と高さをピクセル単位で指定します。デフォルト: 1024x1024、総ピクセル数: [1024x1024 (1048576), 2048x2048 (4194304)]、アスペクト比: [1/16, 16]
“seedream-5-0-flash-260915”: 2 つの方法が利用できます(併用はできません)。
方法 1 | 解像度を指定し、プロンプトで画像のアスペクト比、形状、または用途を記述します。最終的なサイズはモデルが決定します。オプションの値: 1K、1.5K、2K。デフォルト: 2K
方法 2 | 幅と高さをピクセル単位で指定します。総ピクセル数: [1280x720 (921600), 2048x2048x1.1025 (4624220)]、アスペクト比: [1/16, 16]
“seedream-5-5-261028”: 2 つの方法が利用できます(併用はできません)。
方法 1 | 解像度を指定します。オプションの値: 1K、1.5K、2K。デフォルト: 2K
方法 2 | 幅と高さをピクセル単位で指定します。総ピクセル数: [1280x720 (921600), 2048x2048x1.1025 (4624220)]、アスペクト比: [1/16, 16]
“seedream-5-0-pro-260628”、“seedream-5-0-flash-260915”、および “seedream-5-5-261028” で layer_decomposition が有効な場合: 解像度レベルの方法のみがサポートされます。オプションの値: 1K、1.5K、2K、auto。デフォルト: auto。
ベース画像は、元の入力画像のアスペクト比で指定された解像度で出力されます。各レイヤーは、元の画像でのアスペクト比を維持しながら、指定された解像度に近いサイズで出力されます。
auto: 出力は入力画像のサイズとアスペクト比に基づきます。[1280x720, ~2048x2048] 内の入力は元の入力サイズで出力されます。1K より小さい入力は 1K で出力されます。2K より大きい入力は 2K で出力されます。
Comfy Router は完全な JSON 結果を取得するため、明示的に指定された stream フラグを false に確定します。v1 プロキシでは、このフィールドはストリーミング出力モードを有効にするかどうかを制御します。このパラメータをサポートするのは seedream-5.0-lite、4.5、4.0 のみです(seedream-5.0-pro、5.0-flash、5.5 ではサポートされません)。false = すべての出力画像が一度に返されます。true = 各出力画像が生成後すぐに返されます。
生成画像にウォーターマークを追加するかどうかを指定します。false = ウォーターマークなし、true = ‘AI generated’ ラベル付きのウォーターマークを追加します
GET /v2/models/byteplus/seedream-5-0-260128/openapi.json で Router が提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に呼び出しを検証する際に使用されるのと同じドキュメントです。
出力
生成された画像に関する情報が含まれます。
レイヤー分離のシナリオでは、配列の最初の要素がベース画像 (z_index=0) で、以降の要素は z_index の昇順で並んだレイヤーです。
画像が実際に持つ背景タイプ: transparent または opaque。レイヤー分離のシナリオでは、ベース画像は常に opaque で、すべてのレイヤーは transparent です。このフィールドを返すのは seedream-5.5 のみです。
現在のレイヤーがベース画像内で占める領域のバウンディングボックス情報。このフィールドを返すのはレイヤーのみで、ベース画像はキャンバス全体を覆うため bounding_box を返しません。layer_decomposition が true の場合にのみ返されます。
ベース画像のサイズに基づいて [0, 1000] の離散的な整数範囲に比例マッピングされ、最大 1000 で切り捨てられた、レイヤーのバウンディングボックスのパーミル量子化 (正規化) 座標。座標形式: [left, top, right, bottom]。
現在の分離要素の詳細な説明。name よりも豊富なレイヤーの特性 (色、状態、マテリアルなど) を提供します。このフィールドを返すのはレイヤーのみで、ベース画像は返しません。layer_decomposition が true の場合にのみ返されます。
現在の分離要素の名前/ラベル。分離された被写体の特性からモデルが自動的に生成します。このフィールドを返すのはレイヤーのみで、ベース画像は返しません。layer_decomposition が true の場合にのみ返されます。
画像の幅と高さ (ピクセル単位)。形式は <width>x<height> です。このパラメータをサポートするのは seedream-5.0-pro、5.0-lite、5.5、4.5、4.0 のみです。
レイヤーの重なり順。下から上へ向かって増加します。0 が最下層のレイヤー (ベース画像) で、値が大きいほど上に位置します。レイヤーを正しい重なり順で完全な画像に再合成するために使用します。layer_decomposition が true の場合にのみ返されます。
上流の ModelArk エラーコード。SensitiveContentDetected、InputTextSensitiveContentDetected、InputImageSensitiveContentDetected、InputVideoSensitiveContentDetected、InputAudioSensitiveContentDetected、OutputTextSensitiveContentDetected、OutputImageSensitiveContentDetected、OutputVideoSensitiveContentDetected、OutputAudioSensitiveContentDetected はコンテンツポリシーによる拒否を識別します。ファミリーには、InputImageSensitiveContentDetected.PrivacyInformation、OutputVideoSensitiveContentDetected.PolicyViolation、OutputImageSensitiveContentDetected.DeepFake のように、ドット区切りの理由が付くことがあります。これは列挙型ではなくオープンな文字列です。その他のコードは検証エラーやプロバイダーの障害を表します。Router は、トランスポートの障害を上書きすることなく、HTTP 400 のエラーエンベロープおよび HTTP 200 の失敗タスク応答に含まれるポリシーファミリーを認識します。
例
入力
出力
出荷前の確認
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 が現在対応していないことと、代替手段。