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

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