MemoryReference
A memory record retrieved and included in generation context.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
| In webhook payloads | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
memoryId | string | Optional | Identifier of the retrieved memory record. |
score | number (float) or string (NaN, Infinity, -Infinity) | Optional | Relevance score reported by the memory provider for this match. |
memoryText | string | Optional | Text of the retrieved memory record. |
createdAt | string (date-time) | Optional | Time when this record was created. |
updatedAt | string (date-time) | Optional | Time when this record was last updated. |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
memoryId | string | Optional | Identifier of the retrieved memory record. |
score | number (float) or string (NaN, Infinity, -Infinity) | Optional | Relevance score reported by the memory provider for this match. |
memoryText | string | Optional | Text of the retrieved memory record. |
createdAt | string (date-time) | Optional | Time when this record was created. |
updatedAt | string (date-time) | Optional | Time when this record was last updated. |
In webhook payloads
Webhook JSON uses protobuf field names (snake_case).
| Field | Type | Presence | Meaning |
|---|---|---|---|
memory_id | string | Optional | Identifier of the retrieved memory record. |
score | number (float) or string (NaN, Infinity, -Infinity) | Optional | Relevance score reported by the memory provider for this match. |
memory_text | string | Optional | Text of the retrieved memory record. |
created_at | string (date-time) | Optional | Time when this record was created. |
updated_at | string (date-time) | Optional | Time when this record was last updated. |
Where used
| Reference | Relationship |
|---|---|
| Append a message without generating | POST /api/v1/llm/append-message |
| Send a message to a conversation | POST /api/v1/llm/send-message |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Withdraw your rating on a message | POST /api/v1/llm/delete-message-rating |
| Get full conversation state | POST /api/v1/llm/conversation-state |
| Rate an assistant message | POST /api/v1/llm/rate-message |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| llm.message_published | Webhook JSON uses protobuf field names (snake_case). |
| GenerationContext | Nested in model |
| GenerationContext | Nested in model |
| GenerationContext | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-memory-reference.