הסירו רקעים מתוך האפליקציות, החנויות או תהליכי העבודה שלכם באמצעות בקשת HTTPS אחת.
כתובת בסיס: https://bgcut.net/api/v1 · את המפתח ניתן לקבל תחת מפתחות API.
אימות
כל בקשה חייבת לכלול את מפתח ה-API שלכם בכותרת X-Api-Key. המפתחות נוצרים ומבוטלים בחשבון שלכם; ניתן לתת שם לכל מפתח כדי להחליף מפתחות בנפרד לכל אפליקציה.
// 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());
קובץ התמונה (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; עד 25 MB / 30 MP.
image_url
string
כתובת URL ציבורית של התמונה לאחזור במקום העלאה.
image_file_b64
string
תמונה בקידוד Base64 (אפשר עם קידומת data:).
size
auto | preview | full
preview = עד 640 px (מנצל את המכסה החודשית החינמית, ללא קרדיטים); full = רזולוציה מקורית (קרדיט 1); auto (ברירת מחדל) = full כאשר יש לכם קרדיטים, אחרת preview.
format
png | jpg | webp
פורמט הפלט. png שומר על השקיפות; jpg משוטח על bg_color (ברירת מחדל: לבן).
model
fast | hq | portrait
fast (ברירת מחדל, כשנייה אחת), hq (איכות גבוהה יותר, איטי יותר), portrait (מותאם לאנשים).
bg_color
string
צבע הרקע בקוד Hex, לדוגמה #ffffff. יש להשמיט לקבלת רקע שקוף.
bg_blur
number
שמירה על הרקע המקורי תוך טשטושו ברדיוס זה בפיקסלים (1–200), למשל 25 למראה של מצב פורטרט. גובר על bg_color.
crop
boolean
חיתוך הפלט לפי התיבה התוחמת של האובייקט.
crop_margin
integer
שוליים נוספים בפיקסלים סביב האובייקט בעת החיתוך (0–200).
roi
string
אזור עניין כשברים x,y,w,h (0–1). ה-AI בוחן רק את התוכן שבתוך המלבן הזה; כל מה שמחוצה לו הופך לשקוף.
feather
number
ריכוך הקצוות ברדיוס זה בפיקסלים (0–5).
quality
integer
איכות JPG/WebP בטווח 50–100 (ברירת מחדל 92).
response
binary | json
binary (ברירת מחדל) מחזיר את התמונה; json מחזיר מטא-נתונים יחד עם התמונה ב-base64.
תגובות
בקשות שהצליחו מחזירות HTTP 200 עם הבייטים של התמונה ועם הכותרות הבאות:
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