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

Remove Background

वैकल्पिक प्रभावों (ब्लर, शैडो, ग्रेडिएंट, कस्टम बैकग्राउंड) के साथ AI-संचालित बैकग्राउंड हटाना।

API Endpoint

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

Processing: असिंक्रोनस (202 लौटाता है, SSE के माध्यम से स्थिति के लिए /api/v1/jobs/{jobId}/progress पोल करें)

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

Parameters

ParameterTypeRequiredDefaultDescription
filefileYes-इमेज फ़ाइल (multipart)
modelstringNo-उपयोग करने के लिए AI मॉडल संस्करण
backgroundTypestringNo"transparent"इनमें से एक: transparent, color, gradient, blur, image
backgroundColorstringNo-ठोस बैकग्राउंड के लिए Hex रंग
gradientColor1stringNo-पहला ग्रेडिएंट रंग
gradientColor2stringNo-दूसरा ग्रेडिएंट रंग
gradientAnglenumberNo-डिग्री में ग्रेडिएंट कोण
blurEnabledbooleanNo-बैकग्राउंड ब्लर प्रभाव सक्षम करें
blurIntensitynumberNo-ब्लर तीव्रता (0-100)
shadowEnabledbooleanNo-विषय पर ड्रॉप शैडो सक्षम करें
shadowOpacitynumberNo-शैडो अपारदर्शिता (0-100)
outputFormatstringNo-आउटपुट प्रारूप: png, webp, या avif
edgeRefineintegerNo-एज परिशोधन स्तर (0-3)
decontaminatebooleanNo-किनारों से रंग रिसाव हटाएँ

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

AI मॉडल को पुनः चलाए बिना बैकग्राउंड प्रभावों को फिर से लागू करता है। Phase 1 से कैश किए गए मास्क और मूल का उपयोग करता है।

Parameters

ParameterTypeRequiredDefaultDescription
settingsJSONYes-प्रभाव सेटिंग्स के साथ JSON (नीचे देखें)
backgroundImagefileNo-कस्टम बैकग्राउंड इमेज (जब backgroundType image हो)

Settings JSON fields

FieldTypeRequiredDescription
jobIdstringYesPhase 1 से जॉब ID
filenamestringYesPhase 1 से मूल फ़ाइल नाम
backgroundTypestringNotransparent, color, gradient, blur, image
backgroundColorstringNoठोस बैकग्राउंड के लिए Hex रंग
gradientColor1stringNoपहला ग्रेडिएंट रंग
gradientColor2stringNoदूसरा ग्रेडिएंट रंग
gradientAnglenumberNoडिग्री में ग्रेडिएंट कोण
blurEnabledbooleanNoबैकग्राउंड ब्लर सक्षम करें
blurIntensitynumberNoब्लर तीव्रता (0-100)
shadowEnabledbooleanNoड्रॉप शैडो सक्षम करें
shadowOpacitynumberNoशैडो अपारदर्शिता (0-100)
outputFormatstringNopng, webp, या 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

  • background-removal मॉडल बंडल का इंस्टॉल होना आवश्यक है (4-5 GB)।
  • Phase 1 पारदर्शी मास्क और मूल इमेज को कैश करता है ताकि Phase 2 (प्रभाव) AI मॉडल को पुनः चलाए बिना तुरंत अलग-अलग बैकग्राउंड को फिर से लागू कर सके।
  • स्वचालित डिकोडिंग के माध्यम से HEIC/HEIF, RAW, TGA, PSD, EXR और HDR इनपुट प्रारूपों का समर्थन करता है।
  • प्रोसेसिंग से पहले EXIF रोटेशन स्वतः सुधारा जाता है।