bgCut.net API

Fjern bakgrunner fra egne apper, nettbutikker eller pipelines med én enkelt HTTPS-forespørsel.

Basis-URL: https://bgcut.net/api/v1 · Hent nøkkelen din under API-nøkler.

Autentisering

Hver forespørsel må inneholde API-nøkkelen din i headeren X-Api-Key. Nøkler opprettes og tilbakekalles i kontoen din. Hver nøkkel kan navngis, slik at du kan rotere dem per applikasjon.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Alternativt kan du sende den som et Bearer-token: Authorization: Bearer bgc_…

POST /remove

Send bildet som en multipart-fil, som en URL eller base64-kodet. Svaret er som standard det ferdige bildet (binært).

Parametere

ParameterTypeBeskrivelse
image_filefileBildefilen (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; maks. 25 MB / 30 MP.
image_urlstringOffentlig URL til bildet som skal hentes i stedet for å lastes opp.
image_file_b64stringBase64-kodet bilde (eventuelt med data:-prefiks).
sizeauto | preview | fullpreview = opptil 640 px (bruker den gratis månedskvoten din, ingen kreditter); full = original oppløsning (1 kreditt); auto (standard) = full når du har kreditter, ellers preview.
formatpng | jpg | webpUtdataformat. png beholder gjennomsiktigheten; jpg flates ut på bg_color (standard hvit).
modelfast | hq | portraitlite (standard, ~6 s, best balanse), fast (~0,5 s, forhåndsvisningskvalitet), hq (~15 s, maksimal kvalitet), portrait (~0,3 s, kun personer).
bg_colorstringHex-farge for bakgrunnen, f.eks. #ffffff. Utelat for gjennomsiktig bakgrunn.
bg_blurnumberBehold den opprinnelige bakgrunnen, men gjør den uskarp med denne radiusen i piksler (1–200), f.eks. 25 for en portrettmodus-effekt. Overstyrer bg_color.
cropbooleanBeskjær resultatet til motivets avgrensningsboks.
crop_marginintegerEkstra marg i piksler rundt motivet ved beskjæring (0–200).
roistringInteresseområde som brøkdeler x,y,w,h (0–1). AI-en ser bare innenfor dette rektangelet; alt utenfor blir gjennomsiktig.
feathernumberMyk opp kantene med denne radiusen i piksler (0–5).
qualityintegerJPG/WebP-kvalitet 50–100 (standard 92).
responsebinary | jsonbinary (standard) returnerer bildet; json returnerer metadata pluss bildet i base64.

Svar

Vellykkede forespørsler returnerer HTTP 200 med bildedataene og disse headerne:

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

Med response=json får du:

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

Returnerer de siste 100 bildene som er behandlet med API-nøklene dine, inkludert en editor-URL for å finjustere dem i nettleseren.

Feil

Feil returneres som JSON med en feilkode og en lesbar melding:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorBeskrivelse
400bad_request / missing_imageManglende eller ugyldige parametere.
401auth_required / invalid_keyManglende, ugyldig eller tilbakekalt API-nøkkel.
402insufficient_credits / free_quota_exceededIngen kreditter (for full størrelse) eller gratiskvoten er brukt opp (for forhåndsvisning).
422too_large / bad_type / fetch_failedBildet kunne ikke leses eller lastes ned.
429rate_limitedFor mange forespørsler – sett ned tempoet eller kontakt oss for høyere grenser.
500processing_failedBehandlingen mislyktes hos oss – du blir ikke belastet.

Eksempelkode

Alle eksemplene bruker samme endepunkt. Last ned hele eksempelsamlingen: bgcut-api-examples.zip

Offisiell PHP SDK
Klientbibliotek med åpen kildekode, typede resultater, feilklasser og eksempler som er klare til bruk. MIT-lisens.
composer require bgcut-net/bgcut-php
GitHub

Begrensninger

  • 60 forespørsler per minutt per API-nøkkel (høyere grenser på forespørsel).
  • Maks. 25 MB og 30 megapiksler per bilde; større bilder skaleres ned.
  • Behandlede bilder lagres i 30 dager og kan finjusteres i nettredigeringsprogrammet.
  • Mislykkede forespørsler belastes aldri; en belastning refunderes automatisk hvis genereringen av resultatet mislykkes.

Kom i gang med integrasjonen

Opprett en gratis konto, generer en nøkkel og gjør ditt første kall på under ett minutt.

Få en API-nøkkel Priser