DOC-API-MODEL-schema-1k63a85bkp#overview
Memory
A memory is a stored statement associated with a user and, when recorded, an agent or conversation and a run or session. The appId field is the existing public wire name for the tenant identifier. The field name remains unchanged for compatibility.
metadata is an object whose values are strings. A search can add a score; the provider determines its scale. The score does not measure factual truth. createdAt and updatedAt are RFC 3339 timestamp strings and may include fractional seconds. Absent timestamps mean that no value was returned.
Memory text can be incomplete, stale or incorrect. Show the text and available timestamps to the user before acting on it. Search results are a selection by relevance, not a full account of stored memory. See the memory cookbook for review and correction tasks.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1k63a85bkp#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1k63a85bkp#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1k63a85bkp#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1k63a85bkp#field-idSection ID: DOC-API-MODEL-schema-1k63a85bkp#response-field-idid | string | Optional | Unique memory identifier. |
Section ID: DOC-API-MODEL-schema-1k63a85bkp#field-memorySection ID: DOC-API-MODEL-schema-1k63a85bkp#response-field-memorymemory | string | Optional | Stored fact text. It may be incomplete, stale or incorrect. |
Section ID: DOC-API-MODEL-schema-1k63a85bkp#field-useridSection ID: DOC-API-MODEL-schema-1k63a85bkp#response-field-useriduserId | string | Optional | User associated with the memory. |
Section ID: DOC-API-MODEL-schema-1k63a85bkp#field-agentidSection ID: DOC-API-MODEL-schema-1k63a85bkp#response-field-agentidagentId | string | Optional | Agent or conversation associated with the memory. |
Section ID: DOC-API-MODEL-schema-1k63a85bkp#field-appidSection ID: DOC-API-MODEL-schema-1k63a85bkp#response-field-appidappId | string | Optional | Tenant identifier associated with the memory. |
Section ID: DOC-API-MODEL-schema-1k63a85bkp#field-runidSection ID: DOC-API-MODEL-schema-1k63a85bkp#response-field-runidrunId | string | Optional | Associated run or session identifier. |
Section ID: DOC-API-MODEL-schema-1k63a85bkp#field-metadataSection ID: DOC-API-MODEL-schema-1k63a85bkp#response-field-metadatametadata | Map from string to string | Optional | Additional string-valued metadata attached to the memory. |
Section ID: DOC-API-MODEL-schema-1k63a85bkp#field-scoreSection ID: DOC-API-MODEL-schema-1k63a85bkp#response-field-scorescore | number (double) or string (NaN, Infinity, -Infinity) | Optional | Relevance score returned by search. Its scale is provider-specific and is not a probability that the fact is correct. |
Section ID: DOC-API-MODEL-schema-1k63a85bkp#field-createdatSection ID: DOC-API-MODEL-schema-1k63a85bkp#response-field-createdatcreatedAt | string (date-time) | Optional | Creation time as an RFC 3339 timestamp; absent when unavailable. |
Section ID: DOC-API-MODEL-schema-1k63a85bkp#field-updatedatSection ID: DOC-API-MODEL-schema-1k63a85bkp#response-field-updatedatupdatedAt | string (date-time) | Optional | Last update time as an RFC 3339 timestamp; absent when unavailable. |
Where used
Section ID: DOC-API-MODEL-schema-1k63a85bkp#where-used
| Reference | Relationship |
|---|---|
| Get a specific memory | POST /api/v1/llm/get-memory |
| List user memories | POST /api/v1/llm/list-memories |
| Semantic search over memories | POST /api/v1/llm/search-memories |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1k63a85bkp