Objects API
Basics
Section titled “Basics”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>
List objects
Section titled “List objects”GET /api/memory/objects
Retrieve a paginated list of objects. You can filter by type, version, or specific keys.
| Query param | Type | Description |
|---|---|---|
typeId | UUID | Filter by a specific type version ID. |
type | string | Filter by human‑readable name (for example Ticket). Defaults to latest. |
typeVersion | number | Optional. Use with type to target a specific version number. |
key | string | Find a specific object by its custom key. |
page | number | Page number (default 1). |
pageSize | number | Items per page (default 50). |
Response
{ "total": 42, "items": [ { "id": "550e8400-e29b...", "typeId": "b1820464-9e11...", "key": "TICKET-101", "content": { "status": "open", "priority": "high" } } ]}Create an object
Section titled “Create an object”POST /api/memory/objects
Creates a new record. The payload is automatically validated against the schema of the provided typeId.
Body
| Field | Type | Required | Description |
|---|---|---|---|
typeId | UUID | Yes | The ID of the type version to use. |
content | JSON | Yes | The data to store. Must match the schema. |
key | string | No | A 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" }}Update an object
Section titled “Update an object”PATCH /api/memory/objects/{id}
Update the content or metadata of an existing object.
Body
| Field | Type | Description |
|---|---|---|
content | JSON | The new data. Must match the schema. |
key | string | Update the custom identifier. |
typeId | UUID | Migration – provide a new ID to move this object to a new type/version. |
Response
Returns the updated object.
Delete an object
Section titled “Delete an object”DELETE /api/memory/objects/{id}
Permanently removes the object and its semantic embedding.
A note on embeddings
Section titled “A note on embeddings”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.