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

Chave opcional fornecida pelo utilizador (até 255 caracteres). Quando definida, uma resposta bem-sucedida (2xx) fica em cache durante 7 dias. Uma nova tentativa com a mesma chave e o mesmo corpo de pedido devolve a resposta em cache (sem cobrança adicional de créditos); uma nova tentativa com a mesma chave, mas com um corpo diferente, devolve 409. Utilize-a para que repetir um POST após falhas de rede seja seguro. Nos carregamentos multipart/form-data, os pedidos são comparados pelos campos do formulário e pelo conteúdo dos ficheiros, pelo que um carregamento repetido é reproduzido mesmo que o cliente escolha um novo boundary multipart.

Idempotency-Key

image_url

image

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

file

code

message

URL da imagem processada com fundo transparente

data

O corpo do pedido está malformado ou faltam parâmetros obrigatórios

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

O saldo da conta é insuficiente ou a subscrição expirou

Idempotency-Key reutilizada com um corpo de pedido diferente.

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

Recorta o motivo principal e devolve um PNG com um fundo verdadeiramente transparente.

Remover fundo

Entrada

Saída

APIs relacionadas