Actian VectorAI Node.js Client Examples

Runnable examples for the @actian/vectorai-client package.

Prerequisites

• Node.js 18 or newer
• A running Actian VectorAI server, typically at localhost:6574
• For authentication examples, the REST auth endpoint, typically http://localhost:6573

Install

npm install

Run Examples

List all examples:

npm run examples:list

Run the full example suite against the default server:

npm run examples:run

Run the suite against a custom gRPC address:

npm run examples:run -- localhost:6574

Run one example:

npm run example:hello

You can also run any example directly:

npx tsx examples/04_vector_search.ts localhost:6574

Environment Variables

Some examples also read:

ACTIAN_VECTORAI_URL=localhost:6574
ACTIAN_VECTORAI_REST_URL=http://localhost:6573
ACTIAN_VECTORAI_ACCESS_TOKEN=...
VECTORAI_ADMIN_PASS=<ADMIN_PASSWORD>

The authentication example (24_authentication.ts) requires VECTORAI_ADMIN_PASS. It can also be set in a .env.test file in the repository root, which the example loads automatically; explicit environment variables take precedence.

Notes

• Examples create temporary collections and attempt to clean them up before exiting.
• Server-version-sensitive examples may report unsupported operations if the connected server does not implement that feature.
• Authentication and TLS examples require matching server configuration.

License

Copyright (c) 2026 Actian Corporation SPDX-License-Identifier: MIT