bgCut.net API

Xóa phông nền ngay trong ứng dụng, cửa hàng hoặc quy trình của bạn chỉ với một yêu cầu HTTPS.

URL cơ sở: https://bgcut.net/api/v1 · Lấy khóa của bạn tại Khóa API.

Xác thực

Mọi yêu cầu đều phải gửi kèm khóa API của bạn trong header X-Api-Key. Bạn có thể tạo và thu hồi khóa trong tài khoản của mình. Mỗi khóa có thể được đặt tên để dễ dàng thay đổi theo từng ứng dụng.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Hoặc gửi khóa dưới dạng Bearer token: Authorization: Bearer bgc_…

POST /remove

Gửi ảnh dưới dạng tệp multipart, URL hoặc chuỗi mã hóa base64. Theo mặc định, phản hồi là ảnh kết quả (dạng nhị phân).

Tham số

Tham sốLoạiMô tả
image_filefileTệp ảnh (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; tối đa 25 MB / 30 MP.
image_urlstringURL công khai của ảnh để tải về thay vì tải lên.
image_file_b64stringẢnh mã hóa base64 (có thể kèm tiền tố data:).
sizeauto | preview | fullpreview = tối đa 640 px (dùng hạn mức miễn phí hằng tháng, không tốn tín dụng); full = độ phân giải gốc (1 tín dụng); auto (mặc định) = full nếu bạn còn tín dụng, nếu không thì dùng preview.
formatpng | jpg | webpĐịnh dạng đầu ra. png giữ nền trong suốt; jpg được làm phẳng trên bg_color (mặc định là màu trắng).
modelfast | hq | portraitlite (mặc định, ~6 giây, cân bằng tốt nhất), fast (~0,5 giây, chất lượng xem trước), hq (~15 giây, chất lượng cao nhất), portrait (~0,3 giây, chỉ dành cho ảnh người).
bg_colorstringMã màu hex cho nền, ví dụ #ffffff. Bỏ qua để giữ nền trong suốt.
bg_blurnumberGiữ nguyên nền gốc nhưng làm mờ với bán kính tính bằng pixel (1–200), ví dụ 25 để có hiệu ứng như chế độ chân dung. Ghi đè bg_color.
cropbooleanCắt ảnh đầu ra theo khung bao quanh chủ thể.
crop_marginintegerLề bổ sung tính bằng pixel quanh chủ thể khi cắt (0–200).
roistringVùng quan tâm dưới dạng tỷ lệ x,y,w,h (0–1). AI chỉ xử lý bên trong hình chữ nhật này; mọi phần bên ngoài sẽ trở thành trong suốt.
feathernumberLàm mềm viền với bán kính tính bằng pixel (0–5).
qualityintegerChất lượng JPG/WebP từ 50–100 (mặc định 92).
responsebinary | jsonbinary (mặc định) trả về ảnh; json trả về siêu dữ liệu kèm ảnh mã hóa base64.

Phản hồi

Yêu cầu thành công sẽ trả về HTTP 200 kèm dữ liệu ảnh và các header sau:

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

Với response=json, bạn sẽ nhận được:

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

Trả về 100 ảnh gần nhất được xử lý bằng các khóa API của bạn, kèm URL trình chỉnh sửa để tinh chỉnh ảnh ngay trên trình duyệt.

Lỗi

Lỗi được trả về dưới dạng JSON, gồm mã lỗi và thông báo dễ hiểu:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorMô tả
400bad_request / missing_imageThiếu tham số hoặc tham số không hợp lệ.
401auth_required / invalid_keyKhóa API bị thiếu, không hợp lệ hoặc đã bị thu hồi.
402insufficient_credits / free_quota_exceededHết tín dụng (với kích thước đầy đủ) hoặc đã dùng hết hạn mức miễn phí (với bản xem trước).
422too_large / bad_type / fetch_failedKhông thể đọc hoặc tải ảnh về.
429rate_limitedQuá nhiều yêu cầu – hãy giảm tần suất hoặc liên hệ với chúng tôi để được nâng giới hạn.
500processing_failedXử lý thất bại do lỗi từ phía chúng tôi – bạn sẽ không bị tính phí.

Mã mẫu

Tất cả mã mẫu đều dùng chung một endpoint. Tải xuống bộ ví dụ đầy đủ: bgcut-api-examples.zip

SDK PHP chính thức
Thư viện client mã nguồn mở với kết quả có kiểu dữ liệu, các lớp lỗi và ví dụ chạy được ngay. Giấy phép MIT.
composer require bgcut-net/bgcut-php
GitHub

Giới hạn

  • 60 yêu cầu mỗi phút cho mỗi khóa API (có thể nâng giới hạn theo yêu cầu).
  • Tối đa 25 MB và 30 megapixel mỗi ảnh; ảnh lớn hơn sẽ được thu nhỏ.
  • Ảnh đã xử lý được lưu trong 30 ngày và có thể tinh chỉnh trong trình chỉnh sửa web.
  • Yêu cầu thất bại không bao giờ bị tính phí; khoản phí sẽ được tự động hoàn lại nếu quá trình tạo ảnh đầu ra thất bại.

Bắt đầu tích hợp

Tạo tài khoản miễn phí, tạo khóa và thực hiện lệnh gọi đầu tiên trong chưa đầy một phút.

Nhận khóa API Bảng giá