Skip to main content
POST

対応モデル

認証

string
必須
すべてのエンドポイントで Bearer Token による認証が必要ですAPI Key の取得:API Key 管理ページで API Key を取得してくださいリクエストヘッダーに次の値を追加します:

Body

string
必須
モデル名
  • flux-kontext-pro - Kontext Pro 画像生成・編集モデル
  • flux-kontext-max - Kontext Max 高品質画像生成・編集モデル
string
必須
画像の生成または編集内容を記述するテキスト。
array
参照画像のリスト。省略するとテキストから画像を生成し、指定すると画像を編集します。制限:
  • 最大 4 枚の画像に対応
  • 公開アクセス可能な URL または Base64 エンコードされた入力画像に対応しています
  • 出力画像とすべての参照画像の合計ピクセル数は 9MP 以下でなければなりません
string
デフォルト:"1:1"
画像のアスペクト比対応するアスペクト比:
  • 1:1 - 正方形(デフォルト)
  • 4:3 - 横向き 4:3
  • 3:4 - 縦向き 3:4
  • 16:9 - 横向きワイドスクリーン
  • 9:16 - 縦向き
  • 3:2 - 横向き 3:2
  • 2:3 - 縦向き 2:3
  • 21:9 - ウルトラワイド
  • 9:21 - ウルトラトール
1024x1536 のようなピクセル文字列は、対応する最も近いアスペクト比にマッピングされ、正確なピクセルサイズでは出力されません。Kontext は widthheight に対応しておらず、指定するとタスクが失敗します。resolution は Kontext では効果がなく、出力は約 1MP です。
string
デフォルト:"png"
出力画像のエンコード形式
  • png - PNG 形式(デフォルト)
  • jpeg - JPEG 形式
  • webp - WebP 形式
string
レスポンス形式の互換パラメータ。指定できる値は urlb64_json です。画像のエンコード形式は変わらず、画像形式には output_format が優先して使用されます。
integer
デフォルト:"1"
生成する画像の枚数。値は 1 でなければなりません。複数枚が必要な場合は、複数のタスクを送信してください。
integer
ランダムシード。同じシードとその他のパラメータを使用すると、同じ結果を再現できます。省略した場合はランダムに生成されます。
boolean
デフォルト:"false"
プロンプト強化を有効にするかどうか
  • true - 有効
  • false - 無効(デフォルト)
明示的に false を設定すると、プロンプトの書き換えを無効にできます。
integer
デフォルト:"2"
セーフティ許容度範囲:0~6。値が大きいほど許容度が高くなります

実際の出力サイズ

ユースケース例

画像編集(入力画像あり)
テキストから画像を生成(入力画像なし)
複数の参照画像を使った編集

Response

integer
レスポンスステータスコード
array
レスポンスデータの配列

タスク結果の照会

送信に成功したら、GET /v1/tasks/{task_id} でタスクのステータスをポーリングします。詳しくはタスク照会 APIを参照してください。

成功レスポンス例

画像の取得パスは data.result.images[0].url[0] です。expires_at はこのリンクの有効期限を表す Unix タイムスタンプです。有効期限までに画像を保存してください。

タスクステータス

無効なモデルパラメータとタスクの失敗

無効なモデルパラメータは非同期で通知されます。送信時は HTTP 200 と task_id が返り、タスクを照会すると最終的に failed となり、具体的な理由が data.error.message に示されます。そのため、必ず最終ステータスまでポーリングしてください。
この種のエラーでは data.error.code は常に task_failed で、具体的な理由は message に記載されます。失敗したタスクは全額返金されます。

注意事項

  1. 非同期処理:送信後に task_id が返されます。結果を取得するには /v1/tasks/{task_id} をポーリングしてください。
  2. 参照画像の要件:参照画像は最大 4 件まで指定でき、公開アクセス可能な画像 URL または Base64 エンコードされた入力画像を使用できます。出力画像との合計は 9MP 以下でなければなりません。
  3. サイズのルール:デフォルトのアスペクト比は 1:1 です。ピクセル文字列は最も近い対応比率にマッピングされ、width/height は拒否され、resolution は効果がありません。Kontext の出力は約 1MP です。
  4. 生成枚数n1 でなければならず、1 回のリクエストで生成される画像は 1 枚です。
  5. プロンプトの書き換えprompt_upsampling: false を明示的に設定すると、プロンプトの書き換えを無効にできます。
  6. 結果リンク:画像 URL の有効期限は、対応する expires_at の Unix タイムスタンプに従います。期限までに保存してください。
  7. 参照 URL にアクセスできない場合temporarily unavailable dependency というメッセージは、参照画像にアクセスできないことを示す場合があります。URL が公開されており、アクセス制限や期限切れの署名がないことを先に確認してください。