bgCut.net API

Fjarlægðu bakgrunn úr eigin forritum, verslunum eða vinnsluferlum með einni HTTPS-beiðni.

Grunnslóð: https://bgcut.net/api/v1 · Sæktu lykilinn þinn undir API-lyklar.

Auðkenning

Hver beiðni verður að innihalda API-lykilinn þinn í hausnum X-Api-Key. Lyklar eru búnir til og afturkallaðir á aðganginum þínum. Hægt er að gefa hverjum lykli nafn svo þú getir skipt þeim út fyrir hvert forrit.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Einnig er hægt að senda hann sem Bearer-tóka: Authorization: Bearer bgc_…

POST /remove

Sendu myndina sem multipart-skrá, sem slóð eða base64-kóðaða. Sjálfgefið er svarið myndin sem verður til (tvíundargögn).

Færibreytur

FæribreytaTegundLýsing
image_filefileMyndskráin (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; hámark 25 MB / 30 MP.
image_urlstringOpinber slóð myndar sem á að sækja í stað þess að hlaða henni upp.
image_file_b64stringBase64-kóðuð mynd (má hafa data:-forskeyti).
sizeauto | preview | fullpreview = allt að 640 px (notar ókeypis mánaðarkvótann þinn, engar inneignir); full = upprunaleg upplausn (1 inneign); auto (sjálfgefið) = full ef þú átt inneignir, annars preview.
formatpng | jpg | webpÚttakssnið. png heldur gegnsæi; jpg er flatt út á bg_color (sjálfgefið hvítt).
modelfast | hq | portraitlite (sjálfgefið, ~6 s, besta jafnvægið), fast (~0,5 s, forskoðunargæði), hq (~15 s, hámarksgæði), portrait (~0,3 s, aðeins fólk).
bg_colorstringHex-litur bakgrunns, t.d. #ffffff. Slepptu fyrir gegnsæjan bakgrunn.
bg_blurnumberHeldur upprunalega bakgrunninum en móðar hann með þessum radíus í pixlum (1–200), t.d. 25 fyrir portrettáhrif. Gengur framar bg_color.
cropbooleanSker úttakið að afmörkunarramma myndefnisins.
crop_marginintegerViðbótarspássía í pixlum umhverfis myndefnið við skurð (0–200).
roistringÁhugasvæði sem hlutföll x,y,w,h (0–1). Gervigreindin skoðar aðeins innan þessa rétthyrnings; allt utan hans verður gegnsætt.
feathernumberMýkir brúnir með þessum radíus í pixlum (0–5).
qualityintegerJPG/WebP-gæði 50–100 (sjálfgefið 92).
responsebinary | jsonbinary (sjálfgefið) skilar myndinni; json skilar lýsigögnum ásamt base64-mynd.

Svör

Vel heppnaðar beiðnir skila HTTP 200 með bætum myndarinnar og þessum hausum:

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

Með response=json færðu:

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

Skilar síðustu 100 myndum sem unnar voru með API-lyklunum þínum, ásamt slóð í ritilinn til að fínstilla þær í vafranum.

Villur

Villur eru á JSON-sniði með villukóða og skiljanlegum skilaboðum:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorLýsing
400bad_request / missing_imageFæribreytur vantar eða eru ógildar.
401auth_required / invalid_keyAPI-lykil vantar, eða hann er ógildur eða afturkallaður.
402insufficient_credits / free_quota_exceededEngar inneignir (fyrir fulla stærð) eða ókeypis kvóti uppurinn (fyrir preview).
422too_large / bad_type / fetch_failedEkki tókst að lesa eða sækja myndina.
429rate_limitedOf margar beiðnir – hægðu á eða hafðu samband við okkur til að fá hærri mörk.
500processing_failedVinnsla mistókst okkar megin – þú ert ekki rukkaður.

Sýnikóði

Öll dæmin nota sama endapunkt. Sæktu allt dæmasafnið: bgcut-api-examples.zip

Opinbert PHP SDK
Biðlarasafn með opnum frumkóða, tegunduðum niðurstöðum, villuklösum og tilbúnum dæmum. MIT-leyfi.
composer require bgcut-net/bgcut-php
GitHub

Takmarkanir

  • 60 beiðnir á mínútu fyrir hvern API-lykil (hærri mörk ef óskað er).
  • Hámark 25 MB og 30 megapixlar á mynd; stærri myndir eru minnkaðar.
  • Unnar myndir eru geymdar í 30 daga og hægt er að fínstilla þær í vefritlinum.
  • Aldrei er rukkað fyrir misheppnaðar beiðnir; gjald er endurgreitt sjálfkrafa ef gerð úttaks mistekst.

Hefja samþættingu

Stofnaðu ókeypis aðgang, búðu til lykil og sendu fyrstu beiðnina á innan við mínútu.

Fá API-lykil Verð