This page was machine-translated. Spotted a mistake?Help improve it.
Skip to content

Remove Background

Penghapusan latar belakang bertenaga AI dengan efek opsional (blur, bayangan, gradien, latar belakang kustom).

API Endpoint

POST /api/v1/tools/image/remove-background

Processing: Asinkron (mengembalikan 202, polling /api/v1/jobs/{jobId}/progress untuk status via SSE)

Model bundle: background-removal (4-5 GB)

Parameters

ParameterTypeRequiredDefaultDescription
filefileYes-Berkas gambar (multipart)
modelstringNo-Varian model AI yang digunakan
backgroundTypestringNo"transparent"Salah satu dari: transparent, color, gradient, blur, image
backgroundColorstringNo-Warna hex untuk latar belakang solid
gradientColor1stringNo-Warna gradien pertama
gradientColor2stringNo-Warna gradien kedua
gradientAnglenumberNo-Sudut gradien dalam derajat
blurEnabledbooleanNo-Aktifkan efek blur latar belakang
blurIntensitynumberNo-Intensitas blur (0-100)
shadowEnabledbooleanNo-Aktifkan drop shadow pada subjek
shadowOpacitynumberNo-Opasitas bayangan (0-100)
outputFormatstringNo-Format output: png, webp, atau avif
edgeRefineintegerNo-Tingkat penghalusan tepi (0-3)
decontaminatebooleanNo-Hapus rembesan warna dari tepi

Example Request

bash
curl -X POST http://localhost:1349/api/v1/tools/image/remove-background \
  -F "[email protected]" \
  -F 'settings={"backgroundType":"transparent","edgeRefine":2,"outputFormat":"png"}'

Response

Initial Response (202 Accepted)

json
{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "async": true
}

Progress (SSE at /api/v1/jobs/{jobId}/progress)

event: progress
data: {"phase":"processing","stage":"Removing background...","percent":50}

Final Result (via SSE)

json
{
  "phase": "complete",
  "percent": 100,
  "result": {
    "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "downloadUrl": "/api/v1/download/{jobId}/photo_mask.png",
    "maskUrl": "/api/v1/download/{jobId}/photo_mask.png",
    "originalUrl": "/api/v1/download/{jobId}/photo_original.png",
    "originalSize": 245000,
    "processedSize": 180000,
    "filename": "photo.jpg",
    "model": "rembg"
  }
}

Effects Endpoint (Phase 2)

POST /api/v1/tools/image/remove-background/effects

Menerapkan ulang efek latar belakang tanpa menjalankan ulang model AI. Menggunakan mask dan gambar asli yang di-cache dari Fase 1.

Parameters

ParameterTypeRequiredDefaultDescription
settingsJSONYes-JSON dengan pengaturan efek (lihat di bawah)
backgroundImagefileNo-Gambar latar belakang kustom (saat backgroundType adalah image)

Settings JSON fields

FieldTypeRequiredDescription
jobIdstringYesID job dari Fase 1
filenamestringYesNama berkas asli dari Fase 1
backgroundTypestringNotransparent, color, gradient, blur, image
backgroundColorstringNoWarna hex untuk latar belakang solid
gradientColor1stringNoWarna gradien pertama
gradientColor2stringNoWarna gradien kedua
gradientAnglenumberNoSudut gradien dalam derajat
blurEnabledbooleanNoAktifkan blur latar belakang
blurIntensitynumberNoIntensitas blur (0-100)
shadowEnabledbooleanNoAktifkan drop shadow
shadowOpacitynumberNoOpasitas bayangan (0-100)
outputFormatstringNopng, webp, atau avif

Example Request

bash
curl -X POST http://localhost:1349/api/v1/tools/image/remove-background/effects \
  -F 'settings={"jobId":"a1b2c3d4-...","filename":"photo.jpg","backgroundType":"color","backgroundColor":"#FF5500","outputFormat":"png"}'

Response (200 OK)

json
{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/{jobId}/photo_nobg.png",
  "processedSize": 195000
}

Notes

  • Membutuhkan model bundle background-removal terpasang (4-5 GB).
  • Fase 1 meng-cache mask transparan dan gambar asli sehingga Fase 2 (efek) dapat menerapkan ulang latar belakang berbeda secara instan tanpa menjalankan ulang model AI.
  • Mendukung format input HEIC/HEIF, RAW, TGA, PSD, EXR, dan HDR via dekode otomatis.
  • Rotasi EXIF dikoreksi otomatis sebelum diproses.