io.enterpriseai.resources.MemoryClient
Source: sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/MemoryClient.java. Back to the Java SDK reference index.
This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.
Class MemoryClient
Agent memory.
Constructor MemoryClient
MemoryClient(Transport transport)
Creates the client on the shared transport; EnterpriseAIClient builds it and exposes it through the accessor of the same name.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
transport | Transport | yes | Transport shared by the sub-clients of one client. |
MemoryClient.addKnowledge
JsonNode addKnowledge(String agentId, Object body, RequestOptions options)
Ingest knowledge. Adds texts to the Cognee dataset of one scope (Cognee POST /api/v1/add, then POST /api/v1/cognify when build_graph), only when the policy enables knowledge_graph and the engine is cognee or hybrid (else 403 or 422 memory_capability_unsupported). Same DLP, classification, retention and isolation checks as a memory; relation editor on the agent. 201 with dataset, items and graph. Accepts an Idempotency-Key header. Audited as memory.knowledge.create without the content.
Route: /v1/memory/agents/{agent_id}/knowledge (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
body | Object | yes | Texts to ingest and their scope. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Ingest knowledge".
Raises: the typed errors of the transport (Errors).
MemoryClient.agentPolicy
JsonNode agentPolicy(String agentId)
Read the memory policy of an agent. Engine choice (builtin, mem0, cognee, hybrid), instances, modes, scopes, memorization limits, retention, sharing and required isolation of the agent, with version, configured (false: defaults, builtin engine) and engines (per purpose memory or knowledge: instance, provider, isolation and capabilities). Relation viewer on the agent, or the agent itself.
Route: /v1/memory/agents/{agent_id}/policy (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. |
Returns: JsonNode. Decoded JSON answer of the operation "Read the memory policy of an agent".
Raises: the typed errors of the transport (Errors).
MemoryClient.agentPolicyVersions
JsonNode agentPolicyVersions(String agentId)
List the versions of the memory policy. Former versions of the memory policy of the agent, newest first (at most 200), each with its engine, instances, policy, author and date. Relation viewer on the agent.
Route: /v1/memory/agents/{agent_id}/policy/versions (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. |
Returns: JsonNode. Decoded JSON answer of the operation "List the versions of the memory policy".
Raises: the typed errors of the transport (Errors).
MemoryClient.buildGraph
JsonNode buildGraph(String agentId, Object body)
Build the knowledge graph. Runs Cognee POST /api/v1/cognify on readable datasets of the instance of the agent (all of them by default). Relation editor on the agent. Audited as memory.knowledge.build.
Route: /v1/memory/agents/{agent_id}/knowledge/graph (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
body | Object | yes | Datasets to process. |
Returns: JsonNode. Decoded JSON answer of the operation "Build the knowledge graph".
Raises: the typed errors of the transport (Errors).
MemoryClient.datasets
Page<JsonNode> datasets(String agentId, Map<String, ?> query)
List the knowledge datasets. Datasets the caller may read through this agent, paginated with cursor.
Route: /v1/memory/agents/{agent_id}/knowledge/datasets (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
query | Map<String, ?> | yes | Query string parameters of the route. |
Returns: Page<JsonNode>. A Page: One page of a cursor paginated collection ({"items": [...], "next_cursor": "..."|null}).
Raises: the typed errors of the transport (Errors).
MemoryClient.declareEngine
JsonNode declareEngine(Object body, RequestOptions options)
Declare a memory engine instance. Declares an instance of Mem0 or Cognee installed and operated by the Navin Manager, for example one dedicated to a tenant (tenant_id: physical separation, as a bank requires). Only platform_admin (403 otherwise). The credential is a reference only (openbao://<path> or env://EAI_CRED_<NAME>), resolved server side. 409 conflict when the id exists or is reserved (builtin, mem0, cognee), 404 for an unknown tenant. Accepts an Idempotency-Key header. Audited as memory.engine.declare.
Route: /v1/memory/engines (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | The engine instance to declare. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Declare a memory engine instance".
Raises: the typed errors of the transport (Errors).
MemoryClient.delete
void delete(String id)
Delete a memory item. Erases the content, the reference, the vector and the former versions of the item and marks it deleted. Allowed for a writer or owner of the item, or tenant_admin (else 403 not_permitted_acl). An item under legal hold answers 409 legal_hold (the refusal is audited); a non deletable item answers 409 conflict unless the caller is tenant_admin. 404 not_found. Audited as memory.delete.
Route: /v1/memory/{memory_id} (DELETE).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
id | String | yes | Identifier (UUID) of the memory item. |
Returns: void.
Raises: the typed errors of the transport (Errors).
MemoryClient.deleteDataset
JsonNode deleteDataset(String agentId, String datasetId)
Delete a knowledge dataset. Deletes the dataset in Cognee (DELETE /api/v1/datasets/{dataset_id}) and its index entries. 409 legal_hold when the dataset or one of its items is held. Audited as memory.knowledge.delete.
Route: /v1/memory/agents/{agent_id}/knowledge/datasets/{dataset_id} (DELETE).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
datasetId | String | yes | Identifier (UUID) of the Navin index entry of the dataset. |
Returns: JsonNode. Decoded JSON answer of the operation "Delete a knowledge dataset".
Raises: the typed errors of the transport (Errors).
MemoryClient.deleteEngine
JsonNode deleteEngine(String engineId)
Remove a declared memory engine instance. Removes a declared instance and the tenant credentials bound to it. Only platform_admin. 409 memory_engine_in_use while an agent policy or a memory still uses it; 404 memory_engine_not_found. Audited as memory.engine.delete.
Route: /v1/memory/engines/{engine_id} (DELETE).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
engineId | String | yes | Identifier of the engine instance. |
Returns: JsonNode. Decoded JSON answer of the operation "Remove a declared memory engine instance".
Raises: the typed errors of the transport (Errors).
MemoryClient.deleteEngineCredential
JsonNode deleteEngineCredential(String engineId)
Unbind the credential of the tenant. Removes the credential of this tenant on the instance; the credential of the instance is used again. Role tenant_admin. Audited as memory.engine.change.
Route: /v1/memory/engines/{engine_id}/credential (DELETE).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
engineId | String | yes | Identifier of the engine instance. |
Returns: JsonNode. Decoded JSON answer of the operation "Unbind the credential of the tenant".
Raises: the typed errors of the transport (Errors).
MemoryClient.engineCapabilities
JsonNode engineCapabilities(String engineId)
Read the capabilities of a memory engine. Declarative capability set of the engine: only what its provider really executes. memory: among remember, recall, search, update, forget, list, get, purge, get_health, get_capabilities; knowledge: among ingest_knowledge, build_graph, search_graph, get_relations, delete_dataset. An operation outside this set answers 422 memory_capability_unsupported. Also gives isolation for the tenant and session_memory (true for builtin only: session memory never goes to an external engine). Nothing is sent to the engine.
Route: /v1/memory/engines/{engine_id}/capabilities (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
engineId | String | yes | Identifier of the engine instance (builtin, mem0, cognee or a declared id). |
Returns: JsonNode. Decoded JSON answer of the operation "Read the capabilities of a memory engine".
Raises: the typed errors of the transport (Errors).
MemoryClient.engineHealth
JsonNode engineHealth(String engineId)
Check the health of a memory engine. Calls the engine with the credential of the tenant: Mem0 GET /auth/setup-status then GET /configure/providers, Cognee GET /health then GET /api/v1/datasets. Answers status up (or degraded), or down with error and reason (never a secret). Roles tenant_admin, developer, security_officer or auditor.
Route: /v1/memory/engines/{engine_id}/health (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
engineId | String | yes | Identifier of the engine instance. |
Returns: JsonNode. Decoded JSON answer of the operation "Check the health of a memory engine".
Raises: the typed errors of the transport (Errors).
MemoryClient.engines
JsonNode engines()
List the memory engines. Memory engines the tenant may use (Navin Memory Provider): builtin (the Memory Manager store), the platform instances mem0 and cognee rendered by the Navin Manager from its bindings (only when configured), and the instances declared by the platform administrator (shared ones and those dedicated to this tenant; a dedicated instance of another tenant is never listed). Each entry gives provider, base_url, origin (builtin, manager_binding, declared), dedicated, credential_bound (the credential itself is never returned), isolation (logical, backend or dedicated_instance: the separation this instance guarantees for the tenant) and capabilities. Navin Enterprise never installs nor configures an engine: the Navin Manager does.
Route: /v1/memory/engines (GET).
This element takes no parameter.
Returns: JsonNode. Decoded JSON answer of the operation "List the memory engines".
Raises: the typed errors of the transport (Errors).
MemoryClient.export
JsonNode export(String agentId, Object body)
Export the memories of an agent. Exports at most 1000 readable memories with their content (untrusted data). Refused to agents (403). Audited as memory.export without the content.
Route: /v1/memory/agents/{agent_id}/memories/export (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
body | Object | yes | Scopes to export (default: every readable scope). |
Returns: JsonNode. Decoded JSON answer of the operation "Export the memories of an agent".
Raises: the typed errors of the transport (Errors).
MemoryClient.forget
JsonNode forget(String agentId, String itemId)
Forget a memory of an agent. Deletes the memory in its engine (Mem0 DELETE /memories/{memory_id}, Cognee data item deletion, builtin soft delete) and marks the index entry deleted. 409 legal_hold; only the owner agent of a shared memory (403). Audited as memory.provider.delete.
Route: /v1/memory/agents/{agent_id}/memories/{item_id} (DELETE).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
itemId | String | yes | Identifier (UUID) of the Navin index entry. |
Returns: JsonNode. Decoded JSON answer of the operation "Forget a memory of an agent".
Raises: the typed errors of the transport (Errors).
MemoryClient.get
JsonNode get(String id)
Get a memory item. Returns the item as a Memory Contract document with its history (former version numbers and dates). An expired item, or one the caller may not read by ACL or clearance, answers 404 not_found.
Route: /v1/memory/{memory_id} (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
id | String | yes | Identifier (UUID) of the memory item. |
Returns: JsonNode. Decoded JSON answer of the operation "Get a memory item".
Raises: the typed errors of the transport (Errors).
MemoryClient.list
Page<JsonNode> list()
List the memory items. Items the caller may read (listed in readers, classification within its clearance, not expired, not deleted), as Memory Contract documents, paginated with cursor.
Route: /v1/memory (GET).
This element takes no parameter.
Returns: Page<JsonNode>. A Page: One page of a cursor paginated collection ({"items": [...], "next_cursor": "..."|null}).
Raises: the typed errors of the transport (Errors).
MemoryClient.list
Page<JsonNode> list(Map<String, ?> query)
List the memory items. Items the caller may read (listed in readers, classification within its clearance, not expired, not deleted), as Memory Contract documents, paginated with cursor.
Route: /v1/memory (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
query | Map<String, ?> | yes | Query string parameters of the route. |
Returns: Page<JsonNode>. A Page: One page of a cursor paginated collection ({"items": [...], "next_cursor": "..."|null}).
Raises: the typed errors of the transport (Errors).
MemoryClient.memories
Page<JsonNode> memories(String agentId, Map<String, ?> query)
List the memories of an agent. Index entries of the memories the caller may read through this agent (readable scopes of the policy, classification within the clearance, not expired), paginated with cursor. With include_content=true (at most 100 per page) the content is read from the engine and returned as untrusted data. Audited as memory.provider.read.
Route: /v1/memory/agents/{agent_id}/memories (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
query | Map<String, ?> | yes | Query string parameters of the route. |
Returns: Page<JsonNode>. A Page: One page of a cursor paginated collection ({"items": [...], "next_cursor": "..."|null}).
Raises: the typed errors of the transport (Errors).
MemoryClient.memoryItem
JsonNode memoryItem(String agentId, String itemId)
Get a memory of an agent. Index entry and content (read from the engine, untrusted data) of one memory. An item of a scope the caller may not read answers 404, never 403, so its existence is not disclosed. Audited as memory.provider.read.
Route: /v1/memory/agents/{agent_id}/memories/{item_id} (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
itemId | String | yes | Identifier (UUID) of the Navin index entry. |
Returns: JsonNode. Decoded JSON answer of the operation "Get a memory of an agent".
Raises: the typed errors of the transport (Errors).
MemoryClient.purge
JsonNode purge(String agentId, Object body)
Purge one scope of an agent. Deletes every memory and dataset of one scope of the caller (Mem0 DELETE /memories with the identifiers of the scope, Cognee dataset deletion, builtin soft delete). confirm must be true (400). 409 legal_hold when an item of the scope is held. Audited as memory.provider.purge.
Route: /v1/memory/agents/{agent_id}/memories/purge (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
body | Object | yes | The scope to purge and the confirmation. |
Returns: JsonNode. Decoded JSON answer of the operation "Purge one scope of an agent".
Raises: the typed errors of the transport (Errors).
MemoryClient.recall
JsonNode recall(String agentId, Object body)
Recall memories for the LLM. Searches the readable scopes on the engines of the policy (hybrid: Mem0 and Cognee, merged and deduplicated by content, every source kept in sources), keeps only the results indexed by Navin for a readable scope and within the clearance (permission check before anything reaches the LLM), screens them for prompt injection (blocked items dropped) and returns them as untrusted data: framed_content wrapped in the untrusted markers and context_segments of type memory for the Context Manager, never instructions. The policy decision memory.search is evaluated. Audited as memory.provider.read with counts only.
Route: /v1/memory/agents/{agent_id}/recall (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
body | Object | yes | Query, scopes, number of results and session. |
Returns: JsonNode. Decoded JSON answer of the operation "Recall memories for the LLM".
Raises: the typed errors of the transport (Errors).
MemoryClient.relations
JsonNode relations(String agentId, String datasetId)
Read the relations of a dataset. Nodes and edges of the knowledge graph of one readable dataset (Cognee GET /api/v1/datasets/{dataset_id}/graph), screened for prompt injection and returned as untrusted data. 404 for a dataset the caller may not read. Audited as memory.provider.read.
Route: /v1/memory/agents/{agent_id}/knowledge/datasets/{dataset_id}/relations (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
datasetId | String | yes | Identifier (UUID) of the Navin index entry of the dataset. |
Returns: JsonNode. Decoded JSON answer of the operation "Read the relations of a dataset".
Raises: the typed errors of the transport (Errors).
MemoryClient.remember
JsonNode remember(String agentId, Object body, RequestOptions options)
Remember through the engine of the agent. Writes one memory through the engine of the agent policy (session scope: always the builtin store; hybrid: Mem0). 201 with items (index entries, without content), engine and engine_instance. The context (tenant, organization, project, user, agent, session) is derived server side from the authenticated principal, the agent registry and the verified session, never from the body. Checks, each refusal audited: an agent only uses its own memory (403 memory_agent_mismatch), the scope and the kind must be allowed by the policy (403), shared scopes need editor on the agent, the engine must announce remember (422 memory_capability_unsupported) and guarantee the required isolation (409), secrets, passwords, tokens and keys are refused (422 memory_secret_refused), personal data when the policy forbids it (422), a classification above the policy or the clearance (403), a retention above the policy (422). Accepts an Idempotency-Key header. Audited as memory.provider.create without the content.
Route: /v1/memory/agents/{agent_id}/memories (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
body | Object | yes | The memory to remember. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Remember through the engine of the agent".
Raises: the typed errors of the transport (Errors).
MemoryClient.restoreAgentPolicy
JsonNode restoreAgentPolicy(String agentId, int version)
Restore a version of the memory policy. Applies a former version again as a new version, with the same checks as PUT .../policy. 404 for an unknown version. Audited as memory.policy.restore.
Route: /v1/memory/agents/{agent_id}/policy/restore (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
version | int | yes | Version number (1 or more). |
Returns: JsonNode. Decoded JSON answer of the operation "Restore a version of the memory policy".
Raises: the typed errors of the transport (Errors).
MemoryClient.search
JsonNode search(Object body)
Search the memory. Scores the visible items (at most the 2000 most recently updated ones with content) and returns the best top_k with score, keyword_score and vector_score. keyword: share of query terms found; vector: cosine similarity with the query embedding (only items embedded with the current model); hybrid (default): half of each. Recalled content is screened for prompt injection; blocked items are dropped. The policy memory.search is evaluated. 400 invalid_request for an unknown mode. Audited as memory.search.
Route: /v1/memory/search (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | Query, optional scope and kind, number of results and mode. |
Returns: JsonNode. Decoded JSON answer of the operation "Search the memory".
Raises: the typed errors of the transport (Errors).
MemoryClient.search
JsonNode search(Object body, RequestOptions options)
Search the memory. Scores the visible items (at most the 2000 most recently updated ones with content) and returns the best top_k with score, keyword_score and vector_score. keyword: share of query terms found; vector: cosine similarity with the query embedding (only items embedded with the current model); hybrid (default): half of each. Recalled content is screened for prompt injection; blocked items are dropped. The policy memory.search is evaluated. 400 invalid_request for an unknown mode. Audited as memory.search.
Route: /v1/memory/search (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | Query, optional scope and kind, number of results and mode. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Search the memory".
Raises: the typed errors of the transport (Errors).
MemoryClient.searchKnowledge
JsonNode searchKnowledge(String agentId, Object body)
Search the knowledge graph. Cognee POST /api/v1/search, one readable dataset per call so every passage is attributed to its dataset; results are screened and returned as untrusted data with framed_content. The policy decision memory.search is evaluated. Audited as memory.provider.read.
Route: /v1/memory/agents/{agent_id}/knowledge/search (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
body | Object | yes | Query, datasets, number of results and search type. |
Returns: JsonNode. Decoded JSON answer of the operation "Search the knowledge graph".
Raises: the typed errors of the transport (Errors).
MemoryClient.searchMemories
JsonNode searchMemories(String agentId, Object body)
Search the memories of an agent. Same search as recall for a person who consults the memories (no context_segments); shared scopes need editor on the agent. Results are untrusted data. Audited as memory.provider.read.
Route: /v1/memory/agents/{agent_id}/memories/search (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
body | Object | yes | Query, scopes, number of results and session. |
Returns: JsonNode. Decoded JSON answer of the operation "Search the memories of an agent".
Raises: the typed errors of the transport (Errors).
MemoryClient.setAgentPolicy
JsonNode setAgentPolicy(String agentId, Object body)
Set the memory policy of an agent. Replaces the memory policy of the agent (new version, the former one is kept for a restore). Checks: roles tenant_admin, developer or application_owner and relation editor on the agent (403); global_access needs tenant_admin; default_scope must be a write scope and shared_with existing agents (400); the chosen instances must exist, match the provider and guarantee required_isolation (409 memory_isolation_unsatisfied: a dedicated instance installed by the Navin Manager is required). The policy decision memory.policy.update is enforced. shared_with writes or deletes the OpenFGA relation memory_reader of each agent on this one. Audited as memory.policy.update, plus memory.engine.change when the engine or an instance changes and memory.share when the sharing changes.
Route: /v1/memory/agents/{agent_id}/policy (PUT).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
body | Object | yes | Engine choice, instances and memory policy of the agent. |
Returns: JsonNode. Decoded JSON answer of the operation "Set the memory policy of an agent".
Raises: the typed errors of the transport (Errors).
MemoryClient.setEngineCredential
JsonNode setEngineCredential(String engineId, String credentialRef)
Bind the credential of the tenant on an engine. Binds the credential of this tenant on a shared instance (openbao://<path> reference to a secret of the tenant). On a Cognee instance with backend access control, it is the API key of the Cognee user of the tenant: its datasets and permissions are then enforced by Cognee itself (isolation becomes backend). On Mem0 a key does not separate the memories (logical stays). Role tenant_admin. Audited as memory.engine.change.
Route: /v1/memory/engines/{engine_id}/credential (PUT).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
engineId | String | yes | Identifier of the engine instance. | |
credentialRef | String | yes | Reference openbao://<path> to a secret of the tenant. |
Returns: JsonNode. Decoded JSON answer of the operation "Bind the credential of the tenant on an engine".
Raises: the typed errors of the transport (Errors).
MemoryClient.updateMemory
JsonNode updateMemory(String agentId, String itemId, String content)
Update a memory of an agent. Replaces the content of a memory in its engine (Mem0 PUT /memories/{memory_id}, builtin new version) after the same DLP checks as a creation; the version increases. Only the owner agent of a shared memory may change it (403); a held item answers 409 legal_hold. Audited as memory.provider.update.
Route: /v1/memory/agents/{agent_id}/memories/{item_id} (PATCH).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
agentId | String | yes | Name or identifier of the agent. | |
itemId | String | yes | Identifier (UUID) of the Navin index entry. | |
content | String | yes | Text (1 to 20000 characters); secrets are refused. |
Returns: JsonNode. Decoded JSON answer of the operation "Update a memory of an agent".
Raises: the typed errors of the transport (Errors).
MemoryClient.write
JsonNode write(Object body)
Write a memory item. Creates an item, or a new version of memory_id (201, Memory Contract document). Steps: 1. kind and scope.type are checked (400 invalid_request); content or content_ref is required. 2. Personal data detection may raise the classification; a classification above the caller clearance answers 403 policy_denied; the policy memory.write is evaluated. 3. For an update, the caller must be a writer or owner (403 not_permitted_acl) before the content is sent to the embedding model. 4. The content is embedded and stored. A new item defaults to the caller as reader, writer and owner, and to the user scope of the caller. Audited as memory.create or memory.update.
Route: /v1/memory (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | The memory item to write. |
Returns: JsonNode. Decoded JSON answer of the operation "Write a memory item".
Raises: the typed errors of the transport (Errors).
MemoryClient.write
JsonNode write(Object body, RequestOptions options)
Write a memory item. Creates an item, or a new version of memory_id (201, Memory Contract document). Steps: 1. kind and scope.type are checked (400 invalid_request); content or content_ref is required. 2. Personal data detection may raise the classification; a classification above the caller clearance answers 403 policy_denied; the policy memory.write is evaluated. 3. For an update, the caller must be a writer or owner (403 not_permitted_acl) before the content is sent to the embedding model. 4. The content is embedded and stored. A new item defaults to the caller as reader, writer and owner, and to the user scope of the caller. Audited as memory.create or memory.update.
Route: /v1/memory (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | The memory item to write. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Write a memory item".
Raises: the typed errors of the transport (Errors).