byteplus/seedream-4-0-250828 のAPIリファレンスです。Comfy Router が BytePlus から提供しています。
入力: テキスト, 画像 · 出力: 画像
クイックスタート
お使いの Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk および npm install @comfyorg/sdk)を使用しています。cURL スニペットは、同じ呼び出しを raw HTTP で実行するものです。
モデル ID: byteplus/seedream-4-0-250828
エンドポイント: POST https://api.comfy.org/v2/models/byteplus/seedream-4-0-250828
- 結果を待つ
- キューに投入して後で収集
同じボディを
POST https://api.comfy.org/v2/models/byteplus/seedream-4-0-250828/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 では、1 枚の画像または複数の画像を入力できます(複数画像のブレンド例を参照してください)。• 画像URL: 画像URLにアクセスできることを確認してください。
• Base64 エンコーディング: 形式は data:image/<画像形式>;base64,<Base64 エンコーディング> である必要があります。注: <画像形式> は小文字で指定します(例: 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 は必須で、入力できる画像は 1 枚のみです(複数の画像を渡すとエラーを返します)。入力画像は 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 枚の入力画像を 1 枚のベース画像と複数のレイヤー(最大 16、seedream-5.5 では最大 99)に分解し、生成された各レイヤーの位置とコンテンツ情報を返します。これには重ね順(z_index)、バウンディングボックス(bounding_box)、名前(name)、説明(description)が含まれます。
false: 標準の画像生成モード。レイヤー分離は行いません。
レイヤー分離モードの注意点: 入力できる画像は 1 枚のみです(複数の画像を渡すとエラーを返します)。いずれか 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 で拒否します。Comfy Router が /v2/models/byteplus/{model} の
{model} パスセグメントから補完するため、このスキーマの required リストには含まれていません。そのため Router の呼び出し元は省略します。プロンプト最適化機能の設定。seedream-5.0-pro/5.0-lite/4.5/5.5(standard モードのみサポート。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 で出力されます。Possible values:
png, jpeg画像の生成または変換のためのテキスト記述。
レイヤー分離シナリオ(layer_decomposition を有効にした seedream-5.0-pro、5.0-flash、5.5)ではオプションです。プロンプトを指定した場合、モデルはプロンプトの意図に従って指定された要素を認識して分離します。プロンプトを指定しない場合、モデルは画像内の主要な要素をすべて自動的に検出し、独立したレイヤーに分離します。
レスポンスで返される生成画像の形式を指定します。このルートでは b64_json は layer_decomposition と併用できません(v1 では 400、Comfy Router では response_format で 422)。インライン化された base64 のレイヤーは Comfy Router の結果サイズ上限を超える可能性があり、画像がすでにレンダリングされ課金された後に失敗するためです。レイヤー分離リクエストには url(デフォルト)を使用してください。指定可能な値:
url, b64_json画像生成のランダム性を制御するランダムシード。範囲: [-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]
layer_decomposition を有効にした “seedream-5-0-pro-260628”、“seedream-5-0-flash-260915”、“seedream-5-5-261028”: 解像度レベルの方法のみサポートされます。指定可能な値: 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-4-0-250828/openapi.json で Router が提供するスキーマから生成済みです。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用する同一のドキュメントです。
出力
画像が実際に持つ背景の種類(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 が現在対応していないことと、代替手段。