bgCut.net API
एकाच HTTPS विनंतीद्वारे तुमच्या स्वतःच्या अॅप्स, शॉप्स किंवा पाइपलाइन्समधून पार्श्वभूमी काढा.
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_file | file | प्रतिमा फाइल (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; कमाल 25 MB / 30 MP. |
image_url | string | अपलोड करण्याऐवजी आणायच्या प्रतिमेचा सार्वजनिक URL. |
image_file_b64 | string | Base64-एन्कोडेड प्रतिमा (data: प्रीफिक्ससह किंवा त्याशिवाय). |
size | auto | preview | full | preview = 640 px पर्यंत (तुमचा मोफत मासिक कोटा वापरला जातो, क्रेडिट्स लागत नाहीत); full = मूळ रिझोल्यूशन (1 क्रेडिट); auto (डीफॉल्ट) = क्रेडिट्स असल्यास full, अन्यथा preview. |
format | png | jpg | webp | आउटपुट फॉरमॅट. png पारदर्शकता कायम ठेवतो; jpg हा bg_color वर (डीफॉल्ट पांढरा) फ्लॅटन केला जातो. |
model | fast | hq | portrait | lite (डीफॉल्ट, ~6 से., सर्वोत्तम समतोल), fast (~0.5 से., preview गुणवत्ता), hq (~15 से., कमाल गुणवत्ता), portrait (~0.3 से., फक्त व्यक्तींसाठी). |
bg_color | string | पार्श्वभूमीसाठी हेक्स रंग, उदा. #ffffff. पारदर्शक पार्श्वभूमीसाठी हा पॅरामीटर वगळा. |
bg_blur | number | मूळ पार्श्वभूमी कायम ठेवा, पण ती पिक्सेलमधील या त्रिज्येने (1–200) धूसर करा, उदा. पोर्ट्रेट-मोडसारख्या लूकसाठी 25. हे bg_color ओव्हरराइड करते. |
crop | boolean | आउटपुट विषयाच्या बाउंडिंग बॉक्सनुसार क्रॉप करा. |
crop_margin | integer | क्रॉप करताना विषयाभोवती पिक्सेलमध्ये अतिरिक्त समास (0–200). |
roi | string | x,y,w,h अपूर्णांकांच्या (0–1) स्वरूपात निवडलेला प्रदेश. AI फक्त या आयताच्या आत पाहते; त्याबाहेरील सर्व भाग पारदर्शक होतो. |
feather | number | कडा पिक्सेलमधील या त्रिज्येने (0–5) मऊ करा. |
quality | integer | JPG/WebP गुणवत्ता 50–100 (डीफॉल्ट 92). |
response | binary | json | binary (डीफॉल्ट) प्रतिमा परत करते; 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." }
| HTTP | error | वर्णन |
|---|---|---|
| 400 | bad_request / missing_image | पॅरामीटर्स गहाळ किंवा अवैध आहेत. |
| 401 | auth_required / invalid_key | API की गहाळ, अवैध किंवा रद्द केलेली आहे. |
| 402 | insufficient_credits / free_quota_exceeded | क्रेडिट्स नाहीत (full आकारासाठी) किंवा मोफत कोटा संपला आहे (preview साठी). |
| 422 | too_large / bad_type / fetch_failed | प्रतिमा वाचता किंवा डाउनलोड करता आली नाही. |
| 429 | rate_limited | खूप जास्त विनंत्या – वेग कमी करा किंवा जास्त मर्यादांसाठी आमच्याशी संपर्क साधा. |
| 500 | processing_failed | आमच्या बाजूने प्रक्रिया अयशस्वी झाली – तुमच्याकडून शुल्क आकारले जाणार नाही. |
नमुना कोड
सर्व नमुने एकच एंडपॉइंट वापरतात. उदाहरणांचा संपूर्ण संग्रह डाउनलोड करा: bgcut-api-examples.zip
टाइप्ड निकाल, त्रुटी क्लासेस आणि तयार उदाहरणांसह ओपन-सोर्स क्लायंट लायब्ररी. MIT परवाना.
composer require bgcut-net/bgcut-phpमर्यादा
- प्रत्येक API कीसाठी प्रति मिनिट 60 विनंत्या (विनंतीवरून जास्त मर्यादा उपलब्ध).
- प्रति प्रतिमा कमाल 25 MB आणि 30 मेगापिक्सेल; मोठ्या प्रतिमांचा आकार कमी केला जातो.
- प्रक्रिया केलेल्या प्रतिमा 30 दिवस ठेवल्या जातात आणि वेब एडिटरमध्ये सुधारता येतात.
- अयशस्वी विनंत्यांसाठी कधीही शुल्क आकारले जात नाही; आउटपुट तयार करणे अयशस्वी झाल्यास आकारलेले शुल्क आपोआप परत केले जाते.
इंटिग्रेशन सुरू करा
मोफत खाते तयार करा, की जनरेट करा आणि एका मिनिटाच्या आत तुमचा पहिला कॉल करा.
API की मिळवा किंमत