| Entry point | Import | When to use |
|---|---|---|
MemWal | @mysten-incubation/memwal | Recommended default for most integrations — relayer handles embeddings, SEAL, and storage |
MemWalManual | @mysten-incubation/memwal/manual | You need client-managed embeddings and local SEAL operations |
withMemWal | @mysten-incubation/memwal/ai | You already use the Vercel AI SDK and want memory as middleware |
Installation
MemWalManual, you also need the optional peer dependencies:
withMemWal, you also need:
Configuration
Before wiring the SDK into your app:- These hosted endpoints are provided by Walrus Foundation.
- Generate a MemWal account ID and delegate private key for your client using the hosted endpoint:
- Production (mainnet):
https://memwal.aiorhttps://memwal.wal.app - Staging (testnet):
https://staging.memwal.ai
- Production (mainnet):
- Choose a relayer:
- Use the hosted relayer at
https://relayer.memwal.ai(mainnet) orhttps://relayer.staging.memwal.ai(testnet) - Or deploy your own relayer with access to a wallet funded with WAL and SUI
- Use the hosted relayer at
MemWal.create takes a config object with the following fields:
| Property | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Ed25519 private key in hex |
accountId | string | Yes | MemWalAccount object ID on Sui |
serverUrl | string | No | Relayer URL — use https://relayer.memwal.ai (mainnet) or https://relayer.staging.memwal.ai (testnet) for the managed relayer |
namespace | string | No | Default namespace — falls back to "default" |
First Memory
Next Steps
- Usage — all three clients in detail, namespace rules, and restore
- API Reference — full method signatures and config fields