Skip to main content

Memories Commands

See Memories module docs for permissions and data model.

soat list-memories​

List memories

  • Method: GET
  • Path: /api/v1/memories

Usage​

soat list-memories

Options​

--project-id​

Project ID (required if not using project key auth)

  • Source: query
  • Required: no
  • Type: string
  • Example: proj_V1StGXR8Z5jdHi6B
--tags​

Filter memories by tag patterns. Supports glob syntax (* matches any substring, ? matches any single character). Multiple values are ORed — a memory is returned if any of its tags match any of the provided patterns. Omit to return all memories.

  • Source: query
  • Required: no
  • Type: array<string>
  • Example: ["customer*","support"]

soat create-memory​

Create a memory

  • Method: POST
  • Path: /api/v1/memories

Usage​

soat create-memory --name <string>

Options​

--project-id​

Project ID (required if not using project key auth)

  • Source: body
  • Required: no
  • Type: string
  • Example: proj_V1StGXR8Z5jdHi6B
--name​

Memory name

  • Source: body
  • Required: yes
  • Type: string
  • Example: Product Documentation
--description​

Optional description

  • Source: body
  • Required: no
  • Type: string
  • Example: Retrieves product docs for support queries
--tags​

Optional list of tags for filtering in knowledge search

  • Source: body
  • Required: no
  • Type: array<string>
  • Example: ["projectA","customer-support"]

soat get-memory​

Get a memory

  • Method: GET
  • Path: /api/v1/memories/{memory_id}

Usage​

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

Options​

--memory-id​

—

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

soat update-memory​

Update a memory

  • Method: PUT
  • Path: /api/v1/memories/{memory_id}

Usage​

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

Options​

--memory-id​

—

  • Source: path
  • Required: yes
  • Type: string
  • Example: mem_V1StGXR8Z5jdHi6B
--name​

Memory name

  • Source: body
  • Required: no
  • Type: string
--description​

Optional description

  • Source: body
  • Required: no
  • Type: string \| null
--tags​

Optional list of tags for filtering in knowledge search

  • Source: body
  • Required: no
  • Type: array<string>

soat delete-memory​

Delete a memory

  • Method: DELETE
  • Path: /api/v1/memories/{memory_id}

Usage​

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

Options​

--memory-id​

—

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