Skip to main content
Die Localmind API ermöglicht programmatischen Zugriff auf alle Funktionen der Plattform — von der Agenten-Ausführung über Dokumentenverarbeitung bis hin zur Organisations- und Benutzerverwaltung.

​
Basis-URL

Alle API-Requests verwenden die Basis-URL Ihrer Localmind-Instanz: 
https://<ihre-instanz>.localmind.ai
Die genaue URL hängt von Ihrem Deployment ab (Cloud, Dedicated VM oder On-Premise). Kontaktieren Sie Ihren Administrator, falls Sie die URL nicht kennen.

​
Authentifizierung

Die API verwendet Bearer Token Authentication. Senden Sie Ihren API-Schlüssel im Authorization-Header mit jedem Request: 
curl -X GET "https://<ihre-instanz>.localmind.ai/agents/{agent_id}" \
  -H "Authorization: Bearer sk-your-api-key"

​
API-Schlüssel erstellen

API-Schlüssel werden pro Space erstellt und verwaltet:
1

Space öffnen

Navigieren Sie zum gewünschten Space.
2

API Keys aufrufen

Öffnen Sie die Space-Einstellungen und wählen Sie API Keys.
3

Neuen Schlüssel erstellen

Klicken Sie auf Create API Key, vergeben Sie einen Namen und optional ein Ablaufdatum.
4

Schlüssel sichern

Kopieren Sie den Schlüssel sofort — er wird nur einmal angezeigt.
Behandeln Sie API-Schlüssel wie Passwörter. Teilen Sie sie nicht in öffentlichen Repositories oder Client-seitigem Code.

​
Request-Format

  • Content-Type: application/json für alle Requests mit Body
  • Methoden: GET, POST, PATCH, PUT, DELETE
  • Pfad-Parameter: In geschweiften Klammern, z.B. /agents/{item_id}
curl -X POST "https://<ihre-instanz>.localmind.ai/agents/" \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Mein Agent",
    "description": "Ein hilfreicher Assistent",
    "model_id": "gpt-4o-azure",
    "space_id": "space-uuid"
  }'

​
Response-Format

Erfolgreiche Responses liefern die angeforderte Ressource als JSON: 
{
  "id": "abc-123",
  "name": "Mein Agent",
  "description": "Ein hilfreicher Assistent",
  "model_id": "gpt-4o-azure",
  "created_at": "2026-02-11T10:00:00Z",
  "updated_at": "2026-02-11T10:00:00Z"
}

​
Fehler-Responses

Validierungsfehler (HTTP 422) folgen diesem Format: 
{
  "detail": [
    {
      "loc": ["body", "name"],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}
HTTP-CodeBedeutung
200Erfolg
201Ressource erstellt
204Erfolgreich, kein Inhalt
401Nicht authentifiziert — API-Schlüssel fehlt oder ungültig
403Keine Berechtigung für diese Aktion
404Ressource nicht gefunden
422Validierungsfehler — ungültige Eingabedaten
429Rate Limit erreicht
500Interner Serverfehler

​
Paginierung

Such-Endpoints (POST /*/search) verwenden Paginierung. Responses enthalten: 
{
  "items": [...],
  "total_items": 142,
  "total_pages": 15,
  "page": 1,
  "page_size": 10
}
FeldBeschreibung
itemsArray der Ergebnisse auf der aktuellen Seite
total_itemsGesamtanzahl der Treffer
total_pagesGesamtanzahl der Seiten
pageAktuelle Seitennummer (1-basiert)
page_sizeAnzahl Einträge pro Seite

​
OpenAI-kompatible Schnittstelle

Localmind bietet einen drop-in kompatiblen Endpoint zum OpenAI Chat Completions API-Format. Sie können Agenten wie OpenAI-Modelle ansprechen: 
curl -X POST "https://<ihre-instanz>.localmind.ai/agents/{agent_id}/chat/completions" \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4",
    "messages": [
      {"role": "user", "content": "Was ist unsere aktuelle Urlaubsregelung?"}
    ],
    "stream": true
  }'
Der model-Parameter wird aus Kompatibilitätsgründen akzeptiert, aber der Agent verwendet immer sein konfiguriertes Modell. Alle Tools des Agenten werden intern ausgeführt.

​
Schnelleinstieg

Agenten-API

Agenten erstellen, konfigurieren und ausführen.

Conversations

Chat-Konversationen starten und Nachrichten senden.

Daten & Dokumente

Dokumente hochladen und per Hybrid Search durchsuchen.

API Keys

API-Schlüssel programmatisch verwalten.