API bgCut.net

Usuwaj tło z poziomu własnych aplikacji, sklepów lub potoków przetwarzania za pomocą jednego żądania HTTPS.

Bazowy URL: https://bgcut.net/api/v1 · Klucz uzyskasz w sekcji Klucze API.

Uwierzytelnianie

Każde żądanie musi zawierać klucz API w nagłówku X-Api-Key. Klucze tworzy się i unieważnia na koncie; każdemu kluczowi można nadać nazwę, aby rotować je osobno dla każdej aplikacji.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Można go też przesłać jako token Bearer: Authorization: Bearer bgc_…

POST /remove

Prześlij obraz jako plik multipart, adres URL lub w kodowaniu base64. Domyślnie odpowiedzią jest gotowy obraz (binarnie).

Parametry

ParametrTypOpis
image_filefilePlik obrazu (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; maks. 25 MB / 30 MP.
image_urlstringPubliczny adres URL obrazu do pobrania zamiast przesyłania pliku.
image_file_b64stringObraz zakodowany w base64 (opcjonalnie z prefiksem data:).
sizeauto | preview | fullpreview = do 640 px (wykorzystuje darmowy limit miesięczny, bez kredytów); full = oryginalna rozdzielczość (1 kredyt); auto (domyślnie) = full, gdy masz kredyty, w przeciwnym razie preview.
formatpng | jpg | webpFormat wyjściowy. png zachowuje przezroczystość; jpg jest spłaszczany na kolorze bg_color (domyślnie biały).
modelfast | hq | portraitfast (domyślny, ~1 s), hq (wyższa jakość, wolniejszy), portrait (zoptymalizowany pod kątem osób).
bg_colorstringKolor tła w zapisie szesnastkowym, np. #ffffff. Pomiń, aby uzyskać przezroczyste tło.
bg_blurnumberZachowuje oryginalne tło, ale rozmywa je z podanym promieniem w pikselach (1–200), np. 25 dla efektu trybu portretowego. Ma pierwszeństwo przed bg_color.
cropbooleanPrzytnij wynik do obszaru obiektu.
crop_marginintegerDodatkowy margines w pikselach wokół obiektu przy przycinaniu (0–200).
roistringObszar zainteresowania jako ułamki x,y,w,h (0–1). AI analizuje tylko wnętrze tego prostokąta; wszystko poza nim staje się przezroczyste.
feathernumberZmiękczenie krawędzi o podany promień w pikselach (0–5).
qualityintegerJakość JPG/WebP 50–100 (domyślnie 92).
responsebinary | jsonbinary (domyślnie) zwraca obraz; json zwraca metadane oraz obraz w base64.

Odpowiedzi

Pomyślne żądania zwracają HTTP 200 z bajtami obrazu i następującymi nagłówkami:

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

Przy response=json otrzymasz:

{
  "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

Zwraca 100 ostatnich obrazów przetworzonych przy użyciu Twoich kluczy API wraz z adresem URL edytora, w którym można je dopracować w przeglądarce.

Błędy

Błędy są zwracane w formacie JSON z kodem błędu i czytelnym komunikatem:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorOpis
400bad_request / missing_imageBrakujące lub nieprawidłowe parametry.
401auth_required / invalid_keyBrakujący, nieprawidłowy lub unieważniony klucz API.
402insufficient_credits / free_quota_exceededBrak kredytów (dla pełnego rozmiaru) lub wyczerpany darmowy limit (dla podglądu).
422too_large / bad_type / fetch_failedNie udało się odczytać ani pobrać obrazu.
429rate_limitedZbyt wiele żądań – zwolnij tempo lub skontaktuj się z nami w sprawie wyższych limitów.
500processing_failedPrzetwarzanie nie powiodło się po naszej stronie – opłata nie zostanie naliczona.

Przykładowy kod

Wszystkie przykłady korzystają z tego samego punktu końcowego. Pobierz pełny zestaw przykładów: bgcut-api-examples.zip

Limity

  • 60 żądań na minutę na klucz API (wyższe limity na życzenie).
  • Maks. 25 MB i 30 megapikseli na obraz; większe obrazy są zmniejszane.
  • Przetworzone obrazy są przechowywane przez 30 dni i można je dopracować w edytorze online.
  • Nieudane żądania nigdy nie są płatne; jeśli wygenerowanie wyniku się nie powiedzie, opłata jest automatycznie zwracana.

Rozpocznij integrację

Załóż darmowe konto, wygeneruj klucz i wykonaj pierwsze wywołanie w niecałą minutę.

Uzyskaj klucz API Cennik