Objects API

REST Nur Admins

Grundlagen

Memory Objects sind die eigentlichen Datensätze in der Plattform. Jedes Objekt ist mit einem konkreten Data Type verknüpft, sodass deine Daten strukturiert und validiert bleiben.

• Basis‑Pfad: /api/memory/objects
• Auth: Authorization: Bearer <token>

Objekte auflisten

GET /api/memory/objects

Gibt eine paginierte Liste von Objekten zurück. Du kannst nach Typ, Version oder Schlüssel filtern.

Query-Param	Typ	Beschreibung
typeId	UUID	Filter nach einer bestimmten Typ‑Versions‑ID.
type	string	Filter nach lesbarem Namen (z. B. Ticket). Standard ist die neueste Version.
typeVersion	number	Optional. Mit type, um eine konkrete Versionsnummer anzusprechen.
key	string	Sucht ein Objekt mit einem bestimmten Custom‑Key.
page	number	Seitennummer (Standard 1).
pageSize	number	Einträge pro Seite (Standard 50).

Response

{
  "total": 42,
  "items": [
    {
      "id": "550e8400-e29b...",
      "typeId": "b1820464-9e11...",
      "key": "TICKET-101",
      "content": {
        "status": "open",
        "priority": "high"
      }
    }
  ]
}

Objekt erstellen

POST /api/memory/objects

Erzeugt einen neuen Datensatz. Der Payload wird automatisch gegen das Schema des angegebenen typeId validiert.

Body

Feld	Typ	Required	Beschreibung
typeId	UUID	Ja	ID der Typ‑Version, die verwendet werden soll.
content	JSON	Ja	Zu speichernde Daten. Müssen dem Schema entsprechen.
key	string	Nein	Eindeutige Kennung (z. B. INV-2024). Eindeutig pro Type.

Beispiel

{
  "typeId": "b1820464-9e11-41d4-a716-446655440000",
  "key": "user_42",
  "content": {
    "name": "Alice",
    "role": "admin"
  }
}

Validierungsfehler

Wenn content nicht den Regeln des typeId‑Schemas entspricht, liefert die API 400 Bad Request mit einer Liste von Validierungsfehlern.

Objekt aktualisieren

PATCH /api/memory/objects/{id}

Aktualisiert Inhalt oder Metadaten eines bestehenden Objekts.

Body

Feld	Typ	Beschreibung
content	JSON	Neue Daten. Müssen dem Schema entsprechen.
key	string	Aktualisiert den Custom‑Identifier.
typeId	UUID	Migration – neue ID, um das Objekt auf einen neuen Typ/Version zu heben.

Response

Gibt das aktualisierte Objekt zurück.

Daten migrieren

Du kannst ein Objekt in einem Schritt auf eine neue Schema‑Version migrieren (z. B. von Ticket v1 zu Ticket v2).
Sende dafür die neue typeId zusammen mit neuem konformen content. Das System validiert gegen das neue Schema und aktualisiert den Datensatz, während die ursprüngliche UUID erhalten bleibt.

Objekt löschen

DELETE /api/memory/objects/{id}

Entfernt das Objekt und sein semantisches Embedding dauerhaft.

Hinweis zu Embeddings

Beim Erstellen oder Aktualisieren eines Objekts erzeugt die Plattform automatisch eine Vektor‑Embedding aus dem content. Dies geschieht im Hintergrund.

Während diese API die Speicherung übernimmt, nutzt du für semantische Suchen in der Regel die höher‑stufige Retrieval‑API oder Agents.