Skip to main content
POST
この API は非同期です。送信に成功すると task_id が返ります。タスク照会で状態と画像を取得し、completed または failed になったらポーリングを停止してください。4k の生成には数分かかる場合があるため、全体の待機タイムアウトは 10 分を推奨します。

リクエストヘッダー

string
必須
Bearer 認証。形式は Bearer <token> で、<token> は APIMart API Key です。

リクエストパラメータ

string
必須
flux-3-image 固定です。
string
必須
テキストから生成する画像の説明、または画像編集の指示。ネガティブプロンプトは非対応です。生成したい内容を肯定的に記述してください。prompt 内のタグと bbox JSON でレイアウトや部分編集の領域を指定できます。以下の例をご覧ください。
string[]
参照画像のリスト。最大 10 枚に対応し、公開アクセス可能な HTTP(S) URL または Base64 入力を使用できます。省略するとテキストから画像を生成します。1 枚を指定すると単一画像の編集、複数枚を指定すると複数画像を参照できます。
string
デフォルト:"auto"
出力アスペクト比。対応値:21:9、2:1、16:9、3:2、7:5、4:3、5:4、1:1、4:5、3:4、5:7、2:3、9:16、1:2、9:21 または auto。16x9 形式の比率表記にも対応します。auto の場合:
  • 編集または複数画像参照:最初の参照画像の比率に従います。
  • テキストからの生成:プロンプトに基づいて決定し、比率が決まらない場合は 1:1 を使用します。
string
アスペクト比の互換パラメータです。aspect_ratio の代わりに使用でき、同じ値を受け付けます。どちらか一方のみを使用することを推奨します。1024x1024 などのピクセルサイズは非対応で、指定すると HTTP 400 が返ります。出力解像度は resolution で選択してください。
string
デフォルト:"1k"
出力解像度。768sq、1k、1.5k、2k、4k に対応し、大文字・小文字は区別しません。768 は 768sq と同等です。このパラメータで課金区分が決まります。省略時は 1k で生成・課金されます。3k などの非対応値は HTTP 400 を返します。
integer
デフォルト:"2"
コンテンツ安全性の許容度。範囲は 0–4 で、0 が最も厳格です。
boolean
デフォルト:"true"
生成前のウェブ検索または画像検索を許可するかどうか。false で無効にできます。ブール値で指定してください。文字列の "false" や "true" は使用できません。
integer
デフォルト:"1"
1 リクエストにつき 1 枚を生成し、1 のみ指定できます。複数枚が必要な場合は個別にタスクを送信してください。1 を超える値は HTTP 400 を返します。

非対応のパラメータ

次のパラメータを指定すると HTTP 400 が返り、黙って無視されることはありません。
  • width、height
  • 1024x1024 など、ピクセルサイズ形式の size
  • seed、steps、guidance
  • output_format、negative_prompt、prompt_upsampling、mask_url
高解像度には resolution、特定の画面比率には aspect_ratio を使用してください。

参照画像の編集

サンプル URL を公開アクセス可能な画像 URL に置き換えてください。複数画像を参照する場合は、image_urls に合計 10 枚以内の URL を指定します。

複数画像の参照

編集、部分編集、レイアウトは本ページの同じ API とモデルを使用し、resolution に基づいて課金されます。参照画像は順番に、1 枚目が ref_image_0、2 枚目が ref_image_1 です。プロンプトでは Image 1 / Image 2 とも記述できます。

部分編集(bounding box)

prompt の先頭に自然言語の編集指示を書き、<car_1> のような <タグ> で要素を指定します。同じ文字列の後ろに JSON 配列を追加し、各オブジェクトで 1 つの枠を記述します。bbox は独立したリクエストパラメータではありません。 すべての枠フィールド(src_bbox、tgt_bbox、bbox)は [上, 左, 下, 右]、つまり [y1, x1, y2, x2] を使用します。0–1000 の正規化座標で、左上が [0,0]、右下が [1000,1000] です。ピクセル座標ではありません。 次の例では枠内の車を赤くし、保持する背景を記述します。URL と枠の位置は例なので、実際の画像に合わせて置き換えてください。

要素の移動

次のオブジェクトをプロンプト末尾の bbox 配列に入れます。from は元画像、src_bbox は元の位置、tgt_bbox は新しい位置です。自然言語の指示にも対応する <knight_1> タグを使用してください。

テキストからの画像生成のレイアウト

参照画像がなくてもレイアウトを指定できます。各枠は id、bbox、desc を使用します。座標グリッドが画面比率に合わせて伸縮するため、aspect_ratio を明示してください。

使用上の注意

  • bbox JSON は prompt 文字列の一部です。リクエスト JSON を手書きする場合、内部の二重引用符を \" としてエスケープしてください。SDK や JSON シリアライズでは自動処理できます。
  • 保持する領域も列挙し、desc に保持内容を記述してください。
  • プロンプト内の要素タグと JSON の id は一対一で対応させてください。<ref_image_0> などの参照識別子は入力画像を示します。
  • このモデルには mask パラメータがなく、mask_url も非対応です。mask_url を指定すると HTTP 400 が返ります。bbox 編集ではマスクのアップロードパラメータを使用しません。

送信レスポンス

integer
レスポンスステータスコード。成功時は 200 です。
array
タスク送信結果。

タスク結果の照会

成功レスポンスの例(画像 URL はプレースホルダーです):
data.result.images[0].url 配列から画像リンクを取得します。状態が failed の場合は返されたエラーを確認し、画像を待ち続けないでください。

解像度と課金

画像単位で課金されます。単価は resolution のみで決まり、アスペクト比や参照画像の枚数には依存しません。参照画像による追加料金はありません。 出力規模は概算です。実際のピクセルサイズは返された画像を基準にしてください。各解像度の料金はモデル料金をご確認ください。 タスクが失敗した場合、またはコンテンツ審査でブロックされた場合は全額返金されます。

よくあるパラメータエラー