Anymize API Dokumentation

API Übersicht

Die Anymize API ermöglicht die programmatische Anonymisierung von Texten und Dokumenten. Alle Anfragen erfordern eine Authentifizierung via API-Schlüssel.

Anonymisierung

Texte und Dokumente automatisch anonymisieren mit KI-gestützter Erkennung sensibler Daten.

Export

Dokumente als PDF, DOCX oder TXT exportieren - mit oder ohne LLM-Prompts.

Ent-Schlüsselung

Anonymisierte Texte wieder in Originaldaten zurückverwandeln.

OCR

PDFs und Bilder mit OCR verarbeiten und automatisch anonymisieren.

Base URL

https://app.anymize.ai/api

Authentifizierung

Alle API-Anfragen müssen einen gültigen API-Schlüssel im Authorization-Header enthalten.

Header Format

http

Authorization: Bearer YOUR_API_KEY

Sicherheitshinweis

Bewahren Sie Ihren API-Schlüssel sicher auf und teilen Sie ihn niemals öffentlich. Der Schlüssel gewährt vollen Zugriff auf Ihr Konto.

Beispiel-Request

bash

curl -X POST https://app.anymize.ai/api/anonymize \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "Max Mustermann"}'

Text Anonymisierung

Startet die Anonymisierung eines Textes. Der Prozess läuft asynchron.

POST /api/anonymize

Anonymisiert einen Text und gibt eine Job-ID zurück.

Request Body

json

{
  "text": "Mein Name ist Max Mustermann und ich wohne in Berlin.",
  "language": "de"  // Optional: de, en, fr, es, it
}

cURL Beispiel

bash

curl -X POST https://app.anymize.ai/api/anonymize \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Mein Name ist Max Mustermann und ich wohne in Berlin.",
    "language": "de"
  }'

Response (202 Accepted)

json

{
  "job_id": "12345678-abcd-efgh-ijkl-123456789000",
  "status": "processing",
  "message": "Job created successfully. Use /api/status/{job_id} to check status."
}

POST /api/ocr

Verarbeitet ein Dokument mit OCR und anonymisiert den extrahierten Text.

cURL Beispiel

bash

curl -X POST https://app.anymize.ai/api/ocr \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@/pfad/zu/dokument.pdf"

Unterstützte Formate: PDF, PNG, JPG, JPEG, GIF, BMP, TIFF, DOCX

Status Abfrage

Prüft den Status eines Jobs und gibt das Ergebnis zurück.

GET /api/status/{job_id}

Gibt den aktuellen Status und bei Abschluss das vollständige Ergebnis zurück.

cURL Beispiel

bash

curl -X GET https://app.anymize.ai/api/status/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY"

Response (Verarbeitung läuft)

json

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "processing"
}

Response (Abgeschlossen)

json

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "anonymized_text_raw": "Mein Name ist [[Name-abc123]] und ich wohne in [[Stadt-def456]].",
  "original_text": "Mein Name ist Max Mustermann und ich wohne in Berlin.",
  "metadata": {
    "filename": "API Text Input",
    "language": "de",
    "words": 10
  }
}

Dokument Export

Exportiert Dokumente in verschiedenen Formaten mit konfigurierbaren Optionen.

GET /api/jobs/{job_id}/export

Lädt ein Dokument als PDF, DOCX oder TXT herunter.

Query Parameter

Parameter	Optionen	Standard
format	pdf, docx, txt	pdf
textType	anonymized, original	anonymized
includePrompts	true, false	false
language	de, en, fr, it, es	de

Beispiele

Anonymisiertes PDF:

bash

curl -X GET "https://app.anymize.ai/api/jobs/{job_id}/export?format=pdf&textType=anonymized" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o document.pdf

Original-Text als DOCX mit Prompts:

bash

curl -X GET "https://app.anymize.ai/api/jobs/{job_id}/export?format=docx&textType=original&includePrompts=true" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o document.docx

Tipp: Mit includePrompts=true werden LLM-Verarbeitungsanweisungen zum Dokument hinzugefügt, um die korrekte Verwendung der Platzhalter sicherzustellen.

Text Ent-Schlüsselung

Entschlüsselt anonymisierte Texte und stellt die Originaldaten wieder her.

POST /api/deanonymize

Ersetzt Platzhalter durch die ursprünglichen Werte.

Request Body

json

{
  "text": "Mein Name ist [[Name-abc123]] und ich wohne in [[Stadt-def456]]."
}

cURL Beispiel

bash

curl -X POST https://app.anymize.ai/api/deanonymize \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Mein Name ist [[Name-abc123]] und ich wohne in [[Stadt-def456]]."
  }'

Response

json

{
  "text": "Mein Name ist Max Mustermann und ich wohne in Berlin."
}

Wichtig: Die Ent-Schlüsselung funktioniert nur für Texte, die mit Ihrem Account anonymisiert wurden.

Hash-Paare abrufen

Ruft alle Zuordnungen zwischen Original-Werten und Platzhaltern ab.

GET /api/status/{job_id}/strings

Gibt alle Hash-Paare eines Jobs zurück.

cURL Beispiel

bash

curl -X GET https://app.anymize.ai/api/status/550e8400-e29b-41d4-a716-446655440000/strings \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

json

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "count": 2,
  "hash_pairs": [
    {
      "original": "Max Mustermann",
      "hash": "abc123",
      "prefix_name": "Name",
      "placeholder": "[[Name-abc123]]"
    },
    {
      "original": "Berlin",
      "hash": "def456",
      "prefix_name": "Stadt",
      "placeholder": "[[Stadt-def456]]"
    }
  ]
}

Format: Platzhalter folgen dem Schema [[Kategorie-Hash]]

Fehlerbehandlung

Die API verwendet Standard HTTP-Statuscodes und einheitliche Fehler-Responses.

HTTP Status Codes

200 OK Erfolgreiche Anfrage

202 Accepted Asynchrone Verarbeitung gestartet

400 Bad Request Ungültige Anfrage oder Parameter

401 Unauthorized Fehlender oder ungültiger API-Schlüssel

404 Not Found Ressource nicht gefunden

429 Too Many Requests Rate-Limit überschritten

500 Server Error Interner Serverfehler

Fehler Response Format

json

{
  "error": "Beschreibung des Fehlers",
  "code": "ERROR_CODE",
  "details": {}  // Optional
}