Skip to main content

Install

npm install velixar

Quick start

import { Velixar } from 'velixar';

const client = new Velixar({ apiKey: 'vlx_your_key' });

// Store
const mem = await client.store({
  content: 'User prefers dark mode',
  userId: 'user_123',
  tier: 0
});
console.log(mem.id); // mem_abc123

// Search
const results = await client.search({
  query: 'display preferences',
  userId: 'user_123',
  limit: 5
});
results.forEach(r => console.log(`${r.score}${r.content}`));

// Get
const memory = await client.get(mem.id);

// Delete
await client.delete(mem.id);

Configuration

const client = new Velixar({
  apiKey: 'vlx_your_key',
  baseUrl: 'https://api.velixarai.com/v1', // default
  timeout: 30000,                         // ms
});

TypeScript

The SDK is written in TypeScript with full type definitions:
import { Velixar, Memory, SearchResult } from 'velixar';

const results: SearchResult[] = await client.search({
  query: 'user preferences',
  userId: 'user_123'
});

Source

github.com/VelixarAIInc/velixar-js