申請プロセス
API を使用するには、まず Flux Images Generation API の該当ページでサービスを申請する必要があります。ページに入ったら、「Acquire」ボタンをクリックします。以下の図のように：
まだログインまたは登録していない場合は、自動的にログインページにリダイレクトされ、登録とログインを促されます。ログインまたは登録後、現在のページに自動的に戻ります。
初回申請時には無料のクレジットが付与され、この API を無料で使用できます。
基本使用
まず、基本的な使用方法を理解します。これは、プロンプトprompt、生成アクション action、画像サイズ size を入力することで、処理された結果を得ることができます。まず、action フィールドを単純に渡す必要があり、その値は generate です。次に、プロンプトを入力する必要があります。具体的な内容は以下の通りです：
accept：受け取りたいレスポンス結果の形式。ここではapplication/json、つまり JSON 形式を記入します。authorization：API を呼び出すためのキー。申請後、直接ドロップダウンから選択できます。
action：今回の画像生成タスクのアクション。size：画像生成結果のサイズ。count：生成する画像の数。デフォルト値は 1 で、このパラメータは画像生成タスクでのみ有効で、編集タスクでは無効です。prompt：プロンプト。model：生成モデル、デフォルトはflux-dev。callback_url：結果をコールバックする URL。
size にはいくつかの特別な制限があり、主に width x height のアスペクト比、x:y の画像比率の 2 種類に分かれます。具体的には以下の通りです：
参考の画像比率： “1:1” , “16:9”, “21:9” , “3:2”, “2:3”, “4:5”, “5:4”, “3:4”, “4:3”, “9:16”, “9:21”,
選択後、右側にも対応するコードが生成されていることがわかります。以下の図のように：
success：この時点での画像生成タスクの状態。task_id：この時点での画像生成タスク ID。trace_id：この時点での画像生成トレース ID。data：この時点での画像生成タスクの結果リスト。image_url：この時点での画像生成タスクのリンク。prompt：プロンプト。
data の画像リンクアドレスに基づいて生成された Flux 画像を取得するだけです。
また、対応する連携コードを生成したい場合は、生成されたものを直接コピーできます。例えば、CURL のコードは以下の通りです：
画像編集タスク
特定の画像を編集したい場合、まずパラメータimage_url に編集したい画像のリンクを渡す必要があります。この時、action は edit のみがサポートされ、以下の内容を指定できます：
- model：今回の画像編集タスクで使用するモデル。このタスクは現在
flux-kontext-max、flux-kontext-proをサポートしています。 - image_url：編集する必要がある画像をアップロードします。
非同期コールバック
Flux Images Generation APIによって生成される時間は比較的長く、約1〜2分かかります。APIが長時間応答しない場合、HTTPリクエストは接続を維持し続け、追加のシステムリソースを消費するため、本APIは非同期コールバックのサポートも提供しています。 全体の流れは、クライアントがリクエストを開始する際に、追加でcallback_urlフィールドを指定します。クライアントがAPIリクエストを開始すると、APIはすぐに結果を返し、現在のタスクIDを示すtask_idフィールド情報を含みます。タスクが完了すると、生成された画像の結果がPOST JSON形式でクライアントが指定したcallback_urlに送信され、その中にもtask_idフィールドが含まれているため、タスクの結果をIDで関連付けることができます。
以下の例を通じて、具体的にどのように操作するかを理解しましょう。
まず、WebhookコールバックはHTTPリクエストを受信できるサービスであり、開発者は自分で構築したHTTPサーバーのURLに置き換える必要があります。ここでは、デモのために公開のWebhookサンプルサイトhttps://webhook.site/を使用します。このサイトを開くとWebhook URLが得られます。
このURLをコピーすればWebhookとして使用できます。このサンプルはhttps://webhook.site/3d32690d-6780-4187-a65c-870061e8c8abです。
次に、フィールドcallback_urlを上記のWebhook URLに設定し、対応するパラメータを入力します。具体的な内容は以下の通りです：
https://webhook.site/3d32690d-6780-4187-a65c-870061e8c8abで生成された画像の結果を観察できます。以下のようになります：
内容は以下の通りです：
task_idフィールドが含まれており、他のフィールドは上記と似ています。このフィールドを通じてタスクの関連付けが可能です。
エラーハンドリング
APIを呼び出す際にエラーが発生した場合、APIは対応するエラーコードと情報を返します。例えば：400 token_mismatched：不正なリクエスト、パラメータが欠落または無効な可能性があります。400 api_not_implemented：不正なリクエスト、パラメータが欠落または無効な可能性があります。401 invalid_token：未認証、無効または欠落した認証トークン。429 too_many_requests：リクエストが多すぎます、レート制限を超えました。500 api_error：内部サーバーエラー、サーバーで何かがうまくいきませんでした。