Agenten

Ein Agent ist die Einheit, die Sie über die Localmind API ansprechen: Er bündelt System-Prompt, Modell, Tools und den Zugriff auf Wissensquellen. Im Chat referenzieren Sie einen Agent über seine UUID (model = <agent_uuid>). Diese Seite beschreibt, wie Sie Agenten read-only finden und ihre vollständige Konfiguration auslesen.

Zum Auflisten der Agenten, auf die Ihr Key Zugriff hat, gibt es zusätzlich den schlankeren OpenAI-kompatiblen Endpunkt GET /v1/models — er liefert nur id und name. Die hier beschriebenen Endpunkte liefern die vollständige Agent-Konfiguration. Siehe OpenAI-kompatibel.

`POST /v1/agents/search`

Paginierte Suche über die für Ihren Key zugänglichen Agenten. Antwortet im Pagination-Envelope; items[] enthält vollständige Agent-Objekte.

string

required

Bearer sk-… — Ihr persönlicher API-Key.

integer

Anzahl der Einträge pro Seite.

integer

Seitennummer (1-basiert).

object

Filter im Format feld__operator (z. B. space_id__exact). Filter können den Zugriff nur eingrenzen, nie erweitern. Siehe Konventionen und Fehler.

curl -X POST "https://<deine-instanz>-api.localmind.ai/v1/agents/search?page=1&limit=10" \
  -H "Authorization: Bearer sk-…" \
  -H "Content-Type: application/json" \
  -d '{
    "filters": {}
  }'

{
  "items": [
    {
      "id": "{agent_id}",
      "name": "Test-INT1",
      "description": "",
      "version": "1.0.0",
      "agent_type": "simple",
      "model": "<model-deployment>",
      "system_prompt": "Du bist ein hilfreicher Assistent.",
      "temperature": null,
      "max_tokens": 4096,
      "reasoning_config": null,
      "tool_attachments": [
        { "tool_id": "{id}", "config": null }
      ],
      "is_public": false,
      "show_citations": true,
      "save_to_inbox": false,
      "data_access_mode": "origin",
      "allowed_folder_ids": null,
      "organization_id": "{org_id}",
      "space_id": "{space_id}",
      "from_system": false,
      "conversation_count": 3,
      "created_at": "2026-06-13T10:33:54.125058Z",
      "updated_at": "2026-06-13T10:33:54.125058Z",
      "created_by": { "id": "{user_id}", "name": "Beispiel Nutzer", "avatar_url": null }
    }
  ],
  "total_items": 1,
  "total_pages": 1,
  "page": 1,
  "page_size": 10
}

`GET /v1/agents/{agent_id}`

Liefert die vollständige Konfiguration eines einzelnen Agents.

string

required

Bearer sk-… — Ihr persönlicher API-Key.

string

required

Die Agent-UUID (z. B. aus GET /v1/models oder POST /v1/agents/search).

curl "https://<deine-instanz>-api.localmind.ai/v1/agents/{agent_id}" \
  -H "Authorization: Bearer sk-…"

{
  "id": "{agent_id}",
  "name": "Test-INT1",
  "description": "",
  "version": "1.0.0",
  "agent_type": "simple",
  "model": "<model-deployment>",
  "system_prompt": "Du bist ein hilfreicher Assistent.",
  "temperature": null,
  "max_tokens": 4096,
  "reasoning_config": null,
  "tool_attachments": [
    { "tool_id": "{id}", "config": null }
  ],
  "is_public": false,
  "show_citations": true,
  "save_to_inbox": false,
  "data_access_mode": "origin",
  "allowed_folder_ids": null,
  "organization_id": "{org_id}",
  "space_id": "{space_id}",
  "from_system": false,
  "conversation_count": 3,
  "created_at": "2026-06-13T10:33:54.125058Z",
  "updated_at": "2026-06-13T10:33:54.125058Z",
  "created_by": { "id": "{user_id}", "name": "Beispiel Nutzer", "avatar_url": null },
  "last_edited_by": { "id": "{user_id}", "name": "Beispiel Nutzer", "avatar_url": null }
}

Das Agent-Objekt

Beide Endpunkte liefern dasselbe Agent-Objekt mit den folgenden Feldern.

string

Die Agent-UUID. Wird im Chat als model verwendet.

string

Anzeigename des Agents.

string

Freitext-Beschreibung (kann leer sein).

string

Versionskennung der Agent-Konfiguration, z. B. "1.0.0".

string

Typ des Agents, z. B. "simple".

string

Das hinter dem Agent konfigurierte Sprachmodell (Deployment-Name, z. B. "<model-deployment>"). Dieser Wert wird am Agent konfiguriert (Agent bearbeiten → Modell) und ist nicht der Wert, den Sie im Chat als model senden — dort verwenden Sie immer die Agent-UUID (id).

string

Das System-Prompt, das das Verhalten des Agents bestimmt.

number | null

Voreingestellte Sampling-Temperatur, oder null für den Modell-Default. Im Chat überschreibbar.

integer | null

Voreingestellte maximale Token-Anzahl. Im Chat überschreibbar.

object | null

Optionale Reasoning-Konfiguration des Agents.

array

Die dem Agent zugeordneten Tools. Jeder Eintrag hat ein tool_id und ein optionales config. Diese Tools führt der Agent serverseitig aus.

boolean

Gibt an, ob der Agent öffentlich (innerhalb seiner Sichtbarkeit) bereitgestellt ist.

boolean

Ob der Agent Quellenangaben zu seinen Antworten anzeigt.

boolean

Ob Ergebnisse des Agents in der Inbox abgelegt werden.

string

Steuert, auf welche Daten der Agent zugreift, z. B. "origin".

array | null

Schränkt den Wissenszugriff auf bestimmte Ordner ein, oder null für keine Einschränkung.

string

Organisation, der der Agent gehört.

string

Der Space, in dem der Agent lebt.

integer

Anzahl der bisherigen Konversationen mit diesem Agent.

string

Erstellungszeitpunkt (ISO-8601).

object

Ersteller des Agents mit id, name und avatar_url. Das analoge Feld last_edited_by beschreibt den letzten Bearbeiter.

Mehrstufige Chats

Eine persistente Conversation-API (/v1/conversations/*) ist derzeit nicht Teil der öffentlichen Dokumentation und folgt zu einem späteren Zeitpunkt. Für mehrstufige Chats nutzen Sie aktuell den stateless Endpunkt POST /v1/chat/completions und senden den bisherigen Verlauf bei jedem Aufruf im messages-Array mit. Ein vollständiges Beispiel finden Sie unter Use Cases.

OpenAI-kompatibel

Agenten per GET /v1/models auflisten und per Chat Completions ansprechen.

Use Cases

Mehrstufige Chats stateless umsetzen und weitere Rezepte.

Konventionen und Fehler

Pagination, Filter-DSL und das Fehlermodell.

Authentifizierung und Rollen

Welche Agenten Ihr Key sieht und wie der Zugriff verengt wird.

Übersicht

Authentifizierung & Konventionen

Endpoint-Referenz

`POST /v1/agents/search`

`GET /v1/agents/{agent_id}`

Das Agent-Objekt

Mehrstufige Chats

Verwandte Seiten

OpenAI-kompatibel

Use Cases

Konventionen und Fehler

Authentifizierung und Rollen

​POST /v1/agents/search

​GET /v1/agents/{agent_id}

​Das Agent-Objekt

​Mehrstufige Chats

​Verwandte Seiten

OpenAI-kompatibel

Use Cases

Konventionen und Fehler

Authentifizierung und Rollen

`POST /v1/agents/search`

`GET /v1/agents/{agent_id}`

Das Agent-Objekt

Mehrstufige Chats

Verwandte Seiten