bgCut.net API

Távolítson el hátteret saját alkalmazásaiból, webáruházaiból vagy folyamataiból egyetlen HTTPS kéréssel.

Alap URL: https://bgcut.net/api/v1 · API-kulcsát itt szerezheti be: API-kulcsok.

Hitelesítés

Minden kérésnek tartalmaznia kell az API-kulcsot az X-Api-Key fejlécben. A kulcsokat a fiókjában hozhatja létre és vonhatja vissza; minden kulcs elnevezhető, így alkalmazásonként cserélheti őket.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Alternatívaként Bearer tokenként is elküldheti: Authorization: Bearer bgc_…

POST /remove

A képet multipart fájlként, URL-ként vagy base64 kódolással küldje el. A válasz alapértelmezés szerint az eredményül kapott kép (bináris formában).

Paraméterek

ParaméterTípusLeírás
image_filefileA képfájl (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; max. 25 MB / 30 MP.
image_urlstringA kép nyilvános URL-je, ahonnan feltöltés helyett letöltjük.
image_file_b64stringBase64 kódolású kép (opcionálisan data: előtaggal).
sizeauto | preview | fullpreview = legfeljebb 640 px (az ingyenes havi keretet használja, kreditet nem); full = eredeti felbontás (1 kredit); auto (alapértelmezett) = full, ha van kreditje, egyébként preview.
formatpng | jpg | webpKimeneti formátum. A png megőrzi az átlátszóságot; a jpg a bg_color színű háttérre kerül (alapértelmezés: fehér).
modelfast | hq | portraitfast (alapértelmezett, kb. 1 s), hq (jobb minőség, lassabb), portrait (emberekre optimalizálva).
bg_colorstringA háttér hexadecimális színkódja, pl. #ffffff. Átlátszó háttérhez hagyja el.
bg_blurnumberMegtartja az eredeti hátteret, de elmossa a megadott, pixelben mért sugárral (1–200), pl. 25-tel portré módú hatáshoz. Felülírja a bg_color értékét.
cropbooleanA kimenet kivágása a fő téma befoglaló téglalapjára.
crop_marginintegerTovábbi margó pixelben a téma körül kivágáskor (0–200).
roistringVizsgált terület x,y,w,h törtértékekként (0–1). Az MI csak ezen a téglalapon belül dolgozik; minden, ami kívül esik, átlátszó lesz.
feathernumberAz élek lágyítása ekkora sugárral, pixelben (0–5).
qualityintegerJPG/WebP minőség 50–100 (alapértelmezés: 92).
responsebinary | jsonbinary (alapértelmezett) a képet adja vissza; json metaadatokat és a base64 kódolású képet.

Válaszok

A sikeres kérések HTTP 200 kódot adnak vissza a kép bájtjaival és az alábbi fejlécekkel:

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

A response=json paraméterrel a következő választ kapja:

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

Visszaadja az API-kulcsaival feldolgozott utolsó 100 képet, a böngészőben való finomításhoz szükséges szerkesztő URL-lel együtt.

Hibák

A hibák JSON formátumban érkeznek, hibakóddal és közérthető üzenettel:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorLeírás
400bad_request / missing_imageHiányzó vagy érvénytelen paraméterek.
401auth_required / invalid_keyHiányzó, érvénytelen vagy visszavont API-kulcs.
402insufficient_credits / free_quota_exceededNincs kredit (teljes mérethez), vagy elfogyott az ingyenes keret (előnézethez).
422too_large / bad_type / fetch_failedA képet nem sikerült beolvasni vagy letölteni.
429rate_limitedTúl sok kérés – lassítson, vagy magasabb korlátokért lépjen kapcsolatba velünk.
500processing_failedA feldolgozás a mi oldalunkon hiúsult meg – nem számítunk fel díjat.

Mintakód

Minden példa ugyanazt a végpontot használja. Töltse le a teljes példagyűjteményt: bgcut-api-examples.zip

Korlátok

  • API-kulcsonként percenként 60 kérés (kérésre magasabb korlát).
  • Képenként legfeljebb 25 MB és 30 megapixel; a nagyobb képeket kicsinyítjük.
  • A feldolgozott képeket 30 napig tároljuk, és a webes szerkesztőben finomíthatók.
  • A sikertelen kérésekért soha nem számítunk fel díjat; ha a kimenet előállítása meghiúsul, a terhelést automatikusan visszatérítjük.

Kezdje el az integrációt

Hozzon létre ingyenes fiókot, generáljon kulcsot, és indítsa el első hívását egy percen belül.

API-kulcs igénylése Árak