> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mem0.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Memory as OpenAI Tool

> Wire Mem0 memories into OpenAI's inbuilt function-calling flow.

Integrate Mem0’s memory capabilities with OpenAI’s Inbuilt Tools to create AI agents with persistent memory.

## Getting Started

### Installation

```bash theme={null}
npm install mem0ai openai zod
```

## Environment Setup

Save your Mem0 and OpenAI API keys in a `.env` file:

```
MEM0_API_KEY=your_mem0_api_key
OPENAI_API_KEY=your_openai_api_key
```

Get your Mem0 API key from the <a href="https://app.mem0.ai/dashboard/api-keys?utm_source=oss&utm_medium=cookbook-openai-tool-calls" rel="nofollow">Mem0 Dashboard</a>.

### Configuration

```javascript theme={null}
const USER_ID = "sample-user";

const openAIClient = new OpenAI();
const mem0Client = new MemoryClient({ apiKey: process.env.MEM0_API_KEY });
```

## Adding Memories

Store user preferences, past interactions, or any relevant information:

<CodeGroup>
  ```javascript JavaScript theme={null}
  async function addUserPreferences() {
      const mem0Client = new MemoryClient({ apiKey: process.env.MEM0_API_KEY });
      
      const userPreferences = "I Love BMW, Audi and Porsche. I Hate Mercedes. I love Red cars and Maroon cars. I have a budget of 120K to 150K USD. I like Audi the most.";
      
      await mem0Client.add([{
          role: "user",
          content: userPreferences,
      }], { userId: "sample-user" });
  }

  await addUserPreferences();
  ```

  ```json Output theme={null}
  {
    "message": "Memory processing has been queued for background execution",
    "status": "PENDING",
    "event_id": "9f8c2b1a-4e7d-4c3a-9b21-1a2b3c4d5e6f"
  }
  ```
</CodeGroup>

## Retrieving Memories

Search for relevant memories based on the current user input:

```javascript theme={null}
const relevantMemories = await mem0Client.search(userInput, { filters: { user_id: USER_ID } });
```

## Structured Responses with Zod

Define structured response schemas to get consistent output formats:

```javascript theme={null}
// Define the schema for a car recommendation
const CarSchema = z.object({
  car_name: z.string(),
  car_price: z.string(),
  car_url: z.string(),
  car_image: z.string(),
  car_description: z.string(),
});

// Schema for a list of car recommendations
const Cars = z.object({
  cars: z.array(CarSchema),
});

// Create a function tool based on the schema
const carRecommendationTool = zodResponsesFunction({ 
    name: "carRecommendations", 
    parameters: Cars 
});

// Use the tool in your OpenAI request
const response = await openAIClient.responses.create({
    model: "gpt-5-mini",
    tools: [{ type: "web_search_preview" }, carRecommendationTool],
    input: `${getMemoryString(relevantMemories)}\n${userInput}`,
});
```

## Using Web Search

Combine memory with web search for up-to-date recommendations:

```javascript theme={null}
const response = await openAIClient.responses.create({
    model: "gpt-5-mini",
    tools: [{ type: "web_search_preview" }, carRecommendationTool],
    input: `${getMemoryString(relevantMemories)}\n${userInput}`,
});
```

## Examples

## Complete Car Recommendation System

```javascript theme={null}
import MemoryClient from "mem0ai";
import { OpenAI } from "openai";
import { zodResponsesFunction } from "openai/helpers/zod";
import { z } from "zod";
import dotenv from 'dotenv';

dotenv.config();

const USER_ID = "sample-user";

async function run() {
    // Responses without memories
    console.log("\n\nRESPONSES WITHOUT MEMORIES\n\n");
    await main();

    // Adding sample memories
    await addSampleMemories();

    // Responses with memories
    console.log("\n\nRESPONSES WITH MEMORIES\n\n");
    await main(true);
}

// OpenAI Response Schema
const CarSchema = z.object({
  car_name: z.string(),
  car_price: z.string(),
  car_url: z.string(),
  car_image: z.string(),
  car_description: z.string(),
});

const Cars = z.object({
  cars: z.array(CarSchema),
});

async function main(memory = false) {
  const openAIClient = new OpenAI();
  const mem0Client = new MemoryClient({ apiKey: process.env.MEM0_API_KEY });

  const input = "Suggest me some cars that I can buy today.";

  const tool = zodResponsesFunction({ name: "carRecommendations", parameters: Cars });

  // Store the user input as a memory
  await mem0Client.add([{
    role: "user",
    content: input,
  }], { userId: USER_ID });

  // Search for relevant memories
  let relevantMemories = []
  if (memory) {
    relevantMemories = await mem0Client.search(input, { filters: { user_id: USER_ID } });
  }

  const response = await openAIClient.responses.create({
    model: "gpt-5-mini",
    tools: [{ type: "web_search_preview" }, tool],
    input: `${getMemoryString(relevantMemories)}\n${input}`,
  });

  console.log(response.output);
}

async function addSampleMemories() {
  const mem0Client = new MemoryClient({ apiKey: process.env.MEM0_API_KEY });

  const myInterests = "I Love BMW, Audi and Porsche. I Hate Mercedes. I love Red cars and Maroon cars. I have a budget of 120K to 150K USD. I like Audi the most.";
  
  await mem0Client.add([{
    role: "user",
    content: myInterests,
  }], { userId: USER_ID });
}

const getMemoryString = (memories) => {
    const MEMORY_STRING_PREFIX = "These are the memories I have stored. Give more weightage to the question by users and try to answer that first. You have to modify your answer based on the memories I have provided. If the memories are irrelevant you can ignore them. Also don't reply to this section of the prompt, or the memories, they are only for your reference. The MEMORIES of the USER are: \n\n";
    const memoryString = (memories?.results || memories).map((mem) => `${mem.memory}`).join("\n") ?? "";
    return memoryString.length > 0 ? `${MEMORY_STRING_PREFIX}${memoryString}` : "";
};

run().catch(console.error);
```

## Responses

<CodeGroup>
  ```json Without Memories theme={null}
  {
    "cars": [
      {
        "car_name": "Toyota Camry",
        "car_price": "$25,000",
        "car_url": "https://www.toyota.com/camry/",
        "car_image": "https://link-to-toyota-camry-image.com",
        "car_description": "Reliable mid-size sedan with great fuel efficiency."
      },
      {
        "car_name": "Honda Accord",
        "car_price": "$26,000",
        "car_url": "https://www.honda.com/accord/",
        "car_image": "https://link-to-honda-accord-image.com",
        "car_description": "Comfortable and spacious with advanced safety features."
      },
      {
        "car_name": "Ford Mustang",
        "car_price": "$28,000",
        "car_url": "https://www.ford.com/mustang/",
        "car_image": "https://link-to-ford-mustang-image.com",
        "car_description": "Iconic sports car with powerful engine options."
      },
      {
        "car_name": "Tesla Model 3",
        "car_price": "$38,000",
        "car_url": "https://www.tesla.com/model3",
        "car_image": "https://link-to-tesla-model3-image.com",
        "car_description": "Electric vehicle with advanced technology and long range."
      },
      {
        "car_name": "Chevrolet Equinox",
        "car_price": "$24,000",
        "car_url": "https://www.chevrolet.com/equinox/",
        "car_image": "https://link-to-chevron-equinox-image.com",
        "car_description": "Compact SUV with a spacious interior and user-friendly technology."
      }
    ]
  }
  ```

  ```json With Memories theme={null}
  {
    "cars": [
      {
        "car_name": "Audi RS7",
        "car_price": "$118,500",
        "car_url": "https://www.audiusa.com/us/web/en/models/rs7/2023/overview.html",
        "car_image": "https://www.audiusa.com/content/dam/nemo/us/models/rs7/my23/gallery/1920x1080_AOZ_A717_191004.jpg",
        "car_description": "The Audi RS7 is a high-performance hatchback with a sleek design, powerful 591-hp twin-turbo V8, and luxurious interior. It's available in various colors including red."
      },
      {
        "car_name": "Porsche Panamera GTS",
        "car_price": "$129,300",
        "car_url": "https://www.porsche.com/usa/models/panamera/panamera-models/panamera-gts/",
        "car_image": "https://files.porsche.com/filestore/image/multimedia/noneporsche-panamera-gts-sample-m02-high/normal/8a6327c3-6c7f-4c6f-a9a8-fb9f58b21795;sP;twebp/porsche-normal.webp",
        "car_description": "The Porsche Panamera GTS is a luxury sports sedan with a 473-hp V8 engine, exquisite handling, and available in stunning red. Balances sportiness and comfort."
      },
      {
        "car_name": "BMW M5",
        "car_price": "$105,500",
        "car_url": "https://www.bmwusa.com/vehicles/m-models/m5/sedan/overview.html",
        "car_image": "https://www.bmwusa.com/content/dam/bmwusa/M/m5/2023/bmw-my23-m5-sapphire-black-twilight-purple-exterior-02.jpg",
        "car_description": "The BMW M5 is a powerhouse sedan with a 600-hp V8 engine, known for its great handling and luxury. It comes in several distinctive colors including maroon."
      }
    ]
  }
  ```
</CodeGroup>

## Resources

* [Mem0 Documentation](https://docs.mem0.ai/introduction)
* <a href="https://app.mem0.ai/dashboard?utm_source=oss&utm_medium=cookbook-openai-tool-calls" rel="nofollow">Mem0 Dashboard</a>
* [API Reference](https://docs.mem0.ai/api-reference)
* [OpenAI Documentation](https://platform.openai.com/docs)

***

<CardGroup cols={2}>
  <Card title="Agents SDK Tool with Mem0" icon="robot" href="/cookbooks/integrations/agents-sdk-tool">
    Extend the OpenAI Agents SDK with Mem0 integration capabilities.
  </Card>

  <Card title="Control Memory Ingestion" icon="filter" href="/cookbooks/essentials/controlling-memory-ingestion">
    Fine-tune what memories get stored during tool calls.
  </Card>
</CardGroup>

<Snippet file="star-on-github.mdx" />