**Cost**: 5 credits per successful call.

Remove Background 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/remove_bg' \
  -H 'Authorization: Bearer {codia_api_key}' \
  -F 'image=@./product.png'
```

Cut out the foreground subject of an image and return a PNG with a fully transparent background. A synchronous, single-purpose endpoint — no model parameter, no prompt, no options.

## What this API is for

Product photos for storefronts, profile avatars, sticker generation, compositing pipelines — any time you need the subject without its scene. Returns a true alpha-channel PNG (not a flat white background).

## Request

| Field | Required | Notes |
|---|---|---|
| `image_url` | yes | Public URL of the image to process. PNG, JPG, or WebP. Must be reachable from Codia's network. |

## Response

Standard envelope. Unique to this endpoint (not the shared `ImageUrlListSuccess`): `data.image_url` is a **single** string — a CDN URL to the processed transparent PNG. Download promptly; the URL is pre-signed.

```json
{ "code": 0, "message": "ok", "data": { "image_url": "https://cdn.codia.ai/bg-removed/abc.png" } }
```

## Billing & limits

- 5 credits per successful call, from the unified Codia Open API balance.
- Synchronous; typically completes within a few seconds.
- Output is always PNG with an alpha channel, at the input image's resolution.

## Errors

Standard set — `400` for bad input, `401`/`403` auth, `402` credits, `429` rate limit, `500` internal.

> **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=remove_bg` instead. Inputs and credit cost are identical to this v2 endpoint.

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

URL pública de la imagen que se va a procesar

image_url

image

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

file

code

message

URL de la imagen procesada con fondo transparente

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

Recorta el sujeto principal y devuelve un PNG con un fondo realmente transparente.

Eliminar fondo

Entrada

Salida

APIs relacionadas