# AI 背景変更

# 概要
AI 背景変更 API で、画像から被写体を切り出して背景を分離します。
カスタムプロンプトまたは事前定義されたテンプレートで背景を置き換えます。
**使用例**
Before:
![](https://yce.makeupar.com/assets/images/sod/banner/change/yce-topbanner-dt-before.jpg)
After:
![](https://yce.makeupar.com/assets/images/sod/banner/change/yce-topbanner-dt-after.jpg)
Before:
![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_change_bg_s5_poster_before_0753db3e02.jpg)
After:
![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/yce_change_bg_s5_poster_after_7fb288fde2.jpg)


---

## 統合ガイド
**1. 画像のアップロード**
以下のエンドポイントを通じて、アップロード URL とファイル ID をリクエストします。

```
POST /s2s/v2.0/file
```
返された URL を使用して画像をアップロードします。
または、独自のストレージにホストされた公開アクセス可能な画像 URL を指定することもできます。
**2. 背景説明プロンプトの準備または背景テンプレートの選択**

```
GET /s2s/v2.0/task/template/bg-replace
```
事前定義された背景テンプレートのリストを取得し、template_id で 1 つを選択します。プロンプトを使用する場合、プロンプトに基づいて背景が生成されます。テンプレートを使用する場合、template_id で指定されたテンプレートから背景が生成され、prompt パラメータは無視されます。
**3. 分析タスクの実行**

```
POST /s2s/v2.0/task/bg-replace
```
ファイル ID または画像 URL と、希望する背景プロンプトを指定してタスクを送信します。
レスポンスには、結果の追跡と取得に使用される task_id が返されます。
**4. タスク結果の取得**

```
GET /s2s/v2.0/task/bg-replace/{task_id}
```
タスク ID を使用してステータスを追跡し、結果を取得します。
[Webhook](/develop/webhook) を設定すると、タスク完了時に成功またはエラーのステータスで非同期通知を受信できます。タスクエンドポイントを繰り返し呼び出して、ステータスが 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/ja/reference/ai_photo_background_change.yaml)

## V2.0

 - [GET /s2s/v2.0/task/template/bg-replace](https://docs.perfectcorp.com/ja/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/ja/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/
 - [GET /s2s/v2.0/task/bg-replace/{task_id}](https://docs.perfectcorp.com/ja/reference/ai_photo_background_change/v2.0/paths/~1s2s~1v2.0~1task~1bg-replace~1%7Btask_id%7D/get.md)
