Skip to main content

Quickstart

Get started with Audaxic in 5 minutes.

1. Create an Account​

  1. Go to memory-dashboard.audaxic.com
  2. Sign up with your email
  3. You'll start on the Hobby plan (free, no credit card required)

2. Get Your API Key​

  1. In the dashboard, go to Projects
  2. Click Create Project and give your project a name
  3. Click View
  4. Click Create API Key and give your key a name
  5. Copy the key — you'll only see it once

Your API key looks like: ak_abc123def456ghi789jkl012mno345

3. Make Your First API Call​

cURL​

curl -X POST https://api.memory.audaxic.com/add \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ak_your_api_key_here" \
  -d '{
    "messages": ["I prefer dark mode and use VS Code"]
  }'

JavaScript​

const response = await fetch("https://api.memory.audaxic.com/add", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer ak_your_api_key_here",
  },
  body: JSON.stringify({
    messages: ["I prefer dark mode and use VS Code"],
  }),
});

const data = await response.json();
console.log(data);
// { results: [{ id: "mem_xxx", memory: "User prefers dark mode and uses VS Code", metadata: {} }] }

Python​

import requests

response = requests.post(
    "https://api.memory.audaxic.com/add",
    headers={"Authorization": "Bearer ak_your_api_key_here"},
    json={"messages": ["I prefer dark mode and use VS Code"]},
)

data = response.json()
print(data)
# {'results': [{'id': 'mem_xxx', 'memory': 'User prefers dark mode and uses VS Code', 'metadata': {}}]}

4. Search Your Memories​

curl -X POST https://api.memory.audaxic.com/search \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ak_your_api_key_here" \
  -d '{"query": "What editor does the user prefer?"}'

Response:

{
  "results": [
    {
      "id": "mem_xxx",
      "memory": "User prefers dark mode and uses VS Code",
      "metadata": {}
    }
  ]
}

Next Steps​

Last updated on