Quick Start

From zero to your first memory stored and retrieved in under 5 minutes.

Step 1 — Get your API key

Create an account at app.bizxengine.com. Navigate to Settings → API Keys and create a new key. Keys are prefixed with bxe_.

Step 2 — Store your first memory

curl -X POST https://api.bizxengine.com/v1/memory/write \
  -H "Authorization: Bearer bxe_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Client XYZ prefers async comms and morning meetings",
    "workspace_id": "ws_abc123",
    "importance": 8
  }'

import bizxengine

client = bizxengine.Client(api_key="bxe_YOUR_KEY")

memory = client.memory.write(
    workspace_id="ws_abc123",
    text="Client XYZ prefers async comms and morning meetings",
    importance=8
)

print(memory.id)  # mem_7xKzP3...

import { BizXEngine } from "@bizxengine/sdk";

const client = new BizXEngine({ apiKey: "bxe_YOUR_KEY" });

const memory = await client.memory.write({
  workspaceId: "ws_abc123",
  text: "Client XYZ prefers async comms and morning meetings",
  importance: 8,
});

console.log(memory.id);

Step 3 — Search your memories

curl -X POST https://api.bizxengine.com/v1/memory/search \
  -H "Authorization: Bearer bxe_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_id": "ws_abc123",
    "query": "communication preferences",
    "top_k": 5
  }'

The response returns ranked memories with relevance scores:

{
  "memories": [
    {
      "id": "mem_7xKzP3",
      "text": "Client XYZ prefers async comms and morning meetings",
      "score": 0.94,
      "importance": 8,
      "created_at": "2025-03-14T09:41:00Z"
    }
  ],
  "request_id": "req_Kx8mN..."
}