engram-client

TypeScript client for Engram Cloud - AI memory infrastructure for agents.

Installation

npm install engram-client

Quick Start

import { EngramClient } from "engram-client";

const client = new EngramClient({
  baseUrl: "https://engram-cloud-gateway.fly.dev",
  apiKey: "ek_...",
  tenant: "my-tenant",
});

// Create a memory
const memory = await client.create("User prefers dark mode", {
  tags: ["preferences", "ui"],
  workspace: "my-project",
});

// Search (hybrid: BM25 + vector + fuzzy)
const results = await client.search("user preferences");

// List with filters
const memories = await client.list({ limit: 20, workspace: "my-project" });

// Get by ID
const mem = await client.get(42);

// Update
await client.update(42, {
  content: "User prefers light mode",
  tags: ["preferences"],
});

// Delete
await client.delete(42);

// Stats
const stats = await client.stats();

API Reference

new EngramClient(config)

interface EngramConfig {
  baseUrl: string;   // Engram Cloud URL
  apiKey: string;    // API key (ek_...)
  tenant: string;    // Tenant slug
}

Methods

| Method | Return Type | Description | |--------|-------------|-------------| | create(content, options?) | Promise<Memory> | Create a memory | | get(id) | Promise<Memory> | Get memory by ID | | update(id, options) | Promise<Memory> | Update a memory | | delete(id) | Promise<void> | Delete a memory | | list(options?) | Promise<Memory[]> | List memories with filters | | search(query, options?) | Promise<SearchResult[]> | Hybrid search | | stats() | Promise<Stats> | Storage statistics |

Options

CreateOptions: tags, workspace, memoryType, importance, metadata, tier

ListOptions: limit, offset, workspace, memoryType, tags, sortBy, sortOrder

SearchOptions: limit, workspace, tags, memoryType, includeArchived

Error Handling

import { EngramError } from "engram-client";

try {
  await client.get(999);
} catch (e) {
  if (e instanceof EngramError) {
    console.error(`${e.status}: ${e.message}`);
  }
}

Requirements

• TypeScript >= 5.3
• Node.js >= 18 (uses native fetch)

Related

• Engram - Core memory engine (Rust)
• Engram Cloud - Multi-tenant SaaS gateway
• engram-client - Python client

License

MIT