bgCut.net API

Odstraňujte pozadí ve vlastních aplikacích, e-shopech nebo pipelinách jediným HTTPS požadavkem.

Základní URL: https://bgcut.net/api/v1 · Klíč získáte v sekci API klíče.

Autentizace

Každý požadavek musí obsahovat váš API klíč v hlavičce X-Api-Key. Klíče vytváříte a rušíte ve svém účtu; každý klíč lze pojmenovat, takže je můžete obměňovat pro jednotlivé aplikace.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Případně jej můžete poslat jako Bearer token: Authorization: Bearer bgc_…

POST /remove

Obrázek pošlete jako multipart soubor, jako URL nebo zakódovaný v base64. Odpovědí je ve výchozím nastavení výsledný obrázek (binárně).

Parametry

ParametrTypPopis
image_filefileSoubor obrázku (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; max. 25 MB / 30 MP.
image_urlstringVeřejná URL obrázku, který se stáhne místo nahrání.
image_file_b64stringObrázek zakódovaný v base64 (volitelně s prefixem data:).
sizeauto | preview | fullpreview = až 640 px (čerpá z bezplatné měsíční kvóty, bez kreditů); full = původní rozlišení (1 kredit); auto (výchozí) = full, pokud máte kredity, jinak preview.
formatpng | jpg | webpVýstupní formát. png zachovává průhlednost; jpg se vyplní barvou bg_color (výchozí bílá).
modelfast | hq | portraitfast (výchozí, ~1 s), hq (vyšší kvalita, pomalejší), portrait (optimalizováno pro lidi).
bg_colorstringHex barva pozadí, např. #ffffff. Vynechte pro průhledné pozadí.
bg_blurnumberZachová původní pozadí, ale rozmaže ho s tímto poloměrem v pixelech (1–200), např. 25 pro vzhled portrétního režimu. Přepisuje bg_color.
cropbooleanOříznout výstup podle ohraničení objektu.
crop_marginintegerDodatečný okraj v pixelech kolem objektu při ořezu (0–200).
roistringOblast zájmu jako podíly x,y,w,h (0–1). AI analyzuje jen tento obdélník; vše mimo něj bude průhledné.
feathernumberZměkčení okrajů o daný poloměr v pixelech (0–5).
qualityintegerKvalita JPG/WebP 50–100 (výchozí 92).
responsebinary | jsonbinary (výchozí) vrací obrázek; json vrací metadata a obrázek v base64.

Odpovědi

Úspěšné požadavky vracejí HTTP 200 s daty obrázku 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 parametrem response=json získáte:

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

Vrací posledních 100 obrázků zpracovaných pomocí vašich API klíčů, včetně URL editoru, kde je můžete doladit v prohlížeči.

Chyby

Chyby se vracejí jako JSON s kódem chyby a srozumitelnou zprá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_imageChybějící nebo neplatné parametry.
401auth_required / invalid_keyChybějící, neplatný nebo zrušený API klíč.
402insufficient_credits / free_quota_exceededNemáte žádné kredity (pro plnou velikost) nebo je vyčerpán bezplatný limit (pro náhled).
422too_large / bad_type / fetch_failedObrázek nelze načíst ani stáhnout.
429rate_limitedPříliš mnoho požadavků – zpomalte, nebo nás kontaktujte kvůli vyšším limitům.
500processing_failedZpracování selhalo na naší straně – nic vám neúčtujeme.

Ukázkový kód

Všechny ukázky používají stejný endpoint. Stáhněte si kompletní sadu příkladů: bgcut-api-examples.zip

Limity

  • 60 požadavků za minutu na API klíč (vyšší limity na vyžádání).
  • Max. 25 MB a 30 megapixelů na obrázek; větší obrázky se zmenší.
  • Zpracované obrázky uchováváme 30 dní a můžete je doladit ve webovém editoru.
  • Neúspěšné požadavky se nikdy neúčtují; pokud selže generování výstupu, platba se automaticky vrátí.

Začněte s integrací

Vytvořte si bezplatný účet, vygenerujte klíč a proveďte první volání za méně než minutu.

Získat API klíč Ceník