API Документация

Удалить фон

Главная
Блог
Интеграция
Цены
Войти / Зарегистрироваться
Удалить фон
Русский
- Русский
- English
Российский рубль (₽)
- Доллар США ($)
- Российский рубль (₽)

API Документация

Начало

Зарегистрироваться
Получите свой
API ключ
Изучите документацию по работе с API

Информация по API

Отправка запросов с параметром size: "full" уменьшит ваш баланс

Сервер

https://benzin.io/api/removeBackground

Тип запроса

POST

Используя алгоритмы нейросетей автоматически удаляет фон с любого изображения.

Размер файла: до 32 МБ
Источник изображения: Загрузка файла (бинарный, base64 строка) или через URL
К обработке доступны любые изображения
Выходное разрешение: Preview, Full - исходное разрешение изображения
Требуется X-Access-Token заголовок в запросе

Тело запроса

Параметр
size
(string)
Размер возвращаемого изображения.
Доступные значения:
"full", "preview".
По умолчанию:
preview
channels
(string)
Возвращаемые каналы изображения, цветное изображение, либо маска.
Доступные значения:
"rgba", "alpha".
По умолчанию:
rgba
crop
(boolean)
Если true, то изображение будет обрезано по границе распознанного объекта.
Доступные значения:
true, false
По умолчанию:
false
crop_margin
(string)
Определяет отступы от краев обрезанного изображения, работает только если crop = true, значение задается в пикселях (например: 10px), либо в процентах (например: 10%), возможно задавать как одно значение на все края (например: 25%), так и на парные края (например: 10%,100px), первое значение - левой и правый край, второе значение - верх и низ, также можно задать на все края отдельно, например, 10%,25px,25%,33% crop = true, Определяет отступы от краев обрезанного изображения, работает только если crop = true, значение задается в пикселях (например: 10px), либо в процентах (например: 10%), возможно задавать как одно значение на все края (например: 25%), так и на парные края (например: 10%,100px), первое значение - левой и правый край, второе значение - верх и низ, также можно задать на все края отдельно, например, 10%,25px,25%,33%
output_format
(string)
Формат в котором будут возвращены данные.
Доступные значения:
"image" - "image" - in the form of an image (image/*), "json" - картинка будет закодирована в base64 (application/json)
По умолчанию:
image
output_image_format
(string)
Формат возвращаемого изображения.
Доступные значения:
png, jpg, webp
По умолчанию:
png
image_file
(binary)
Изображение к обработке в бинарной форме
(Используется только при multi-part/form-data)
image_file_b64
(string)
Изображение к обработке в формате base64
По умолчанию:
none
image_file_url
(string)
Изображение к обработке по URL
По умолчанию:
none
bg_color
(string)
Новый фон изображения. Может быть обозначено названием цвета (white, blue), или rgb кодом (#fff)
По умолчанию:
none
bg_image_file
(binary)
Новый фон картинкой в бинарной форме
(Используется только при multi-part/form-data)
bg_image_file_b64
(string)
Новый фон картинкой в формате base64
По умолчанию:
none
bg_image_file_url
(string)
Новый фон картинкой по URL
По умолчанию:
none

Responses

Код
Описание
200
Ответ, если output_format: "image" - бинарный вид изображения;
Ответ, если output_format: "json" -
{ "image_height": 'val', "image_raw": base64 code, "image_type": "png", "image_width": 'val' }
400
Error: Неверные параметры или входное изображение не может быть обработано.
Пример: исходное изображение не указано в запросе
{ "error": "missing image" }
Пример: заголовок X-Access-Token не установлен и вы пытаетесь выполнить запрос с параметром size: "full"
{ "error": "Токен не задан" }

Примеры запросов

 //Guzzle MULTIPART request - output_format: "image" 
 $client = new HttpClient(["base_uri" => "https://benzin.io"]); 
 $options = [ 
 "multipart" => [ 
   [ 
     "name" => "image_file", "contents" => fopen("your-image.jpg", "r") 
   ], 
   [ 
     "name" => "size", "contents" => "full" 
   ], 
 ], 
   "headers" => [ 
     "X-Access-Token" => "Your Api Key Here" 
   ], 
 ]; 
 $response = $client->post("/api/removeBackground", $options); 
 $fout = fopen("response-image.png", "wb"); 
 fwrite($fout, $response->getBody()); 
 fclose($fout);

 //Guzzle JSON request - output_format: "json" 
 $client = new HttpClient(["base_uri" => "https://benzin.io"]); 
 $options = [ 
 "json" => [ 
 "image_file_url" => "https://www.path/to-image.jpg", 
 "size" => "full", 
 "output_format" => "json" 
 ], 
   "headers" => [ 
     "X-Access-Token" => "Your Api Key Here" 
   ], 
 ]; 
 $response = $client->post("/api/removeBackground", $options); 
 $response->getBody()->getContents();

 //jQuery AJAX client JSON request - output_format: "json" 
 jQuery.ajax({ 
 type: "POST", 
 url: "https://benzin.io/api/removeBackground", 
 dataType: "json", 
 contentType: "application/json", 
 headers:{ 
   "X-Access-Token":"Your Api Key Here" 
 }, 
 data: JSON.stringify({ 
   "image_file_b64": "b64string", "size": "full", "output_format": "json" 
 }), 
 success: function (data) { 
   data = JSON.parse(data); 
 } 
 });

Наш сайт использует cookies:

Подробнее

Все изображения обработаны!