**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.

Kunci opsional dari pengguna (maksimal 255 karakter). Jika diisi, respons sukses (2xx) di-cache selama 7 hari. Retry dengan kunci yang sama + body permintaan yang identik mengembalikan respons dari cache (tanpa potongan kredit tambahan); retry dengan kunci yang sama tetapi body berbeda mengembalikan 409. Gunakan agar POST aman di-retry saat terjadi gangguan jaringan. Untuk unggahan multipart/form-data, permintaan dibandingkan berdasarkan field formulir dan isi file, sehingga unggahan yang di-retry tetap diputar ulang meskipun klien memilih multipart boundary baru.

Idempotency-Key

image_url

URL publik gambar mask (putih = area yang dihapus, hitam = dipertahankan)

mask_url

Model yang menjalankan inpainting. Default-nya `codia_image_v2`. Saat ini semua model yang didukung memakan 5 kredit per permintaan.

| Model | Cocok untuk | Kredit |
| --- | --- | ---: |
| `codia_image_v2` | Inpainting yang bersih dan cepat untuk foto dan UI. Paling baik jika konteks sekitarnya sederhana. | 5 |
| `nano_banana_2` | Penghapusan berbasis AI yang memahami konteks dan merekonstruksi konteks kompleks (Gemini 3.1 Flash). | 5 |
| `nano_banana_pro` | Penghapusan presisi tinggi dengan rekonstruksi latar belakang yang rumit (Gemini 3 Pro). | 5 |

model

image

Field file gambar sumber untuk kompatibilitas (usang: gunakan `image`).

file

mask

URL gambar sumber jika tidak mengunggah gambar

URL gambar mask jika tidak mengunggah mask

code

message

image_urls

data

Body permintaan tidak valid atau parameter wajib tidak ada

API key tidak ada, tidak valid, atau sudah dicabut

Saldo akun tidak mencukupi atau langganan telah berakhir

Akun tidak memiliki akses ke endpoint ini

Idempotency-Key dipakai ulang dengan body permintaan yang berbeda.

Terkena rate limit. Tunggu selama jumlah detik di header `Retry-After` sebelum mencoba lagi.

Menghapus area yang ditandai pada mask lalu mengisinya sehingga objek tampak seperti tidak pernah ada.

Hapus Objek

Input

Output

API terkait