bgCut.net API

با یک درخواست HTTPS، پس‌زمینه تصاویر را از درون اپلیکیشن‌ها، فروشگاه‌ها یا پایپ‌لاین‌های خود حذف کنید.

نشانی پایه: https://bgcut.net/api/v1 · دریافت کلید در بخش کلیدهای API.

احراز هویت

هر درخواست باید کلید API شما را در هدر X-Api-Key داشته باشد. کلیدها در حساب کاربری شما ایجاد و باطل می‌شوند. می‌توانید برای هر کلید نامی تعیین کنید تا کلیدها را برای هر برنامه جداگانه تعویض کنید.

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 مگابایت / 30 مگاپیکسل.
image_urlstringنشانی عمومی تصویر برای دریافت، به‌جای آپلود.
image_file_b64stringتصویر با کدگذاری Base64 (به‌طور اختیاری با پیشوند data:).
sizeauto | preview | fullpreview = تا 640 پیکسل (از سهمیه رایگان ماهانه شما استفاده می‌کند و اعتباری کسر نمی‌شود)؛ 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رنگ پس‌زمینه به‌صورت هگز، مثلاً #ffffff. برای پس‌زمینه شفاف آن را وارد نکنید.
bg_blurnumberپس‌زمینه اصلی را حفظ می‌کند اما آن را با این شعاع بر حسب پیکسل (1 تا 200) محو می‌کند؛ مثلاً 25 برای جلوه‌ای شبیه حالت پرتره. بر bg_color اولویت دارد.
cropbooleanبرش خروجی به کادر محیطی سوژه.
crop_marginintegerحاشیه اضافی بر حسب پیکسل در اطراف سوژه هنگام برش (0 تا 200).
roistringناحیه موردنظر به‌صورت کسرهای x,y,w,h (0 تا 1). هوش مصنوعی فقط داخل این مستطیل را بررسی می‌کند و هر چیزی بیرون از آن شفاف می‌شود.
feathernumberنرم کردن لبه‌ها با این شعاع بر حسب پیکسل (0 تا 5).
qualityintegerکیفیت JPG/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

100 تصویر آخری را که با کلیدهای API شما پردازش شده‌اند برمی‌گرداند، همراه با نشانی ویرایشگر برای اصلاح آن‌ها در مرورگر.

خطاها

خطاها به‌صورت 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_keyکلید API وارد نشده، نامعتبر یا باطل‌شده است.
402insufficient_credits / free_quota_exceededاعتبار ندارید (برای اندازه کامل) یا سهمیه رایگان تمام شده است (برای پیش‌نمایش).
422too_large / bad_type / fetch_failedخواندن یا دانلود تصویر ممکن نبود.
429rate_limitedتعداد درخواست‌ها بیش از حد است – سرعت را کم کنید یا برای محدودیت‌های بالاتر با ما تماس بگیرید.
500processing_failedپردازش در سمت ما ناموفق بود – هزینه‌ای از شما کسر نمی‌شود.

نمونه کد

همه نمونه‌ها از یک نقطه پایانی استفاده می‌کنند. مجموعه کامل نمونه‌ها را دانلود کنید: bgcut-api-examples.zip

SDK رسمی PHP
کتابخانه کلاینت متن‌باز با نتایج نوع‌دار، کلاس‌های خطا و نمونه‌های آماده اجرا. دارای مجوز MIT.
composer require bgcut-net/bgcut-php
GitHub

محدودیت‌ها

  • 60 درخواست در دقیقه برای هر کلید API (محدودیت‌های بالاتر در صورت درخواست).
  • حداکثر 25 مگابایت و 30 مگاپیکسل برای هر تصویر؛ تصاویر بزرگ‌تر کوچک‌سازی می‌شوند.
  • تصاویر پردازش‌شده به مدت 30 روز نگهداری می‌شوند و می‌توان آن‌ها را در ویرایشگر وب اصلاح کرد.
  • برای درخواست‌های ناموفق هرگز هزینه‌ای کسر نمی‌شود؛ اگر تولید خروجی ناموفق باشد، هزینه به‌طور خودکار بازگردانده می‌شود.

یکپارچه‌سازی را شروع کنید

یک حساب رایگان بسازید، کلید ایجاد کنید و در کمتر از یک دقیقه اولین درخواست خود را ارسال کنید.

دریافت کلید API قیمت‌ها