Skip to main content

MemoryStores

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

soat.memoryStores.listMemoryStores()​

List memory stores

  • Method: GET
  • Path: /api/v1/memory-stores
await soat.memoryStores.listMemoryStores({
  query: { /* + optional */ },
});

→ Request & response schema

soat.memoryStores.createMemoryStore()​

Create a memory store

  • Method: POST
  • Path: /api/v1/memory-stores
await soat.memoryStores.createMemoryStore({
  body: { name, /* + optional */ },
});

→ Request & response schema

soat.memoryStores.getMemoryStore()​

Get a memory store

  • Method: GET
  • Path: /api/v1/memory-stores/{memory_store_id}
await soat.memoryStores.getMemoryStore({
  path: { memory_store_id },
});

→ Request & response schema

soat.memoryStores.updateMemoryStore()​

Update a memory store

  • Method: PUT
  • Path: /api/v1/memory-stores/{memory_store_id}
await soat.memoryStores.updateMemoryStore({
  path: { memory_store_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.memoryStores.deleteMemoryStore()​

Delete a memory store

  • Method: DELETE
  • Path: /api/v1/memory-stores/{memory_store_id}
await soat.memoryStores.deleteMemoryStore({
  path: { memory_store_id },
});

→ Request & response schema

soat.memoryStores.listMemoryStoreAssertions()​

List a memory store's write assertions

  • Method: GET
  • Path: /api/v1/memory-stores/{memory_store_id}/assertions
await soat.memoryStores.listMemoryStoreAssertions({
  path: { memory_store_id },
  query: { /* + optional */ },
});

→ Request & response schema

soat.memoryStores.exportMemories()​

Export a memory store's memories as NDJSON

  • Method: GET
  • Path: /api/v1/memory-stores/{memory_store_id}/export
await soat.memoryStores.exportMemories({
  path: { memory_store_id },
  query: { /* + optional */ },
});

→ Request & response schema

soat.memoryStores.getMemoryStoreTags()​

Get memory store tags

  • Method: GET
  • Path: /api/v1/memory-stores/{memory_store_id}/tags
await soat.memoryStores.getMemoryStoreTags({
  path: { memory_store_id },
});

→ Request & response schema

soat.memoryStores.replaceMemoryStoreTags()​

Replace memory store tags

  • Method: PUT
  • Path: /api/v1/memory-stores/{memory_store_id}/tags
await soat.memoryStores.replaceMemoryStoreTags({
  path: { memory_store_id },
  body,
});

→ Request & response schema

soat.memoryStores.mergeMemoryStoreTags()​

Merge memory store tags

  • Method: PATCH
  • Path: /api/v1/memory-stores/{memory_store_id}/tags
await soat.memoryStores.mergeMemoryStoreTags({
  path: { memory_store_id },
  body,
});

→ Request & response schema