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

Chave opcional fornecida pelo usuário (até 255 caracteres). Quando definida, uma resposta bem-sucedida (2xx) fica em cache por 7 dias. Uma nova tentativa com a mesma chave e o mesmo corpo de requisição retorna a resposta em cache (sem cobrança extra de créditos); uma nova tentativa com a mesma chave, mas com um corpo diferente, retorna 409. Use para que repetir um POST após falhas de rede seja seguro. Em uploads multipart/form-data, as requisições são comparadas pelos campos do formulário e pelo conteúdo dos arquivos, então um upload repetido é reproduzido mesmo que o cliente escolha um novo boundary multipart.

Idempotency-Key

image_url

URL pública da imagem de máscara (branco = área a apagar, preto = manter)

mask_url

Modelo que faz o inpainting. O padrão é `codia_image_v2`. Atualmente, todos os modelos suportados custam 5 créditos por requisição.

| Modelo | Ideal para | Créditos |
| --- | --- | ---: |
| `codia_image_v2` | Inpainting limpo e rápido para fotos e UI. Ideal quando o contexto ao redor é simples. | 5 |
| `nano_banana_2` | Remoção com IA que reconstrói contextos complexos (Gemini 3.1 Flash). | 5 |
| `nano_banana_pro` | Remoção de alta fidelidade com reconstrução de fundos complexos (Gemini 3 Pro). | 5 |

model

image

Campo compatível para o arquivo da imagem de origem (obsoleto: use `image`).

file

mask

URL da imagem de origem quando a imagem não é enviada

URL da imagem de máscara quando a máscara não é enviada

code

message

image_urls

data

O corpo da requisição está malformado ou faltam parâmetros obrigatórios

A chave de API está ausente, é inválida ou foi revogada

O saldo da conta é insuficiente ou a assinatura expirou

Idempotency-Key reutilizada com um corpo de requisição diferente.

Limite de taxa atingido. Aguarde o número de segundos indicado no cabeçalho `Retry-After` antes de tentar novamente.

Remove as áreas marcadas em uma máscara e as preenche para que pareça que o objeto nunca esteve ali.

Apagar objeto

Entrada

Saída

APIs relacionadas