ideogram/ideogram-v3 の API リファレンス。Comfy Router が Ideogram から提供しています。
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk)を使用します。cURL のスニペットは、生の HTTP で同じ呼び出しを行います。
モデル ID: ideogram/ideogram-v3
エンドポイント: POST https://api.comfy.org/v2/models/ideogram/ideogram-v3
- Wait for the result
- Queue and collect later
スキーマ
入力
string
アスペクト比(WxH 形式)
object
object[]
重み(任意)を付けられる明示的な色
string
16 進数のカラーコード
number
色の重み(任意、0~1)範囲:
0 ~ 1string
カラーパレットの名前
string
magic prompt による拡張を有効にするかどうか指定可能な値:
AUTO、ON、OFFstring
生成時に避けたい内容を指定するテキストプロンプト
integer
生成する画像の数範囲:
1 ~ …string
必須
画像生成のためのテキストプロンプト
string
デフォルト:"\"DEFAULT\""
必須
生成速度と品質のトレードオフを制御するレンダリング速度の設定指定可能な値:
DEFAULT、TURBO、QUALITYstring
画像の解像度(WxH 形式)
integer
再現可能な生成のためのシード値
string[]
16 進数形式のスタイルコードの配列
string
デフォルト:"\"GENERAL\""
指定可能な値:
AUTO、GENERAL、REALISTIC、DESIGN、FICTIONGET /v2/models/ideogram/ideogram-v3/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用するのと同じドキュメントです。
出力
string (date-time)
生成が作成された日時。形式:
date-timeobject[]
生成された画像情報の配列。
boolean
画像が安全と見なされるかどうかを示します。
string
この画像の生成に使用されたプロンプト。
string
生成された画像の解像度(例: ‘1024x1024’)。
integer
この生成に使用されたシード値。
string
生成に使用されたスタイルタイプ(例: ‘REALISTIC’、‘ANIME’)。
string
生成された画像の URL。
例
入力
出力
出荷前の確認
SDK はIdempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。
リクエストが失敗すると、Router は理由を示す X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。