bgCut.net API

ลบพื้นหลังจากแอป ร้านค้าออนไลน์ หรือ pipeline ของคุณเองด้วยคำขอ HTTPS เพียงครั้งเดียว

Base URL: https://bgcut.net/api/v1 · รับคีย์ของคุณได้ที่ คีย์ API.

การยืนยันตัวตน

ทุกคำขอต้องแนบคีย์ API ในเฮดเดอร์ X-Api-Key คีย์สามารถสร้างและเพิกถอนได้ในบัญชีของคุณ และตั้งชื่อแต่ละคีย์ได้เพื่อหมุนเวียนคีย์แยกตามแอปพลิเคชัน

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

หรือส่งเป็น Bearer token: Authorization: Bearer bgc_…

POST /remove

ส่งภาพเป็นไฟล์ multipart, URL หรือแบบเข้ารหัส base64 โดยค่าเริ่มต้น การตอบกลับจะเป็นภาพผลลัพธ์ (ไบนารี)

พารามิเตอร์

พารามิเตอร์ประเภทคำอธิบาย
image_filefileไฟล์ภาพ (multipart/form-data) JPG, PNG, WebP, GIF, BMP, TIFF; สูงสุด 25 MB / 30 MP
image_urlstringURL สาธารณะของภาพที่จะดึงมาใช้แทนการอัปโหลด
image_file_b64stringภาพที่เข้ารหัส base64 (จะมีคำนำหน้า data: หรือไม่ก็ได้)
sizeauto | preview | fullpreview = สูงสุด 640 px (ใช้โควตาฟรีรายเดือน ไม่ใช้เครดิต); full = ความละเอียดต้นฉบับ (1 เครดิต); auto (ค่าเริ่มต้น) = full เมื่อมีเครดิต มิฉะนั้นเป็น preview
formatpng | jpg | webpรูปแบบไฟล์ผลลัพธ์ png คงความโปร่งใสไว้; jpg จะถูกรวมเลเยอร์บน bg_color (ค่าเริ่มต้นสีขาว)
modelfast | hq | portraitfast (ค่าเริ่มต้น, ~1 วินาที), hq (คุณภาพสูงกว่า แต่ช้ากว่า), portrait (ปรับให้เหมาะกับภาพบุคคล)
bg_colorstringรหัสสีแบบ hex สำหรับพื้นหลัง เช่น #ffffff ไม่ต้องระบุหากต้องการพื้นหลังโปร่งใส
bg_blurnumberคงพื้นหลังเดิมไว้แต่เบลอด้วยรัศมีนี้ในหน่วยพิกเซล (1–200) เช่น 25 เพื่อให้ได้ลุคแบบโหมดภาพบุคคล ค่านี้จะแทนที่ bg_color
cropbooleanครอปผลลัพธ์ให้พอดีกับกรอบของวัตถุ
crop_marginintegerระยะขอบเพิ่มเติมรอบวัตถุเป็นพิกเซลเมื่อครอป (0–200)
roistringพื้นที่ที่สนใจในรูปแบบสัดส่วน x,y,w,h (0–1) AI จะพิจารณาเฉพาะภายในสี่เหลี่ยมนี้ ส่วนที่อยู่นอกกรอบจะกลายเป็นโปร่งใส
feathernumberทำให้ขอบนุ่มนวลขึ้นตามรัศมีที่กำหนดเป็นพิกเซล (0–5)
qualityintegerคุณภาพ JPG/WebP 50–100 (ค่าเริ่มต้น 92)
responsebinary | jsonbinary (ค่าเริ่มต้น) ส่งคืนภาพ; 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

เมื่อใช้ response=json คุณจะได้รับ:

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

แสดงรูปภาพ 100 รายการล่าสุดที่ประมวลผลด้วยคีย์ API ของคุณ พร้อม URL ของเครื่องมือแก้ไขสำหรับปรับแต่งเพิ่มเติมในเบราว์เซอร์

ข้อผิดพลาด

ข้อผิดพลาดจะส่งกลับเป็น JSON ซึ่งมีรหัสข้อผิดพลาดและข้อความที่อ่านเข้าใจได้:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorคำอธิบาย
400bad_request / missing_imageพารามิเตอร์ขาดหายหรือไม่ถูกต้อง
401auth_required / invalid_keyคีย์ API ขาดหาย ไม่ถูกต้อง หรือถูกเพิกถอนแล้ว
402insufficient_credits / free_quota_exceededเครดิตไม่เพียงพอ (สำหรับขนาดเต็ม) หรือโควตาฟรีหมดแล้ว (สำหรับภาพตัวอย่าง)
422too_large / bad_type / fetch_failedไม่สามารถอ่านหรือดาวน์โหลดรูปภาพได้
429rate_limitedมีคำขอมากเกินไป – โปรดลดความถี่ หรือติดต่อเราเพื่อขอเพิ่มขีดจำกัด
500processing_failedการประมวลผลล้มเหลวจากฝั่งเรา – คุณจะไม่ถูกเรียกเก็บเงิน

โค้ดตัวอย่าง

ตัวอย่างทั้งหมดใช้ปลายทางเดียวกัน ดาวน์โหลดชุดตัวอย่างฉบับเต็ม: bgcut-api-examples.zip

ข้อจำกัด

  • 60 คำขอต่อนาทีต่อคีย์ API (ขอเพิ่มขีดจำกัดได้)
  • สูงสุด 25 MB และ 30 เมกะพิกเซลต่อรูปภาพ รูปภาพที่ใหญ่กว่านี้จะถูกย่อขนาด
  • รูปภาพที่ประมวลผลแล้วจะถูกเก็บไว้ 30 วัน และสามารถปรับแต่งได้ในเครื่องมือแก้ไขบนเว็บ
  • คำขอที่ล้มเหลวจะไม่ถูกเรียกเก็บเงิน และหากการสร้างผลลัพธ์ล้มเหลว ระบบจะคืนเงินให้โดยอัตโนมัติ

เริ่มการผสานรวม

สร้างบัญชีฟรี สร้างคีย์ และเรียกใช้งานครั้งแรกได้ภายในไม่ถึงหนึ่งนาที

รับคีย์ API ราคา