bgCut.net API

Ta bort bakgrunder från dina egna appar, butiker eller pipelines med en enda HTTPS-förfrågan.

Bas-URL: https://bgcut.net/api/v1 · Hämta din nyckel under API-nycklar.

Autentisering

Varje förfrågan måste innehålla din API-nyckel i huvudet X-Api-Key. Nycklar skapas och återkallas i ditt konto; varje nyckel kan namnges så att du kan rotera dem per applikation.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Du kan också skicka den som en Bearer-token: Authorization: Bearer bgc_…

POST /remove

Skicka bilden som en multipart-fil, som en URL eller base64-kodad. Som standard är svaret den resulterande bilden (binärt).

Parametrar

ParameterTypBeskrivning
image_filefileBildfilen (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; max 25 MB / 30 MP.
image_urlstringOffentlig URL till bilden som ska hämtas i stället för att laddas upp.
image_file_b64stringBase64-kodad bild (valfritt med ett data:-prefix).
sizeauto | preview | fullpreview = upp till 640 px (använder din kostnadsfria månadskvot, inga krediter); full = originalupplösning (1 kredit); auto (standard) = full om du har krediter, annars preview.
formatpng | jpg | webpUtdataformat. png behåller transparensen; jpg plattas till mot bg_color (standard vit).
modelfast | hq | portraitfast (standard, ~1 s), hq (högre kvalitet, långsammare), portrait (optimerad för personer).
bg_colorstringHexfärg för bakgrunden, t.ex. #ffffff. Utelämna för transparent bakgrund.
bg_blurnumberBehåll originalbakgrunden men gör den suddig med denna radie i pixlar (1–200), t.ex. 25 för en porträttlägeseffekt. Åsidosätter bg_color.
cropbooleanBeskär utdata till motivets avgränsningsram.
crop_marginintegerExtra marginal i pixlar runt motivet vid beskärning (0–200).
roistringIntresseområde som bråkdelar x,y,w,h (0–1). AI:n tittar bara inom denna rektangel; allt utanför blir transparent.
feathernumberMjuka upp kanterna med denna radie i pixlar (0–5).
qualityintegerJPG/WebP-kvalitet 50–100 (standard 92).
responsebinary | jsonbinary (standard) returnerar bilden; json returnerar metadata plus bilden i base64.

Svar

Lyckade förfrågningar returnerar HTTP 200 med bildens byte och följande huvuden:

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

Returnerar de senaste 100 bilderna som bearbetats med dina API-nycklar, inklusive en redigeringslänk för att finjustera dem i webbläsaren.

Fel

Fel returneras som JSON med en felkod och ett läsbart meddelande:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorBeskrivning
400bad_request / missing_imageParametrar saknas eller är ogiltiga.
401auth_required / invalid_keyAPI-nyckeln saknas, är ogiltig eller har återkallats.
402insufficient_credits / free_quota_exceededInga krediter (för full storlek) eller gratiskvoten är förbrukad (för förhandsgranskning).
422too_large / bad_type / fetch_failedBilden kunde inte läsas eller laddas ned.
429rate_limitedFör många förfrågningar – sakta ned eller kontakta oss för högre gränser.
500processing_failedBearbetningen misslyckades hos oss – du debiteras inte.

Exempelkod

Alla exempel använder samma slutpunkt. Ladda ned hela exempelsamlingen: bgcut-api-examples.zip

Begränsningar

  • 60 förfrågningar per minut och API-nyckel (högre gränser på begäran).
  • Max 25 MB och 30 megapixlar per bild; större bilder skalas ned.
  • Bearbetade bilder sparas i 30 dagar och kan finjusteras i webbredigeraren.
  • Misslyckade förfrågningar debiteras aldrig; en debitering återbetalas automatiskt om genereringen av resultatet misslyckas.

Kom igång med integrationen

Skapa ett gratiskonto, generera en nyckel och gör ditt första anrop på under en minut.

Skaffa en API-nyckel Priser