bgCut.net API

Αφαιρέστε φόντα από τις δικές σας εφαρμογές, τα ηλεκτρονικά σας καταστήματα ή τις ροές εργασιών σας με ένα μόνο αίτημα HTTPS.

Βασικό URL: 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 | portraitlite (προεπιλογή, ~6 δευτ., η καλύτερη ισορροπία), fast (~0,5 δευτ., ποιότητα προεπισκόπησης), hq (~15 δευτ., μέγιστη ποιότητα), portrait (~0,3 δευτ., μόνο για πρόσωπα).
bg_colorstringΧρώμα φόντου σε δεκαεξαδική μορφή, π.χ. #ffffff. Παραλείψτε το για διαφανές φόντο.
bg_blurnumberΔιατηρεί το αρχικό φόντο, αλλά το θολώνει με αυτή την ακτίνα σε pixel (1–200), π.χ. 25 για εφέ πορτρέτου. Υπερισχύει του bg_color.
cropbooleanΠερικοπή της εικόνας εξόδου στο πλαίσιο οριοθέτησης του θέματος.
crop_marginintegerΕπιπλέον περιθώριο σε pixel γύρω από το θέμα κατά την περικοπή (0–200).
roistringΠεριοχή ενδιαφέροντος ως κλάσματα x,y,w,h (0–1). Η AI εξετάζει μόνο το εσωτερικό αυτού του ορθογωνίου· οτιδήποτε εκτός του γίνεται διαφανές.
feathernumberΕξομάλυνση των άκρων με αυτή την ακτίνα σε pixel (0–5).
qualityintegerΠοιότητα JPG/WebP 50–100 (προεπιλογή 92).
responsebinary | jsonΤο binary (προεπιλογή) επιστρέφει την εικόνα· το json επιστρέφει μεταδεδομένα μαζί με την εικόνα σε base64.

Αποκρίσεις

Τα επιτυχή αιτήματα επιστρέφουν HTTP 200 με τα byte της εικόνας και τις εξής κεφαλίδες:

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Η επεξεργασία απέτυχε από τη δική μας πλευρά – δεν χρεώνεστε.

Δείγματα κώδικα

Όλα τα δείγματα χρησιμοποιούν το ίδιο endpoint. Κατεβάστε την πλήρη συλλογή παραδειγμάτων: bgcut-api-examples.zip

Επίσημο PHP SDK
Βιβλιοθήκη-πελάτης ανοιχτού κώδικα με τυποποιημένα αποτελέσματα, κλάσεις σφαλμάτων και έτοιμα προς εκτέλεση παραδείγματα. Άδεια MIT.
composer require bgcut-net/bgcut-php
GitHub

Όρια

  • 60 αιτήματα ανά λεπτό ανά κλειδί API (υψηλότερα όρια κατόπιν αιτήματος).
  • Έως 25 MB και 30 megapixel ανά εικόνα· οι μεγαλύτερες εικόνες σμικρύνονται.
  • Οι επεξεργασμένες εικόνες διατηρούνται για 30 ημέρες και μπορείτε να τις βελτιώσετε στον online επεξεργαστή.
  • Τα αποτυχημένα αιτήματα δεν χρεώνονται ποτέ· αν αποτύχει η δημιουργία της εικόνας εξόδου, η χρέωση επιστρέφεται αυτόματα.

Ξεκινήστε την ενσωμάτωση

Δημιουργήστε δωρεάν λογαριασμό, δημιουργήστε ένα κλειδί και κάντε την πρώτη σας κλήση σε λιγότερο από ένα λεπτό.

Αποκτήστε κλειδί API Τιμές