v2

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-272589173.5 KB
Memories

Update a memory

Update memory-level properties including name, metadata, and collection associations.

This endpoint allows updating properties of an entire memory (document or conversation) without modifying its content:

  • name: Updates the authoritative engram title
  • metadata: Can replace or merge with existing metadata
  • collection_ids: Updates authoritative engram collection associations

Users can only update memories they own or have access to through collections. At least one collection association must be maintained.

If collection_id is provided and the engram is shared across collections, a copy-on-write will be performed to create a collection-specific copy before modification.

patch/v1/memories/{id}

Path parameters

idstring uuid required

The unique identifier of the memory

The unique identifier of the memory

Query parameters

collection_idstring uuid nullable

Collection context for copy-on-write. If provided and engram is shared, creates a copy before modification.

Collection context for copy-on-write. If provided and engram is shared, creates a copy before modification.

Request body

collection_idsstring[] nullable

New collection associations

merge_metadataboolean

Merge with existing metadata

metadataobject nullable

Metadata to update

namestring nullable

New name for the memory

Response

Successful Response

Example response

{
  "results": {
    "collection_ids": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "created_at": "2021-01-01T00:00:00",
    "document_type": "pdf",
    "engram_type": "document",
    "extraction_status": "pending",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "ingestion_attempt_number": 0,
    "ingestion_status": "pending",
    "metadata": {
      "title": "Sample Document"
    },
    "owner_id": "123e4567-e89b-12d3-a456-426614174000",
    "size_in_bytes": 123456,
    "title": "Sample Document",
    "total_tokens": 1000,
    "updated_at": "2021-01-01T00:00:00",
    "version": "1.0"
  }
}