Back to Supermemory

AI SDK Integration

apps/docs/ai-sdk/overview.mdx

latest2.4 KB
Original Source

The Supermemory AI SDK provides native integration with Vercel's AI SDK through two approaches: User Profiles for automatic personalization and Memory Tools for agent-based interactions.

<Card title="Supermemory tools on npm" icon="npm" href="https://www.npmjs.com/package/@supermemory/tools"> Check out the NPM page for more details </Card>

Installation

bash
npm install @supermemory/tools

User Profiles with Middleware

Automatically inject user profiles into every LLM call for instant personalization. Customize how memories are formatted with the promptTemplate option for XML-based prompting, custom branding, or model-specific formatting.

typescript
import { generateText } from "ai"
import { withSupermemory } from "@supermemory/tools/ai-sdk"
import { openai } from "@ai-sdk/openai"

// Wrap your model with Supermemory - profiles are automatically injected
const modelWithMemory = withSupermemory(openai("gpt-5"), "user-123")

const result = await generateText({
  model: modelWithMemory,
  messages: [{ role: "user", content: "What do you know about me?" }]
})
// The model automatically has the user's profile context!
<Note> **Memory saving is disabled by default.** The middleware only retrieves existing memories. To automatically save new memories from conversations, enable it explicitly:
typescript
const modelWithMemory = withSupermemory(openai("gpt-5"), "user-123", {
  addMemory: "always"
})
</Note>
typescript

Memory Tools

Add memory capabilities to AI agents with search, add, and fetch operations.

typescript
import { streamText } from "ai"
import { createAnthropic } from "@ai-sdk/anthropic"
import { supermemoryTools } from "@supermemory/tools/ai-sdk"

const anthropic = createAnthropic({
  apiKey: "YOUR_ANTHROPIC_KEY"
})

const result = await streamText({
  model: anthropic("claude-3-sonnet"),
  prompt: "Remember that my name is Alice",
  tools: supermemoryTools("YOUR_SUPERMEMORY_KEY")
})

When to Use

ApproachUse Case
User ProfilesPersonalized LLM responses with automatic user context
Memory ToolsAI agents that need explicit memory control

Next Steps

<CardGroup cols={2}> <Card title="User Profiles" icon="user" href="/integrations/ai-sdk"> Automatic personalization with profiles </Card> <Card title="Memory Tools" icon="wrench" href="/integrations/ai-sdk"> Agent-based memory management </Card> </CardGroup>