API de bgCut.net

Elimineu fons des de les vostres aplicacions, botigues o fluxos de treball amb una sola sol·licitud HTTPS.

URL base: https://bgcut.net/api/v1 · Obteniu la vostra clau a Claus d'API.

Autenticació

Cada sol·licitud ha d'incloure la vostra clau d'API a la capçalera X-Api-Key. Les claus es creen i es revoquen al vostre compte; podeu posar un nom a cada clau per rotar-les per aplicació.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

També la podeu enviar com a token Bearer: Authorization: Bearer bgc_…

POST /remove

Envieu la imatge com a fitxer multipart, com a URL o codificada en base64. Per defecte, la resposta és la imatge resultant (en binari).

Paràmetres

ParàmetreTipusDescripció
image_filefileEl fitxer d'imatge (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; màx. 25 MB / 30 MP.
image_urlstringURL pública de la imatge que s'ha d'obtenir en lloc de pujar-la.
image_file_b64stringImatge codificada en base64 (opcionalment amb el prefix data:).
sizeauto | preview | fullpreview = fins a 640 px (fa servir la vostra quota mensual gratuïta, sense crèdits); full = resolució original (1 crèdit); auto (per defecte) = full si teniu crèdits; si no, preview.
formatpng | jpg | webpFormat de sortida. png conserva la transparència; jpg s'aplana sobre bg_color (blanc per defecte).
modelfast | hq | portraitlite (per defecte, ~6 s, el millor equilibri), fast (~0,5 s, qualitat de previsualització), hq (~15 s, qualitat màxima), portrait (~0,3 s, només persones).
bg_colorstringColor hexadecimal del fons, p. ex. #ffffff. Ometeu-lo per obtenir un fons transparent.
bg_blurnumberConserva el fons original però el desenfoca amb aquest radi en píxels (1–200), p. ex. 25 per a un efecte de mode retrat. Té prioritat sobre bg_color.
cropbooleanRetalla la sortida al quadre delimitador del subjecte.
crop_marginintegerMarge addicional en píxels al voltant del subjecte en retallar (0–200).
roistringRegió d'interès en fraccions x,y,w,h (0–1). La IA només analitza l'interior d'aquest rectangle; tot el que queda fora esdevé transparent.
feathernumberSuavitza les vores amb aquest radi en píxels (0–5).
qualityintegerQualitat JPG/WebP de 50 a 100 (92 per defecte).
responsebinary | jsonbinary (per defecte) retorna la imatge; json retorna les metadades i la imatge en base64.

Respostes

Les sol·licituds correctes retornen HTTP 200 amb els bytes de la imatge i aquestes capçaleres:

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

Amb response=json obteniu:

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

Retorna les 100 darreres imatges processades amb les vostres claus d'API, amb una URL de l'editor per refinar-les al navegador.

Errors

Els errors es retornen en JSON amb un codi d'error i un missatge llegible:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorDescripció
400bad_request / missing_imageParàmetres absents o no vàlids.
401auth_required / invalid_keyClau d'API absent, no vàlida o revocada.
402insufficient_credits / free_quota_exceededNo teniu crèdits (per a la mida completa) o s'ha esgotat la quota gratuïta (per a la previsualització).
422too_large / bad_type / fetch_failedNo s'ha pogut llegir ni descarregar la imatge.
429rate_limitedMassa sol·licituds: reduïu el ritme o contacteu amb nosaltres per obtenir límits més alts.
500processing_failedEl processament ha fallat per part nostra; no se us cobra res.

Codi d'exemple

Tots els exemples fan servir el mateix endpoint. Descarregueu la col·lecció completa d'exemples: bgcut-api-examples.zip

SDK oficial per a PHP
Biblioteca client de codi obert amb resultats tipats, classes d'error i exemples llestos per executar. Llicència MIT.
composer require bgcut-net/bgcut-php
GitHub

Límits

  • 60 sol·licituds per minut per clau d'API (límits més alts si ho sol·liciteu).
  • Màx. 25 MB i 30 megapíxels per imatge; les imatges més grans es redueixen.
  • Les imatges processades es conserven durant 30 dies i es poden refinar a l'editor web.
  • Les sol·licituds fallides no es cobren mai; si falla la generació del resultat, l'import es reemborsa automàticament.

Comenceu la integració

Creeu un compte gratuït, genereu una clau i feu la primera crida en menys d'un minut.

Obteniu una clau d'API Preus