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

Image Replace 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/image/replace_background' \
  -H 'Authorization: Bearer {codia_api_key}' \
  -F 'image=@./product.png' \
  -F 'prompt=clean white studio background'
```

Keep the foreground subject of an image and synthesize a new background described by a text prompt. Synchronous, single-call. Combines background removal + inpainting + generative rendering in one step.

## What this API is for

Reshooting product photography against new scenes ("on a marble counter", "in front of a sunset window"), reusing portraits across campaigns, or any time you want to keep the subject and change its environment. The subject is preserved; the prompt only steers the new background.

## Request

| Field | Required | Notes |
|---|---|---|
| `image_url` | yes | Public URL of the source image. |
| `prompt` | yes | Natural-language description of the desired new background. Be specific about lighting, surface, and context for best results. |
| `model` | no | Model ID. Defaults to `nano_banana_2`. Also: `nano_banana_pro` (higher fidelity), `ideogram_v3` (alternative aesthetic). |

**Prompt tips**: describe the surface or scene ("clean white marble table"), the lighting ("soft studio lighting from the left"), and the mood. Avoid contradicting the subject's lighting unless you want the subject re-lit (the model may match it).

## Response

Shared `ImageUrlListSuccess` shape — `data.image_urls` is an array of CDN URLs (length 1).

## Billing & limits

- 13 credits per request from the unified Codia Open API balance.
- Synchronous, single-digit-second latency for typical inputs.

## Errors

Standard set — `400` bad input (missing `image_url` or `prompt`), `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=image_replace_background` instead. Inputs and credit cost are identical.

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

image_url

Descripción en texto del nuevo fondo que quieres

prompt

Modelo que sintetiza el nuevo fondo. El valor predeterminado es `nano_banana_2`. Actualmente, todos los modelos admitidos cuestan 13 créditos por solicitud.

| Modelo | Ideal para | Créditos |
| --- | --- | ---: |
| `nano_banana_2` | Cambios de fondo rápidos (Gemini 3.1 Flash). Buena opción predeterminada para la mayoría de las imágenes. | 13 |
| `nano_banana_pro` | Fondos 4K con calidad de estudio, iluminación y reflejos realistas. | 13 |
| `ideogram_v3` | Fondos estilizados, ilustrativos o con mucho texto. | 13 |

model

image

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

file

URL de la imagen de origen si no se sube la imagen

code

message

URL de las imágenes generadas o procesadas

image_urls

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

Conserva el sujeto y genera un fondo nuevo a partir de un prompt de texto.

Reemplazar fondo

Entrada

Salida

APIs relacionadas