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

Необязательный ключ, задаваемый пользователем (до 255 символов). Если он указан, успешный ответ (2xx) кешируется на 7 дней. Повторный запрос с тем же ключом и идентичным телом возвращает закешированный ответ (без дополнительного списания кредитов); повторный запрос с тем же ключом, но другим телом возвращает 409. Позволяет безопасно повторять POST-запросы при сетевых сбоях. Для загрузок multipart/form-data запросы сравниваются по полям формы и содержимому файлов, поэтому повторная загрузка распознаётся как повтор, даже если клиент выбирает новую границу multipart.

Idempotency-Key

Публичный URL исходного изображения

image_url

Текстовое описание желаемого нового фона

prompt

Модель, генерирующая новый фон. По умолчанию — `nano_banana_2`. Сейчас все поддерживаемые модели стоят 13 кредитов за запрос.

| Модель | Для чего подходит | Кредиты |
| --- | --- | ---: |
| `nano_banana_2` | Быстрая замена фона (Gemini 3.1 Flash). Хороший вариант по умолчанию для большинства изображений. | 13 |
| `nano_banana_pro` | Фоны студийного качества в 4K с реалистичным освещением и отражениями. | 13 |
| `ideogram_v3` | Стилизованные, иллюстративные или насыщенные текстом фоны. | 13 |

model

Файл исходного изображения

image

Поле файла исходного изображения для совместимости (устарело: используйте `image`).

file

URL исходного изображения, если изображение не загружается

Промпт для нового фона

Необязательная модель

URL обработанных изображений

code

message

URL сгенерированных или обработанных изображений

image_urls

data

Тело запроса имеет неверный формат или в нём отсутствуют обязательные параметры

API-ключ отсутствует, недействителен или отозван

Недостаточно средств на балансе аккаунта или срок подписки истёк

У аккаунта нет доступа к этому эндпоинту

Idempotency-Key повторно использован с другим телом запроса.

Превышен лимит запросов. Перед повторной попыткой подождите столько секунд, сколько указано в заголовке `Retry-After`.

На сервере произошла непредвиденная ошибка

Сохраняет объект и генерирует новый фон по текстовому промпту.

Замена фона

Входные данные

Выходные данные

Похожие API