API

REST-API-Dokumentation von SigCleaner.

Jede erfolgreiche Anfrage an \/api\/clean zieht 1 Bearbeitung vom Kontoguthaben ab.

Methode: Hintergrundentfernung

POST https://sigclean.io/api/clean
Autorisierung
Authorization: Bearer YOUR_API_KEY
Anfrageparameter
ParameterTypErforderlichBeschreibung
file multipart file Eines von beiden PNG-, JPG- oder PDF-Bild.
Wenn das PDF mehrseitig ist — wird nur die erste Seite verarbeitet.
url string Eines von beiden Direkter Link zum Bild
type string Nein json (Standard) — JSON mit einem Link zur Datei zurückgeben
webp — binäre WebP-Datei mit transparentem Hintergrund zurückgeben
png — binäre PNG-Datei mit transparentem Hintergrund zurückgeben
extract string Nein Extrahieren eines bestimmten Elements. Standardmäßig leer — normale Hintergrundentfernung.
signature — nur die handschriftliche Unterschrift beibehalten und alles andere entfernen.
stamp — nur den Stempelabdruck beibehalten und alles andere entfernen.
aggressive boolean Nein Aggressive Textentfernung.
Wenn auf 1 (true) gesetzt, werden alle gedruckten Buchstaben, Zahlen und geraden schwarzen Formularlinien aggressiv entfernt, sodass nur das angegebene Element übrig bleibt.
mode string Nein Verarbeitungsmodus. Standardmäßig — standard.
standard — Standardmodus. Eignet sich gut für Bilder in guter Qualität. Das Ergebnis kommt dem Original so nah wie möglich.
advanced — intelligenter Modus. Präzisere Verarbeitung; geeignet für Bilder in schlechter Qualität oder mit vielen störenden Elementen.
name string Nein Angezeigter Dateiname in der Liste „Meine Dateien“. Wird bei erfolgreicher Verarbeitung gespeichert.
Antwort: 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 }
Antwort: type=webp

Gibt eine WebP-Binärdatei mit transparentem Hintergrund zurück. Content-Type: image/webp.

Antwort: type=png

Gibt eine PNG-Binärdatei mit transparentem Hintergrund zurück. Content-Type: image/png.

cURL-Beispiele
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

Extrahieren der Unterschrift mit aggressivem Entfernen von Text:

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

Intelligenter Verarbeitungsmodus:

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

Methode: Dateiliste

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

Gibt eine Liste aller erfolgreich verarbeiteten Dateien des aktuellen Benutzers zurück. Die Dateien sind über einen Link abrufbar /api/file/{uuid}.

Autorisierung
Authorization: Bearer YOUR_API_KEY
Antwort
{ "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" } ] }
FeldTypBeschreibung
uuid string Eindeutige Datei-ID
name string | null Angezeigter Dateiname (aus dem Parameter name bei \/api\/clean oder nach Umbenennung)
url string Direkter Download-Link für die Datei (WebP)
created_at string (ISO 8601) Datum und Uhrzeit der Dateierstellung (UTC)
expires_at string | null Ablaufdatum der Speicherung (UTC).
cURL-Beispiel
curl https://sigclean.io/api/files \ -H "Authorization: Bearer YOUR_KEY"

Methode: Datei löschen

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

Löscht die Datei unwiderruflich vom Server. Die Datei muss dem aktuellen Benutzer gehören.

Autorisierung
Authorization: Bearer YOUR_API_KEY
Request-Body application\/json
ParameterTypErforderlichBeschreibung
uuid string Ja Datei-UUID aus der Antwort von \/api\/clean oder \/api\/files.
Antwort
{ "status": "ok" }
Fehlercodes
CodeBeschreibung
401Nicht autorisiert
404Datei nicht gefunden oder gehört nicht dem Benutzer
422Fehlende oder ungültige uuid
cURL-Beispiel
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"}'

Methode: Dateiumbenennung

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

Ändert den angezeigten Dateinamen. Die Datei muss dem aktuellen Benutzer gehören.

Autorisierung
Authorization: Bearer YOUR_API_KEY
Request-Body application\/json
ParameterTypErforderlichBeschreibung
uuid string Ja Datei-UUID aus der Antwort von \/api\/clean oder \/api\/files.
name string Ja Neuer angezeigter Dateiname (bis zu 255 Zeichen).
Antwort
{ "status": "ok", "name": "stamp.jpg" }
Fehlercodes
CodeBeschreibung
401Nicht autorisiert
404Datei nicht gefunden oder gehört nicht dem Benutzer
422Fehlende oder ungültige uuid \/ name
cURL-Beispiel
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-Schlüsselverwaltung

Sie müssen sich anmelden, um Schlüssel zu verwalten.