Skip to main content
Die Localmind v1-API gibt Ihnen programmatischen Zugriff auf die KI-Funktionen Ihrer Localmind-Instanz. Sie sprechen Ihre konfigurierten Agenten direkt an, durchsuchen Ihre eigenen Dokumente per Hybrid Search und automatisieren Abläufe — alles über eine OpenAI-kompatible Schnittstelle.

​
Was Sie mit der API tun können

Agenten programmatisch nutzen

Senden Sie Anfragen an einen Agent und erhalten Sie dessen Antwort — inklusive der intern ausgeführten Tools und Wissensquellen.

RAG über eigene Dokumente

Laden Sie Dokumente in einen Space, lassen Sie die Pipeline sie verarbeiten und durchsuchen Sie sie semantisch per Hybrid Search.

OpenAI-SDK-Drop-in

Stellen Sie eine bestehende OpenAI-Codebasis auf Localmind um — nur base_url, api_key und model ändern.

n8n und Automatisierung

Rufen Sie die API aus n8n-Workflows oder eigenen Diensten auf, etwa für Chatbots oder geplante Verarbeitungen.

​
Plattform-Modell

Die API spiegelt die Hierarchie der Localmind-Plattform wider:
  • Instance — die vollständige Localmind-Installation (multi-tenant).
  • Organization (Org) — Tenant-Einheit mit Mitgliedern, Audit-Logs, Library und Billing. Ein API-Key ist immer an genau eine Org gebunden.
  • Space — Arbeits- und Berechtigungs-Container. Ein Space enthält Agents, Documents, Files, Folders und Conversations.
Es gibt zwei Space-Typen: Ihr Private Space (jeder Nutzer ist automatisch dessen Owner und darf dort per API alles verwalten) und Shared Spaces (geteilt, rollenbasiert). Der Private Space ist der natürliche Ort, um per API eigene Dokumente zu verwalten.
Welche Spaces und Agenten ein Key sieht, bestimmt die Rolle seines Besitzers. Ein Key kann den Zugriff nur verengen, nie erweitern. Details finden Sie unter Authentifizierung und Rollen.

​
Zwei Storage-Layer

Hochgeladene Dateien existieren in zwei Schichten: als Files (pfad-basierte Rohdateien, per-Org verschlüsselt) und als Documents (durch die Pipeline verarbeitet — parse, chunk, embed — und damit per Hybrid Search durchsuchbar). Ein Upload über den Daten-Endpunkt befüllt beide Layer gleichzeitig. Die Details und alle Endpunkte beschreibt Dokumente und Suche.

​
Base-URL

Jede Localmind-Instanz hat einen eigenen API-Host mit -api-Suffix. Alle Pfade tragen den /v1-Prefix: 
https://<ihre-instanz>-api.localmind.ai/v1
In den Beispielen dieser Referenz verwenden wir den Staging-Host https://v3-api.localmind.dev/v1. Ersetzen Sie ihn durch den Host Ihrer Instanz.
Es gibt keinen geteilten Host https://api.localmind.ai. Die API läuft ausschließlich auf der instanz-spezifischen Subdomain mit -api-Suffix und /v1-Prefix.

​
Authentifizierung (Kurzfassung)

Authentifizieren Sie jeden Request mit einem persönlichen User-API-Key (sk-…) im Authorization-Header: 
curl "https://v3-api.localmind.dev/v1/models" \
  -H "Authorization: Bearer sk-…"
Den Key erstellen Sie in den Benutzereinstellungen → API-Schlüssel (Admins über Einstellungen → Sicherheit → API-Schlüssel). Beim Anlegen wählen Sie den Scope „alle Spaces” oder „ausgewählte Spaces”. Das vollständige Rollen- und Zugriffsmodell beschreibt Authentifizierung und Rollen.

​
OpenAI-Kompatibilität

Localmind bietet eine OpenAI-kompatible Oberfläche. Sie listen verfügbare Agenten mit GET /v1/models und chatten mit POST /v1/chat/completions. Wichtig: Der model-Parameter ist immer eine Agent-UUID (aus GET /v1/models), kein Modellname wie gpt-4. 
from openai import OpenAI

client = OpenAI(base_url="https://v3-api.localmind.dev/v1", api_key="sk-…")
resp = client.chat.completions.create(
    model="{agent_id}",                       # Agent-UUID, kein Modellname
    messages=[{"role": "user", "content": "Hallo"}],
)
print(resp.choices[0].message.content)
Mehr dazu unter OpenAI-kompatibel.

​
Nächste Schritte

Quickstart

API-Key erstellen, Agenten auflisten und die erste Anfrage senden — in wenigen Minuten.

OpenAI-kompatibel

Die Endpunkte /v1/models und /v1/chat/completions mit allen Parametern und Responses.

Dokumente und Suche

Dokumente hochladen, die Pipeline verfolgen und per Hybrid Search abfragen.

Authentifizierung und Rollen

Wie ein API-Key Rollen erbt, an die Org gebunden ist und den Zugriff verengt.