Skip to main content

MemoryEntries Commands

See MemoryEntries module docs for permissions and data model.

soat list-memory-entries​

List memory entries

  • Method: GET
  • Path: /api/v1/memory-entries

Usage​

soat list-memory-entries --memory-id <string>

Options​

--memory-id​

Memory container to list entries from (mem_...)

  • Source: query
  • Required: yes
  • Type: string
  • Example: mem_V1StGXR8Z5jdHi6B

soat create-memory-entry​

Create a memory entry

  • Method: POST
  • Path: /api/v1/memory-entries

Usage​

soat create-memory-entry --memory-id <string> --content <string>

Options​

--memory-id​

Memory container to add the entry to (mem_...)

  • Source: body
  • Required: yes
  • Type: string
  • Example: mem_V1StGXR8Z5jdHi6B
--content​

The text content of the memory entry

  • Source: body
  • Required: yes
  • Type: string
  • Example: The customer prefers email communication over phone calls
--source-type​

How this entry was created

  • Source: body
  • Required: no
  • Type: enum("manual", "agent", "extraction")
  • Default: manual
  • Example: manual
--duplicate-threshold​

Cosine similarity score at or above which the incoming content is considered a duplicate and skipped (default 0.95)

  • Source: body
  • Required: no
  • Type: number
  • Default: 0.95
--update-threshold​

Cosine similarity score at or above which the incoming content is appended to the existing entry (default 0.75)

  • Source: body
  • Required: no
  • Type: number
  • Default: 0.75

soat get-memory-entry​

Get a memory entry

  • Method: GET
  • Path: /api/v1/memory-entries/{entry_id}

Usage​

soat get-memory-entry --entry-id <string>

Options​

--entry-id​

—

  • Source: path
  • Required: yes
  • Type: string
  • Example: mem_entry_V1StGXR8Z5jdHi6B

soat update-memory-entry​

Update a memory entry

  • Method: PUT
  • Path: /api/v1/memory-entries/{entry_id}

Usage​

soat update-memory-entry --entry-id <string>

Options​

--entry-id​

—

  • Source: path
  • Required: yes
  • Type: string
  • Example: mem_entry_V1StGXR8Z5jdHi6B
--content​

Updated text content

  • Source: body
  • Required: no
  • Type: string

soat delete-memory-entry​

Delete a memory entry

  • Method: DELETE
  • Path: /api/v1/memory-entries/{entry_id}

Usage​

soat delete-memory-entry --entry-id <string>

Options​

--entry-id​

—

  • Source: path
  • Required: yes
  • Type: string
  • Example: mem_entry_V1StGXR8Z5jdHi6B