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_file | file | فایل تصویر (multipart/form-data). JPG، PNG، WebP، GIF، BMP، TIFF؛ حداکثر 25 مگابایت / 30 مگاپیکسل. |
image_url | string | نشانی عمومی تصویر برای دریافت، بهجای آپلود. |
image_file_b64 | string | تصویر با کدگذاری Base64 (بهطور اختیاری با پیشوند data:). |
size | auto | preview | full | preview = تا 640 پیکسل (از سهمیه رایگان ماهانه شما استفاده میکند و اعتباری کسر نمیشود)؛ full = وضوح اصلی (1 اعتبار)؛ auto (پیشفرض) = اگر اعتبار داشته باشید full، در غیر این صورت preview. |
format | png | jpg | webp | قالب خروجی. png شفافیت را حفظ میکند؛ jpg روی bg_color (پیشفرض سفید) مسطح میشود. |
model | fast | hq | portrait | lite (پیشفرض، حدود 6 ثانیه، بهترین تعادل)، fast (حدود 0.5 ثانیه، کیفیت پیشنمایش)، 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). هوش مصنوعی فقط داخل این مستطیل را بررسی میکند و هر چیزی بیرون از آن شفاف میشود. |
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
100 تصویر آخری را که با کلیدهای API شما پردازش شدهاند برمیگرداند، همراه با نشانی ویرایشگر برای اصلاح آنها در مرورگر.
خطاها
خطاها بهصورت 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 | اعتبار ندارید (برای اندازه کامل) یا سهمیه رایگان تمام شده است (برای پیشنمایش). |
| 422 | too_large / bad_type / fetch_failed | خواندن یا دانلود تصویر ممکن نبود. |
| 429 | rate_limited | تعداد درخواستها بیش از حد است – سرعت را کم کنید یا برای محدودیتهای بالاتر با ما تماس بگیرید. |
| 500 | processing_failed | پردازش در سمت ما ناموفق بود – هزینهای از شما کسر نمیشود. |
نمونه کد
همه نمونهها از یک نقطه پایانی استفاده میکنند. مجموعه کامل نمونهها را دانلود کنید: bgcut-api-examples.zip
کتابخانه کلاینت متنباز با نتایج نوعدار، کلاسهای خطا و نمونههای آماده اجرا. دارای مجوز MIT.
composer require bgcut-net/bgcut-phpمحدودیتها
- 60 درخواست در دقیقه برای هر کلید API (محدودیتهای بالاتر در صورت درخواست).
- حداکثر 25 مگابایت و 30 مگاپیکسل برای هر تصویر؛ تصاویر بزرگتر کوچکسازی میشوند.
- تصاویر پردازششده به مدت 30 روز نگهداری میشوند و میتوان آنها را در ویرایشگر وب اصلاح کرد.
- برای درخواستهای ناموفق هرگز هزینهای کسر نمیشود؛ اگر تولید خروجی ناموفق باشد، هزینه بهطور خودکار بازگردانده میشود.
یکپارچهسازی را شروع کنید
یک حساب رایگان بسازید، کلید ایجاد کنید و در کمتر از یک دقیقه اولین درخواست خود را ارسال کنید.
دریافت کلید API قیمتها