# JavaScript and TypeScript

:::::callout{intent="note" title="JavaScript/TypeScript client (SDK)"}
The latest TypeScript client is version `v3.13.1`.

::::card-grid
:::card{title="weaviate/typescript-client" href="https://github.com/weaviate/typescript-client" icon="github"}
:::

:::card{title="Reference manual" href="https://weaviate.github.io/typescript-client/index.html" icon="book"}
:::
::::
:::::

The TypeScript client supports code that is written in TypeScript or JavaScript.

The **v3 client** is the current TypeScript client. If you have code written for the [v2 client](typescript.md#javascripttypescript-client-v2-deprecation), you should migrate it to v3 as the v2 client is no longer maintained.

:::callout{intent="note"}
The v3 client supports server side development (Node.js hosted). If your application is browser based, you might consider using the [TypeScript client v2](typescript.md#javascripttypescript-client-v2-deprecation). Keep in mind that the v2 client is outdated and no longer officially maintained.
:::

## Installation

This section details how install and configure the v3 TypeScript client.

#### Install the package

The v3 client package has a new name, `weaviate-client`. Use [npm](https://www.npmjs.com/) to install the TypeScript client library package:

```bash
npm install weaviate-client
```

#### Import the Client

The v3 client uses `ES Modules`. Most of the sample code in the documentation also uses the `ES Module` style.

If your code requires `CommonJS` compatibility, use the `CommonJS` import style:

:::code-group{sync="languages"}
```ts title="ES Modules"
import weaviate from "weaviate-client";
```

```ts title="CommonJS"
const weaviate = require("weaviate-client").default;
```
:::

#### TypeScript setup

Edit your project's configuration files to make these changes:

- Add `"type": "module"` to `package.json`
- Add the following code to [`tsconfig.json`](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html)

:::accordion{title="tsconfig.json file"}
```json
{
  "compilerOptions": {
    "target": "ESNext",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "esModuleInterop": true,
    "skipLibCheck": true,
    "allowSyntheticDefaultImports": true,
    "strict": true
  },
  "include": ["src/index.ts"] // this compiles only src/.index.ts, to compile all .ts files, use ["*.ts"]
}
```
:::

## Get started

:::callout{intent="tip" title="Prerequisites"}
If you haven't yet, we recommend going through the [**Quickstart tutorial**](../quickstart/index.md) first to get the most out of this section.
:::

The following code demonstrates how to:

1. Connect to a local Weaviate instance.
2. Create a new collection.
3. Populate the database using batch import and vectorize the data.
4. Perform a vector search.

```typescript {5-11,21-30,32-36}
import weaviate, { WeaviateClient, vectors } from 'weaviate-client';

const client: WeaviateClient = await weaviate.connectToLocal();

await client.collections.create({
    name: 'Question',
    vectorizers: vectors.text2VecOllama({    // Configure the Ollama embedding integration
        apiEndpoint: 'http://ollama:11434',  // If using Docker you might need: http://host.docker.internal:11434
        model: 'nomic-embed-text',           // The model to use
    }),
});

// Load data
async function getJsonData() {
    const file = await fetch(
        'https://raw.githubusercontent.com/weaviate-tutorials/quickstart/main/data/jeopardy_tiny.json'
    );
    return file.json();
}

// Note: The TS client does not have a `batch` method yet
// We use `insertMany` instead, which sends all of the data in one request
async function importQuestions() {
    const questions = client.collections.use('Question');
    const data = await getJsonData();
    const result = await questions.data.insertMany(data);
    console.log('Insertion response: ', result);
}

await importQuestions();

const questions = client.collections.use('Question');

const result = await questions.query.nearText('biology', {
    limit: 2,
});

result.objects.forEach((item) => {
    console.log(JSON.stringify(item.properties, null, 2));
});

client.close(); // Close the client connection
```

## Asynchronous usage

All client v3 methods, with the exception of `collection.use()`, use ES6 Promises with asynchronous code. This means you have to use `.then()` after function calls, or wrap your code `async/await` blocks.

When there is an asynchronous code error, a promise returns the specific error message. If you use `async` and `await`, a rejected promises acts like a thrown exception

## Releases

Go to the [GitHub releases page](https://github.com/weaviate/typescript-client/releases) to see the history of the TypeScript client library releases and change logs.

::::accordion{title="Click here for a table of Weaviate and corresponding client versions"}
This table lists recent Weaviate Database versions and corresponding client library versions.

| Weaviate Database <br>(\[GitHub]\[cWeaviate])                       | First <br>release date |                          Python <br>(\[GitHub]\[cPython])                         |           TypeScript/ <br>JavaScript <br>(\[GitHub]\[cTypeScript])           |                           Go <br>(\[GitHub]\[cGo])                          |                     Java <br>(\[GitHub]\[cJava])                    |                      C# <br>(\[GitHub]\[cCSharp])                     |
| :------------------------------------------------------------------ | :--------------------- | :-------------------------------------------------------------------------------: | :--------------------------------------------------------------------------: | :-------------------------------------------------------------------------: | :-----------------------------------------------------------------: | :-------------------------------------------------------------------: |
| [1.39.x](https://github.com/weaviate/weaviate/releases/tag/v1.39.0) | 2026-08-04             | [4.23.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.23.0) |                                       -                                      |                                      -                                      | [6.3.1](https://github.com/weaviate/java-client/releases/tag/6.3.1) | [1.2.0](https://github.com/weaviate/csharp-client/releases/tag/1.2.0) |
| [1.38.x](https://github.com/weaviate/weaviate/releases/tag/v1.38.0) | 2026-06-05             | [4.22.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.22.0) | [3.14.x](https://github.com/weaviate/typescript-client/releases/tag/v3.14.0) |                                      -                                      | [6.3.0](https://github.com/weaviate/java-client/releases/tag/6.3.0) | [1.2.0](https://github.com/weaviate/csharp-client/releases/tag/1.2.0) |
| [1.37.x](https://github.com/weaviate/weaviate/releases/tag/v1.37.0) | 2026-04-16             | [4.21.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.21.0) | [3.13.x](https://github.com/weaviate/typescript-client/releases/tag/v3.13.0) | [5.7.3](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.7.3) | [6.2.0](https://github.com/weaviate/java-client/releases/tag/6.2.0) | [1.1.1](https://github.com/weaviate/csharp-client/releases/tag/1.1.1) |
| [1.36.x](https://github.com/weaviate/weaviate/releases/tag/v1.36.0) | 2026-02-24             | [4.20.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.20.0) | [3.12.x](https://github.com/weaviate/typescript-client/releases/tag/v3.12.0) | [5.7.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.7.0) | [6.1.0](https://github.com/weaviate/java-client/releases/tag/6.1.0) | [1.0.1](https://github.com/weaviate/csharp-client/releases/tag/1.0.1) |
| [1.35.x](https://github.com/weaviate/weaviate/releases/tag/v1.35.0) | 2025-12-17             | [4.19.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.19.0) | [3.11.x](https://github.com/weaviate/typescript-client/releases/tag/v3.11.0) | [5.6.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.6.0) | [6.0.0](https://github.com/weaviate/java-client/releases/tag/6.0.0) | [1.0.0](https://github.com/weaviate/csharp-client/releases/tag/1.0.0) |

:::accordion{title="Older releases"}
| Weaviate Database <br>([GitHub][cWeaviate])                         | First <br>release date |                           Python <br>([GitHub][cPython])                          |            TypeScript/ <br>JavaScript <br>([GitHub][cTypeScript])            |                             Go <br>([GitHub][cGo])                            |                                                         Java <br>([GitHub][cJava])                                                         |
| :------------------------------------------------------------------ | :--------------------- | :-------------------------------------------------------------------------------: | :--------------------------------------------------------------------------: | :---------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------: |
| [1.34.x](https://github.com/weaviate/weaviate/releases/tag/v1.34.0) | 2025-11-05             | [4.18.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.18.0) | [3.10.x](https://github.com/weaviate/typescript-client/releases/tag/v3.10.0) |  [5.6.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.6.0)  |                                     [6.0.0](https://github.com/weaviate/java-client/releases/tag/6.0.0)                                    |
| [1.33.x](https://github.com/weaviate/weaviate/releases/tag/v1.33.0) | 2025-09-25             | [4.17.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.17.0) |  [3.9.x](https://github.com/weaviate/typescript-client/releases/tag/v3.9.0)  |  [5.5.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.5.0)  |                                     [5.5.x](https://github.com/weaviate/java-client/releases/tag/5.5.0)                                    |
| [1.32.x](https://github.com/weaviate/weaviate/releases/tag/v1.32.0) | 2025-07-14             | [4.16.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.16.0) |  [3.8.x](https://github.com/weaviate/typescript-client/releases/tag/v3.8.0)  |  [5.3.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.3.0)  |                                     [5.4.x](https://github.com/weaviate/java-client/releases/tag/5.4.0)                                    |
| [1.31.x](https://github.com/weaviate/weaviate/releases/tag/v1.31.0) | 2025-05-30             | [4.15.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.15.0) |  [3.6.x](https://github.com/weaviate/typescript-client/releases/tag/v3.6.0)  |  [5.2.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.2.0)  |                                     [5.3.x](https://github.com/weaviate/java-client/releases/tag/5.3.0)                                    |
| [1.30.x](https://github.com/weaviate/weaviate/releases/tag/v1.30.0) | 2025-04-03             | [4.12.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.12.0) |  [3.5.x](https://github.com/weaviate/typescript-client/releases/tag/v3.5.0)  |  [5.1.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.1.0)  |                                     [5.2.x](https://github.com/weaviate/java-client/releases/tag/5.2.0)                                    |
| [1.29.x](https://github.com/weaviate/weaviate/releases/tag/v1.29.0) | 2025-02-17             | [4.11.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.11.0) |  [3.4.x](https://github.com/weaviate/typescript-client/releases/tag/v3.4.0)  |  [5.0.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v5.0.0)  |                                     [5.1.x](https://github.com/weaviate/java-client/releases/tag/5.1.0)                                    |
| [1.28.x](https://github.com/weaviate/weaviate/releases/tag/v1.28.0) | 2024-12-11             | [4.10.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.10.0) |  [3.3.x](https://github.com/weaviate/typescript-client/releases/tag/v3.3.0)  | [4.16.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v4.16.0) |                                     [5.0.x](https://github.com/weaviate/java-client/releases/tag/5.0.0)                                    |
| [1.27.x](https://github.com/weaviate/weaviate/releases/tag/v1.27.0) | 2024-10-16             |  [4.9.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.9.0)  |  [3.2.x](https://github.com/weaviate/typescript-client/releases/tag/v3.2.0)  | [4.16.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v4.16.0) | [5.0.x](https://github.com/weaviate/java-client/releases/tag/5.0.0)<br>[4.9.x](https://github.com/weaviate/java-client/releases/tag/4.9.0) |
| [1.26.x](https://github.com/weaviate/weaviate/releases/tag/v1.26.0) | 2024-07-22             |  [4.7.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.7.0)  |  [3.1.x](https://github.com/weaviate/typescript-client/releases/tag/v3.1.0)  | [4.15.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v4.15.0) |                                     [4.8.x](https://github.com/weaviate/java-client/releases/tag/4.8.0)                                    |
| [1.25.x](https://github.com/weaviate/weaviate/releases/tag/v1.25.0) | 2024-05-10             |  [4.6.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.6.0)  |  [2.1.x](https://github.com/weaviate/typescript-client/releases/tag/v2.1.0)  | [4.13.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v4.13.0) |                                     [4.6.x](https://github.com/weaviate/java-client/releases/tag/4.6.0)                                    |
| [1.24.x](https://github.com/weaviate/weaviate/releases/tag/v1.24.0) | 2024-02-27             |  [4.5.x](https://github.com/weaviate/weaviate-python-client/releases/tag/v4.5.0)  |  [2.0.x](https://github.com/weaviate/typescript-client/releases/tag/v2.0.0)  | [4.10.x](https://github.com/weaviate/weaviate-go-client/releases/tag/v4.10.0) |                                     [4.4.x](https://github.com/weaviate/java-client/releases/tag/4.4.0)                                    |
| 1.23.x                                                              | 2023-12-18             |                                       3.26.x                                      |                                     1.5.x                                    |                                     4.10.x                                    |                                                                    4.4.x                                                                   |
| 1.22.x                                                              | 2023-10-27             |                                       3.25.x                                      |                                     1.5.x                                    |                                     4.10.x                                    |                                                                    4.3.x                                                                   |
| 1.21.x                                                              | 2023-08-17             |                                       3.22.x                                      |                                     1.4.x                                    |                                     4.9.x                                     |                                                                    4.2.x                                                                   |
| 1.20.x                                                              | 2023-07-06             |                                       3.22.x                                      |                                     1.1.x                                    |                                     4.7.x                                     |                                                                    4.2.x                                                                   |
| 1.19.x                                                              | 2023-05-04             |                                       3.17.x                                      |                   1.1.x[:sup[1]](#typescript-client-change)                  |                                     4.7.x                                     |                                                                    4.0.x                                                                   |
| 1.18.x                                                              | 2023-03-07             |                                       3.13.x                                      |                                    2.14.x                                    |                                     4.6.x                                     |                                                                    3.6.x                                                                   |
| 1.17.x                                                              | 2022-12-20             |                                       3.9.x                                       |                                    2.14.x                                    |                                     4.5.x                                     |                                                                    3.5.x                                                                   |
| 1.16.x                                                              | 2022-10-31             |                                       3.8.x                                       |                                    2.13.x                                    |                                     4.4.x                                     |                                                                    3.4.x                                                                   |
| 1.15.x                                                              | 2022-09-07             |                                       3.6.x                                       |                                    2.12.x                                    |                                     4.3.x                                     |                                                                    3.3.x                                                                   |
| 1.14.x                                                              | 2022-07-07             |                                       3.6.x                                       |                                    2.11.x                                    |                                     4.2.x                                     |                                                                    3.2.x                                                                   |
| 1.13.x                                                              | 2022-05-03             |                                       3.4.x                                       |                                     2.9.x                                    |                                     4.0.x                                     |                                                                    2.4.x                                                                   |
| 1.12.x                                                              | 2022-04-05             |                                       3.4.x                                       |                                     2.8.x                                    |                                     3.0.x                                     |                                                                    2.3.x                                                                   |
| 1.11.x                                                              | 2022-03-14             |                                       3.2.x                                       |                                     2.7.x                                    |                                     2.6.x                                     |                                                                    2.3.x                                                                   |
| 1.10.x                                                              | 2022-01-27             |                                       3.1.x                                       |                                     2.5.x                                    |                                     2.4.x                                     |                                                                    2.1.x                                                                   |
| 1.9.x                                                               | 2021-12-10             |                                       3.1.x                                       |                                     2.4.x                                    |                                     2.4.x                                     |                                                                    2.1.x                                                                   |
| 1.8.x                                                               | 2021-11-30             |                                       3.1.x                                       |                                     2.4.x                                    |                                     2.3.x                                     |                                                                    1.1.x                                                                   |
| 1.7.x                                                               | 2021-09-01             |                                       3.1.x                                       |                                     2.4.x                                    |                                     2.3.x                                     |                                                                    1.1.x                                                                   |
| 1.6.x                                                               | 2021-08-11             |                                       2.4.x                                       |                                     2.3.x                                    |                                     2.2.x                                     |                                                                    1.0.x                                                                   |
| 1.5.x                                                               | 2021-07-13             |                                       2.2.x                                       |                                     2.1.x                                    |                                     2.1.x                                     |                                                                    1.0.x                                                                   |
| 1.4.x                                                               | 2021-06-09             |                                       2.2.x                                       |                                     2.1.x                                    |                                     2.1.x                                     |                                                                    1.0.x                                                                   |
| 1.3.x                                                               | 2021-04-23             |                                       2.2.x                                       |                                     2.1.x                                    |                                     2.1.x                                     |                                                                    1.0.x                                                                   |
| 1.2.x                                                               | 2021-03-15             |                                       2.2.x                                       |                                     2.0.x                                    |                                     1.1.x                                     |                                                                      -                                                                     |
| 1.1.x                                                               | 2021-02-10             |                                       2.1.x                                       |                                       -                                      |                                       -                                       |                                                                      -                                                                     |
| 1.0.x                                                               | 2021-01-14             |                                       2.0.x                                       |                                       -                                      |                                       -                                       |                                                                      -                                                                     |

#### TypeScript client change

The [TypeScript client](https://github.com/weaviate/typescript-client) replaced the [JavaScript client](https://github.com/weaviate/weaviate-javascript-client) on 2023-03-17.

[comment]: # " repo links "
[cWeaviate]: https://github.com/weaviate/weaviate/releases
[cPython]: https://github.com/weaviate/weaviate-python-client/releases
[cTypeScript]: https://github.com/weaviate/typescript-client/releases
[cGo]: https://github.com/weaviate/weaviate-go-client/releases
[cJava]: https://github.com/weaviate/java-client/releases
[cCSharp]: https://github.com/weaviate/csharp-client/releases
:::
::::

#### Vectorizer API changes `v3.8.0`

Starting with the Weaviate JS/TS client `v3.8.0`, there are multiple changes to the vectorizer configuration API when creating collections:

- `configure.vectorizer` has been replaced with `configure.vectors`
- `configure.multiVectors` has been added to enable users work with [Multi-vectors](../how-to-manage-collections/vector-config.md#define-multi-vector-embeddings-eg-colbert-colpali)
- `configure.vectorizer.none` have been replaced with `configure.vectors.selfProvided`

#### JavaScript/TypeScript client `v2` deprecation

The Weaviate JavaScript/TypeScript client `v2` has been deprecated and should no longer be used. If you need documentation for the `v2` client, see the [documentation archive](https://archive.docs.weaviate.io/weaviate/client-libraries/typescript/typescript-v2). If you are migrating from the JavaScript/TypeScript `v2` client to the `v3` client, see this [migration guide](https://archive.docs.weaviate.io/weaviate/client-libraries/typescript/v2_v3_migration).

## Code examples & further resources

Usage information for various operations and features can be found throughout the Weaviate documentation.

::::card-grid
:::card{title="How-to: Configure Weaviate" href="/guides/how-to-configure-weaviate-index" icon="settings"}
Configure compression, backups, authentication, authorization, data replication and more.
:::

:::card{title="How-to: Manage collections" href="/guides/how-to-manage-collections-index" icon="layers"}
Manage collections (CRUD), configure vectorizers and index parameters, set up multi-tenancy, and perform migrations.
:::

:::card{title="How-to: Manage objects" href="/guides/how-to-manage-objects-index" icon="box"}
Adding new objects, fetching existing ones, modifying them, and removing them from collections.
:::

:::card{title="How-to: Query & search" href="/guides/how-to-query-search-index" icon="search"}
From basic vector and hybrid searches to specialized image queries and performing data aggregations.
:::
::::

The Weaviate API reference pages for [search](../apis/index.md) and [REST](/weaviate/api/rest) may also be useful starting points.

## Questions and feedback

Have a question or feedback? Here's how to reach us.

::::card-grid
:::card{title="Community Forum" href="https://forum.weaviate.io/c/support" icon="messages-square"}
Ask questions and connect with other developers on our **Community forum**.
:::

:::card{title="Support" href="/guides/support-overview" icon="life-buoy"}
Weaviate Cloud user or customer? Find the right channel on the **Support page**.
:::
::::

## Related pages

- [Agents](./agents-index.md)
- [AI-assisted Weaviate code generation](./ai-assisted-vibe-coding-index.md)
- [APIs](./apis-index.md)
- [Authorization and authentication](./authorization-and-authentication-index.md)
- [Benchmarks](./benchmarks-index.md)
- [Best practices](./best-practices-index.md)
- [Client libraries](./clients-index.md)
- [Client Libraries / SDKs](./client-libraries-index.md)
- [Cloud](./cloud-index.md)
- [Cloud account management](./cloud-account-management-index.md)

# Agent Instructions

This portal answers questions programmatically. To receive a synthesized,
source-cited answer instead of crawling page by page, append the `?ask=`
query parameter to any page URL on this site:

    /guides/quickstart?ask=how+do+I+authenticate

Optional parameters:

- `&goal=<what-you-are-trying-to-do>` steers the answer toward your
  objective (e.g. `&goal=write+a+python+client`).
- `&version=<label>` scopes the answer to a mounted version when the
  portal publishes more than one.

The response is `text/markdown`: the answer followed by a `# Sources` list
of the portal pages it was grounded in. Status codes are the contract:

- `200` — the answer; `402` — the portal owner’s plan or answer credits are
  exhausted (surface this to your operator; do NOT retry); `429` — you are
  rate-limited; back off for the `Retry-After` seconds; `503` — the answer
  lane is temporarily unavailable; fall back to crawling the `.md` pages.

For the full corpus map read `llms.txt` at the site root; for the tool
surface (search + page fetch as MCP tools) see `/mcp`.