https://<deine-instanz>-api.localmind.ai/v1 — ersetzen Sie <deine-instanz> durch den Host Ihrer Instanz (beachten Sie das -api-Suffix).
1
API-Key erstellen
Öffnen Sie Benutzereinstellungen → API-Schlüssel und legen Sie einen neuen Schlüssel an (Admins können Schlüssel auch über Einstellungen → Sicherheit → API-Schlüssel ausstellen). Wählen Sie den Scope „alle Spaces” oder „ausgewählte Spaces”. Der Key gilt nur für Ihre Heim-Organisation und wird nur einmal angezeigt — kopieren Sie ihn sofort.
2
Verfügbare Agenten auflisten
GET /v1/models liefert alle Agenten, auf die Ihr Key Zugriff hat — im OpenAI-/models-Format. Das Feld id ist die Agent-UUID, die Sie im nächsten Schritt als model verwenden; name dient nur der Lesbarkeit.3
Erste Anfrage senden
Senden Sie eine Chat-Anfrage an
POST /v1/chat/completions. Setzen Sie model auf die Agent-UUID aus dem vorigen Schritt — kein Modellname wie gpt-4. Das Modell, die Tools und die Wissensquellen verwendet der Agent automatisch.Die Antwort
Die Response folgt dem OpenAI-Chat-Completions-Format. Die Assistent-Antwort liegt inchoices[0].message.content:
Sie erhalten
HTTP 200 und ein chat.completion-Objekt mit der Agent-Antwort in choices[0].message.content. Damit ist Ihr Setup vollständig — Sie können jetzt eigene Workflows bauen.Erhalten Sie
404 {"detail":"Model '…' not found"}, ist die model-UUID kein gültiger Agent — listen Sie die Agenten erneut mit GET /v1/models. Erhalten Sie 401, prüfen Sie den Authorization-Header. Siehe Konventionen und Fehler.Nächste Schritte
OpenAI-kompatibel
Alle Parameter von
/v1/chat/completions, Streaming und JSON-Mode.Use Cases
Fertige Rezepte: OpenAI-Drop-in, RAG, Chatbot, n8n, Dokumenten-Organisation.
Dokumente und Suche
Dokumente hochladen und per Hybrid Search semantisch abfragen.
Authentifizierung und Rollen
Wie Ihr Key Rollen erbt, an die Org gebunden ist und den Zugriff verengt.
