跳轉到主要內容
本文將介紹一種 Flux Images Generation API 串接說明,它是可以透過輸入自訂參數來生成 Flux 官方的圖片。

申請流程

要使用 Flux Images Generation API,首先到 Ace Data Cloud 控制台 取得您的 API Token,留作備用。 如果你尚未登入或註冊,會自動跳轉到登入頁面邀請你註冊和登入,完成後會自動返回目前頁面。 一個 API Token 即可呼叫平台所有服務,無需為每個服務單獨申請。 首次申請會贈送免費額度,可免費體驗;額度不足時可在 控制台 儲值通用餘額。
📘 完整文件:Flux Images Generation API →

基本使用

首先先了解一下基本的使用方式,就是輸入提示詞 prompt、生成行為 action、圖片尺寸 size,便可獲得處理後的結果,首先需要簡單地傳遞一個 action 欄位,它的值為 generate,然後我們還需要輸入提示詞,具體的內容如下:

可以看到這裡我們設定了 Request Headers,包括:
  • accept:想要接收怎樣格式的回應結果,這裡填寫為 application/json,即 JSON 格式。
  • authorization:呼叫 API 的金鑰,申請之後可以直接下拉選擇。
另外設定了 Request Body,包括:
  • action:此次圖片生成任務的行為。
  • size:圖片生成結果的尺寸大小。flux-2-flex / flux-2-pro / flux-2-max 系列必須傳入圖片比例(如 1:1、16:9),不接受 1024x1024 這類像素尺寸,預設會回傳 400。
  • count:生成圖片的數量,預設值是 1,該參數只有在生成圖片任務有效,編輯任務是無效的。
  • prompt:提示詞。
  • model:生成模型,預設 flux-dev;最新旗艦為 flux-2-pro、flux-2-max(畫質更高,需搭配圖片比例 size)。
  • callback_url:需要回呼結果的 URL。
  • async:可選,設為 true 時介面立即回傳 task_id,無需提供 callback_url,隨後透過對應的任務查詢介面輪詢取得結果。
參數 size有一些特別限制,主要分為width x height寬高比例、x:y 圖片比例兩種類型,具體的如下: 參考的圖片比例: “21:9”, “16:9”, “4:3”, “3:2”, “1:1”, “2:3”, “3:4”, “9:16”, “9:21”。 選擇參數後,右側會自動生成對應程式碼。複製前請確認授權標頭使用你自己的 API Key,文件和截圖中不應出現真實憑證。 點擊「Try」按鈕即可進行測試,這裡我們得到了如下結果:
回傳結果一共有多個欄位,介紹如下:
  • success,此時影片生成任務的狀態情況。
  • task_id,此時影片生成任務 ID。
  • trace_id,此時影片生成追蹤 ID。
  • data,此時影像生成任務的結果列表。
    • image_url,此時圖片生成任務的連結。
    • prompt,提示詞。
可以看到我們得到了滿意的圖片資訊,我們只需要根據結果中 data 的圖片連結地址取得生成的 Flux 圖片即可。 另外如果想生成對應的串接程式碼,可以直接複製生成,例如 CURL 的程式碼如下:

編輯圖片任務

如果想對某張圖片進行編輯的話,首先參數image_url必須傳入需要編輯的圖片連結,此時 action 只支援 edit,就可以指定如下內容:
  • model:此次編輯圖片任務所採用的模型,支援 flux-dev、flux-pro、flux-kontext-pro、flux-kontext-max、flux-2-flex、flux-2-pro、flux-2-max。
  • image_url:上傳需要編輯的圖片。
填寫範例如下:

填寫完畢之後自動生成了程式碼如下:

對應的程式碼:
點擊執行,可以發現會立即得到一個結果,如下:
可以看到,生成的效果是對原始圖片進行編輯的效果,結果與上文類似。

非同步回呼

由於 Flux Images Generation API 生成的時間相對較長,大約需要 1-2 分鐘,如果 API 長時間無回應,HTTP 請求會一直保持連線,導致額外的系統資源消耗,所以本 API 也提供了非同步回呼的支援。 整體流程是:用戶端發起請求的時候,額外指定一個 callback_url 欄位,用戶端發起 API 請求之後,API 會立刻返回一個結果,包含一個 task_id 的欄位資訊,代表目前的任務 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:內部伺服器錯誤,伺服器發生了問題。

錯誤回應範例

結論

透過本文檔,您已經了解如何使用 Flux Images Generation API,透過輸入提示詞來生成圖片。希望本文檔能幫助您更好地串接和使用該 API。如有任何問題,請隨時聯絡我們的技術支援團隊。