bgCut.net API

Премахвайте фона от собствените си приложения, магазини или процеси с една HTTPS заявка.

Базов URL адрес: https://bgcut.net/api/v1 · Вземете ключа си в API ключове.

Удостоверяване

Всяка заявка трябва да съдържа вашия API ключ в заглавката X-Api-Key. Ключовете се създават и отменят от вашия акаунт. Всеки ключ може да получи име, за да ги сменяте поотделно за всяко приложение.

X-Api-Key: bgc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Като алтернатива можете да го изпратите като Bearer токен: Authorization: Bearer bgc_…

POST /remove

Изпратете изображението като multipart файл, като URL адрес или кодирано в base64. По подразбиране отговорът е полученото изображение (в двоичен вид).

Параметри

ПараметърТипОписание
image_filefileФайлът с изображението (multipart/form-data). JPG, PNG, WebP, GIF, BMP, TIFF; макс. 25 MB / 30 MP.
image_urlstringПубличен URL адрес на изображението, което да бъде изтеглено вместо качено.
image_file_b64stringИзображение, кодирано в base64 (по избор с префикс data:).
sizeauto | preview | fullpreview = до 640 px (използва безплатната ви месечна квота, без кредити); full = оригинална резолюция (1 кредит); auto (по подразбиране) = full, ако имате кредити, иначе preview.
formatpng | jpg | webpИзходен формат. png запазва прозрачността; при jpg изображението се слива с bg_color (по подразбиране бял).
modelfast | hq | portraitlite (по подразбиране, ~6 s, най-добър баланс), fast (~0,5 s, качество за преглед), hq (~15 s, максимално качество), portrait (~0,3 s, само за хора).
bg_colorstringШестнадесетичен код на цвета на фона, напр. #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

Официален PHP SDK
Клиентска библиотека с отворен код, с типизирани резултати, класове за грешки и готови за изпълнение примери. Лиценз MIT.
composer require bgcut-net/bgcut-php
GitHub

Ограничения

  • 60 заявки в минута на API ключ (по-високи ограничения при запитване).
  • Макс. 25 MB и 30 мегапиксела на изображение; по-големите изображения се смаляват.
  • Обработените изображения се съхраняват 30 дни и могат да се доработват в уеб редактора.
  • Неуспешните заявки никога не се таксуват; ако генерирането на резултата се провали, таксата се възстановява автоматично.

Започнете интеграцията

Създайте безплатен акаунт, генерирайте ключ и направете първата си заявка за по-малко от минута.

Вземете API ключ Цени