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

Clave opcional proporcionada por el usuario (hasta 255 caracteres). Si se indica, una respuesta correcta (2xx) se guarda en caché durante 7 días. Un reintento con la misma clave y un cuerpo de solicitud idéntico devuelve la respuesta en caché (sin cobrar créditos adicionales); un reintento con la misma clave pero un cuerpo distinto devuelve 409. Úsala para que reintentar un POST tras un fallo de red sea seguro. En las subidas multipart/form-data, las solicitudes se comparan por los campos del formulario y el contenido de los archivos, de modo que una subida reintentada se reproduce aunque el cliente elija un nuevo boundary multipart.

Idempotency-Key

image_url

URL pública de la imagen de máscara (blanco = zona que se borra, negro = se conserva)

mask_url

Modelo que realiza el inpainting. El valor predeterminado es `codia_image_v2`. Actualmente, todos los modelos admitidos cuestan 5 créditos por solicitud.

| Modelo | Ideal para | Créditos |
| --- | --- | ---: |
| `codia_image_v2` | Inpainting limpio y rápido para fotos e interfaces. Ideal cuando el contexto circundante es sencillo. | 5 |
| `nano_banana_2` | Borrado con IA que reconstruye contextos complejos (Gemini 3.1 Flash). | 5 |
| `nano_banana_pro` | Borrado de alta fidelidad con reconstrucción de fondos intrincados (Gemini 3 Pro). | 5 |

model

image

Campo compatible para el archivo de imagen de origen (obsoleto: usa `image` en su lugar).

file

mask

URL de la imagen de origen si no se sube la imagen

URL de la imagen de máscara si no se sube la máscara

code

message

URL de las imágenes generadas o procesadas

image_urls

data

El cuerpo de la solicitud tiene un formato incorrecto o le faltan parámetros obligatorios

Falta la clave de API, no es válida o se ha revocado

El saldo de la cuenta es insuficiente o la suscripción ha caducado

La cuenta no tiene acceso a este endpoint

Idempotency-Key reutilizada con un cuerpo de solicitud distinto.

Límite de frecuencia alcanzado. Espera el número de segundos indicado en el encabezado `Retry-After` antes de reintentar.

Se ha producido un error inesperado en el servidor

Elimina las zonas marcadas en una máscara y las rellena para que parezca que el objeto nunca estuvo ahí.

Borrar objeto

Entrada

Salida

APIs relacionadas