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

คีย์ที่ผู้ใช้กำหนดเอง (ไม่บังคับ ยาวสูงสุด 255 อักขระ) เมื่อกำหนดไว้ การตอบกลับที่สำเร็จ (2xx) จะถูกแคชไว้ 7 วัน การลองใหม่ด้วยคีย์เดิม + เนื้อหาคำขอที่เหมือนกันทุกประการจะได้การตอบกลับที่แคชไว้ (ไม่หักเครดิตเพิ่ม) ส่วนการลองใหม่ด้วยคีย์เดิมแต่เนื้อหาคำขอต่างกันจะได้ 409 ใช้เพื่อให้ส่ง POST ซ้ำได้อย่างปลอดภัยเมื่อเครือข่ายขัดข้อง สำหรับการอัปโหลดแบบ multipart/form-data ระบบจะเปรียบเทียบคำขอจากฟิลด์ในฟอร์มและเนื้อหาไฟล์ ดังนั้นการอัปโหลดซ้ำจะได้ผลลัพธ์เดิมแม้ไคลเอนต์จะสร้าง multipart boundary ใหม่

Idempotency-Key

URL สาธารณะของรูปภาพที่จะประมวลผล

image_url

ไฟล์รูปภาพต้นฉบับ

image

ฟิลด์ไฟล์รูปภาพต้นฉบับสำหรับความเข้ากันได้ (เลิกใช้แล้ว: ให้ใช้ `image` แทน)

file

ลบพื้นหลังสำเร็จ

code

message

URL ของรูปภาพที่ประมวลผลแล้วซึ่งมีพื้นหลังโปร่งใส

data

เนื้อหาคำขอมีรูปแบบไม่ถูกต้องหรือขาดพารามิเตอร์ที่จำเป็น

ไม่มี API key หรือ key ไม่ถูกต้องหรือถูกเพิกถอนแล้ว

ยอดคงเหลือในบัญชีไม่เพียงพอหรือการสมัครใช้งานหมดอายุแล้ว

บัญชีไม่มีสิทธิ์เข้าถึง endpoint นี้

ใช้ Idempotency-Key ซ้ำกับเนื้อหาคำขอที่ต่างออกไป

ถูกจำกัดอัตราการเรียกใช้ (rate limit) ให้รอตามจำนวนวินาทีในเฮดเดอร์ `Retry-After` ก่อนลองใหม่

เกิดข้อผิดพลาดที่ไม่คาดคิดบนเซิร์ฟเวอร์

ตัดวัตถุหลักออกมาและส่งคืนเป็น PNG ที่มีพื้นหลังโปร่งใสจริง

ลบพื้นหลัง

อินพุต

เอาต์พุต

API ที่เกี่ยวข้อง