byteplus/seedream-5-0-pro-260628 の API リファレンスです。Comfy Router が BytePlus から提供しています。
入力: テキスト, 画像 · 出力: 画像
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk と npm install @comfyorg/sdk)を使用しており、cURL のスニペットは同じ呼び出しを生の HTTP で行うものです。
モデル ID: byteplus/seedream-5-0-pro-260628
エンドポイント: POST https://api.comfy.org/v2/models/byteplus/seedream-5-0-pro-260628
- 結果を待つ
- キューに送信して後で取得する
同じボディを
POST https://api.comfy.org/v2/models/byteplus/seedream-5-0-pro-260628/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形式: float編集対象の画像(1 枚または複数)。アクセス可能な URL、または data-URI プレフィックス付きの Base64 ペイロードとして指定します。参照画像の上限がこのモデルでは 14 ではなく 10 である点を除き、共通の Seedream フィールドと同じです。
レイヤー分離を有効にするかどうかを制御します。このパラメータをサポートするのは 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(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 で出力されます。指定可能な値:
png、jpeg画像の生成または変換のためのテキスト記述。
レイヤー分離シナリオ(layer_decomposition を有効にした seedream-5.0-pro、5.0-flash、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、disabledseedream-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-pro-260628/openapi.jsonで提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に呼び出しを検証するのと同じドキュメントです。
出力
画像が実際に持つ背景タイプ(transparent または opaque)。レイヤー分離のシナリオでは、ベース画像は常に opaque で、各レイヤーは transparent です。このフィールドを返すのは seedream-5.5 のみです。
現在のレイヤーがベース画像内で占める領域のバウンディングボックス情報。このフィールドを返すのはレイヤーのみで、ベース画像はキャンバス全体を覆うため bounding_box を返しません。layer_decomposition が true の場合にのみ返されます。
レイヤーのバウンディングボックスの絶対ピクセル座標。出力されるベース画像の座標系で、左上隅が (0, 0) です。座標の形式: [left, top, right, bottom]。
レイヤーのバウンディングボックスのパーミル量子化(正規化)座標。ベース画像のサイズを基準に [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 などです。これは enum ではなくオープンな文字列で、その他のコードは検証およびプロバイダーの障害を表します。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 が現在対応していないことと、代替手段。