Skip to main content
Diese Rezepte zeigen, wie die Localmind v1-API real eingesetzt wird. Jedes Beispiel ist eigenständig und verweist auf die passende Referenz-Page. Alle Beispiele nutzen die Base-URL https://<deine-instanz>-api.localmind.ai/v1. Ersetzen Sie <deine-instanz> durch den Host Ihrer Instanz (beachten Sie das -api-Suffix) und authentifizieren Sie jeden Request mit Authorization: Bearer sk-….

A) OpenAI-Drop-in

Stellen Sie eine bestehende OpenAI-Codebasis auf Localmind um, ohne die Logik zu ändern: Sie setzen nur base_url, api_key und model (= Agent-UUID).
Die verfügbaren Agent-UUIDs finden Sie über GET /v1/models. Alle Parameter und das Streaming-Format beschreibt OpenAI-kompatibel.

B) RAG über eigene Dokumente

Jeder Nutzer ist Owner seines Privaten Space und darf dort per Key Dokumente verwalten. Der Ablauf: Space finden, Dokument hochladen, auf die Pipeline warten, semantisch suchen.
Die hybrid-search-Treffer kommen mit score-Werten sortiert zurück. Den vollständigen Upload-, Polling- und Such-Ablauf — inklusive Response-Feldern und dem Eingrenzen des Suchraums per document_ids — beschreibt Dokumente und Suche.
Als Alternative zum direkten hybrid-search-Aufruf können Sie einen Agent mit Daten-Tool ansprechen — dann genügt POST /v1/chat/completions, und der Agent zieht die Belege selbst aus seinem Space.

C) Chatbot und WhatsApp

Für Chatbots (z. B. eine WhatsApp-Anbindung) nutzen Sie den statelessen Weg über POST /v1/chat/completions. Localmind persistiert hier keinen Verlauf — den Gesprächsverlauf hält Ihr Client und sendet ihn bei jeder Anfrage vollständig im messages-Array mit.
In einer WhatsApp-Integration verbinden Sie das eingehende Nachrichten-Webhook mit diesem Aufruf — typischerweise über einen n8n-Workflow (siehe nächstes Rezept). Speichern Sie das messages-Array pro Nutzer in Ihrem eigenen Speicher. Mehr zum Request-Aufbau unter OpenAI-kompatibel.

D) n8n und Automatisierung

In n8n rufen Sie die API über einen HTTP-Request-Node auf: Methode POST, URL https://<deine-instanz>-api.localmind.ai/v1/chat/completions, Header Authorization: Bearer sk-…, Body als JSON.
Da chat/completions stateless ist, hält der Workflow den Gesprächskontext selbst — etwa indem er das messages-Array zwischen den Node-Ausführungen mitführt. So bauen Sie Chatbots, geplante Verarbeitungen oder Event-getriggerte Abläufe. Die Plattform-Sicht auf die n8n-Anbindung beschreibt Localmind-Agent in Automate.

E) Dokumenten-Organisation

Strukturieren Sie Dokumente in Ordnern über die Folder-Resource-API. Ordner lassen sich beliebig schachteln; space_id ist beim Anlegen Pflicht.
Alle Folder-Endpunkte (Anlegen, Schachteln, Umbenennen, Verschieben, Cascade-Delete) und die Abgrenzung zu pfad-basierten Datei-Ordnern beschreibt Dateien und Ordner.

F) Externes System (Formular/DMS/Fachanwendung) anbinden

Ein externes Formular-, DMS- oder Fachsystem ruft einen Localmind-Agenten über einen persönlichen API-Key mit passendem Space-Scope auf. Der Aufruf ist ein einzelner POST /v1/chat/completions gegen https://<deine-instanz>-api.localmind.ai/v1 mit Authorization: Bearer <key>; als model senden Sie die Agent-UUID aus GET /v1/models. Der Agent verarbeitet die übergebenen Feld- oder Dokumentinhalte (z. B. Klassifikation, Zusammenfassung, Extraktion) und liefert die Antwort synchron zurück — das externe System wartet auf die Response und verarbeitet sie direkt weiter.
Für strukturierte Rückgaben, die Ihr Fachsystem maschinell weiterverarbeitet, setzen Sie response_format: { "type": "json_object" } — der Agent antwortet dann mit einem JSON-Objekt statt Fließtext.
response_format ist modellabhängig — nicht jedes Modell unterstützt den JSON-Mode. Prüfen Sie das Verhalten mit dem Modell, das dem Ziel-Agenten zugewiesen ist, bevor Sie sich in der Integration darauf verlassen.
Scopen Sie den Key für solche Integrationen auf ausgewählte Spaces: Das externe System erreicht dann nur den Space des Ziel-Agenten — mehr Reichweite braucht es nicht. Verwenden Sie dafür den Key eines org-eigenen Users: In Multi-Org-Setups funktioniert der Key eines org-fremden Users nicht, da er nur in dessen Heimat-Org wirkt. Wie Scopes wirken, beschreibt Authentifizierung und Rollen.

Weiterführend

OpenAI-kompatibel

/v1/models und /v1/chat/completions mit allen Parametern.

Dokumente und Suche

Upload, Pipeline-Status und Hybrid Search im Detail.

Dateien und Ordner

Folder-Resource-API und Raw-File-Storage.

Agenten

Agenten per API auflisten und ihre Konfiguration lesen.