API bgCut.net

Видаляйте фон у власних застосунках, магазинах чи конвеєрах обробки одним 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 МБ / 30 МП.
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 | portraitfast (за замовчуванням, ~1 с), hq (вища якість, повільніше), portrait (оптимізовано для людей).
bg_colorstringКолір фону в шістнадцятковому форматі, напр. #ffffff. Не вказуйте для прозорого фону.
bg_blurnumberЗберегти оригінальний фон, але розмити його з указаним радіусом у пікселях (1–200), наприклад 25 для ефекту портретного режиму. Має пріоритет над bg_color.
cropbooleanОбрізати результат за межами об’єкта.
crop_marginintegerДодатковий відступ у пікселях навколо об’єкта під час обрізання (0–200).
roistringОбласть інтересу у вигляді часток x,y,w,h (0–1). ШІ аналізує лише цей прямокутник; усе поза ним стає прозорим.
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-ключами, разом із посиланням на редактор для їх доопрацювання в браузері.

Помилки

Помилки повертаються у форматі 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_keyAPI-ключ відсутній, недійсний або відкликаний.
402insufficient_credits / free_quota_exceededНемає кредитів (для повного розміру) або вичерпано безкоштовну квоту (для попереднього перегляду).
422too_large / bad_type / fetch_failedНе вдалося прочитати або завантажити зображення.
429rate_limitedЗабагато запитів – зменште частоту або зверніться до нас щодо вищих лімітів.
500processing_failedПомилка обробки на нашому боці – кошти не списуються.

Приклади коду

Усі приклади використовують один і той самий ендпоінт. Завантажте повну колекцію прикладів: bgcut-api-examples.zip

Обмеження

  • 60 запитів на хвилину на один API-ключ (вищі ліміти – за запитом).
  • Максимум 25 МБ і 30 мегапікселів на зображення; більші зображення зменшуються.
  • Оброблені зображення зберігаються 30 днів, їх можна доопрацювати у веб-редакторі.
  • За невдалі запити кошти ніколи не списуються; якщо не вдалося створити результат, оплата повертається автоматично.

Почніть інтеграцію

Створіть безкоштовний обліковий запис, згенеруйте ключ і зробіть перший виклик менш ніж за хвилину.

Отримати API-ключ Ціни