bgCut.net API

एक ही HTTPS अनुरोध से अपने ऐप, शॉप या पाइपलाइन में बैकग्राउंड हटाएँ।

बेस URL: https://bgcut.net/api/v1 · अपनी कुंजी यहाँ प्राप्त करें: API कुंजियाँ.

प्रमाणीकरण

हर अनुरोध में X-Api-Key हेडर में आपकी API कुंजी होनी चाहिए। कुंजियाँ आपके खाते में बनाई और रद्द की जाती हैं; हर कुंजी को नाम दिया जा सकता है ताकि आप उन्हें प्रत्येक एप्लिकेशन के लिए अलग से बदल सकें।

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

वैकल्पिक रूप से इसे Bearer टोकन के रूप में भेजें: Authorization: Bearer bgc_…

POST /remove

इमेज को multipart फ़ाइल, URL या base64-एन्कोडेड रूप में भेजें। डिफ़ॉल्ट रूप से रिस्पॉन्स परिणामी इमेज (बाइनरी) होता है।

पैरामीटर

पैरामीटरप्रकारविवरण
image_filefileइमेज फ़ाइल (multipart/form-data)। JPG, PNG, WebP, GIF, BMP, TIFF; अधिकतम 25 MB / 30 MP।
image_urlstringअपलोड करने के बजाय प्राप्त की जाने वाली इमेज का सार्वजनिक URL।
image_file_b64stringBase64-एन्कोडेड इमेज (वैकल्पिक रूप से data: प्रीफ़िक्स के साथ)।
sizeauto | preview | fullpreview = अधिकतम 640 px (आपके मुफ़्त मासिक कोटे से, कोई क्रेडिट नहीं); full = मूल रिज़ॉल्यूशन (1 क्रेडिट); auto (डिफ़ॉल्ट) = क्रेडिट होने पर full, अन्यथा preview।
formatpng | jpg | webpआउटपुट फ़ॉर्मेट। png पारदर्शिता बनाए रखता है; jpg को bg_color (डिफ़ॉल्ट सफ़ेद) पर फ़्लैट किया जाता है।
modelfast | hq | portraitfast (डिफ़ॉल्ट, ~1 s), hq (उच्च गुणवत्ता, धीमा), portrait (लोगों के लिए अनुकूलित)।
bg_colorstringबैकग्राउंड के लिए हेक्स रंग, जैसे #ffffff। पारदर्शी के लिए इसे छोड़ दें।
bg_blurnumberमूल बैकग्राउंड रखें, लेकिन उसे पिक्सेल में दी गई इस त्रिज्या (1–200) से धुंधला करें, जैसे पोर्ट्रेट-मोड लुक के लिए 25। यह bg_color को ओवरराइड करता है।
cropbooleanआउटपुट को विषय के बाउंडिंग बॉक्स तक क्रॉप करें।
crop_marginintegerक्रॉप करते समय विषय के चारों ओर पिक्सेल में अतिरिक्त मार्जिन (0–200)।
roistringx,y,w,h भिन्नों (0–1) के रूप में रुचि का क्षेत्र। AI केवल इस आयत के अंदर देखता है; इसके बाहर का सब कुछ पारदर्शी हो जाता है।
feathernumberकिनारों को इतने पिक्सेल की त्रिज्या से नरम करें (0–5)।
qualityintegerJPG/WebP गुणवत्ता 50–100 (डिफ़ॉल्ट 92)।
responsebinary | jsonbinary (डिफ़ॉल्ट) इमेज लौटाता है; json मेटाडेटा के साथ base64 इमेज लौटाता है।

रिस्पॉन्स

सफल अनुरोध इमेज बाइट्स और इन हेडर के साथ HTTP 200 लौटाते हैं:

HTTP/1.1 200 OK
Content-Type: image/png
X-Credits-Charged: 1
X-Credits-Remaining: 149
X-Free-Remaining: 5
X-Width: 3000
X-Height: 2000
X-Image-Id: 1f3a…
X-Type: hd

response=json के साथ आपको यह मिलता है:

{
  "ok": true,
  "image": { "id": "1f3a…", "width": 3000, "height": 2000, "format": "png", "type": "hd", "bytes": 812345, "bbox": [120, 40, 2810, 1990], "data": "iVBORw0KGgo…" },
  "credits_charged": 1,
  "credits_remaining": 149,
  "free_remaining": 5
}

GET /account

curl https://bgcut.net/api/v1/account -H "X-Api-Key: bgc_…"

{ "ok": true, "email": "[email protected]", "credits": 149, "free_remaining": 5, "free_per_month": 5, "free_max_width": 640, "rate_limit_per_minute": 60 }

GET /images

आपकी API कुंजियों से प्रोसेस की गई अंतिम 100 इमेज लौटाता है, साथ ही ब्राउज़र में उन्हें बेहतर बनाने के लिए एडिटर URL भी।

त्रुटियाँ

त्रुटियाँ JSON के रूप में मिलती हैं, जिनमें एक त्रुटि कोड और आसानी से समझ आने वाला संदेश होता है:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorविवरण
400bad_request / missing_imageपैरामीटर मौजूद नहीं हैं या अमान्य हैं।
401auth_required / invalid_keyAPI कुंजी मौजूद नहीं है, अमान्य है या रद्द कर दी गई है।
402insufficient_credits / free_quota_exceededक्रेडिट नहीं हैं (फ़ुल साइज़ के लिए) या मुफ़्त कोटा समाप्त हो गया है (प्रीव्यू के लिए)।
422too_large / bad_type / fetch_failedइमेज पढ़ी या डाउनलोड नहीं की जा सकी।
429rate_limitedबहुत अधिक अनुरोध – गति कम करें या अधिक सीमा के लिए हमसे संपर्क करें।
500processing_failedहमारी ओर से प्रोसेसिंग विफल रही – आपसे कोई शुल्क नहीं लिया जाएगा।

सैंपल कोड

सभी उदाहरण एक ही एंडपॉइंट का उपयोग करते हैं। उदाहरणों का पूरा संग्रह डाउनलोड करें: bgcut-api-examples.zip

सीमाएँ

  • प्रति API कुंजी प्रति मिनट 60 अनुरोध (अनुरोध करने पर अधिक सीमा उपलब्ध)।
  • प्रति इमेज अधिकतम 25 MB और 30 मेगापिक्सेल; बड़ी इमेज का आकार घटा दिया जाता है।
  • प्रोसेस की गई इमेज 30 दिनों तक रखी जाती हैं और वेब एडिटर में बेहतर बनाई जा सकती हैं।
  • विफल अनुरोधों के लिए कभी शुल्क नहीं लिया जाता; यदि आउटपुट बनाना विफल हो जाए, तो शुल्क अपने-आप वापस कर दिया जाता है।

इंटीग्रेशन शुरू करें

मुफ़्त खाता बनाएँ, कुंजी जनरेट करें और एक मिनट से भी कम समय में अपना पहला कॉल करें।

API कुंजी पाएँ कीमतें