bgCut.net API

Eemaldage taustu oma rakendustest, e-poodidest või töövoogudest ühe HTTPS-päringuga.

Baas-URL: https://bgcut.net/api/v1 · Võtme saate jaotisest API võtmed.

Autentimine

Iga päring peab sisaldama teie API-võtit päises X-Api-Key. Võtmeid saab luua ja tühistada oma kontol. Igale võtmele saab anda nime, et neid rakenduste kaupa vahetada.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Teise võimalusena saatke see Bearer-tokenina: Authorization: Bearer bgc_…

POST /remove

Saatke pilt multipart-failina, URL-ina või base64-kodeeringus. Vaikimisi on vastuseks töödeldud pilt (binaarkujul).

Parameetrid

ParameeterTüüpKirjeldus
image_filefilePildifail (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; kuni 25 MB / 30 MP.
image_urlstringPildi avalik URL, kust pilt üleslaadimise asemel alla laaditakse.
image_file_b64stringBase64-kodeeringus pilt (soovi korral data: eesliitega).
sizeauto | preview | fullpreview = kuni 640 px (kasutab tasuta igakuist limiiti, krediiti ei kulu); full = algne eraldusvõime (1 krediit); auto (vaikimisi) = full, kui teil on krediiti, muidu preview.
formatpng | jpg | webpVäljundvorming. png säilitab läbipaistvuse; jpg puhul paigutatakse pilt bg_color taustale (vaikimisi valge).
modelfast | hq | portraitlite (vaikimisi, ~6 s, parim tasakaal), fast (~0,5 s, eelvaate kvaliteet), hq (~15 s, maksimaalne kvaliteet), portrait (~0,3 s, ainult inimesed).
bg_colorstringTaustavärv kuueteistkümnendkoodina, nt #ffffff. Läbipaistva tausta jaoks jätke parameeter välja.
bg_blurnumberSäilitab algse tausta, kuid hägustab seda antud raadiusega pikslites (1–200), nt 25 portreerežiimi efekti jaoks. Alistab parameetri bg_color.
cropbooleanKärbib väljundi objekti piirdekasti järgi.
crop_marginintegerLisaveeris pikslites objekti ümber kärpimisel (0–200).
roistringHuvipiirkond murdarvudena x,y,w,h (0–1). AI analüüsib ainult selle ristküliku sisu; kõik väljaspool seda muutub läbipaistvaks.
feathernumberPehmendab servi antud raadiusega pikslites (0–5).
qualityintegerJPG/WebP kvaliteet 50–100 (vaikimisi 92).
responsebinary | jsonbinary (vaikimisi) tagastab pildi; json tagastab metaandmed koos base64-pildiga.

Vastused

Õnnestunud päringud tagastavad koodi HTTP 200 koos pildi baitide ja järgmiste päistega:

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

Väärtusega response=json saate:

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

Tagastab viimased 100 teie API-võtmetega töödeldud pilti koos redaktori URL-iga, et saaksite neid brauseris täiustada.

Vead

Vead tagastatakse JSON-vormingus koos veakoodi ja loetava teatega:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorKirjeldus
400bad_request / missing_imagePuuduvad või vigased parameetrid.
401auth_required / invalid_keyPuuduv, vigane või tühistatud API-võti.
402insufficient_credits / free_quota_exceededKrediiti pole (täissuuruse puhul) või tasuta limiit on ammendatud (eelvaate puhul).
422too_large / bad_type / fetch_failedPilti ei õnnestunud lugeda ega alla laadida.
429rate_limitedLiiga palju päringuid – vähendage päringute sagedust või võtke kõrgemate limiitide saamiseks meiega ühendust.
500processing_failedTöötlemine ebaõnnestus meie poolel – tasu ei võeta.

Näidiskood

Kõik näited kasutavad sama lõpp-punkti. Laadige alla kõik näited: bgcut-api-examples.zip

Ametlik PHP SDK
Avatud lähtekoodiga klienditeek tüübitud tulemuste, veaklasside ja kasutusvalmis näidetega. MIT-litsents.
composer require bgcut-net/bgcut-php
GitHub

Piirangud

  • 60 päringut minutis API-võtme kohta (soovi korral kõrgemad limiidid).
  • Kuni 25 MB ja 30 megapikslit pildi kohta; suuremaid pilte vähendatakse.
  • Töödeldud pilte säilitatakse 30 päeva ja neid saab veebiredaktoris täiustada.
  • Ebaõnnestunud päringute eest tasu ei võeta. Kui väljundi loomine ebaõnnestub, tagastatakse tasu automaatselt.

Alustage integreerimist

Looge tasuta konto, genereerige võti ja tehke oma esimene päring vähem kui minutiga.

Hankige API-võti Hinnad