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

Idempotency-Key

Публичный URL исходного изображения

image_url

Публичный URL изображения маски (белый = область для удаления, чёрный = оставить)

mask_url

Модель, выполняющая инпейнтинг. По умолчанию — `codia_image_v2`. Сейчас все поддерживаемые модели стоят 5 кредитов за запрос.

| Модель | Для чего подходит | Кредиты |
| --- | --- | ---: |
| `codia_image_v2` | Чистый и быстрый инпейнтинг для фото и интерфейсов. Лучше всего подходит, когда окружающий контекст простой. | 5 |
| `nano_banana_2` | Интеллектуальное удаление с восстановлением сложного контекста (Gemini 3.1 Flash). | 5 |
| `nano_banana_pro` | Высокоточное удаление с восстановлением сложного фона (Gemini 3 Pro). | 5 |

model

Файл исходного изображения

image

Поле файла исходного изображения для совместимости (устарело: используйте `image`).

file

Файл изображения маски

mask

URL исходного изображения, если изображение не загружается

URL изображения маски, если маска не загружается

Необязательная модель

URL обработанных изображений

code

message

URL сгенерированных или обработанных изображений

image_urls

data

Тело запроса имеет неверный формат или в нём отсутствуют обязательные параметры

API-ключ отсутствует, недействителен или отозван

Недостаточно средств на балансе аккаунта или срок подписки истёк

У аккаунта нет доступа к этому эндпоинту

Idempotency-Key повторно использован с другим телом запроса.

Превышен лимит запросов. Перед повторной попыткой подождите столько секунд, сколько указано в заголовке `Retry-After`.

На сервере произошла непредвиденная ошибка

Удаляет области, отмеченные маской, и заполняет их так, будто объекта там никогда не было.

Удаление объектов

Входные данные

Выходные данные

Похожие API