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

Optional user-supplied key (up to 255 chars). When set, a successful (2xx) response is cached for 7 days. A retry with the same key + identical request body returns the cached response (no extra credit charged); a retry with the same key but a different body returns 409. Use to make POST safe to retry on network failures. For multipart/form-data uploads, requests are compared by form fields and file contents, so a retried upload is replayed even though the client picks a new multipart boundary.

Idempotency-Key

image_url

Public URL of the mask image (white = area to erase, black = keep)

mask_url

Model that performs the inpainting. Defaults to `codia_image_v2`. All supported models currently cost 5 credits per request.

| Model | Best for | Credits |
| --- | --- | ---: |
| `codia_image_v2` | Clean, fast inpainting for photos and UI. Best when the surrounding context is simple. | 5 |
| `nano_banana_2` | AI-aware erase that reconstructs complex context (Gemini 3.1 Flash). | 5 |
| `nano_banana_pro` | High-fidelity erase with intricate background reconstruction (Gemini 3 Pro). | 5 |

model

image

Compatible source image file field (deprecated: use `image` instead).

file

mask

Source image URL when not uploading image

code

message

image_urls

data

The request body is malformed or missing required parameters

The API key is missing, invalid, or revoked

Account balance is insufficient or subscription has expired

Account does not have access to this endpoint

Idempotency-Key reused with a different request body.

Rate limited. Wait for the number of seconds in the `Retry-After` header before retrying.

An unexpected error occurred on the server

Removes the areas marked in a mask and fills them in so the object looks like it was never there.

Erase Object

Input

Output

Related APIs