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 MB / 30 MP.
image_urlstringכתובת URL ציבורית של התמונה לאחזור במקום העלאה.
image_file_b64stringתמונה בקידוד Base64 (אפשר עם קידומת data:).
sizeauto | preview | fullpreview = עד 640 px (מנצל את המכסה החודשית החינמית, ללא קרדיטים); full = רזולוציה מקורית (קרדיט 1); auto (ברירת מחדל) = full כאשר יש לכם קרדיטים, אחרת preview.
formatpng | jpg | webpפורמט הפלט. png שומר על השקיפות; jpg משוטח על bg_color (ברירת מחדל: לבן).
modelfast | hq | portraitfast (ברירת מחדל, כשנייה אחת), hq (איכות גבוהה יותר, איטי יותר), portrait (מותאם לאנשים).
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).
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 שלך, כולל כתובת 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_keyמפתח API חסר, לא תקין או מבוטל.
402insufficient_credits / free_quota_exceededאין קרדיטים (לגודל מלא) או שהמכסה החינמית נוצלה (לתצוגה מקדימה).
422too_large / bad_type / fetch_failedלא ניתן היה לקרוא או להוריד את התמונה.
429rate_limitedיותר מדי בקשות – יש להאט את הקצב או לפנות אלינו לקבלת מגבלות גבוהות יותר.
500processing_failedהעיבוד נכשל בצד שלנו – לא תחויב.

קוד לדוגמה

כל הדוגמאות משתמשות באותה נקודת קצה. להורדת אוסף הדוגמאות המלא: bgcut-api-examples.zip

מגבלות

  • 60 בקשות לדקה לכל מפתח API (מגבלות גבוהות יותר לפי בקשה).
  • עד 25 MB ו-30 מגה-פיקסל לתמונה; תמונות גדולות יותר מוקטנות.
  • תמונות מעובדות נשמרות למשך 30 ימים וניתן לשפר אותן בעורך המקוון.
  • בקשות שנכשלו לעולם אינן מחויבות; חיוב מוחזר אוטומטית אם יצירת הפלט נכשלת.

התחילו בשילוב

צרו חשבון חינמי, הפיקו מפתח ובצעו את הקריאה הראשונה בפחות מדקה.

קבלת מפתח API מחירים