**Cost**: 5 credits per successful call.

Image Object Erase supports two input modes:

1. **JSON URL mode**: send `application/json` with the existing URL field.
2. **Direct upload mode**: send `multipart/form-data` with a local image file in the `image` field. The compatible field name `file` is also accepted for the primary image. Codia checks credits before reading and uploading the file, so insufficient-credit requests return `402` without uploading anything.

Direct upload example:

```bash
curl 'https://openapi.codia.ai/v2/open/image/object_erase' \
  -H 'Authorization: Bearer {codia_api_key}' \
  -F 'image=@./photo.png' \
  -F 'mask=@./mask.png'
```

Remove specific regions of an image as identified by a **mask** image, and inpaint the gap so the result looks like the object was never there. Synchronous.

## What this API is for

Deleting people from background plates, removing unwanted objects from product shots, cleaning up screenshots before redistribution. Unlike `watermark_remove` (which auto-detects), this endpoint requires you to **specify exactly what to erase** via a binary mask.

## Mask format

`mask_url` must point to an image with the **same dimensions** as `image_url`:

- **White (255)** pixels = area to erase + inpaint.
- **Black (0)** pixels = keep as-is.
- Grayscale values in between produce partial blending; for crisp removal, threshold your mask to pure black/white.

The mask can be a separate PNG you generated client-side (e.g. from a brush UI or a segmentation model) or an alpha-channel cutout. Soft edges in the mask produce softer transitions in the result.

## Request

| Field | Required | Notes |
|---|---|---|
| `image_url` | yes | Public URL of the source image. |
| `mask_url` | yes | Public URL of the mask image (same dimensions as source). |
| `model` | no | Model ID. Defaults to `codia_image_v2`. Also: `nano_banana_2`, `nano_banana_pro` (higher fidelity at higher latency). |

## Response

Shared `ImageUrlListSuccess` — `data.image_urls` carries one CDN URL of the cleaned image.

## Billing & limits

- 5 credits per request from the unified Codia Open API balance.
- Synchronous.

## Errors

Standard set; in particular `400` on size mismatch between image and mask.

> **Sync vs. async**
> This synchronous endpoint returns the result inline — the simplest path. For production pipelines that need webhook delivery, automatic retry with idempotency, or explicit task cancellation, call `POST /v2/open/tasks` with `operation=image_object_erase` instead. Inputs and credit cost are identical.

任意のユーザー指定キー（最大 255 文字）。設定すると、成功した（2xx）レスポンスが 7 日間キャッシュされます。同じキーかつ同一のリクエストボディでリトライすると、キャッシュされたレスポンスが返されます（追加のクレジットは消費されません）。同じキーで異なるボディを送ると 409 が返されます。ネットワーク障害時に POST を安全にリトライできるようにするために使用します。multipart/form-data のアップロードでは、フォームフィールドとファイル内容でリクエストを比較するため、クライアントが新しい multipart boundary を選んでも、リトライしたアップロードにもキャッシュ済みのレスポンスが返されます。

Idempotency-Key

image_url

マスク画像の公開 URL（白 = 消去する領域、黒 = 保持）

mask_url

インペインティングを実行するモデル。デフォルトは `codia_image_v2` です。現在、サポートされているすべてのモデルは 1 リクエストあたり 5 クレジットです。

| モデル | 最適な用途 | クレジット |
| --- | --- | ---: |
| `codia_image_v2` | 写真や UI 向けの、クリーンで高速なインペインティング。周囲のコンテキストが単純な場合に最適です。 | 5 |
| `nano_banana_2` | 複雑なコンテキストを再構築する、AI による消去（Gemini 3.1 Flash）。 | 5 |
| `nano_banana_pro` | 精緻な背景の再構築を伴う、高忠実度の消去（Gemini 3 Pro）。 | 5 |

model

image

互換性のための元画像ファイルフィールド（非推奨: 代わりに `image` を使用してください）。

file

mask

画像をアップロードしない場合の元画像 URL

マスクをアップロードしない場合のマスク画像 URL

code

message

生成または処理された画像の URL

image_urls

data

リクエストボディの形式が正しくないか、必須パラメータが不足しています

API キーが指定されていないか、無効か、失効しています

アカウントの残高が不足しているか、サブスクリプションの有効期限が切れています

アカウントにこのエンドポイントへのアクセス権がありません

Idempotency-Key が異なるリクエストボディで再利用されました。

レート制限に達しました。`Retry-After` ヘッダーに示された秒数だけ待ってからリトライしてください。

サーバーで予期しないエラーが発生しました

マスクで指定した領域を削除し、オブジェクトが最初から存在しなかったかのように自然に補完します。

オブジェクト消去

入力

出力

関連する API