API bgCut.net

Busak latar saka aplikasi, toko utawa pipeline panjenengan dhéwé nganggo siji panjaluk HTTPS.

URL dhasar: https://bgcut.net/api/v1 · Jupuk kunci panjenengan ing Kunci API.

Otentikasi

Saben panjalukan kudu nggawa kunci API panjenengan ing header X-Api-Key. Kunci digawe lan dicabut ing akun panjenengan; saben kunci bisa diwenehi jeneng supaya bisa diganti miturut aplikasi.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Utawa, kirim minangka token Bearer: Authorization: Bearer bgc_…

POST /remove

Kirim gambar minangka berkas multipart, URL utawa dienkode base64. Kanthi gawan, respons arupa gambar asil (biner).

Paramèter

ParameterJinisKatrangan
image_filefileBerkas gambar (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; maks. 25 MB / 30 MP.
image_urlstringURL umum gambar sing dijupuk tinimbang diunggah.
image_file_b64stringGambar sing dienkode base64 (bisa nganggo awalan data:).
sizeauto | preview | fullpreview = nganti 640 px (nganggo kuota gratis saben sasi, tanpa kredit); full = resolusi asli (1 kredit); auto (gawan) = full yen panjenengan duwe kredit, yen ora preview.
formatpng | jpg | webpFormat asil. png njaga transparansi; jpg diratakake ing bg_color (gawan putih).
modelfast | hq | portraitlite (gawan, ~6 s, imbangan paling apik), fast (~0,5 s, kualitas pratinjau), hq (~15 s, kualitas maksimal), portrait (~0,3 s, mung kanggo wong).
bg_colorstringWerna hex kanggo latar mburi, contone #ffffff. Ora usah diisi kanggo latar transparan.
bg_blurnumberTetep nganggo latar asli nanging diburemake nganggo radius iki ing piksel (1–200), contone 25 kanggo tampilan mode potret. Ngganti bg_color.
cropbooleanPotong asil miturut kothak wates subjek.
crop_marginintegerMargin tambahan ing piksel ing sakubenge subjek nalika motong (0–200).
roistringWilayah sing dikarepake minangka pecahan x,y,w,h (0–1). AI mung nggatekake ing njero persegi dawa iki; kabeh sing ana ing njaba dadi transparan.
feathernumberAlusake pinggiran nganggo radius iki ing piksel (0–5).
qualityintegerKualitas JPG/WebP 50–100 (gawan 92).
responsebinary | jsonbinary (gawan) ngasilake gambar; json ngasilake metadata lan gambar base64.

Respons

Panjalukan sing kasil ngasilake HTTP 200 kanthi bita gambar lan header iki:

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

Kanthi response=json panjenengan entuk:

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

Ngasilake 100 gambar pungkasan sing diproses nganggo kunci API panjenengan, kalebu URL editor kanggo nyampurnakake ing browser.

Kasalahan

Kasalahan arupa JSON kanthi kode kasalahan lan pesen sing gampang diwaca:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorKatrangan
400bad_request / missing_imageParameter ilang utawa ora valid.
401auth_required / invalid_keyKunci API ilang, ora valid utawa wis dicabut.
402insufficient_credits / free_quota_exceededOra ana kredit (kanggo ukuran full) utawa kuota gratis wis entek (kanggo preview).
422too_large / bad_type / fetch_failedGambar ora bisa diwaca utawa diunduh.
429rate_limitedKakehan panjalukan – alonana utawa hubungi kita kanggo watesan sing luwih dhuwur.
500processing_failedPamrosesan gagal ing pihak kita – panjenengan ora dikenani biaya.

Kode conto

Kabeh conto nganggo endpoint sing padha. Unduh koleksi conto lengkap: bgcut-api-examples.zip

SDK PHP resmi
Pustaka klien open-source kanthi asil sing duwe tipe, kelas kasalahan lan conto siap dilakokake. Lisensi MIT.
composer require bgcut-net/bgcut-php
GitHub

Watesan

  • 60 panjalukan saben menit saben kunci API (watesan luwih dhuwur yen dijaluk).
  • Maks. 25 MB lan 30 megapiksel saben gambar; gambar sing luwih gedhe dicilikake.
  • Gambar sing wis diproses disimpen suwene 30 dina lan bisa disampurnakake ing editor web.
  • Panjalukan sing gagal ora tau dikenani biaya; biaya dibalekake kanthi otomatis yen nggawe asil gagal.

Wiwiti integrasi

Gawe akun gratis, gawe kunci lan lakokake panggilan pisanan kurang saka samenit.

Entuk kunci API Rega