# MemoryStores SDK Methods

> The soat.memoryStores methods of the SOAT TypeScript SDK for the MemoryStores module, each linked to its REST operation.

# MemoryStores

SDK methods for the MemoryStores module, accessed via `soat.memoryStores`. See the [MemoryStores module docs](/docs/modules/memories) 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`

```ts
await soat.memoryStores.listMemoryStores({
  query: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/memory-stores/list-memory-stores)

### `soat.memoryStores.createMemoryStore()`

Create a memory store

- Method: `POST`
- Path: `/api/v1/memory-stores`

```ts
await soat.memoryStores.createMemoryStore({
  body: { name, /* + optional */ },
});
```

→ [Request & response schema](/docs/api/memory-stores/create-memory-store)

### `soat.memoryStores.getMemoryStore()`

Get a memory store

- Method: `GET`
- Path: `/api/v1/memory-stores/{memory_store_id}`

```ts
await soat.memoryStores.getMemoryStore({
  path: { memory_store_id },
});
```

→ [Request & response schema](/docs/api/memory-stores/get-memory-store)

### `soat.memoryStores.updateMemoryStore()`

Update a memory store

- Method: `PUT`
- Path: `/api/v1/memory-stores/{memory_store_id}`

```ts
await soat.memoryStores.updateMemoryStore({
  path: { memory_store_id },
  body: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/memory-stores/update-memory-store)

### `soat.memoryStores.deleteMemoryStore()`

Delete a memory store

- Method: `DELETE`
- Path: `/api/v1/memory-stores/{memory_store_id}`

```ts
await soat.memoryStores.deleteMemoryStore({
  path: { memory_store_id },
});
```

→ [Request & response schema](/docs/api/memory-stores/delete-memory-store)

### `soat.memoryStores.listMemoryStoreAssertions()`

List a memory store's write assertions

- Method: `GET`
- Path: `/api/v1/memory-stores/{memory_store_id}/assertions`

```ts
await soat.memoryStores.listMemoryStoreAssertions({
  path: { memory_store_id },
  query: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/memory-stores/list-memory-store-assertions)

### `soat.memoryStores.exportMemories()`

Export a memory store's memories as NDJSON

- Method: `GET`
- Path: `/api/v1/memory-stores/{memory_store_id}/export`

```ts
await soat.memoryStores.exportMemories({
  path: { memory_store_id },
  query: { /* + optional */ },
});
```

→ [Request & response schema](/docs/api/memory-stores/export-memories)

### `soat.memoryStores.getMemoryStoreTags()`

Get memory store tags

- Method: `GET`
- Path: `/api/v1/memory-stores/{memory_store_id}/tags`

```ts
await soat.memoryStores.getMemoryStoreTags({
  path: { memory_store_id },
});
```

→ [Request & response schema](/docs/api/memory-stores/get-memory-store-tags)

### `soat.memoryStores.replaceMemoryStoreTags()`

Replace memory store tags

- Method: `PUT`
- Path: `/api/v1/memory-stores/{memory_store_id}/tags`

```ts
await soat.memoryStores.replaceMemoryStoreTags({
  path: { memory_store_id },
  body,
});
```

→ [Request & response schema](/docs/api/memory-stores/replace-memory-store-tags)

### `soat.memoryStores.mergeMemoryStoreTags()`

Merge memory store tags

- Method: `PATCH`
- Path: `/api/v1/memory-stores/{memory_store_id}/tags`

```ts
await soat.memoryStores.mergeMemoryStoreTags({
  path: { memory_store_id },
  body,
});
```

→ [Request & response schema](/docs/api/memory-stores/merge-memory-store-tags)