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

Optionaler, vom Client festgelegter Schlüssel (bis zu 255 Zeichen). Ist er gesetzt, wird eine erfolgreiche (2xx) Antwort 7 Tage lang zwischengespeichert. Eine Wiederholung mit demselben Schlüssel und identischem Request-Body liefert die gespeicherte Antwort (ohne zusätzliche Credits); eine Wiederholung mit demselben Schlüssel, aber anderem Body liefert 409. Damit lassen sich POST-Requests bei Netzwerkfehlern gefahrlos wiederholen. Bei multipart/form-data-Uploads werden Requests anhand der Formularfelder und Dateiinhalte verglichen, sodass ein wiederholter Upload auch dann als Wiederholung erkannt wird, wenn der Client eine neue Multipart-Boundary wählt.

Idempotency-Key

image_url

Öffentliche URL des Maskenbildes (weiß = zu entfernender Bereich, schwarz = behalten)

mask_url

Modell, das das Inpainting ausführt. Standard ist `codia_image_v2`. Alle unterstützten Modelle kosten derzeit 5 Credits pro Request.

| Modell | Geeignet für | Credits |
| --- | --- | ---: |
| `codia_image_v2` | Sauberes, schnelles Inpainting für Fotos und UIs. Am besten bei einfachem Umgebungskontext. | 5 |
| `nano_banana_2` | KI-gestütztes Entfernen, das komplexen Kontext rekonstruiert (Gemini 3.1 Flash). | 5 |
| `nano_banana_pro` | Hochpräzises Entfernen mit Rekonstruktion detailreicher Hintergründe (Gemini 3 Pro). | 5 |

model

image

Kompatibilitätsfeld für die Quellbilddatei (veraltet: verwenden Sie stattdessen `image`).

file

mask

URL des Quellbildes, wenn kein Bild hochgeladen wird

URL des Maskenbildes, wenn keine Maske hochgeladen wird

code

message

URLs der generierten oder verarbeiteten Bilder

image_urls

data

Der Request-Body ist fehlerhaft oder es fehlen erforderliche Parameter

Der API-Schlüssel fehlt, ist ungültig oder wurde widerrufen

Das Kontoguthaben reicht nicht aus oder das Abonnement ist abgelaufen

Das Konto hat keinen Zugriff auf diesen Endpunkt

Idempotency-Key mit einem anderen Request-Body wiederverwendet.

Rate-Limit erreicht. Warten Sie vor einem erneuten Versuch die im Header `Retry-After` angegebene Anzahl an Sekunden.

Auf dem Server ist ein unerwarteter Fehler aufgetreten

Entfernt die in einer Maske markierten Bereiche und füllt sie so auf, als wäre das Objekt nie da gewesen.

Objekt entfernen

Eingabe

Ausgabe

Ähnliche APIs