API
Документація REST API сервісу SigCleaner.
Метод: видалення фону
POST https://sigclean.io/api/clean
Авторизація
Authorization: Bearer YOUR_API_KEY
Параметри запиту
| Параметр | Тип | Обов'язковий | Опис |
|---|---|---|---|
file |
multipart file | Один із двох | Зображення у форматі PNG, JPG або PDF |
url |
string | Один із двох | Пряме посилання на зображення |
type |
string | Ні | json (за замовчуванням) — повернути JSON із посиланнямwebp — вернуть бинарный файл WebP с прозрачным фономpng — вернуть бинарный файл PNG с прозрачным фоном |
Відповідь: 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
Завантажити результат
GET https://sigclean.io/api/file/{uuid}
Метод: список файлів
GET https://sigclean.io/api/files
Повертає список усіх успішно оброблених файлів, що належать поточному користувачеві. Файли доступні за посиланням /api/file/{uuid}.
Авторизація
Bearer-токен або активна сесія (cookie). Без авторизації повертає 401.
Authorization: Bearer YOUR_API_KEY
Відповідь
{
"status": "ok",
"files": [
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"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 | Унікальний ідентифікатор файлу |
url |
string | Пряме посилання для завантаження файлу (WebP) |
created_at |
string (ISO 8601) | Дата та час створення файлу (UTC) |
expires_at |
string | null | Дата закінчення терміну зберігання (UTC). null — файл зберігається безстроково (авторизовані користувачі). Для гостей — created_at + 1 рік. |
Приклад cURL
curl https://sigclean.io/api/files \
-H "Authorization: Bearer YOUR_KEY"
Метод: видалення файлу
POST https://sigclean.io/api/files/delete
Безповоротно видаляє файл із сервера. Файл повинен належати поточному користувачеві.
Авторизація
Bearer-токен або активна сесія (cookie). Без авторизації повертає 401.
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"}'
Керування ключами API
Для керування ключами необхідно увійти в акаунт.