Quickstart
Get started with Hypersave in under 5 minutes. This guide will walk you through saving your first memory and asking your first question.
Prerequisites
- A Hypersave API key (Get one here (opens in a new tab))
Step 1: Get Your API Key
- Sign up at platform.hypersave.io (opens in a new tab)
- Navigate to API Keys in the dashboard
- Click Create New Key
- Copy your API key (starts with
hs_live_orhs_test_)
⚠️
Keep your API key secure! Never expose it in client-side code or public repositories.
Step 2: Save Your First Memory
Let's save some content to Hypersave. The /v1/save endpoint accepts text, URLs, or files.
curl -X POST https://api.hypersave.io/v1/save \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"content": "Hypersave is a memory API that gives AI applications persistent, intelligent memory. Founded in 2024, it enables developers to build applications that can remember, learn, and recall information semantically."
}'Response:
{
"success": true,
"message": "Content saved successfully",
"documentId": "doc_abc123xyz"
}Step 3: Ask a Question
Now let's ask a question about the content we just saved using the /v1/ask endpoint.
curl -X POST https://api.hypersave.io/v1/ask \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "What is Hypersave and when was it founded?"
}'Response:
{
"success": true,
"answer": "Hypersave is a memory API that gives AI applications persistent, intelligent memory. It was founded in 2024 and enables developers to build applications that can remember, learn, and recall information semantically."
}Step 4: Search Your Memories
Use semantic search to find relevant content with the /v1/search endpoint.
curl -X POST https://api.hypersave.io/v1/search \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "AI memory",
"limit": 5
}'Response:
{
"success": true,
"results": [
{
"content": "Hypersave is a memory API that gives AI applications persistent, intelligent memory...",
"score": 0.92,
"documentId": "doc_abc123xyz"
}
]
}