Skip to main content
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.
​
Authorization
string
required
Bearer sk-… — Ihr persönlicher API-Key.
​
limit
integer
Anzahl der Einträge pro Seite.
​
page
integer
Seitennummer (1-basiert).
​
filters
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" \
  -H "Authorization: Bearer sk-…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 10,
    "page": 1,
    "filters": {}
  }'

{
  "items": [
    {
      "id": "{agent_id}",
      "name": "Test-INT1",
      "description": "",
      "version": "1.0.0",
      "agent_type": "simple",
      "model": "claude-4_6-sonnet-vertex",
      "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.
​
Authorization
string
required
Bearer sk-… — Ihr persönlicher API-Key.
​
agent_id
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": "claude-4_6-sonnet-vertex",
  "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.
​
id
string
Die Agent-UUID. Wird im Chat als model verwendet.
​
name
string
Anzeigename des Agents.
​
description
string
Freitext-Beschreibung (kann leer sein).
​
version
string
Versionskennung der Agent-Konfiguration, z. B. "1.0.0".
​
agent_type
string
Typ des Agents, z. B. "simple".
​
model
string
Das hinter dem Agent konfigurierte Sprachmodell (z. B. "claude-4_6-sonnet-vertex"). Dieser Wert wird in der Library gesetzt und ist nicht der Wert, den Sie im Chat als model senden — dort verwenden Sie immer die Agent-UUID (id).
​
system_prompt
string
Das System-Prompt, das das Verhalten des Agents bestimmt.
​
temperature
number | null
Voreingestellte Sampling-Temperatur, oder null für den Modell-Default. Im Chat überschreibbar.
​
max_tokens
integer | null
Voreingestellte maximale Token-Anzahl. Im Chat überschreibbar.
​
reasoning_config
object | null
Optionale Reasoning-Konfiguration des Agents.
​
tool_attachments
array
Die dem Agent zugeordneten Tools. Jeder Eintrag hat ein tool_id und ein optionales config. Diese Tools führt der Agent serverseitig aus.
​
is_public
boolean
Gibt an, ob der Agent öffentlich (innerhalb seiner Sichtbarkeit) bereitgestellt ist.
​
show_citations
boolean
Ob der Agent Quellenangaben zu seinen Antworten anzeigt.
​
save_to_inbox
boolean
Ob Ergebnisse des Agents in der Inbox abgelegt werden.
​
data_access_mode
string
Steuert, auf welche Daten der Agent zugreift, z. B. "origin".
​
allowed_folder_ids
array | null
Schränkt den Wissenszugriff auf bestimmte Ordner ein, oder null für keine Einschränkung.
​
organization_id
string
Organisation, der der Agent gehört.
​
space_id
string
Der Space, in dem der Agent lebt.
​
conversation_count
integer
Anzahl der bisherigen Konversationen mit diesem Agent.
​
created_at
string
Erstellungszeitpunkt (ISO-8601).
​
created_by
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.

​
Verwandte Seiten

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.