bgCut.net API

Mag-alis ng background mula sa sarili mong app, shop o pipeline gamit ang iisang HTTPS request.

Base URL: https://bgcut.net/api/v1 · Kunin ang iyong key sa Mga API key.

Authentication

Dapat nakalagay ang iyong API key sa X-Api-Key header ng bawat request. Ginagawa at binabawi ang mga key sa iyong account; maaaring pangalanan ang bawat key para mapalitan mo ang mga ito kada application.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Bilang alternatibo, ipadala ito bilang Bearer token: Authorization: Bearer bgc_…

POST /remove

Ipadala ang larawan bilang multipart file, URL, o base64-encoded. Bilang default, ang response ay ang resultang larawan (binary).

Mga parameter

ParameterUriPaglalarawan
image_filefileAng file ng larawan (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; max 25 MB / 30 MP.
image_urlstringPampublikong URL ng larawang kukunin sa halip na i-upload.
image_file_b64stringBase64-encoded na larawan (puwedeng may data: prefix).
sizeauto | preview | fullpreview = hanggang 640 px (gumagamit ng libreng buwanang quota, walang credit); full = orihinal na resolusyon (1 credit); auto (default) = full kung may credit ka, kung wala ay preview.
formatpng | jpg | webpFormat ng output. Pinapanatili ng png ang transparency; ang jpg ay pina-flatten sa bg_color (default na puti).
modelfast | hq | portraitlite (default, ~6 s, pinakamahusay na balanse), fast (~0.5 s, kalidad ng preview), hq (~15 s, pinakamataas na kalidad), portrait (~0.3 s, para sa tao lamang).
bg_colorstringHex na kulay ng background, hal. #ffffff. Huwag isama para maging transparent.
bg_blurnumberPanatilihin ang orihinal na background pero i-blur ito gamit ang radius na ito sa pixel (1–200), hal. 25 para sa itsurang portrait mode. Nangingibabaw ito sa bg_color.
cropbooleanI-crop ang output sa bounding box ng subject.
crop_marginintegerDagdag na margin sa pixel sa paligid ng subject kapag nagka-crop (0–200).
roistringRegion of interest bilang mga fraction na x,y,w,h (0–1). Sa loob lang ng parihabang ito titingin ang AI; magiging transparent ang lahat ng nasa labas.
feathernumberPalambutin ang mga gilid gamit ang radius na ito sa pixel (0–5).
qualityintegerKalidad ng JPG/WebP 50–100 (default 92).
responsebinary | jsonIbinabalik ng binary (default) ang larawan; ibinabalik ng json ang metadata kasama ang base64 na larawan.

Mga response

Ang matagumpay na request ay nagbabalik ng HTTP 200 kasama ang bytes ng larawan at ang mga header na ito:

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

Kapag response=json, matatanggap mo ang:

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

Ibinabalik ang huling 100 larawang naproseso gamit ang iyong mga API key, kasama ang editor URL para pinuhin ang mga ito sa browser.

Mga error

Ang mga error ay JSON na may error code at mensaheng madaling maintindihan:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorPaglalarawan
400bad_request / missing_imageKulang o hindi wastong parameter.
401auth_required / invalid_keyWalang API key, hindi ito wasto, o binawi na.
402insufficient_credits / free_quota_exceededWalang credit (para sa full size) o ubos na ang libreng quota (para sa preview).
422too_large / bad_type / fetch_failedHindi mabasa o ma-download ang larawan.
429rate_limitedMasyadong maraming request – bagalan o makipag-ugnayan sa amin para sa mas mataas na limitasyon.
500processing_failedNabigo ang pagproseso sa aming panig – hindi ka sisingilin.

Sample na code

Iisang endpoint ang gamit ng lahat ng sample. I-download ang buong koleksyon ng mga halimbawa: bgcut-api-examples.zip

Opisyal na PHP SDK
Open-source na client library na may typed na resulta, mga error class at mga halimbawang handa nang patakbuhin. MIT licensed.
composer require bgcut-net/bgcut-php
GitHub

Mga limitasyon

  • 60 request kada minuto bawat API key (mas mataas na limitasyon kapag hiniling).
  • Max 25 MB at 30 megapixel bawat larawan; pinaliliit ang mas malalaking larawan.
  • Itinatago ang mga naprosesong larawan nang 30 araw at maaaring pinuhin sa web editor.
  • Hindi kailanman sinisingil ang mga nabigong request; awtomatikong ibinabalik ang bayad kung mabigo ang paggawa ng output.

Simulan ang integrasyon

Gumawa ng libreng account, mag-generate ng key at gawin ang unang call mo sa loob ng wala pang isang minuto.

Kumuha ng API key Presyo