API bgCut.net

Buang latar belakang daripada aplikasi, kedai atau saluran paip anda sendiri dengan satu permintaan HTTPS.

URL asas: https://bgcut.net/api/v1 · Dapatkan kunci anda di Kunci API.

Pengesahan

Setiap permintaan mesti membawa kunci API anda dalam pengepala X-Api-Key. Kunci dicipta dan dibatalkan dalam akaun anda; setiap kunci boleh dinamakan supaya anda boleh menggilirkannya mengikut aplikasi.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Sebagai alternatif, hantarkannya sebagai token Bearer: Authorization: Bearer bgc_…

POST /remove

Hantar imej sebagai fail multipart, sebagai URL atau dalam pengekodan base64. Secara lalai, respons ialah imej yang terhasil (binari).

Parameter

ParameterJenisPenerangan
image_filefileFail imej (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; maks. 25 MB / 30 MP.
image_urlstringURL awam imej yang akan diambil dan bukannya dimuat naik.
image_file_b64stringImej berkod base64 (boleh disertakan awalan data:).
sizeauto | preview | fullpreview = sehingga 640 px (menggunakan kuota bulanan percuma anda, tanpa kredit); full = resolusi asal (1 kredit); auto (lalai) = full jika anda mempunyai kredit, jika tidak preview.
formatpng | jpg | webpFormat output. png mengekalkan ketelusan; jpg diratakan pada bg_color (lalai putih).
modelfast | hq | portraitlite (lalai, ~6 s, keseimbangan terbaik), fast (~0.5 s, kualiti pratonton), hq (~15 s, kualiti maksimum), portrait (~0.3 s, orang sahaja).
bg_colorstringWarna heks untuk latar belakang, cth. #ffffff. Abaikan untuk latar telus.
bg_blurnumberKekalkan latar belakang asal tetapi kaburkannya dengan jejari ini dalam piksel (1–200), cth. 25 untuk kesan mod potret. Mengatasi bg_color.
cropbooleanPangkas output mengikut kotak sempadan subjek.
crop_marginintegerMargin tambahan dalam piksel di sekeliling subjek semasa memangkas (0–200).
roistringKawasan minat sebagai pecahan x,y,w,h (0–1). AI hanya meneliti bahagian dalam segi empat ini; semua di luarnya menjadi telus.
feathernumberLembutkan tepi dengan jejari ini dalam piksel (0–5).
qualityintegerKualiti JPG/WebP 50–100 (lalai 92).
responsebinary | jsonbinary (lalai) memulangkan imej; json memulangkan metadata beserta imej base64.

Respons

Permintaan yang berjaya memulangkan HTTP 200 dengan bait imej dan pengepala berikut:

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

Dengan response=json anda akan menerima:

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

Memulangkan 100 imej terakhir yang diproses dengan kunci API anda, termasuk URL editor untuk memperhalusinya dalam pelayar.

Ralat

Ralat dipulangkan dalam JSON dengan kod ralat dan mesej yang mudah dibaca:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorPenerangan
400bad_request / missing_imageParameter tiada atau tidak sah.
401auth_required / invalid_keyKunci API tiada, tidak sah atau telah dibatalkan.
402insufficient_credits / free_quota_exceededTiada kredit (untuk saiz penuh) atau kuota percuma telah habis (untuk pratonton).
422too_large / bad_type / fetch_failedImej tidak dapat dibaca atau dimuat turun.
429rate_limitedTerlalu banyak permintaan – perlahankan atau hubungi kami untuk had yang lebih tinggi.
500processing_failedPemprosesan gagal di pihak kami – anda tidak dicaj.

Kod contoh

Semua contoh menggunakan titik akhir yang sama. Muat turun koleksi contoh penuh: bgcut-api-examples.zip

SDK PHP rasmi
Pustaka klien sumber terbuka dengan hasil bertaip, kelas ralat dan contoh sedia dijalankan. Berlesen MIT.
composer require bgcut-net/bgcut-php
GitHub

Had

  • 60 permintaan seminit bagi setiap kunci API (had lebih tinggi atas permintaan).
  • Maks. 25 MB dan 30 megapiksel bagi setiap imej; imej yang lebih besar akan dikecilkan.
  • Imej yang diproses disimpan selama 30 hari dan boleh diperhalusi dalam editor web.
  • Permintaan yang gagal tidak akan dicaj; caj dipulangkan secara automatik jika penjanaan output gagal.

Mula berintegrasi

Cipta akaun percuma, jana kunci dan buat panggilan pertama anda dalam masa kurang daripada seminit.

Dapatkan kunci API Harga