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

مفتاح اختياري يحدده المستخدم (حتى 255 حرفًا). عند تعيينه، تُخزَّن الاستجابة الناجحة (2xx) مؤقتًا لمدة 7 أيام. إعادة المحاولة بالمفتاح نفسه + جسم طلب مطابق تُعيد الاستجابة المخزّنة (دون خصم رصيد إضافي)؛ أما إعادة المحاولة بالمفتاح نفسه مع جسم مختلف فتُعيد 409. استخدمه لجعل إعادة إرسال POST آمنة عند حدوث أعطال في الشبكة. في عمليات الرفع بصيغة multipart/form-data، تُقارن الطلبات بحسب حقول النموذج ومحتوى الملفات، لذا يُعاد تشغيل الرفع المُكرَّر حتى لو اختار العميل multipart boundary جديدًا.

Idempotency-Key

رابط URL العام للصورة المراد تفكيكها إلى طبقات

image_url

image

حقل ملف الصورة المصدر للتوافق (مهمل: استخدم `image` بدلًا منه).

file

رابط URL للصورة المصدر عند عدم رفع صورة

نتيجة الصورة متعددة الطبقات

code

message

نوع نتيجة تقسيم الطبقات

type

شجرة طبقات قابلة للتحرير مُرمَّزة بصيغة JSON

data

جسم الطلب غير صالح أو تنقصه معاملات مطلوبة

مفتاح API مفقود أو غير صالح أو تم إبطاله

رصيد الحساب غير كافٍ أو انتهت صلاحية الاشتراك

لا يملك الحساب صلاحية الوصول إلى نقطة النهاية هذه

أُعيد استخدام Idempotency-Key مع جسم طلب مختلف.

تم تجاوز حد المعدل. انتظر عدد الثواني المحدد في الترويسة `Retry-After` قبل إعادة المحاولة.

حدث خطأ غير متوقع في الخادم

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

يقسّم صورة مسطّحة إلى مجموعة مرتبة من الطبقات (الخلفية والعناصر والنصوص والتراكبات) يمكن تحرير كلٍّ منها على حدة.

فصل طبقات الصورة

المدخلات

المخرجات

واجهات API ذات صلة