Entwickler-API
Eine HTTP-API erlaubt, WivenLLM in Ihre Anwendungen zu integrieren: Bereiche befüllen, Fragen stellen, Benutzer verwalten, Gespräche auswerten.
Verfügbar bei Server- oder gehosteter Bereitstellung. In der Desktop-Anwendung antwortet sie nur vom Rechner selbst aus.
Authentifizierung
Erstellen Sie einen Schlüssel unter Einstellungen → Sicherheit → API-Schlüssel. Er wird nur bei der Erstellung angezeigt.
Jede Anfrage trägt den Schlüssel im Header Authorization:
Authorization: Bearer IHR_API_SCHLUESSEL
Ein Schlüssel gibt vollständigen Zugriff auf die API, einschliesslich der Konfiguration der Instanz. Erstellen Sie einen pro Integration, widerrufen Sie nicht mehr Benötigtes und veröffentlichen Sie Schlüssel nie in geteiltem Code. Erstellen und Löschen von Schlüsseln werden protokolliert.
Ein Schlüssel handelt für die Instanz, ohne Person dahinter. Er ist an keinen Benutzer gebunden und hat keinen Geltungsbereich pro Bereich. Er sieht alle Dokumente, auch jene, die namentlich genannten Personen vorbehalten sind. Behandeln Sie ihn entsprechend: Die Anwendung, die ihn hält, muss selbst filtern, was sie ihren Benutzern zeigt.
Kontingent und Durchsatz. Das tägliche Nachrichtenkontingent eines Benutzers gilt nicht für die API. Es gilt nur eine Durchsatzgrenze: 600 Anfragen pro 15 Minuten und Schlüssel, bei der Installation einstellbar.
Interaktive Dokumentation
Eine interaktive API-Dokumentation wird von der Instanz selbst bereitgestellt. Sie listet alle Endpunkte mit ihren Parametern auf und erlaubt, sie auszuprobieren. Sie ist die aktuelle Referenz Ihrer Version.
Sie kann im Produktivbetrieb deaktiviert werden.
Wichtigste Endpunkte
Die API deckt das Wesentliche der Anwendung ab. Die Familien von Endpunkten:
| Familie | Was sie ermöglicht |
|---|---|
| Arbeitsbereiche | Bereiche auflisten, erstellen, einstellen und löschen; Dokumente einem Bereich hinzufügen oder daraus entfernen; ein Dokument anheften |
| Gespräch | Einem Bereich eine Frage stellen, als vollständige Antwort oder fortlaufend gestreamt; den Verlauf lesen; nur eine Dokumentsuche ohne Generierung starten |
| Gesprächsfäden | Einen Faden erstellen, darin schreiben, seinen Verlauf lesen, ihn löschen |
| Dokumente | Eine Datei hochladen, eine URL importieren, Rohtext einspeisen, Dokumente und unterstützte Formate auflisten, Ordner organisieren |
| Administration | Benutzer, Einladungen, Mitglieder der Bereiche und Gespräche der Instanz (Mehrbenutzermodus) |
| Widgets, System, Tickets | Verwaltung der Widgets und ihrer Gespräche, Informationen zur Instanz, Export der Gespräche, interne Rückruf-Tickets |
Jede Gesprächsanfrage gibt den Arbeitsbereich und den mode (chat, query oder automatic) an. Die Antwort enthält den erzeugten Text und die verwendeten Quellen. Die reine Dokumentsuche ist nützlich, wenn Sie die relevanten Passagen finden und selbst verarbeiten wollen, ohne über ein Modell zu gehen.
Zur Erinnerung: Hochladen macht ein Dokument nicht abfragbar. Es muss danach einem Arbeitsbereich hinzugefügt werden.
Eine Nachricht mit dem Präfix @agent startet einen Agenten, in einem einzigen Austausch. Niemand kann dann auf eine Bestätigungskarte antworten: Jede Aktion, die eine verlangt, wird abgelehnt, ausser sie wurde vorab bestätigt. Aktionen ohne Bestätigung (SQL-Abfragen, MCP-Tools, Abläufe) werden normal ausgeführt.
Die vollständige Liste der Endpunkte mit ihren Parametern finden Sie in der interaktiven Dokumentation Ihrer Instanz.
OpenAI-Kompatibilität
Eine Reihe von Endpunkten bildet die Schnittstelle des OpenAI-Standards nach: Chat Completions, Embeddings, Modellliste, Bildgenerierung und Vector Stores.
Der Vorteil: Eine bereits für diesen Standard geschriebene Anwendung funktioniert mit WivenLLM, indem Basisadresse und Schlüssel geändert werden. Der Modellname entspricht dem abzufragenden Arbeitsbereich, sodass dessen Dokumentkontext genutzt wird.
Das ist der kürzeste Weg, ein bestehendes Tool an Ihre private Dokumentbasis anzubinden.
Der Systemprompt des Clients ersetzt jenen des Bereichs. Enthält die Anfrage eine Nachricht system, tritt sie vollständig an die Stelle des Systemprompts des Bereichs: Die Vorgaben, die Sie dort geschrieben haben, gelten nicht mehr. Ohne Nachricht system wird der Prompt des Bereichs verwendet. Die Client-Anwendung entscheidet also über das Verhalten des Assistenten.
Diese Endpunkte lösen keinen Agenten aus: @agent und die Fähigkeiten sind dort nicht verfügbar. Der Verlauf ist jener, den der Client sendet.
Bewährte Vorgehensweisen für die Integration
Ein Bereich pro Verwendung. Trennen Sie die einer Anwendung zugänglichen Bereiche von jenen, die Ihre Mitarbeitenden nutzen.
Ein Faden pro Endbenutzer. Bedient Ihre Anwendung mehrere Personen, erstellen Sie einen Faden pro Person: Die Kontexte vermischen sich nicht. Der Parameter sessionId trennt die Verläufe ebenfalls, ohne einen Faden zu erstellen. Keines von beiden beschränkt die zugänglichen Dokumente.
Behandeln Sie den Modus. Der Parameter mode (chat, query oder automatic) ist für eine Integration entscheidend: query verhindert erfundene Antworten, wenn die Datenbank die Information nicht enthält.
Behandeln Sie Fehler und Latenz. Eine Antwort kann mehrere Sekunden dauern, mit einem Agenten länger. Sehen Sie angemessene Timeouts und eine Behandlung von Fehlern des Modellanbieters vor.
Nutzen Sie das Streaming für jede Oberfläche, an der ein Mensch wartet: Die Antwort erscheint nach und nach, die gefühlte Wartezeit ist viel kürzer.
Nutzen Sie die Quellen. Die Antworten liefern die verwendeten Auszüge: Zeigen Sie sie an, denn das macht die Integration überprüfbar.

Français