Remova fundos a partir dos seus próprios apps, lojas ou pipelines com uma única requisição HTTPS.
URL base: https://bgcut.net/api/v1 · Obtenha sua chave em Chaves de API.
Autenticação
Toda requisição deve incluir sua chave de API no cabeçalho X-Api-Key. As chaves são criadas e revogadas na sua conta. Cada chave pode receber um nome, para que você possa alterná-las por aplicação.
// 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());
O arquivo de imagem (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; máx. 25 MB / 30 MP.
image_url
string
URL pública da imagem a ser baixada em vez de enviada.
image_file_b64
string
Imagem codificada em base64 (opcionalmente com prefixo data:).
size
auto | preview | full
preview = até 640 px (usa sua cota mensal gratuita, sem créditos); full = resolução original (1 crédito); auto (padrão) = full quando você tem créditos, caso contrário preview.
format
png | jpg | webp
Formato de saída. png mantém a transparência; jpg é mesclado sobre bg_color (branco por padrão).
model
fast | hq | portrait
lite (padrão, ~6 s, melhor equilíbrio), fast (~0,5 s, qualidade de prévia), hq (~15 s, qualidade máxima), portrait (~0,3 s, apenas pessoas).
bg_color
string
Cor hexadecimal do fundo, p. ex. #ffffff. Omita para fundo transparente.
bg_blur
number
Mantém o fundo original, mas o desfoca com este raio em pixels (1–200), p. ex. 25 para um efeito de modo retrato. Substitui bg_color.
crop
boolean
Recorta a saída para a área delimitadora do objeto.
crop_margin
integer
Margem extra em pixels ao redor do objeto ao recortar (0–200).
roi
string
Região de interesse como frações x,y,w,h (0–1). A IA analisa apenas o interior deste retângulo; tudo o que estiver fora fica transparente.
feather
number
Suaviza as bordas com este raio em pixels (0–5).
quality
integer
Qualidade JPG/WebP de 50 a 100 (padrão 92).
response
binary | json
binary (padrão) retorna a imagem; json retorna os metadados e a imagem em base64.
Respostas
Requisições bem-sucedidas retornam HTTP 200 com os bytes da imagem e estes cabeçalhos:
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 as últimas 100 imagens processadas com suas chaves de API, incluindo uma URL do editor para refiná-las no navegador.
Erros
Os erros são retornados em JSON com um código de erro e uma mensagem legível:
{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTP
error
Descrição
400
bad_request / missing_image
Parâmetros ausentes ou inválidos.
401
auth_required / invalid_key
Chave de API ausente, inválida ou revogada.
402
insufficient_credits / free_quota_exceeded
Sem créditos (para tamanho completo) ou cota gratuita esgotada (para prévia).
422
too_large / bad_type / fetch_failed
Não foi possível ler ou baixar a imagem.
429
rate_limited
Requisições em excesso – reduza a frequência ou entre em contato conosco para obter limites maiores.
500
processing_failed
Falha no processamento do nosso lado – nada será cobrado.
Código de exemplo
Todos os exemplos usam o mesmo endpoint. Baixe a coleção completa de exemplos: bgcut-api-examples.zip
SDK PHP oficial Biblioteca cliente de código aberto com resultados tipados, classes de erro e exemplos prontos para uso. Licença MIT. composer require bgcut-net/bgcut-php