Memory Store object
Create, get, list, and archive endpoints return Memory Store objects.| Field | Type | Description |
|---|---|---|
id | string | Memory Store ID with the memstore_ prefix |
type | string | Always "memory_store" |
name | string | Store name. Trimmed by the server; maximum 64 characters |
description | string | Store description. Trimmed by the server; maximum 1024 characters |
status | string | Store status. See Memory Store status |
entry_count | integer | Number of active memory entries in the store |
total_size | integer | Total size in bytes of active memory entries |
metadata | Metadata object | Custom metadata. Defaults to {} |
archived_at | string | UTC archive time, returned only when the store is archived |
created_at | string | UTC creation time |
updated_at | string | UTC last update time |
Memory Store status
| Value | Description |
|---|---|
active | Store can accept new memory entries and entry updates |
archived | Store is archived. Entries and versions can be read, but entries cannot be created or updated |
Memory entry object
Create entry, get entry, list entries, and update entry endpoints return Memory entry objects.| Field | Type | Description |
|---|---|---|
id | string | Memory entry ID with the mem_ prefix |
type | string | Always "memory" |
store_id | string | Owning Memory Store ID |
path | string | Relative memory path. Maximum 1024 bytes; cannot start with / and cannot contain .. |
size | integer | Content size in bytes |
content_sha256 | string | SHA-256 digest of the current content |
version | integer | Current entry version. The first version is 1 and each update increments it |
metadata | Metadata object | Custom metadata. Defaults to {} |
content | string | Returned by create, get, and update responses when content is available. Omitted from list responses |
created_at | string | UTC creation time |
updated_at | string | UTC last update time |
content is required on create and update. It must be non-empty after trimming and must be at most 100 KB.
Memory version object
List versions and get version endpoints return Memory version objects.| Field | Type | Description |
|---|---|---|
id | string | Memory version ID with the memver_ prefix |
type | string | Always "memory_version" |
store_id | string | Owning Memory Store ID |
entry_id | string | Memory entry ID |
entry_path | string | Entry path at the time this version was recorded |
size | integer | Version content size in bytes |
content_sha256 | string | SHA-256 digest of the version content |
action | string | Version action. See Memory version action |
redacted | boolean | Whether the version content has been redacted |
redacted_at | string | UTC redaction time, returned only when redacted is true |
content | string | Returned by get version only when the version is not redacted and content is available |
created_at | string | UTC creation time |
Memory version action
| Value | Description |
|---|---|
created | Entry was created |
updated | Entry content was updated |
deleted | Entry was deleted. Historical version records can contain this action |
Metadata object
Memory Store and memory entrymetadata fields use the shared Metadata object: at most 16 key-value pairs, keys up to 64 characters, and string values up to 512 characters.
Related
Build persistent memory
Give your agent persistent memory across sessions.