Skip to main content

Weaviate JavaScript/Typescript client

Installation

The latest Weaviate TypeScript client library can be installed using npm. The client library is tested on Node v18 and later. Install it using the following command:

npm install weaviate-client

The latest major version is v3 (e.g. 3.x.x). You can check the version like so:

npm view weaviate-client version

Basic usage

You can import the Weaviate client library like so:

import weaviate, { generateUuid5, ApiKey } from "weaviate-client"

The client provides sets of helper functions (e.g. generateUuid5, ApiKey) to make it easier to interact with Weaviate.

Next, we'll show you how create a Weaviate instance and connect to it.

Questions and feedback

If you have any questions or feedback, let us know in the user forum.