API DocsWissensdatenbanken

Wissensdatenbanken

Wissensdatenbanken per API erstellen, Dokumente hochladen, RAG-Suche durchführen.

Knowledge Base API

Erstelle vollständig verwaltete RAG-Wissensdatenbanken per API. Wir übernehmen Vektorisierung, Embedding-Modelle und Reranking — du musst dich um nichts kümmern.

Unterstützte Dateiformate

Lade verschiedene Dokumenttypen und YouTube-Videos in deine Wissensdatenbank hoch.

PDF

DOCX

PPTX

XLSX

TXT

CSV

HTML

JSON

PNG

JPG

YouTube

Limits

Folgende Limits gelten für Knowledge Bases.

Ressource	Limit
Dateigröße	100 MB
Dateien pro KB	30
KBs pro Nutzer	20
Tokens pro KB	1,000,000

Credits

Nur anonymisierte Dokumente kosten Credits (1 Wort = 1 Credit). Nicht-anonymisierte Uploads und Suchen sind kostenlos.

Schnellstart

In vier Schritten zur RAG-fähigen Wissensdatenbank:

1Knowledge Base erstellen

2Dokumente hochladen

3Verarbeitung abwarten

4Wissensdatenbank durchsuchen

Erstellen

Knowledge Base erstellen

Erstelle eine neue Wissensdatenbank, um Dokumente zu organisieren und per RAG durchsuchbar zu machen.

POST/api/v1/knowledge-bases

Parameter

Parameter	Type	Default	Description
`name`required	`string`	-	Name der Wissensdatenbank
`description`	`string`	-	Optionale Beschreibung

Beispiel

1curl -X POST https://app.anymize.ai/api/v1/knowledge-bases \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY" \
3  -H #86efac">"Content-Type: application/json" \
4  -d '{
5    #86efac">"name": "Product Documentation",
6    #86efac">"description": "All product docs"
7  }'

Antwort

Bei Erfolg wird die erstellte Wissensdatenbank mit ihrer ID zurückgegeben.

201Created

{
  "success": true,
  "knowledgeBase": {
    "id": "kb_abc123",
    "name": "Product Documentation",
    "description": "All product docs",
    "rag_status": "pending",
    "rag_progress": 0,
    "doc_count": 0,
    "created_at": "2025-01-15T10: 30: 00Z"
  }
}

Auflisten

Knowledge Bases auflisten

Listet alle Wissensdatenbanken auf, die dir gehören oder auf die du Zugriff hast.

GET/api/v1/knowledge-bases

Authentifizierung

Nutze deinen API-Key im Authorization-Header.

Hinweis

Wissensdatenbanken, die per API erstellt werden, sind auch im Chat verfügbar — und umgekehrt.

Antwort

Gibt ein Array aller Wissensdatenbanken mit Status und Statistiken zurück.

200OK

{
  "list": [
    {
      "id": "kb_abc123",
      "name": "Product Documentation",
      "description": "All product docs",
      "rag_status": "completed",
      "rag_progress": 100,
      "doc_count": 5,
      "chunk_count": 234,
      "total_tokens": 45200,
      "role": "owner",
      "created_at": "2025-01-15T10: 30: 00Z"
    }
  ],
  "total": 1
}

Antwortfelder

Jede Wissensdatenbank enthält folgende Felder.

Feld	Typ	Beschreibung
`id`	`string`	Eindeutige ID der Wissensdatenbank
`name`	`string`	Name der Wissensdatenbank
`description`	`string`	Beschreibung der Wissensdatenbank
`rag_status`	`string`	Verarbeitungsstatus (pending, processing, completed, failed)
`rag_progress`	`number`	Fortschritt in Prozent (0–100)
`doc_count`	`number`	Anzahl der Dokumente
`chunk_count`	`number`	Anzahl der erstellten Chunks
`total_tokens`	`number`	Gesamtzahl der Tokens
`role`	`string`	Deine Rolle (owner, editor, viewer)
`created_at`	`string`	Erstellungszeitpunkt

Beispiel

1curl https://app.anymize.ai/api/v1/knowledge-bases \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY"

Details

Knowledge Base abrufen

Ruft Details einer Wissensdatenbank ab, einschließlich Dokumentliste, Chunk-Statistiken und Gesundheitsstatus.

GET/api/v1/knowledge-bases/{id}

Parameter

Parameter	Type	Default	Description
`id`required	`string`	-	ID der Wissensdatenbank

Antwort

Gibt die Wissensdatenbank mit Dokumenten und Chunk-Statistiken zurück.

200OK

{
  "knowledgeBase": {
    "id": "kb_abc123",
    "name": "Product Documentation",
    "description": "All product docs",
    "summary": "Contains product guides, API references, and FAQ documents.",
    "rag_status": "completed",
    "health": "healthy",
    "documents": [
      {
        "id": "doc_xyz789",
        "name": "getting-started.pdf",
        "status": "processed",
        "chunk_count": 42,
        "token_count": 8500,
        "created_at": "2025-01-15T10: 35: 00Z"
      }
    ],
    "chunkStats": {
      "total_chunks": 234,
      "total_tokens": 45200,
      "avg_tokens_per_chunk": 193
    },
    "created_at": "2025-01-15T10: 30: 00Z",
    "updated_at": "2025-01-16T14: 20: 00Z"
  }
}

Beispiel

1curl https://app.anymize.ai/api/v1/knowledge-bases/kb_abc123 \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY"

Knowledge Base aktualisieren

Aktualisiere Name oder Beschreibung einer Wissensdatenbank.

PATCH/api/v1/knowledge-bases/{id}

Parameter

Parameter	Type	Default	Description
`id`required	`string`	-	ID der Wissensdatenbank
`name`	`string`	-	Neuer Name
`description`	`string`	-	Neue Beschreibung

Antwort

200OK

{
  "knowledgeBase": {
    "id": "kb_abc123",
    "name": "Updated Documentation",
    "description": "Revised product docs",
    "rag_status": "completed",
    "updated_at": "2025-01-17T09: 15: 00Z"
  }
}

Beispiel

1curl -X PATCH https://app.anymize.ai/api/v1/knowledge-bases/kb_abc123 \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY" \
3  -H #86efac">"Content-Type: application/json" \
4  -d '{
5    #86efac">"name": "Updated Documentation",
6    #86efac">"description": "Revised product docs"
7  }'

Knowledge Base löschen

Löscht eine Wissensdatenbank und alle zugehörigen Embeddings. Nur der Eigentümer kann löschen.

DELETE/api/v1/knowledge-bases/{id}

Achtung

Das Löschen entfernt alle Embeddings und Chunks. Die originalen Dokumente bleiben erhalten.

Parameter

Parameter	Type	Default	Description
`id`required	`string`	-	ID der Wissensdatenbank

Antwort

200OK

{
  "success": true
}

Beispiel

1curl -X DELETE https://app.anymize.ai/api/v1/knowledge-bases/kb_abc123 \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY"

Dokumente hochladen

Lade Dateien oder YouTube-Videos in eine Wissensdatenbank hoch. Unterstützt multipart/form-data für Dateien und application/json für YouTube-URLs.

POST/api/v1/knowledge-bases/:id/upload

Upload-Modi

Der Endpoint unterstützt zwei Modi: Datei-Upload (multipart/form-data) und YouTube-URL (application/json).

Unterstützte Dateitypen

PDF, DOCX, PPTX, XLSX, TXT, MD, CSV, HTML, JSON, PNG, JPG und weitere Bildformate.

Datei-Upload Parameter

Sende die Datei als multipart/form-data mit folgenden Feldern.

Parameter	Type	Default	Description
`file`required	`File`	-	Die hochzuladende Datei (max. 100 MB)
`with_anonymization`	`string`	`"false"`	Datei vor dem Hinzufügen zur KB anonymisieren. Kostet Credits.
`auto_process`	`string`	`"true"`	RAG-Verarbeitung automatisch starten, wenn alle Dokumente bereit sind.

Credits

Anonymisierte Uploads kosten Credits (1 Wort = 1 Credit). Nicht-anonymisierte Uploads sind kostenlos.

Datei-Upload Beispiel

1curl -X POST https://app.anymize.ai/api/v1/knowledge-bases/kb_abc123/upload \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY" \
3  -F #86efac">"file=@product-guide.pdf" \
4  -F #86efac">"with_anonymization=false" \
5  -F #86efac">"auto_process=true"

Datei-Upload Antwort

Gibt die Job-ID und den Status zurück. Nutze den Status-Endpoint, um den Fortschritt zu prüfen.

201Created

{
  "job_id": "job_abc123",
  "status": "pending",
  "filename": "product-guide.pdf",
  "with_anonymization": false,
  "message": "File uploaded to knowledge base"
}

YouTube-URL Parameter

Sende die YouTube-URL als JSON-Body.

Parameter	Type	Default	Description
`youtube_url`required	`string`	-	Vollständige YouTube-URL (youtube.com/watch?v=..., youtu.be/...)
`auto_process`	`boolean`	`true`	RAG-Verarbeitung automatisch starten

Tipp

YouTube-Transkripte werden automatisch extrahiert. Bei längeren Videos kann die Verarbeitung einen Moment dauern.

YouTube-Upload Beispiel

1curl -X POST https://app.anymize.ai/api/v1/knowledge-bases/kb_abc123/upload \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY" \
3  -H #86efac">"Content-Type: application/json" \
4  -d '{
5    #86efac">"youtube_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
6    #86efac">"auto_process": true
7  }'

YouTube-Upload Antwort

Gibt die Job-ID, den Titel des Videos und den Status zurück.

201Created

{
  "job_id": "job_def456",
  "status": "completed",
  "title": "Product Overview Video",
  "message": "YouTube video added to knowledge base"
}

Dokumente verwalten

Dokumente auflisten

Listet alle Dokumente einer Wissensdatenbank mit Chunk-Zählung und Anonymisierungsstatus auf.

GET/api/v1/knowledge-bases/:id/documents

Antwort

Gibt ein Array der Dokumente mit Metadaten zurück.

200OK

{
  "documents": [
    {
      "id": "job_abc123",
      "filename": "product-guide.pdf",
      "status": "completed",
      "is_anonymized": false,
      "chunk_count": 45,
      "added_at": "2025-01-15T10: 30: 00Z"
    }
  ],
  "total": 1
}

Dokumentfelder

Jedes Dokument enthält folgende Felder.

Feld	Typ	Beschreibung
`id`	`string`	Eindeutige Dokument-ID
`filename`	`string`	Dateiname des Dokuments
`status`	`string`	Verarbeitungsstatus (pending, completed, failed)
`is_anonymized`	`boolean`	Ob das Dokument anonymisiert wurde
`chunk_count`	`number`	Anzahl der erstellten Chunks
`added_at`	`string`	Zeitpunkt des Hinzufügens zur KB

Beispiel

1curl https://app.anymize.ai/api/v1/knowledge-bases/kb_abc123/documents \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY"

Dokumente entfernen

Entfernt Dokumente aus einer Wissensdatenbank und löscht die zugehörigen Embeddings.

DELETE/api/v1/knowledge-bases/:id/documents

Parameter

Parameter	Type	Default	Description
`jobIds`required	`string[]`	-	Array von Dokument-IDs, die entfernt werden sollen

Achtung

Entfernte Dokumente verlieren ihre Embeddings und Chunks in dieser Wissensdatenbank.

Beispiel

1curl -X DELETE https://app.anymize.ai/api/v1/knowledge-bases/kb_abc123/documents \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY" \
3  -H #86efac">"Content-Type: application/json" \
4  -d '{
5    #86efac">"jobIds": ["job_abc123", "job_def456"]
6  }'

Antwort

Gibt die Anzahl entfernter und verbleibender Dokumente zurück.

200OK

{
  "success": true,
  "removed": 1,
  "remaining": 4
}

Verarbeitung

Verarbeitung starten

Startet die RAG-Verarbeitung für eine Wissensdatenbank. Erstellt Chunks, Embeddings und die Hierarchie.

POST/api/v1/knowledge-bases/:id/process

Parameter

Parameter	Type	Default	Description
`buildHierarchy`	`boolean`	`true`	Mehrstufige Chunk-Hierarchie erstellen (Level 1/2/3)
`generateSummary`	`boolean`	`true`	KI-generierte Zusammenfassung der KB erstellen

Antwort

Gibt den Verarbeitungsstatus zurück. Nutze GET, um den Fortschritt zu prüfen.

202Processing Started

{
  "success": true,
  "status": "processing",
  "message": "Processing started. Use GET to poll status."
}

Hinweis

Die Verarbeitung läuft asynchron. Nutze den GET-Endpoint, um den Fortschritt abzurufen. Statuswerte: pending, processing, completed, failed.

Beispiel

1curl -X POST https://app.anymize.ai/api/v1/knowledge-bases/kb_abc123/process \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY" \
3  -H #86efac">"Content-Type: application/json" \
4  -d '{
5    #86efac">"buildHierarchy": true,
6    #86efac">"generateSummary": true
7  }'

Verarbeitungsstatus abfragen

Ruft den aktuellen Verarbeitungsstatus einer Wissensdatenbank ab.

GET/api/v1/knowledge-bases/:id/process

Antwort

Gibt Fortschritt, Token-Anzahl und Chunk-Statistiken zurück.

200Processing Status

{
  "status": "completed",
  "progress": 100,
  "total_docs": 5,
  "processed_docs": 5,
  "total_tokens": 45200,
  "chunk_count": 234,
  "has_summary": true,
  "error": null
}

Beispiel

1curl https://app.anymize.ai/api/v1/knowledge-bases/kb_abc123/process \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY"

Tipp

Füge ?force=true hinzu, um eine KB erneut zu verarbeiten, auch wenn sie bereits abgeschlossen ist.

Suche

Wissensdatenbank durchsuchen

Führe eine semantische Suche mit Vektorsuche, Reranking und hierarchischer Anreicherung durch.

POST/api/v1/rag/search

Parameter

Parameter	Type	Default	Description
`knowledgeBaseId`required	`string`	-	ID der zu durchsuchenden Wissensdatenbank
`query`required	`string`	-	Suchanfrage in natürlicher Sprache
`topK`	`number`	`5`	Anzahl der Ergebnisse (Standard: 5)
`useHierarchy`	`boolean`	`true`	Hierarchische Chunk-Anreicherung für mehr Kontext
`useReranking`	`boolean`	`true`	Voyage Reranker für bessere Relevanz

Voraussetzung

Die Wissensdatenbank muss den Status 'completed' haben, bevor sie durchsucht werden kann. Gibt 422 zurück, wenn sie noch nicht bereit ist.

Antwort

Gibt Suchergebnisse mit Relevanz-Scores, Quellenangaben und Timing-Statistiken zurück.

200Search Results

{
  "query": "How does the product authentication work?",
  "results": [
    {
      "content": "Authentication is handled via OAuth 2.0...",
      "relevance_score": 0.92,
      "metadata": {
        "source_file": "auth-guide.pdf",
        "document_title": "Authentication Guide",
        "page": 3
      }
    }
  ],
  "total": 3,
  "stats": {
    "vector_search_time_ms": 45,
    "reranking_time_ms": 120,
    "total_time_ms": 180
  }
}

Beispiel

1curl -X POST https://app.anymize.ai/api/v1/rag/search \
2  -H #86efac">"Authorization: Bearer YOUR_API_KEY" \
3  -H #86efac">"Content-Type: application/json" \
4  -d '{
5    #86efac">"knowledgeBaseId": "kb_abc123",
6    #86efac">"query": "How does authentication work?",
7    #86efac">"topK": 5,
8    #86efac">"useHierarchy": true,
9    #86efac">"useReranking": true
10  }'