xai/grok-imagine-image の API リファレンスです。
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk)を使用しています。cURL のスニペットは、生の HTTP で同じ呼び出しを行うものです。
モデル ID: xai/grok-imagine-image
エンドポイント: POST https://api.comfy.org/v2/models/xai/grok-imagine-image
- Wait for the result
- Queue and collect later
スキーマ
入力
string
デフォルト:"\"auto\""
生成される画像のアスペクト比。デフォルトは auto で、プロンプトに最適な比率が自動的に選択されます。取り得る値:
1:1、3:4、4:3、9:16、16:9、2:3、3:2、9:19.5、19.5:9、9:20、20:9、1:2、2:1、autostring
デフォルト:"\"grok-imagine-image\""
使用するモデル。対応: grok-imagine-image(デフォルト)、grok-imagine-image-pro、grok-imagine-image-quality、grok-imagine-image-2.0。非推奨の -beta ID は、それぞれの GA モデルのエイリアスとして扱われます。
integer
デフォルト:"1"
生成する画像の数範囲:
1 から 10string
必須
画像生成のためのプロンプト
string
出力画像の品質。grok-imagine-image-2.0 では、これが価格ティアを選択します(low/medium。デフォルトは medium)。その他のモデルは現在のところこれを無視します。取り得る値:
low、medium、highstring
デフォルト:"\"1k\""
生成される画像の解像度。デフォルトは 1k。取り得る値:
1k、2kstring
デフォルト:"\"url\""
画像を返す際のレスポンス形式。url または b64_json を指定できます。Comfy Router(
POST /v2/models/xai/{model})は、いずれの場合も画像結果を再ホストされた URL として提供するため、送信リクエストではこれを url に強制変換します。この /proxy/ ルートでは記述されたとおりに扱われます。取り得る値: url、b64_jsonstring
画像のサイズ(サポートされていません)
string
画像のスタイル(サポートされていません)
string
エンドユーザーを表す一意の識別子。xAI が監視や不正利用の検出に役立てることができます
GET /v2/models/xai/grok-imagine-image/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する対象となるドキュメントと同じものです。
出力
string
リクエストが入力モデレーションによってブロックされた場合、そのブロック理由が含まれます
object[]
生成された画像オブジェクトのリスト
string
生成された画像を jpeg エンコーディングで表した base64 エンコード文字列(response_format が b64_json の場合)
string
生成された画像の MIME タイプ(例: image/png、image/jpeg、image/webp)。
string
生成された画像への URL(response_format が url の場合)
object
画像生成リクエストの使用状況情報
integer
このリクエストの正確なコストを USD ティックで表したもの(10,000,000,000 ティック = 1 USD)
例
入力
出力
出荷前の確認
SDK はIdempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。
リクエストが失敗すると、Router は理由を示す X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。