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 | portraitlite (طے شدہ، ~6 سیکنڈ، بہترین توازن)، fast (~0.5 سیکنڈ، پیش نظارہ معیار)، hq (~15 سیکنڈ، اعلیٰ ترین معیار)، portrait (~0.3 سیکنڈ، صرف افراد کے لیے)۔
bg_colorstringپس منظر کے لیے Hex رنگ، مثلاً #ffffff۔ شفاف پس منظر کے لیے خالی چھوڑ دیں۔
bg_blurnumberاصل پس منظر برقرار رکھیں لیکن اسے پکسلز میں دیے گئے اس رداس (1–200) سے دھندلا کر دیں، مثلاً پورٹریٹ موڈ جیسے انداز کے لیے 25۔ یہ bg_color پر فوقیت رکھتا ہے۔
cropbooleanآؤٹ پٹ کو مرکزی شے کے احاطی خانے تک کراپ کریں۔
crop_marginintegerکراپ کرتے وقت مرکزی شے کے گرد پکسلز میں اضافی حاشیہ (0–200)۔
roistringمطلوبہ حصہ بطور کسور x,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کریڈٹ موجود نہیں (full سائز کے لیے) یا مفت کوٹہ ختم ہو چکا ہے (preview کے لیے)۔
422too_large / bad_type / fetch_failedتصویر پڑھی یا ڈاؤن لوڈ نہیں کی جا سکی۔
429rate_limitedبہت زیادہ درخواستیں – رفتار کم کریں یا زیادہ حدود کے لیے ہم سے رابطہ کریں۔
500processing_failedہماری طرف سے پروسیسنگ ناکام ہو گئی – آپ سے کوئی چارج نہیں لیا جائے گا۔

نمونہ کوڈ

تمام نمونے ایک ہی اینڈ پوائنٹ استعمال کرتے ہیں۔ مثالوں کا مکمل مجموعہ ڈاؤن لوڈ کریں: bgcut-api-examples.zip

باضابطہ PHP SDK
typed نتائج، ایرر کلاسز اور فوری قابلِ استعمال مثالوں کے ساتھ اوپن سورس کلائنٹ لائبریری۔ MIT لائسنس یافتہ۔
composer require bgcut-net/bgcut-php
GitHub

حدود

  • فی API کلید فی منٹ 60 درخواستیں (درخواست پر زیادہ حدود دستیاب ہیں)۔
  • فی تصویر زیادہ سے زیادہ 25 MB اور 30 میگا پکسل؛ بڑی تصاویر کا سائز کم کر دیا جاتا ہے۔
  • پروسیس شدہ تصاویر 30 دن تک محفوظ رکھی جاتی ہیں اور ویب ایڈیٹر میں بہتر بنائی جا سکتی ہیں۔
  • ناکام درخواستوں پر کبھی چارج نہیں لیا جاتا؛ اگر آؤٹ پٹ تیار نہ ہو سکے تو کٹوتی خود بخود واپس کر دی جاتی ہے۔

انٹیگریشن شروع کریں

مفت اکاؤنٹ بنائیں، کلید تیار کریں اور ایک منٹ سے بھی کم وقت میں اپنی پہلی کال کریں۔

API کلید حاصل کریں قیمتیں