# AI 圖片換背景

# 概述
AI 圖片換背景 API 透過將主體與原始背景隔離來增強影像，支援廣泛的應用，包括商業中以產品為中心的應用案例。
這個 API 讓開發者使用自訂提示詞或預先定義的範本更換背景。
**使用範例**
之前：
![](https://yce.makeupar.com/assets/images/sod/banner/change/yce-topbanner-dt-before.jpg)
之後：
![](https://yce.makeupar.com/assets/images/sod/banner/change/yce-topbanner-dt-after.jpg)
之前：
![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_change_bg_s5_poster_before_0753db3e02.jpg)
之後：
![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_change_bg_s5_poster_after_7fb288fde2.jpg)


---

## 整合指南
**1. 上傳圖片**
透過以下方式請求上傳網址與檔案 ID：

```
POST /s2s/v2.0/file
```
使用回傳的網址上傳圖片。
或者，提供託管在您自有儲存空間、可公開存取的圖片網址。
**2. 準備背景描述提示詞，或選擇背景範本。**

```
GET /s2s/v2.0/task/template/bg-replace
```
取得預先定義的背景範本清單，並以其 template_id 選擇其一。使用 prompt（預設）時，背景會依據提供的提示詞生成。使用 template 時，背景會由 template_id 指定的預先定義範本生成，prompt 參數將被忽略。
**3. 執行分析任務**

```
POST /s2s/v2.0/task/bg-replace
```
使用檔案 ID 或圖片網址作為輸入，並附上理想的背景提示詞，提交任務。
回應會回傳 task_id 用於追蹤與取得結果。
**4. 取得任務結果**

```
GET /s2s/v2.0/task/bg-replace/{task_id}
```
使用任務 ID 追蹤狀態並得結
可設定 [Webhooks](/develop/webhook) 在任務完成時接收非同步通知，狀態為 success 或 error。也支援輪詢，重複呼叫任務端點直到狀態從 running 更新為 success 或 error。
僅在任務成功完成時才計費。


---

## 檔案規格與錯誤
* 支援的格式與尺寸

| AI 功能 | 支援的尺寸 | 支援的檔案大小 | 支援的格式 |
|  --- | --- | --- | --- |
| AI 圖片換背景 | 較長邊不得超過 4096 像素。 | < 10MB | jpg/jpeg/png |

* 錯誤代碼

| 錯誤代碼 | 說明 |
|  --- | --- |
| exceed_max_filesize | 輸入檔案大小超過允許的上限。 |
| size_mismatch_on_input_image_and_mask | 輸入圖片尺寸必須與輸入遮罩圖片的尺寸相符。 |
| invalid_parameter | 參數值無效。請求參數缺失、格式無效，或包含不支援的值。 |

* 環境與相依性

| 範例程式語言 / 工具 | 建議的執行環境版本 |
|  --- | --- |
| cURL | - bash >= 3.2   - curl >= 7.58（現代 TLS/HTTP 支援）   - jq >= 1.6（穩健的 JSON 解析） |
| Node.js（JavaScript） | Node >= 18（支援全域 fetch） |
| JavaScript | - Chrome / Edge >= 80   - Firefox >= 74   - Safari >= 13.1 |
| PHP | PHP >= 7.4（現代 TLS/相容性），ext-curl（建議）或 allow_url_fopen=On + ext-openssl、ext-json |
| Python | Python >= 3.10（支援 f-strings），requests >= 2.20.0 |
| Java | Java 11+（支援 HttpClient），Jackson Databind >= 2.12.0 |



---

## 點數消耗
| AI 功能 | 消耗的點數 |
|  --- | --- |
| AI 圖片換背景 V2.0 | 4 |



---

License: Privacy policy

## Servers

```
https://yce-api-01.makeupar.com
```

## Security

### BearerAuthenticationV2

使用標準的 'Bearer authentication'。請在標頭中放入您的 'API Key'：`Authorization:Bearer YOUR_API_KEY`。請注意 'Bearer' 與 'YOUR_API_KEY' 之間有一個空格。

Type: http
Scheme: bearer

## Download OpenAPI description

 - [AI 圖片換背景](https://docs.perfectcorp.com/_bundle/@l10n/zh-TW/reference/ai_photo_background_change.yaml)

## V2.0

 - [GET /s2s/v2.0/task/template/bg-replace](https://docs.perfectcorp.com/zh-tw/reference/ai_photo_background_change/v2.0/paths/~1s2s~1v2.0~1task~1template~1bg-replace/get.md)
 - [POST /s2s/v2.0/task/bg-replace](https://docs.perfectcorp.com/zh-tw/reference/ai_photo_background_change/v2.0/paths/~1s2s~1v2.0~1task~1bg-replace/post.md): AI 任務是非同步的。當功能支援 webhook 時，請優先使用以 webhook 為基礎的完成處理。設定您的 webhook 端點、驗證 webhook 簽章，並在收到 `success` 或 `error` 通知後，使用收到的 `task_id` 查詢任務結果。設定與驗證細節請見 [webhook 整合指南](/develop/webhook)。 若您的整合不支援 webhook 或無法使用
 - [GET /s2s/v2.0/task/bg-replace/{task_id}](https://docs.perfectcorp.com/zh-tw/reference/ai_photo_background_change/v2.0/paths/~1s2s~1v2.0~1task~1bg-replace~1%7Btask_id%7D/get.md)