Skip to main content

Install

npm install velixar

Quick Start

import Velixar from 'velixar';

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

// Store
const { id } = await v.store('Staging database is in us-west-2', {
  tags: ['infrastructure', 'staging']
});

// Search
const results = await v.search('staging database');

// Knowledge graph
const graph = await v.graphTraverse('PostgreSQL', { depth: 2 });

// Identity
const profile = await v.getIdentity();

// CI/CD webhook
await v.webhook('deployment', 'Deployed v1.0.0 to production', {
  tags: ['production'], metadata: { version: '1.0.0' }
});

Configuration

const v = new Velixar({
  apiKey: 'vlx_your_key',       // Required
  baseUrl: 'https://...',       // Optional — custom endpoint
  workspaceId: 'my-project',    // Optional — workspace isolation
  maxRetries: 3,                // Optional — retry attempts
  timeout: 30000,               // Optional — request timeout (ms)
});

Methods

Memory

MethodReturnsDescription
store(content, opts?){ id }Store a memory
search(query, opts?)SearchResultSemantic search
list(opts?)ListResultPaginated list
get(id)MemoryGet by ID
update(id, updates){ updated }Update content or tags
delete(id){ deleted }Delete

Knowledge Graph

MethodReturnsDescription
graphTraverse(entity, opts?)TraverseResultWalk relationships
graphSearch(query, opts?){ entities }Search entities
graphEntities(opts?){ entities }List all entities

Cognitive

MethodReturnsDescription
getIdentity(opts?)IdentityProfileUser profile
overview()OverviewResultKnowledge graph stats
contradictions(){ contradictions }Conflicting facts

Integration

MethodReturnsDescription
webhook(eventType, content, opts?)WebhookResultCI/CD event
exportMemories(opts?)ExportResultExport as JSON/Markdown
importMemories(data, opts?){ imported, failed }Bulk import
health()objectHealth check

TypeScript

Full type definitions included. Key types: Memory, SearchResult, GraphEntity, GraphRelation, TraverseResult, IdentityProfile.

Source

github.com/VelixarAi/velixar-js