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.
// 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());
Offentlig URL til bildet som skal hentes i stedet for å lastes opp.
image_file_b64
string
Base64-kodet bilde (eventuelt med data:-prefiks).
size
auto | preview | full
preview = 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.
format
png | jpg | webp
Utdataformat. png beholder gjennomsiktigheten; jpg flates ut på bg_color (standard hvit).
model
fast | hq | portrait
lite (standard, ~6 s, best balanse), fast (~0,5 s, forhåndsvisningskvalitet), hq (~15 s, maksimal kvalitet), portrait (~0,3 s, kun personer).
bg_color
string
Hex-farge for bakgrunnen, f.eks. #ffffff. Utelat for gjennomsiktig bakgrunn.
bg_blur
number
Behold 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.
crop
boolean
Beskjær resultatet til motivets avgrensningsboks.
crop_margin
integer
Ekstra marg i piksler rundt motivet ved beskjæring (0–200).
roi
string
Interesseområde som brøkdeler x,y,w,h (0–1). AI-en ser bare innenfor dette rektangelet; alt utenfor blir gjennomsiktig.
feather
number
Myk opp kantene med denne radiusen i piksler (0–5).
quality
integer
JPG/WebP-kvalitet 50–100 (standard 92).
response
binary | json
binary (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
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." }
HTTP
error
Beskrivelse
400
bad_request / missing_image
Manglende eller ugyldige parametere.
401
auth_required / invalid_key
Manglende, ugyldig eller tilbakekalt API-nøkkel.
402
insufficient_credits / free_quota_exceeded
Ingen kreditter (for full størrelse) eller gratiskvoten er brukt opp (for forhåndsvisning).
422
too_large / bad_type / fetch_failed
Bildet kunne ikke leses eller lastes ned.
429
rate_limited
For mange forespørsler – sett ned tempoet eller kontakt oss for høyere grenser.
500
processing_failed
Behandlingen 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