Skip to content

Objects API

REST Admin only

Memory Objects are the actual data records stored in the platform. Every object is linked to a specific Data Type, ensuring your data is always structured and validated.

  • Base path: /api/memory/objects
  • Auth: Authorization: Bearer <token>

GET /api/memory/objects

Retrieve a paginated list of objects. You can filter by type, version, or specific keys.

Query paramTypeDescription
typeIdUUIDFilter by a specific type version ID.
typestringFilter by human‑readable name (for example Ticket). Defaults to latest.
typeVersionnumberOptional. Use with type to target a specific version number.
keystringFind a specific object by its custom key.
pagenumberPage number (default 1).
pageSizenumberItems per page (default 50).

Response

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

POST /api/memory/objects

Creates a new record. The payload is automatically validated against the schema of the provided typeId.

Body

FieldTypeRequiredDescription
typeIdUUIDYesThe ID of the type version to use.
contentJSONYesThe data to store. Must match the schema.
keystringNoA unique identifier (for example INV-2024). Unique per type ID.

Example

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

PATCH /api/memory/objects/{id}

Update the content or metadata of an existing object.

Body

FieldTypeDescription
contentJSONThe new data. Must match the schema.
keystringUpdate the custom identifier.
typeIdUUIDMigration – provide a new ID to move this object to a new type/version.

Response

Returns the updated object.

DELETE /api/memory/objects/{id}

Permanently removes the object and its semantic embedding.

When you create or update an object, the platform automatically generates a vector embedding based on the content. This happens in the background.

While this API handles storage, you generally use the high‑level Retrieval API or Agents to perform semantic searches against these embeddings.