bgCut.net API
Fjern baggrunde fra dine egne apps, webshops eller pipelines med en enkelt HTTPS-anmodning.
https://bgcut.net/api/v1 · Hent din nøgle under API-nøgler.Godkendelse
Hver anmodning skal indeholde din API-nøgle i headeren X-Api-Key. Nøgler oprettes og tilbagekaldes på din konto. Hver nøgle kan navngives, så du kan rotere dem pr. applikation.
X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Du kan også sende den som Bearer-token: Authorization: Bearer bgc_…
POST /remove
Send billedet som multipart-fil, som URL eller base64-kodet. Svaret er som standard det færdige billede (binært).
Parametre
| Parameter | Type | Beskrivelse |
|---|---|---|
image_file | file | Billedfilen (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; maks. 25 MB / 30 MP. |
image_url | string | Offentlig URL til billedet, der skal hentes i stedet for at blive uploadet. |
image_file_b64 | string | Base64-kodet billede (eventuelt med data:-præfiks). |
size | auto | preview | full | preview = op til 640 px (bruger din gratis månedlige kvote, ingen kreditter); full = original opløsning (1 kredit); auto (standard) = full, når du har kreditter, ellers preview. |
format | png | jpg | webp | Outputformat. png bevarer gennemsigtighed; jpg udfyldes med bg_color (standard hvid). |
model | fast | hq | portrait | lite (standard, ~6 sek., bedste balance), fast (~0,5 sek., preview-kvalitet), hq (~15 sek., maksimal kvalitet), portrait (~0,3 sek., kun personer). |
bg_color | string | Hex-farve til baggrunden, f.eks. #ffffff. Udelad for gennemsigtig. |
bg_blur | number | Bevar den originale baggrund, men slør den med denne radius i pixels (1–200), f.eks. 25 for en portrætlook. Tilsidesætter bg_color. |
crop | boolean | Beskær outputtet til motivets afgrænsningsramme. |
crop_margin | integer | Ekstra margen i pixels omkring motivet ved beskæring (0–200). |
roi | string | Interesseområde som brøkdele x,y,w,h (0–1). AI'en kigger kun inden for dette rektangel; alt udenfor bliver gennemsigtigt. |
feather | number | Blødgør kanterne med denne radius i pixels (0–5). |
quality | integer | JPG/WebP-kvalitet 50–100 (standard 92). |
response | binary | json | binary (standard) returnerer billedet; json returnerer metadata samt billedet i base64. |
Svar
Vellykkede anmodninger returnerer HTTP 200 med billedets bytes og disse headere:
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 seneste 100 billeder, der er behandlet med dine API-nøgler, inklusive en editor-URL til at finjustere dem i browseren.
Fejl
Fejl returneres som JSON med en fejlkode og en læsbar meddelelse:
{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
| HTTP | error | Beskrivelse |
|---|---|---|
| 400 | bad_request / missing_image | Manglende eller ugyldige parametre. |
| 401 | auth_required / invalid_key | Manglende, ugyldig eller tilbagekaldt API-nøgle. |
| 402 | insufficient_credits / free_quota_exceeded | Ingen kreditter (til fuld størrelse) eller gratis kvote opbrugt (til preview). |
| 422 | too_large / bad_type / fetch_failed | Billedet kunne ikke læses eller downloades. |
| 429 | rate_limited | For mange anmodninger – sænk tempoet, eller kontakt os for højere grænser. |
| 500 | processing_failed | Behandlingen mislykkedes hos os – du bliver ikke opkrævet. |
Kodeeksempler
Alle eksempler bruger samme endpoint. Download hele eksempelsamlingen: bgcut-api-examples.zip
Open source-klientbibliotek med typede resultater, fejlklasser og klar-til-brug-eksempler. MIT-licens.
composer require bgcut-net/bgcut-phpBegrænsninger
- 60 anmodninger pr. minut pr. API-nøgle (højere grænser efter aftale).
- Maks. 25 MB og 30 megapixel pr. billede; større billeder skaleres ned.
- Behandlede billeder gemmes i 30 dage og kan finjusteres i webeditoren.
- Mislykkede anmodninger opkræves aldrig; en opkrævning refunderes automatisk, hvis genereringen af output mislykkes.
Kom i gang med integrationen
Opret en gratis konto, generér en nøgle, og foretag dit første kald på under et minut.
Få en API-nøgle Priser