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ó.
// Never ship your API key in public front-end code – proxy through your server.
const input = document.querySelector('input[type=file]');
input.addEventListener('change', async () => {
const form = new FormData();
form.append('image_file', input.files[0]);
form.append('size', 'preview');
const res = await fetch('https://bgcut.net/api/v1/remove', { method: 'POST', headers: { 'X-Api-Key': 'bgc_YOUR_API_KEY' }, body: form });
const blob = await res.blob();
document.querySelector('img#out').src = URL.createObjectURL(blob);
});
// Java 11+ HttpClient, no external libraries
import java.net.URI;
import java.net.http.*;
import java.nio.file.*;
public class BgCut {
public static void main(String[] a) throws Exception {
String key = "bgc_YOUR_API_KEY";
String boundary = "----bgcut" + System.nanoTime();
byte[] file = Files.readAllBytes(Path.of("photo.jpg"));
String head = "--" + boundary + "\r\nContent-Disposition: form-data; name=\"image_file\"; filename=\"photo.jpg\"\r\nContent-Type: image/jpeg\r\n\r\n";
String tail = "\r\n--" + boundary + "\r\nContent-Disposition: form-data; name=\"size\"\r\n\r\nauto\r\n--" + boundary + "--\r\n";
byte[] body = concat(head.getBytes(), file, tail.getBytes());
HttpRequest req = HttpRequest.newBuilder(URI.create("https://bgcut.net/api/v1/remove"))
.header("X-Api-Key", key)
.header("Content-Type", "multipart/form-data; boundary=" + boundary)
.POST(HttpRequest.BodyPublishers.ofByteArray(body)).build();
HttpResponse<byte[]> res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofByteArray());
if (res.statusCode() == 200) Files.write(Path.of("result.png"), res.body());
else System.out.println(new String(res.body()));
}
static byte[] concat(byte[]... parts) { int n = 0; for (byte[] p : parts) n += p.length; byte[] out = new byte[n]; int o = 0; for (byte[] p : parts) { System.arraycopy(p, 0, out, o, p.length); o += p.length; } return out; }
}
using System.Net.Http;
using System.Net.Http.Headers;
var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-Api-Key", "bgc_YOUR_API_KEY");
using var form = new MultipartFormDataContent();
var fileContent = new ByteArrayContent(await File.ReadAllBytesAsync("photo.jpg"));
fileContent.Headers.ContentType = new MediaTypeHeaderValue("image/jpeg");
form.Add(fileContent, "image_file", "photo.jpg");
form.Add(new StringContent("auto"), "size");
form.Add(new StringContent("png"), "format");
var res = await client.PostAsync("https://bgcut.net/api/v1/remove", form);
if (res.IsSuccessStatusCode)
await File.WriteAllBytesAsync("result.png", await res.Content.ReadAsByteArrayAsync());
else
Console.WriteLine(await res.Content.ReadAsStringAsync());
URL pública de la imatge que s'ha d'obtenir en lloc de pujar-la.
image_file_b64
string
Imatge codificada en base64 (opcionalment amb el prefix data:).
size
auto | preview | full
preview = 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.
format
png | jpg | webp
Format de sortida. png conserva la transparència; jpg s'aplana sobre bg_color (blanc per defecte).
model
fast | hq | portrait
lite (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_color
string
Color hexadecimal del fons, p. ex. #ffffff. Ometeu-lo per obtenir un fons transparent.
bg_blur
number
Conserva 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.
crop
boolean
Retalla la sortida al quadre delimitador del subjecte.
crop_margin
integer
Marge addicional en píxels al voltant del subjecte en retallar (0–200).
roi
string
Regió 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.
feather
number
Suavitza les vores amb aquest radi en píxels (0–5).
quality
integer
Qualitat JPG/WebP de 50 a 100 (92 per defecte).
response
binary | json
binary (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
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." }
HTTP
error
Descripció
400
bad_request / missing_image
Paràmetres absents o no vàlids.
401
auth_required / invalid_key
Clau d'API absent, no vàlida o revocada.
402
insufficient_credits / free_quota_exceeded
No teniu crèdits (per a la mida completa) o s'ha esgotat la quota gratuïta (per a la previsualització).
422
too_large / bad_type / fetch_failed
No s'ha pogut llegir ni descarregar la imatge.
429
rate_limited
Massa sol·licituds: reduïu el ritme o contacteu amb nosaltres per obtenir límits més alts.
500
processing_failed
El 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