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

Image Layering 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/layering' \
  -H 'Authorization: Bearer {codia_api_key}' \
  -F 'image=@./image.png'
```

Decompose a single image into an **ordered stack of editable layers** — background, subject(s), and overlays — each rendered separately. The output is a JSON DSL describing the layer tree plus the per-layer image data. Use this when you want a designer-style PSD-equivalent, not a single flat composition.

## What this API is for

Turning a flat marketing image back into editable components; pre-processing for downstream compositing; setting up animated reveals where each layer animates separately; segmenting photo content for fine-grained editing.

Different from `image_to_design`: that one returns a structural design-tree (Body / Layer / Text / Image nodes with positions and styles). `image_layering` returns visual layers (independent rendered images that you can stack). They complement each other.

## Request

| Field | Required | Notes |
|---|---|---|
| `image_url` | yes | Public URL of the image to decompose. |

No `model` parameter — uses Codia's layering pipeline.

## Response

Unique to this endpoint:

| Field | Type | Meaning |
|---|---|---|
| `data.type` | integer | Result-type code. Identifies the schema variant of `dsl`. |
| `data.dsl` | string | **JSON-encoded** layer tree. Parse client-side. Contains layer metadata + URLs to the rendered layer images. |

```json
{ "code": 0, "message": "ok", "data": { "type": 1, "dsl": "{\"layers\":[…]}" } }
```

The `dsl` field is intentionally a string (not a nested object) so you can store it verbatim or stream it without re-encoding.

## Billing & limits

- 13 credits per request from the unified Codia Open API balance.
- Synchronous.

## Errors

Standard set.

> **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_layering` instead. Inputs and credit cost are identical.

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

URL público da imagem a decompor em camadas

image_url

image

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

file

URL da imagem de origem quando a imagem não é carregada

code

message

Tipo de resultado da separação em camadas

type

Árvore de camadas editável codificada em JSON

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.

Image

LAUNCH OFFER

SHOP NOW

skin tone.

Vitamin C + hyaluronic acid for a bright

Vitamin C + hyaluronic acid for a brighter, even

Glow Serum

SKINCARE · NEW

VELORA

Divide uma imagem plana numa pilha ordenada de camadas (fundo, motivos, texto e sobreposições) que podem ser editadas separadamente.

Separação em camadas

Entrada

Saída

APIs relacionadas