本文將介紹一種 Flux Images Generation API 對接說明,它是可以通過輸入自定義參數來生成Flux官方的圖片。
接下來介紹下 Flux Images Generation API 的對接說明。
申請流程
要使用 API,需要先到?Flux Images Generation API?對應頁面申請對應的服務,進入頁面之后,點擊「Acquire」按鈕,如圖所示:
如果你尚未登錄或注冊,會自動跳轉到登錄頁面邀請您來注冊和登錄,登錄注冊之后會自動返回當前頁面。
在首次申請時會有免費額度贈送,可以免費使用該 API。
基本使用
首先先了解下基本的使用方式,就是輸入提示詞?prompt
、 生成行為?action
、圖片尺寸?size
,便可獲得處理后的結果,首先需要簡單地傳遞一個?action
?字段,它的值為?generate
,然后我們還需要輸入提示詞,具體的內容如下:
可以看到這里我們設置了 Request Headers,包括:
accept
:想要接收怎樣格式的響應結果,這里填寫為?application/json
,即 JSON 格式。authorization
:調用 API 的密鑰,申請之后可以直接下拉選擇。
另外設置了 Request Body,包括:
action
:此次圖片生成任務的行為。size
:圖片生成結果的尺寸大小。count
:生成圖片的數量,默認值是1,該參數只有在生成圖片任務有效,編輯任務是無效的。prompt
:提示詞。callback_url
:需要回調結果的URL。
選擇之后,可以發現右側也生成了對應代碼,如圖所示:
點擊「Try」按鈕即可進行測試,如上圖所示,這里我們就得到了如下結果:
json { "success": true, "task_id": "226eb763-9eab-4d06-ad57-d59753a03307", "trace_id": "089f8b46-0167-4f25-88ee-3c3f88d80e84", "data": [ { "prompt": "a white siamese cat", "image_url": "https://fal.media/files/lion/NVhtlwwGYQD6HrGaEfrzu_341484fad6d84b21b73f4f8824a3f98a.png", "timings": 1752743801 }, { "prompt": "a white siamese cat", "image_url": "https://fal.media/files/monkey/8UEQpFbQCYVOK1wKP3aV0_9bbc26fad64049b18d0244b99ef66ad1.png", "timings": 1752743801 } ] }
返回結果一共有多個字段,介紹如下:
success
,此時視頻生成任務的狀態情況。task_id
,此時視頻生成任務ID。trace_id
,此時視頻生成跟蹤ID。data
,此時圖像生成任務的結果列表。image_url
,此時圖片生成任務的鏈接。prompt
,提示詞。
可以看到我們得到了滿意的圖片信息,我們只需要根據結果中?data
?的圖片鏈接地址獲取生成的Flux圖片即可。
另外如果想生成對應的對接代碼,可以直接復制生成,例如 CURL 的代碼如下:
shell curl -X POST 'https://api.acedata.cloud/flux/images' \ -H 'authorization: Bearer {token}' \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -d '{ "action": "generate", "prompt": "a white siamese cat", "model": "flux-kontext-pro", "count": 2 }'
編輯圖片任務
如果想對某張圖片進行編輯的話, 首先參數image_url
必須傳入需要編輯的圖片鏈接,此時?action
?只支持?edits
,就可以指定如下內容:
- model:此次編輯圖片任務所采用的模型,該任務目前支持?
flux-kontext-max
、?flux-kontext-pro
。 - image_url:上傳需要編輯的圖片。
填寫樣例如下:
填寫完畢之后自動生成了代碼如下:
對應的代碼:
```python import requests
url = "https://api.acedata.cloud/flux/images"
headers = { "accept": "application/json", "authorization": "Bearer {token}", "content-type": "application/json" }
payload = { "action": "edits", "prompt": "a white siamese cat", "model": "flux-kontext-pro", "image_url": "https://cdn.acedata.cloud/ytj2qy.png" }
response = requests.post(url, json=payload, headers=headers) print(response.text) ```
點擊運行,可以發現會立即得到一個結果,如下:
json { "success": true, "task_id": "2a7979ff-1f77-4380-92c6-a2dc37c3b4c8", "trace_id": "732b65c0-48d9-49f7-b568-64e5acffe4c0", "data": [ { "prompt": "a white siamese cat", "image_url": "https://fal.media/files/monkey/aEUXJZ6Faj9YXUCQVs01Q_af0cea56c558441c9ba8df67b200812d.png", "timings": 1752744073 } ] }
可以看到,生成的效果是對原圖片進行編輯的效果,結果與上文類似。
異步回調
由于 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,同時填入相應的參數,具體的內容如圖所示:
點擊運行,可以發現會立即得到一個結果,如下:
{ "task_id": "6a97bf49-df50-4129-9e46-119aa9fca73c" }
稍等片刻,我們可以在?https://webhook.site/3d32690d-6780-4187-a65c-870061e8c8ab
?上觀察到生成圖片的結果,如圖所示:
內容如下:
json { "success": true, "task_id": "6a97bf49-df50-4129-9e46-119aa9fca73c", "trace_id": "9b4b1ff3-90f2-470f-b082-1061ec2948cc", "data": [ { "prompt": "a white siamese cat", "image_url": "https://sf-maas-uat-prod.oss-cn-shanghai.aliyuncs.com/outputs/f4f8d407-377a-408a-82d0-427a5a836f09_0.png", "seed": 1698551532, "timings": { "inference": 3.328 } } ] }
可以看到結果中有一個?task_id
?字段,其他的字段都和上文類似,通過該字段即可實現任務的關聯。
錯誤處理
在調用 API 時,如果遇到錯誤,API 會返回相應的錯誤代碼和信息。例如:
400 token_mismatched
:Bad request, possibly due to missing or invalid parameters.400 api_not_implemented
:Bad request, possibly due to missing or invalid parameters.401 invalid_token
:Unauthorized, invalid or missing authorization token.429 too_many_requests
:Too many requests, you have exceeded the rate limit.500 api_error
:Internal server error, something went wrong on the server.
錯誤響應示例
json { "success": false, "error": { "code": "api_error", "message": "fetch failed" }, "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89" }
結論
通過本文檔,您已經了解了如何使用 Flux Images Generation API 可通過輸入提示詞來生成圖片。希望本文檔能幫助您更好地對接和使用該 API。如有任何問題,請隨時聯系我們的技術支持團隊。