Skip to main content

Memories

SDK methods for the Memories module, accessed via soat.memories. See the Memories module docs for permissions and data model, and each method's REST page for the full request/response schema.

soat.memories.listMemories()​

List memories

  • Method: GET
  • Path: /api/v1/memories
await soat.memories.listMemories({
  query: { memory_store_id, /* + optional */ },
});

→ Request & response schema

soat.memories.createMemory()​

Create a memory

  • Method: POST
  • Path: /api/v1/memories
await soat.memories.createMemory({
  body: { memory_store_id, content, /* + optional */ },
});

→ Request & response schema

soat.memories.getMemory()​

Get a memory

  • Method: GET
  • Path: /api/v1/memories/{memory_id}
await soat.memories.getMemory({
  path: { memory_id },
});

→ Request & response schema

soat.memories.updateMemory()​

Update a memory

  • Method: PUT
  • Path: /api/v1/memories/{memory_id}
await soat.memories.updateMemory({
  path: { memory_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.memories.deleteMemory()​

Delete a memory

  • Method: DELETE
  • Path: /api/v1/memories/{memory_id}
await soat.memories.deleteMemory({
  path: { memory_id },
});

→ Request & response schema

soat.memories.retractMemory()​

Retract a memory

  • Method: POST
  • Path: /api/v1/memories/{memory_id}/retract
await soat.memories.retractMemory({
  path: { memory_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.memories.listMemoryAssertions()​

List a memory's assertions

  • Method: GET
  • Path: /api/v1/memories/{memory_id}/assertions
await soat.memories.listMemoryAssertions({
  path: { memory_id },
});

→ Request & response schema

soat.memories.getMemoryTags()​

Get memory tags

  • Method: GET
  • Path: /api/v1/memories/{memory_id}/tags
await soat.memories.getMemoryTags({
  path: { memory_id },
});

→ Request & response schema

soat.memories.replaceMemoryTags()​

Replace memory tags

  • Method: PUT
  • Path: /api/v1/memories/{memory_id}/tags
await soat.memories.replaceMemoryTags({
  path: { memory_id },
  body,
});

→ Request & response schema

soat.memories.mergeMemoryTags()​

Merge memory tags

  • Method: PATCH
  • Path: /api/v1/memories/{memory_id}/tags
await soat.memories.mergeMemoryTags({
  path: { memory_id },
  body,
});

→ Request & response schema