Installation

Install the JavaScript SDK with npm install @actian/vectorai-client.

The JavaScript SDK provides a TypeScript-first VectorAIClient for VectorAI DB over gRPC, plus REST-based auth/admin helpers.

Prerequisites

Requirement	Version
Node.js	18 or higher
npm	9 or higher
VectorAI DB	Running at localhost:6574 by default

Install the SDK

npm install @actian/vectorai-client

With yarn:

yarn add @actian/vectorai-client

Verify installation

Requires VectorAI DB running locally. See the Docker setup guide if you haven’t done that yet.

Save the following as health.ts and run it with npx tsx health.ts.

import { VectorAIClient } from '@actian/vectorai-client';

const client = new VectorAIClient('localhost:6574');

try {
  const health = await client.healthCheck();
  console.log(`Server: ${health.title} v${health.version}`);
} finally {
  client.close();
}

For all client configuration options, see the JavaScript SDK reference.

Project setup

Create a TypeScript project and install the SDK.

mkdir my-vectorai-app
cd my-vectorai-app
npm init -y
npm install @actian/vectorai-client
npm install --save-dev typescript tsx @types/node
npx tsc --init

Troubleshooting

Issue	Solution
MODULE_NOT_FOUND	Verify the SDK is installed with npm ls @actian/vectorai-client.
gRPC connection errors	Confirm VectorAI DB is reachable at localhost:6574.
Node.js version mismatch	Run node --version; the SDK requires Node.js 18 or later.
TypeScript module errors	Use an ESM-compatible setup and run examples with tsx.

Next steps

Quickstart

Create a collection, insert vectors, and run a search.

JavaScript reference

Review namespaces, client options, filters, auth, batching, and errors.