bgCut.net API

Odstranjujte ozadja v svojih aplikacijah, trgovinah ali cevovodih z eno samo zahtevo HTTPS.

Osnovni URL: https://bgcut.net/api/v1 · Ključ dobite v razdelku Ključi API.

Preverjanje pristnosti

Vsaka zahteva mora v glavi X-Api-Key vsebovati vaš API ključ. Ključe ustvarite in prekličete v svojem računu. Vsakemu ključu lahko dodelite ime, da jih lahko menjate ločeno za vsako aplikacijo.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Ključ lahko pošljete tudi kot žeton Bearer: Authorization: Bearer bgc_…

POST /remove

Sliko pošljite kot datoteko multipart, kot URL ali kodirano v base64. Odgovor je privzeto obdelana slika (binarno).

Parametri

ParameterVrstaOpis
image_filefileSlikovna datoteka (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; največ 25 MB / 30 MP.
image_urlstringJavni URL slike, ki jo prenesemo namesto nalaganja.
image_file_b64stringSlika, kodirana v base64 (po želji s predpono data:).
sizeauto | preview | fullpreview = do 640 px (porabi brezplačno mesečno kvoto, brez kreditov); full = izvirna ločljivost (1 kredit); auto (privzeto) = full, če imate kredite, sicer preview.
formatpng | jpg | webpIzhodna oblika. png ohrani prosojnost; jpg se združi z ozadjem bg_color (privzeto belo).
modelfast | hq | portraitlite (privzeto, ~6 s, najboljše razmerje), fast (~0,5 s, kakovost predogleda), hq (~15 s, največja kakovost), portrait (~0,3 s, samo osebe).
bg_colorstringBarva ozadja v zapisu hex, npr. #ffffff. Izpustite za prosojno ozadje.
bg_blurnumberOhrani izvirno ozadje, vendar ga zamegli s tem polmerom v slikovnih pikah (1–200), npr. 25 za učinek portretnega načina. Preglasi bg_color.
cropbooleanObreže rezultat na okvir predmeta.
crop_marginintegerDodaten rob v slikovnih pikah okoli predmeta pri obrezovanju (0–200).
roistringObmočje zanimanja kot deleži x,y,w,h (0–1). Umetna inteligenca upošteva samo ta pravokotnik; vse zunaj njega postane prosojno.
feathernumberZmehča robove s tem polmerom v slikovnih pikah (0–5).
qualityintegerKakovost JPG/WebP 50–100 (privzeto 92).
responsebinary | jsonbinary (privzeto) vrne sliko; json vrne metapodatke in sliko v base64.

Odgovori

Uspešne zahteve vrnejo HTTP 200 z bajti slike in temi glavami:

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

Z response=json prejmete:

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

Vrne zadnjih 100 slik, obdelanih z vašimi API ključi, skupaj z URL-jem urejevalnika za dodelavo v brskalniku.

Napake

Napake so v obliki JSON s kodo napake in berljivim sporočilom:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorOpis
400bad_request / missing_imageManjkajoči ali neveljavni parametri.
401auth_required / invalid_keyManjkajoč, neveljaven ali preklican API ključ.
402insufficient_credits / free_quota_exceededNi kreditov (za polno velikost) ali pa je brezplačna kvota porabljena (za predogled).
422too_large / bad_type / fetch_failedSlike ni bilo mogoče prebrati ali prenesti.
429rate_limitedPreveč zahtev – upočasnite ali nas kontaktirajte za višje omejitve.
500processing_failedObdelava na naši strani ni uspela – ničesar vam ne zaračunamo.

Primeri kode

Vsi primeri uporabljajo isto končno točko. Prenesite celotno zbirko primerov: bgcut-api-examples.zip

Uradni PHP SDK
Odprtokodna odjemalska knjižnica s tipiziranimi rezultati, razredi napak in primeri, pripravljenimi za zagon. Licenca MIT.
composer require bgcut-net/bgcut-php
GitHub

Omejitve

  • 60 zahtev na minuto na API ključ (višje omejitve na zahtevo).
  • Največ 25 MB in 30 megapikslov na sliko; večje slike se pomanjšajo.
  • Obdelane slike hranimo 30 dni in jih lahko dodelate v spletnem urejevalniku.
  • Neuspešne zahteve se nikoli ne zaračunajo; če ustvarjanje rezultata ne uspe, se znesek samodejno povrne.

Začnite z integracijo

Ustvarite brezplačen račun, ustvarite ključ in izvedite prvi klic v manj kot minuti.

Pridobite API ključ Cenik