5 minute setup
Quickstart Guide
Get your AI remembering things in under 5 minutes. No complex setup required.
1
Get Your API Key
Sign up and create an API key from the dashboard.
2
Install the SDK
Choose Python or TypeScript and install the package.
3
Start Building
Add memories and search with just a few lines of code.
Step 1: Get Your API Key
Sign up at the Developer Dashboard and create an API key. It's free to start with 1,000 API calls per month.
Terminal
export HEBBRIX_API_KEY="mem_sk_your_api_key_here"Step 2: Install the SDK
We support Python and TypeScript. Pick your favorite:
Python
pip install hebbrixTypeScript
npm install hebbrixStep 3: Create Your First Memory
Store a memory and then search for it. That's all it takes.
Python
from hebbrix import Hebbrix
# Initialize the client
client = Hebbrix(api_key="your_api_key")
# Store a memory
memory = client.memories.create(
content="User prefers dark mode and uses Python for development"
)
print(f"Created memory: {memory.id}")
# Search for it
results = client.search("what programming language does the user prefer?")
for result in results:
print(f"Found: {result.content}")TypeScript
import { Hebbrix } from 'hebbrix';
// Initialize the client
const client = new Hebbrix({ apiKey: 'your_api_key' });
// Store a memory
const memory = await client.memories.create({
content: 'User prefers dark mode and uses TypeScript for development'
});
console.log('Created memory:', memory.id);
// Search for it
const results = await client.search('what programming language does the user prefer?');
results.forEach(result => {
console.log('Found:', result.content);
});Bonus: OpenAI-Compatible Chat
Use our chat completions endpoint as a drop-in replacement for OpenAI. Memories are automatically injected into the context.
OpenAI-Compatible
from openai import OpenAI
# Point to Hebbrix instead of OpenAI
client = OpenAI(
api_key="your_hebbrix_api_key",
base_url="https://api.hebbrix.com/v1"
)
# Chat with memory
response = client.chat.completions.create(
model="gpt-4", # or any model
messages=[
{"role": "user", "content": "What do I prefer?"}
]
)
# The response will include relevant memories automatically
print(response.choices[0].message.content)What's Next?
Now that you've got the basics, explore more features:
