Installation — ConvoMem Docs

ConvoMem provides official SDKs for TypeScript, Python, and Rust, plus full REST API support via cURL.

Install the SDK

# npm
npx jsr add @optraze/convomem-sdk
 
# pnpm
pnpm i jsr:@optraze/convomem-sdk
 
# bun
bunx jsr add @optraze/convomem-sdk
 
# deno
deno add jsr:@optraze/convomem-sdk

Get an API key

Create a key from the dashboard. Each key is bound to one agent — the workspace for one bot or use case — and everything you capture or recall with it stays inside that agent. Give each bot its own key. See Authentication.

Keep keys server-side

Never expose an API key in client-side code. All ConvoMem calls should originate from your backend or an edge function. For browser widgets, use embed tokens.

Initialize the client

import { ConvoMem } from '@optraze/convomem-sdk'
 
const client = new ConvoMem({
  apiKey: process.env.CONVOMEM_API_KEY!,
})

Verify the connection

const { total } = await client.listCustomers({ limit: 1 })
console.log(`Connected — ${total} customers`)

Once this succeeds, continue to the Quick start to capture your first conversation.