Skip to main content
本文將介紹一種 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:116:9),不接受 1024x1024 這類像素尺寸,缺省會返回 400。
  • count:生成圖片的數量,默認值是 1,該參數只有在生成圖片任務有效,編輯任務是無效的。
  • prompt:提示詞。
  • model:生成模型,默認 flux-dev;最新旗艦為 flux-2-proflux-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-devflux-proflux-kontext-proflux-kontext-maxflux-2-flexflux-2-proflux-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。如有任何問題,請隨時聯繫我們的技術支持團隊。