bgCut.net API

Odstraňujte pozadie vo vlastných aplikáciách, e-shopoch či procesoch jedinou HTTPS požiadavkou.

Základná URL: https://bgcut.net/api/v1 · Kľúč získate v sekcii API kľúče.

Overenie

Každá požiadavka musí obsahovať váš API kľúč v hlavičke X-Api-Key. Kľúče vytvárate a rušíte vo svojom účte. Každý kľúč môžete pomenovať, aby ste ich mohli obmieňať pre jednotlivé aplikácie.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Prípadne ho môžete poslať ako Bearer token: Authorization: Bearer bgc_…

POST /remove

Obrázok pošlite ako multipart súbor, ako URL alebo v kódovaní base64. Odpoveďou je predvolene výsledný obrázok (binárne dáta).

Parametre

ParameterTypPopis
image_filefileSúbor s obrázkom (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; max. 25 MB / 30 MP.
image_urlstringVerejná URL obrázka, ktorý sa stiahne namiesto nahrania.
image_file_b64stringObrázok v kódovaní base64 (voliteľne s prefixom data:).
sizeauto | preview | fullpreview = do 640 px (čerpá z bezplatnej mesačnej kvóty, bez kreditov); full = pôvodné rozlíšenie (1 kredit); auto (predvolené) = full, ak máte kredity, inak preview.
formatpng | jpg | webpVýstupný formát. png zachováva priehľadnosť; jpg sa zlúči s farbou bg_color (predvolene biela).
modelfast | hq | portraitlite (predvolený, ~6 s, najlepší pomer), fast (~0,5 s, kvalita náhľadu), hq (~15 s, maximálna kvalita), portrait (~0,3 s, len ľudia).
bg_colorstringHex kód farby pozadia, napr. #ffffff. Vynechajte pre priehľadné pozadie.
bg_blurnumberZachová pôvodné pozadie, ale rozmaže ho s týmto polomerom v pixeloch (1–200), napr. 25 pre efekt portrétneho režimu. Má prednosť pred bg_color.
cropbooleanOreže výstup na ohraničenie objektu.
crop_marginintegerDodatočný okraj v pixeloch okolo objektu pri orezaní (0–200).
roistringOblasť záujmu ako zlomky x,y,w,h (0–1). AI analyzuje len vnútro tohto obdĺžnika; všetko mimo neho bude priehľadné.
feathernumberZjemní okraje s týmto polomerom v pixeloch (0–5).
qualityintegerKvalita JPG/WebP 50–100 (predvolene 92).
responsebinary | jsonbinary (predvolené) vráti obrázok; json vráti metadáta a obrázok v base64.

Odpovede

Úspešné požiadavky vrátia HTTP 200 s bajtmi obrázka a týmito hlavičkami:

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

S response=json dostanete:

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

Vráti posledných 100 obrázkov spracovaných vašimi API kľúčmi vrátane URL editora na ich doladenie v prehliadači.

Chyby

Chyby sa vracajú ako JSON s kódom chyby a zrozumiteľnou správou:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorPopis
400bad_request / missing_imageChýbajúce alebo neplatné parametre.
401auth_required / invalid_keyChýbajúci, neplatný alebo zrušený API kľúč.
402insufficient_credits / free_quota_exceededŽiadne kredity (pre plnú veľkosť) alebo vyčerpaná bezplatná kvóta (pre náhľad).
422too_large / bad_type / fetch_failedObrázok sa nepodarilo načítať ani stiahnuť.
429rate_limitedPríliš veľa požiadaviek – spomaľte alebo nás kontaktujte kvôli vyšším limitom.
500processing_failedSpracovanie zlyhalo na našej strane – nič vám nebude účtované.

Ukážky kódu

Všetky ukážky používajú rovnaký endpoint. Stiahnite si kompletnú kolekciu príkladov: bgcut-api-examples.zip

Oficiálne PHP SDK
Open-source klientska knižnica s typovanými výsledkami, triedami chýb a príkladmi pripravenými na spustenie. Licencia MIT.
composer require bgcut-net/bgcut-php
GitHub

Limity

  • 60 požiadaviek za minútu na jeden API kľúč (vyššie limity na požiadanie).
  • Max. 25 MB a 30 megapixelov na obrázok; väčšie obrázky sa zmenšia.
  • Spracované obrázky uchovávame 30 dní a môžete ich doladiť vo webovom editore.
  • Neúspešné požiadavky sa nikdy neúčtujú; ak zlyhá generovanie výstupu, poplatok sa automaticky vráti.

Začnite s integráciou

Vytvorte si bezplatný účet, vygenerujte kľúč a urobte prvé volanie za menej ako minútu.

Získať API kľúč Cenník