API

Documentación de la API REST de SigCleaner.

Cada solicitud exitosa a \/api\/clean descuenta 1 procesamiento del saldo de la cuenta.

Método: eliminación de fondo

POST https://sigclean.io/api/clean
Autorización
Authorization: Bearer YOUR_API_KEY
Parámetros de la solicitud
ParámetroTipoObligatorioDescripción
file multipart file Uno de los dos Imagen PNG, JPG o PDF.
Si el PDF tiene varias páginas — solo se procesa la primera.
url string Uno de los dos Enlace directo a la imagen
type string No json (por defecto) — devuelve un JSON con el enlace al archivo
webp — devuelve un archivo binario WebP con fondo transparente
png — devuelve un archivo binario PNG con fondo transparente
extract string No Extracción de un elemento específico. Vacío por defecto — eliminación de fondo estándar.
signature — conserva solo la firma manuscrita, eliminando todo lo demás.
stamp — conserva solo el sello, eliminando todo lo demás.
aggressive boolean No Eliminación agresiva de texto.
Cuando se establece en 1 (true), elimina de forma agresiva todas las letras impresas, números y líneas negras rectas del formulario, dejando solo el elemento especificado.
mode string No Modo de procesamiento. Por defecto — standard.
standard — modo estándar. Funciona bien con imágenes de buena calidad. El resultado es lo más fiel posible al original.
advanced — modo inteligente. Procesamiento más exhaustivo; ideal para imágenes de baja calidad o con muchos elementos no deseados.
name string No Nombre de archivo mostrado en la lista «Mis archivos». Se guarda tras un procesamiento exitoso.
Respuesta: 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 }
Respuesta: type=webp

Devuelve un archivo binario WebP con fondo transparente. Content-Type: image/webp.

Respuesta: type=png

Devuelve un archivo binario PNG con fondo transparente. Content-Type: image/png.

Ejemplos de 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

Extracción de firma con eliminación agresiva de texto:

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

Modo de procesamiento inteligente:

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
Descargar resultado
GET https://sigclean.io/api/file/{uuid}

Método: lista de archivos

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

Devuelve una lista de todos los archivos procesados correctamente que pertenecen al usuario actual. Los archivos están disponibles a través del enlace /api/file/{uuid}.

Autorización
Authorization: Bearer YOUR_API_KEY
Respuesta
{ "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" } ] }
CampoTipoDescripción
uuid string Identificador único del archivo
name string | null Nombre de archivo mostrado (del parámetro name en \/api\/clean o después de renombrarlo)
url string Enlace directo para descargar el archivo (WebP)
created_at string (ISO 8601) Fecha y hora de creación del archivo (UTC)
expires_at string | null Fecha de expiración del almacenamiento (UTC).
Ejemplo de cURL
curl https://sigclean.io/api/files \ -H "Authorization: Bearer YOUR_KEY"

Método: eliminación de archivo

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

Elimina el archivo del servidor de forma permanente. El archivo debe pertenecer al usuario actual.

Autorización
Authorization: Bearer YOUR_API_KEY
Cuerpo de la solicitud application\/json
ParámetroTipoObligatorioDescripción
uuid string Sí UUID del archivo de la respuesta \/api\/clean o \/api\/files.
Respuesta
{ "status": "ok" }
Códigos de error
CódigoDescripción
401No autorizado
404Archivo no encontrado o no pertenece al usuario
422Falta el uuid o no es válido
Ejemplo de 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"}'

Método: renombrado de archivo

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

Cambia el nombre de archivo mostrado. El archivo debe pertenecer al usuario actual.

Autorización
Authorization: Bearer YOUR_API_KEY
Cuerpo de la solicitud application\/json
ParámetroTipoObligatorioDescripción
uuid string Sí UUID del archivo de la respuesta \/api\/clean o \/api\/files.
name string Sí Nuevo nombre de archivo mostrado (hasta 255 caracteres).
Respuesta
{ "status": "ok", "name": "stamp.jpg" }
Códigos de error
CódigoDescripción
401No autorizado
404Archivo no encontrado o no pertenece al usuario
422Falta el uuid \/ name o no es válido
Ejemplo de 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"}'

Gestión de claves API

Debes iniciar sesión para gestionar las claves.