Memories

Append content to an engram

Append content to an existing engram.

For conversation engrams:

  • Provide messages array with content, role, and optional metadata
  • Works like /conversations/{id}/messages endpoint

For document engrams:

  • Provide either raw_text or chunks to append additional content
  • Content will be processed and added to the engram
post/v1/memories/{id}/append

Path parameters

idstring uuid required

The unique identifier of the engram

The unique identifier of the engram

Request body

chunksstring[] nullable

Pre-processed text chunks to append for document memories.

collection_idstring uuid required

Target collection ID for the appended content.

ingestion_mode'hi-res' | 'ocr' | 'fast' | 'custom'
metadataobject nullable

Additional metadata for the appended content.

raw_textstring nullable

Raw text content to append for document memories.

Response

Successful Response

OR

Example response

{
  "results": {
    "message": {
      "content": "This is a test message.",
      "role": "user"
    }
  }
}

Changes

Changed in 1 of the 2 revisions of this API.10920

  • b1da2c0bb1ae10920See the full diff
    • added the new required request property messages/anyOf[subschema #1]/items/content

      new-required-request-property

    • added the new required request property messages/anyOf[subschema #1]/items/role

      new-required-request-property

    • removed ChunkingStrategy subschema #1 from the ingestion_config/anyOf[subschema #1: IngestionConfig]/chunking_strategy request property anyOf list

      request-property-any-of-removed

    • the chunks/anyOf[subschema #1]/ request property's minItems was increased to 1

      request-property-min-items-increased

    • the messages/anyOf[subschema #1]/ request property's minItems was increased to 1

      request-property-min-items-increased

    • the chunks/anyOf[subschema #1]/items/ request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • the raw_text/anyOf[subschema #1]/ request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • added the pattern [\s\S]*\S[\s\S]* to the request property chunks/anyOf[subschema #1]/items/

      request-property-pattern-added

    • added the pattern [\s\S]*\S[\s\S]* to the request property raw_text/anyOf[subschema #1]/

      request-property-pattern-added

    • the ingestion_config/anyOf[subschema #1: IngestionConfig]/chunking_strategy request property type/format changed from / to string/

      request-property-type-changed

    • removed the request property ingestion_config/anyOf[subschema #1: IngestionConfig]/app

      request-property-removed

    • removed the request property ingestion_config/anyOf[subschema #1: IngestionConfig]/chunk_enrichment_settings/generation_config

      request-property-removed

    • removed the request property ingestion_config/anyOf[subschema #1: IngestionConfig]/chunks_for_document_summary

      request-property-removed

    • removed the request property ingestion_config/anyOf[subschema #1: IngestionConfig]/document_summary_max_length

      request-property-removed

    • removed the request property ingestion_config/anyOf[subschema #1: IngestionConfig]/document_summary_model

      request-property-removed

    • removed the request property ingestion_config/anyOf[subschema #1: IngestionConfig]/document_summary_system_prompt

      request-property-removed

    • removed the request property ingestion_config/anyOf[subschema #1: IngestionConfig]/document_summary_task_prompt

      request-property-removed

    • removed the request property ingestion_config/anyOf[subschema #1: IngestionConfig]/extra_fields

      request-property-removed

    • removed the request property ingestion_config/anyOf[subschema #1: IngestionConfig]/skip_document_summary

      request-property-removed

    • api operation id append_to_engram_v1_memories__id__append_post removed and replaced with append_memory

      api-operation-id-removed

    • api tag Memories added

      api-tag-added

    • added the new optional request property messages/anyOf[subschema #1]/items/authority

      new-optional-request-property

    • added the new optional request property messages/anyOf[subschema #1]/items/metadata

      new-optional-request-property

    • added the new optional request property messages/anyOf[subschema #1]/items/parent_id

      new-optional-request-property

    • added the new optional request property messages/anyOf[subschema #1]/items/source_role_id

      new-optional-request-property

    • added the new optional request property messages/anyOf[subschema #1]/items/timestamp

      new-optional-request-property

    • the automatic_extraction request property default value false was added

      request-property-default-value-added

    • the chunk_overlap request property default value 512 was added

      request-property-default-value-added

    • the chunk_size request property default value 1024 was added

      request-property-default-value-added

    • the chunking_strategy request property default value recursive was added

      request-property-default-value-added

    • the max_concurrent_vlm_tasks request property default value 5 was added

      request-property-default-value-added

    • the provider request property default value nebula was added

      request-property-default-value-added

    • the vlm_batch_size request property default value 5 was added

      request-property-default-value-added

    • the vlm_max_tokens_to_sample request property default value 1024 was added

      request-property-default-value-added

    • the vlm_ocr_one_page_per_chunk request property default value true was added

      request-property-default-value-added

    • added NebulaResults_AppendMemoryResponse_ to the response body anyOf list for the response status 200

      response-body-any-of-added

    • removed NebulaResults_MessageResponse_ from the response body anyOf list for the response status 200

      response-body-any-of-removed

    • added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

    This revision also has 119 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog