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

Clé facultative fournie par l’utilisateur (jusqu’à 255 caractères). Si elle est définie, une réponse réussie (2xx) est mise en cache pendant 7 jours. Une nouvelle tentative avec la même clé et un corps de requête identique renvoie la réponse en cache (sans crédit supplémentaire facturé) ; une nouvelle tentative avec la même clé mais un corps différent renvoie 409. Permet de relancer un POST sans risque en cas d’erreur réseau. Pour les envois multipart/form-data, les requêtes sont comparées sur la base des champs du formulaire et du contenu des fichiers : un envoi relancé est donc bien rejoué même si le client choisit une nouvelle frontière multipart.

Idempotency-Key

image_url

image

Champ de fichier image source conservé pour compatibilité (obsolète : utilisez plutôt `image`).

file

code

message

URL de l’image traitée, avec fond transparent

data

Le corps de la requête est mal formé ou des paramètres obligatoires sont manquants

La clé d’API est manquante, invalide ou révoquée

Le solde du compte est insuffisant ou l’abonnement a expiré

Le compte n’a pas accès à cet endpoint

Idempotency-Key réutilisée avec un corps de requête différent.

Limite de débit atteinte. Attendez le nombre de secondes indiqué dans l’en-tête `Retry-After` avant de réessayer.

Une erreur inattendue s’est produite sur le serveur

Détoure le sujet principal et renvoie un PNG avec un véritable fond transparent.

Supprimer l'arrière-plan

Entrée

Sortie

APIs associées