申請流程
要使用 Face Swap API,需要先到 申請頁面 Face Swap API 申請相應的服務,進入頁面之後,點擊「Acquire」按鈕,如圖所示:
如果您尚未登入或註冊,會自動跳轉到登入頁面邀請您來註冊和登入,登入註冊之後會自動返回當前頁面。
首次申請時會有免費額度贈送,可以免費使用該 API。
請求示例
我們以兩種圖片為示例,演示如何使用該 API。假設源圖片為下圖所示:

設置請求頭和請求體
Request Headers 包括:accept:指定接收 JSON 格式的響應結果,這裡填寫為application/json。authorization:調用 API 的密鑰,申請之後可以直接下拉選擇。
source_image_url:上傳的源圖片鏈接。target_image_url:上傳的目標圖片鏈接。timeout:可選,處理超時時間(秒),超時會直接返回。

代碼示例
可以發現,在頁面右側已經自動生成了各種語言的代碼,如圖所示:
CURL
Python
響應示例
請求成功後,API 將返回換臉後端圖片結果信息。例如:image_url 字段,裡面包含了將目標圖片的人臉換掉原圖片的人臉後的圖片鏈接,其它信息如下圖所示:
image_url,生成圖片的鏈接。image_width,生成圖片的寬度。image_height,生成圖片的長度。image_size,生成圖片的大小。task_id,此次生成任務的 ID。

異步回調
由於 Face Swap 生成的時間相對較長,大約需要 1-2 分鐘,如果 API 長時間無響應,HTTP 請求會一直保持連接,導致額外的系統資源消耗,所以本 API 也提供了異步回調的支持。 整體流程是:客戶端發起請求的時候,額外指定一個callback_url 字段,客戶端發起 API 請求之後,API 會立馬返回一個結果,包含一個 task_id 的字段信息,代表當前的任務 ID。當任務完成之後,生成 Face Swap 的結果會通過 POST JSON 的形式發送到客戶端指定的 callback_url,其中也包括了 task_id 字段,這樣任務結果就可以通過 ID 關聯起來了。
下面我們通過示例來了解下具體怎樣操作。
首先,Webhook 回調是一個可以接收 HTTP 請求的服務,開發者應該替換為自己搭建的 HTTP 伺服器的 URL。此處為了方便演示,使用一個公開的 Webhook 樣例網站 https://webhook.site/,打開該網站即可得到一個 Webhook URL,如圖所示:
將此 URL 複製下來,就可以作為 Webhook 來使用,此處的樣例為 https://webhook.site/3b76eba5-4573-432a-b607-3000b87afc06。
接下來,我們可以設置字段 callback_url 為上述 Webhook URL,同時填入相應的參數,如圖所示:

內容如下:
task_id 字段,其他的字段都和上文類似,通過該字段即可實現任務的關聯。
錯誤處理
在調用 API 時,如果遇到錯誤,API 會返回相應的錯誤代碼和信息。例如:400 token_mismatched:錯誤的請求,可能是因為缺少或無效的參數。400 api_not_implemented:錯誤的請求,可能是因為缺少或無效的參數。401 invalid_token:未授權,無效或缺失的授權令牌。429 too_many_requests:請求過多,您已超過速率限制。500 api_error:內部伺服器錯誤,伺服器出現問題。

