API

Documentação da API REST do serviço SigCleaner.

Cada requisição bem-sucedida para \/api\/clean desconta 1 processamento do saldo da conta.

Método: remoção de fundo

POST https://sigclean.io/api/clean
Autorização
Authorization: Bearer YOUR_API_KEY
Parâmetros da requisição
ParâmetroTipoObrigatórioDescrição
file multipart file Um dos dois Imagem em PNG, JPG ou PDF.
Se o PDF tiver várias páginas, apenas a primeira será processada.
url string Um dos dois Link direto para a imagem
type string Não json (padrão) — retornar JSON com o link do arquivo
webp — retornar arquivo binário WebP com fundo transparente
png — retornar arquivo binário PNG com fundo transparente
extract string Não Extração de um elemento específico. Vazio por padrão — remoção de fundo padrão.
signature — manter apenas a assinatura manuscrita, removendo todo o resto.
stamp — manter apenas o carimbo, removendo todo o resto.
aggressive boolean Não Remoção agressiva de texto.
Quando definido como 1 (true), remove agressivamente todas as letras impressas, números e linhas pretas retas do formulário, mantendo apenas o elemento especificado.
mode string Não Modo de processamento. O padrão é standard.
standard — modo padrão. Funciona bem com imagens de boa qualidade. O resultado fica o mais próximo possível do original.
advanced — modo inteligente. Processamento mais minucioso; ideal para imagens de baixa qualidade ou com muitos elementos indesejados.
name string Não Nome de exibição do arquivo na lista «Meus arquivos». Salvo após o processamento bem-sucedido.
Resposta: 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 }
Resposta: type=webp

Retorna um arquivo binário WebP com fundo transparente. Content-Type: image/webp.

Resposta: type=png

Retorna um arquivo binário PNG com fundo transparente. Content-Type: image/png.

Exemplos 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

Extração de assinatura com remoção agressiva de textos:

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

Método: lista de arquivos

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

Retorna uma lista de todos os arquivos processados com sucesso pertencentes ao usuário atual. Os arquivos estão disponíveis via link /api/file/{uuid}.

Autorização
Authorization: Bearer YOUR_API_KEY
Resposta
{ "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" } ] }
CampoTipoDescrição
uuid string Identificador único do arquivo
name string | null Nome de exibição do arquivo (do parâmetro name em \/api\/clean ou após renomear)
url string Link direto para baixar o arquivo (WebP)
created_at string (ISO 8601) Data e hora de criação do arquivo (UTC)
expires_at string | null Data de expiração do armazenamento (UTC).
Exemplo de cURL
curl https://sigclean.io/api/files \ -H "Authorization: Bearer YOUR_KEY"

Método: exclusão de arquivo

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

Exclui o arquivo do servidor permanentemente. O arquivo deve pertencer ao usuário atual.

Autorização
Authorization: Bearer YOUR_API_KEY
Corpo da requisição application\/json
ParâmetroTipoObrigatórioDescrição
uuid string Sim UUID do arquivo da resposta \/api\/clean ou \/api\/files.
Resposta
{ "status": "ok" }
Códigos de erro
CódigoDescrição
401Não autorizado
404Arquivo não encontrado ou não pertence ao usuário
422uuid ausente ou inválido
Exemplo 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: renomear arquivo

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

Altera o nome de exibição do arquivo. O arquivo deve pertencer ao usuário atual.

Autorização
Authorization: Bearer YOUR_API_KEY
Corpo da requisição application\/json
ParâmetroTipoObrigatórioDescrição
uuid string Sim UUID do arquivo da resposta \/api\/clean ou \/api\/files.
name string Sim Novo nome de exibição do arquivo (até 255 caracteres).
Resposta
{ "status": "ok", "name": "stamp.jpg" }
Códigos de erro
CódigoDescrição
401Não autorizado
404Arquivo não encontrado ou não pertence ao usuário
422uuid \/ name ausente ou inválido
Exemplo 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"}'

Gerenciamento de chaves de API

Para gerenciar as chaves, é necessário fazer login na conta.