Quickstart Guide

Get started with Engram in just a few minutes

Quickstart Guide

Get up and running with Engram in just a few minutes. This guide will walk you through the basic setup and your first API calls.

Installation

Using npm (Node.js)

npm install @engram/sdk

Using pip (Python)

pip install engram-sdk

Setup

First, you'll need an API key. Sign up for a free account at engram.dev to get your API key.

Environment Setup

Create a .env file in your project root:

ENGRAM_API_KEY=your_api_key_here
ENGRAM_BASE_URL=https://api.engram.dev

Your First Memory

Let's store your first piece of information in Engram:

Node.js Example

import { EngramClient } from '@engram/sdk';

const client = new EngramClient({
  apiKey: process.env.ENGRAM_API_KEY,
});

// Store a memory
const memory = await client.store({
  content: "Engram is an advanced AI memory system",
  metadata: {
    category: "documentation",
    importance: 0.8
  }
});

console.log('Memory stored:', memory.id);

Python Example

from engram import EngramClient

client = EngramClient(api_key=os.getenv('ENGRAM_API_KEY'))

# Store a memory
memory = client.store(
    content="Engram is an advanced AI memory system",
    metadata={
        "category": "documentation",
        "importance": 0.8
    }
)

print(f"Memory stored: {memory.id}")

Searching Memories

Now let's search for the memory we just stored:

Node.js Example

// Search for memories
const results = await client.search({
  query: "What is Engram?",
  limit: 10
});

console.log('Found memories:', results.memories);

Python Example

# Search for memories
results = client.search(
    query="What is Engram?",
    limit=10
)

print(f"Found memories: {results.memories}")

Next Steps

Congratulations! You've successfully stored and retrieved your first memory with Engram. Here's what to explore next:

Need Help?

Happy building! 🚀