API

Документация REST API сервиса SigCleaner.

Каждый успешный запрос /api/clean списывает 1 обработку с баланса аккаунта.

Метод: удаление фона

POST https://sigclean.io/api/clean
Авторизация
Authorization: Bearer YOUR_API_KEY
Параметры запроса
ПараметрТипОбязателенОписание
file multipart file Один из двух PNG, JPG или PDF изображение.
Если PDF многостраничный — обрабатывается только первая страница.
url string Один из двух Прямая ссылка на изображение
type string Нет json (по умолчанию) — вернуть JSON со ссылкой на файл
webp — вернуть бинарный файл WebP с прозрачным фоном
png — вернуть бинарный файл PNG с прозрачным фоном
extract string Нет Извлечение конкретного элемента. По умолчанию пусто — стандартное удаление фона.
signature — сохранить только рукописную подпись, удалив всё остальное.
stamp — сохранить только оттиск печати, удалив всё остальное.
aggressive boolean Нет Агрессивное удаление надписей.
Когда установлен в 1 (true), агрессивно удаляет все напечатанные буквы, цифры и прямые чёрные линии бланка, оставляя только указанный элемент.
mode string Нет Режим обработки. По умолчанию — standard.
standard — стандартный режим. Хорошо справляется с изображениями хорошего качества. Результат максимально приближен к оригиналу.
advanced — интеллектуальный режим. Более тщательная обработка; подходит для изображений плохого качества или со множеством посторонних элементов.
name string Нет Отображаемое имя файла в списке «Мои файлы». Сохраняется при успешной обработке.
Ответ: type=json
{ "status": "ok", "uuid": "550e8400-e29b-41d4-a716-446655440000", "url": "https://sigclean.io/api/file/550e8400-e29b-41d4-a716-446655440000", "remaining": 9, "limit": 10 }
Ответ: type=webp

Возвращает бинарный файл WebP с прозрачным фоном. Content-Type: image/webp.

Ответ: type=png

Возвращает бинарный файл PNG с прозрачным фоном. Content-Type: image/png.

Примеры cURL
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=json"
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=png" \ --output result.png
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=webp" \ --output result.webp

Извлечение подписи с агрессивным удалением надписей:

curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@document.jpg" \ -F "type=png" \ -F "extract=signature" \ -F "aggressive=1" \ --output signature.png

Интеллектуальный режим обработки:

curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=png" \ -F "mode=advanced" \ --output result.png
Скачать результат
GET https://sigclean.io/api/file/{uuid}

Метод: список файлов

GET https://sigclean.io/api/files

Возвращает список всех успешно обработанных файлов, принадлежащих текущему пользователю. Файлы доступны по ссылке /api/file/{uuid}.

Авторизация
Authorization: Bearer YOUR_API_KEY
Ответ
{ "status": "ok", "files": [ { "uuid": "550e8400-e29b-41d4-a716-446655440000", "name": "stamp.jpg", "url": "https://sigclean.io/api/file/550e8400-e29b-41d4-a716-446655440000", "created_at": "2026-07-01T10:00:00Z", "expires_at": "2027-07-01T10:00:00Z" } ] }
ПолеТипОписание
uuid string Уникальный идентификатор файла
name string | null Отображаемое имя файла (из параметра name при /api/clean или после переименования)
url string Прямая ссылка для скачивания файла (WebP)
created_at string (ISO 8601) Дата и время создания файла (UTC)
expires_at string | null Дата истечения хранения (UTC).
Пример cURL
curl https://sigclean.io/api/files \ -H "Authorization: Bearer YOUR_KEY"

Метод: удаление файла

POST https://sigclean.io/api/files/delete

Удаляет файл с сервера безвозвратно. Файл должен принадлежать текущему пользователю.

Авторизация
Authorization: Bearer YOUR_API_KEY
Тело запроса application/json
ПараметрТипОбязателенОписание
uuid string Да UUID файла из ответа /api/clean или /api/files.
Ответ
{ "status": "ok" }
Коды ошибок
КодОписание
401Не авторизован
404Файл не найден или не принадлежит пользователю
422Не передан или некорректный uuid
Пример cURL
curl -X POST https://sigclean.io/api/files/delete \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"uuid":"550e8400-e29b-41d4-a716-446655440000"}'

Метод: переименование файла

POST https://sigclean.io/api/files/rename

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

Авторизация
Authorization: Bearer YOUR_API_KEY
Тело запроса application/json
ПараметрТипОбязателенОписание
uuid string Да UUID файла из ответа /api/clean или /api/files.
name string Да Новое отображаемое имя файла (до 255 символов).
Ответ
{ "status": "ok", "name": "stamp.jpg" }
Коды ошибок
КодОписание
401Не авторизован
404Файл не найден или не принадлежит пользователю
422Не передан или некорректный uuid / name
Пример cURL
curl -X POST https://sigclean.io/api/files/rename \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"uuid":"550e8400-e29b-41d4-a716-446655440000","name":"stamp.jpg"}'

Управление ключами API

Для управления ключами необходимо войти в аккаунт.