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
Для управления ключами необходимо войти в аккаунт.