bgCut.net API

Noņemiet fonus savās lietotnēs, veikalos vai darbplūsmās ar vienu HTTPS pieprasījumu.

Bāzes URL: https://bgcut.net/api/v1 · Atslēgu saņemiet sadaļā API atslēgas.

Autentifikācija

Katrā pieprasījumā galvenē X-Api-Key jānorāda jūsu API atslēga. Atslēgas var izveidot un atsaukt savā kontā. Katrai atslēgai var piešķirt nosaukumu, lai tās varētu nomainīt katrai lietotnei atsevišķi.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Atslēgu var nosūtīt arī kā Bearer pilnvaru: Authorization: Bearer bgc_…

POST /remove

Nosūtiet attēlu kā multipart failu, kā URL vai base64 kodējumā. Pēc noklusējuma atbildē tiek atgriezts iegūtais attēls (binārā formā).

Parametri

ParametrsVeidsApraksts
image_filefileAttēla fails (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; maks. 25 MB / 30 MP.
image_urlstringPublisks attēla URL, no kura attēlu ielādēt augšupielādes vietā.
image_file_b64stringBase64 kodēts attēls (pēc izvēles ar data: prefiksu).
sizeauto | preview | fullpreview = līdz 640 px (izmanto bezmaksas mēneša kvotu, bez kredītiem); full = oriģinālā izšķirtspēja (1 kredīts); auto (noklusējums) = full, ja jums ir kredīti, pretējā gadījumā preview.
formatpng | jpg | webpIzvades formāts. png saglabā caurspīdīgumu; jpg tiek saplacināts uz bg_color fona (pēc noklusējuma balts).
modelfast | hq | portraitlite (noklusējums, ~6 s, labākais līdzsvars), fast (~0,5 s, priekšskatījuma kvalitāte), hq (~15 s, maksimālā kvalitāte), portrait (~0,3 s, tikai cilvēkiem).
bg_colorstringFona krāsa heksadecimālā formātā, piem., #ffffff. Izlaidiet, lai fons būtu caurspīdīgs.
bg_blurnumberSaglabā oriģinālo fonu, bet izpludina to ar norādīto rādiusu pikseļos (1–200), piem., 25 portreta režīma efektam. Aizstāj bg_color.
cropbooleanApgriež izvadi līdz objekta robežām.
crop_marginintegerPapildu atstarpe pikseļos ap objektu apgriešanas laikā (0–200).
roistringInterešu apgabals kā daļas x,y,w,h (0–1). AI analizē tikai šo taisnstūri; viss ārpus tā kļūst caurspīdīgs.
feathernumberMīkstina malas ar norādīto rādiusu pikseļos (0–5).
qualityintegerJPG/WebP kvalitāte 50–100 (noklusējums 92).
responsebinary | jsonbinary (noklusējums) atgriež attēlu; json atgriež metadatus un attēlu base64 formātā.

Atbildes

Veiksmīgi pieprasījumi atgriež HTTP 200 ar attēla baitiem un šīm galvenēm:

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

Ar response=json jūs saņemat:

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

Atgriež pēdējos 100 attēlus, kas apstrādāti ar jūsu API atslēgām, ieskaitot redaktora URL to precizēšanai pārlūkā.

Kļūdas

Kļūdas tiek atgrieztas JSON formātā ar kļūdas kodu un cilvēkam saprotamu ziņojumu:

{ "ok": false, "error": "insufficient_credits", "message": "No credits left. Buy credits at https://bgcut.net/pricing or request size=preview." }
HTTPerrorApraksts
400bad_request / missing_imageTrūkst parametru vai tie ir nederīgi.
401auth_required / invalid_keyAPI atslēga trūkst, ir nederīga vai atsaukta.
402insufficient_credits / free_quota_exceededNav kredītu (pilnam izmēram) vai izsmelta bezmaksas kvota (priekšskatījumam).
422too_large / bad_type / fetch_failedAttēlu neizdevās nolasīt vai lejupielādēt.
429rate_limitedPārāk daudz pieprasījumu – samaziniet tempu vai sazinieties ar mums par augstākiem ierobežojumiem.
500processing_failedApstrāde neizdevās mūsu pusē – maksa netiek iekasēta.

Koda piemēri

Visi piemēri izmanto vienu un to pašu galapunktu. Lejupielādējiet pilnu piemēru kolekciju: bgcut-api-examples.zip

Oficiālais PHP SDK
Atvērtā koda klienta bibliotēka ar tipizētiem rezultātiem, kļūdu klasēm un lietošanai gataviem piemēriem. MIT licence.
composer require bgcut-net/bgcut-php
GitHub

Ierobežojumi

  • 60 pieprasījumi minūtē uz vienu API atslēgu (augstāki ierobežojumi pēc pieprasījuma).
  • Maks. 25 MB un 30 megapikseļi uz attēlu; lielāki attēli tiek samazināti.
  • Apstrādātie attēli tiek glabāti 30 dienas, un tos var precizēt tīmekļa redaktorā.
  • Par neveiksmīgiem pieprasījumiem maksa netiek iekasēta; ja izvades ģenerēšana neizdodas, maksa tiek automātiski atmaksāta.

Sāciet integrāciju

Izveidojiet bezmaksas kontu, ģenerējiet atslēgu un veiciet pirmo izsaukumu mazāk nekā minūtē.

Iegūt API atslēgu Cenas