> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Weaviate

The Weaviate connector lets your AI agent act in each user's Weaviate account. Each user connects their own Weaviate access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 25 tools.

**Authentication:** Bearer Token
**Categories:** Databases, AI
**Tools:** 25: 15 read, 8 write, 2 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=WEAVIATE)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Weaviate connection

   In **AgentKit > Connections**, create a Weaviate connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'weaviate'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Weaviate:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'weaviate_collection_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "weaviate"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Weaviate:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="weaviate_collection_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Weaviate credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'weaviate_collection_get',
  toolInput: {
    collection: '<collection>',
  },
  connector: 'weaviate',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="weaviate_collection_get",
    tool_input={
        "collection": "<collection>",
    },
    connection_name="weaviate",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `weaviate_collection_get`

Get Collection · Read-only

Get the definition of one Weaviate collection (class).
Returns its name, description, properties (name, dataType, tokenization, index flags), vectorizer and vectorConfig, module config, and multi-tenancy, replication and sharding settings.
Use weaviate_collection_get to see the properties you can return or filter on. Use weaviate_collection_list to find collection names.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection` (`string`, required): Name of the collection (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.

Example input: `{"collection":"<collection>"}`

### `weaviate_collection_list`

List Collections · Read-only

List every collection (class) defined in the Weaviate schema.
Returns a classes array; each entry has the collection name, description, properties with data types, vectorizer and vector index settings, and multi-tenancy and replication config.
Use weaviate_collection_list to discover collection and property names. Use weaviate_collection_get for one collection's definition.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `weaviate_collection_object_count`

Count Collection Objects · Read-only

Count the objects in a Weaviate collection, optionally only those that match a filter.
Returns data.Aggregate.[0].meta.count, plus an errors array if the query failed.
Use weaviate_collection_object_count to size a collection or a filtered subset. Use weaviate_object_list to read the objects themselves.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection` (`string`, required): Name of the collection (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `tenant` (`string`, optional): Tenant to count in. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.
- `where_filter` (`string`, optional): Optional filter, written as a GraphQL where object literal (not JSON: operator values are unquoted). It sets path (property name array), operator (Equal, NotEqual, GreaterThan, GreaterThanEqual, LessThan, LessThanEqual, Like, ContainsAny, ContainsAll, IsNull, And, Or) and a typed value field such as valueText, valueInt, valueNumber, valueBoolean or valueDate; And/Or take an operands list. Example: {path: ["wordCount"], operator: GreaterThan, valueInt: 1000}.

Example input: `{"collection":"<collection>"}`

### `weaviate_collection_shard_list`

List Collection Shards · Read-only

List the shards of a Weaviate collection with their status.
Returns each shard's name, status (READY or READONLY), per-node status and vector queue size. It does not return vector indexing status.
Use weaviate_collection_shard_list to check whether a collection is writable. Use weaviate_node_list with verbose output for vector indexing status and per-node object counts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection` (`string`, required): Name of the collection (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `tenant` (`string`, optional): For a multi-tenant collection, the tenant whose shard to show; leave blank to list all shards. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.

Example input: `{"collection":"<collection>"}`

### `weaviate_graphql_query`

Run GraphQL Query · Read-only

Run any Weaviate GraphQL query: Get (with nearText, nearVector, nearObject, hybrid, bm25, where, sort, groupBy), Aggregate, or Explore. Weaviate's GraphQL API is read-only.
Returns the GraphQL response: data keyed by Get, Aggregate or Explore, plus an errors array if the query failed (often with HTTP 200).
Use weaviate_graphql_query for queries the other tools do not cover, such as nearVector, groupBy, sorting, aggregations by property or cross-reference fields. Use weaviate_object_search_hybrid, weaviate_object_search_near_text or weaviate_object_search_bm25 for ordinary searches.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): The GraphQL query text. Collection names are used as field names under Get or Aggregate. Example: { Get { Article(nearVector: {vector: [0.1, 0.2, 0.3]}, limit: 5) { title _additional { id distance } } } }.
- `operation_name` (`string`, optional): Name of the operation to run when the query text defines several. Example: ArticleSearch.
- `variables` (`object`, optional): Values for variables declared in the query, keyed by variable name. Example: {"limit": 5}.

Example input: `{"query":"<query>"}`

### `weaviate_meta_get`

Get Instance Metadata · Read-only

Get metadata about the connected Weaviate instance.
Returns the hostname, Weaviate version, and the enabled modules (vectorizers, generative and reranker modules) with their versions.
Use weaviate_meta_get to check the server version or which vectorizer modules are available before creating a collection. Use weaviate_node_list for node health and object counts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `weaviate_node_list`

List Nodes · Read-only

List the nodes of the Weaviate cluster with their status.
Returns each node's name, status (HEALTHY, UNHEALTHY, UNAVAILABLE), version, git hash and statistics; with output=verbose also each shard, its collection and object count.
Use weaviate_node_list to check cluster health or how many objects each shard holds. Use weaviate_meta_get for the server version and modules.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `output` (`string`, optional): Detail level: minimal (node status only) or verbose (also per-shard statistics such as object counts). Defaults to minimal. Example: verbose. One of: `minimal`, `verbose`. Default: `minimal`.

Example input: `{}`

### `weaviate_object_get`

Get Object · Read-only

Get one Weaviate object by collection and UUID.
Returns the object's id, class, properties, tenant, creation and update times, and its vector(s) when include=vector.
Use weaviate_object_get when you know the object's id. Use weaviate_object_list or a search tool to find ids.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection` (`string`, required): Name of the collection the object belongs to (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `object_id` (`string`, required): UUID of the object, from the id field returned by weaviate_object_list or a search tool. Example: 36ddd591-2dee-4e7e-a3cc-eb86d30a4303.
- `consistency_level` (`string`, optional): How many replicas must acknowledge the request: ONE, QUORUM or ALL. Leave blank for the server default (QUORUM). Only matters on a cluster with replication. Example: QUORUM. One of: `ONE`, `QUORUM`, `ALL`.
- `include` (`string`, optional): Extra fields to include, comma-separated: vector (the object's vector or named vectors), classification, featureProjection. Example: vector.
- `tenant` (`string`, optional): Tenant the object belongs to. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.

Example input: `{"collection":"<collection>","object_id":"<object_id>"}`

### `weaviate_object_list`

List Objects · Read-only

List objects in a Weaviate collection, one page at a time.
Returns an objects array (each with id, class, properties, creationTimeUnix and lastUpdateTimeUnix), plus totalResults, the number of objects that match the query (not the number on this page).
Use weaviate_object_list to browse or export a collection. Use weaviate_object_search_hybrid, weaviate_object_search_near_text or weaviate_object_search_bm25 to find objects by meaning or keywords.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `after` (`string`, optional): Cursor for paging through a whole collection: the id of the last object on the previous page. Requires collection and cannot be combined with offset, sort or where filters. Example: 36ddd591-2dee-4e7e-a3cc-eb86d30a4303.
- `collection` (`string`, optional): Collection (class) to list objects from. Set it: if left blank, List Objects returns no objects; it does not list every collection. Example: Article.
- `include` (`string`, optional): Extra fields to include, comma-separated: vector (the object's vector or named vectors), classification, featureProjection. Example: vector.
- `limit` (`integer`, optional): Maximum number of objects to return. Defaults to 25. Example: 50.
- `offset` (`integer`, optional): Number of objects to skip, for page-based paging. Cannot be combined with after. Example: 25.
- `order` (`string`, optional): Sort direction for each sort property, comma-separated asc or desc, matching the sort list. Example: desc.
- `sort` (`string`, optional): Property name(s) to sort by, comma-separated. Example: title or country,city.
- `tenant` (`string`, optional): Tenant to list objects from. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.

Example input: `{}`

### `weaviate_object_search_bm25`

Keyword Search (BM25) · Read-only

Search a Weaviate collection by keywords with BM25 ranking; no vectorizer is needed.
Returns data.Get. as a list of objects with the requested properties and _additional.id and _additional.score, plus an errors array if the query failed.
Use weaviate_object_search_bm25 for exact terms, names or codes. Use weaviate_object_search_hybrid to add semantic matching, and weaviate_object_search_near_text for meaning only.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection` (`string`, required): Name of the collection to search (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `query` (`string`, required): Keywords to search for. Example: quarterly revenue report.
- `return_properties` (`array`, required): Properties to return for each matching object; the object id and score or distance are always returned under _additional. Get property names from weaviate_collection_get. Example: ["title", "summary"].
- `limit` (`integer`, optional): Maximum number of objects to return. Example: 10. Default: `10`.
- `offset` (`integer`, optional): Number of top results to skip, for paging. Example: 10.
- `properties` (`array`, optional): Text properties to search; append ^N to boost one, such as title^3. Leave blank to search all searchable text properties. Example: ["title^3", "body"].
- `tenant` (`string`, optional): Tenant to search in. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.
- `where_filter` (`string`, optional): Optional filter, written as a GraphQL where object literal (not JSON: operator values are unquoted). It sets path (property name array), operator (Equal, NotEqual, GreaterThan, GreaterThanEqual, LessThan, LessThanEqual, Like, ContainsAny, ContainsAll, IsNull, And, Or) and a typed value field such as valueText, valueInt, valueNumber, valueBoolean or valueDate; And/Or take an operands list. Example: {path: ["wordCount"], operator: GreaterThan, valueInt: 1000}.

Example input: `{"collection":"<collection>","query":"<query>","return_properties":["title","summary"]}`

### `weaviate_object_search_hybrid`

Hybrid Search · Read-only

Search a Weaviate collection with a hybrid query that combines keyword (BM25) and vector (semantic) scores, weighted by alpha.
Returns data.Get. as a list of objects with the requested properties and _additional.id, _additional.score and _additional.explainScore, plus an errors array if the query failed.
Use weaviate_object_search_hybrid as the default search for natural-language questions. Use weaviate_object_search_near_text for meaning only, and weaviate_object_search_bm25 for exact keywords.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection` (`string`, required): Name of the collection to search (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `query` (`string`, required): Search text, used both for keyword (BM25) matching and, vectorized, for semantic matching. Example: solar panel subsidies.
- `return_properties` (`array`, required): Properties to return for each matching object; the object id and score or distance are always returned under _additional. Get property names from weaviate_collection_get. Example: ["title", "summary"].
- `alpha` (`number`, optional): Balance between keyword and vector search: 0 is pure keyword (BM25), 1 is pure vector, 0.75 is the server default. Example: 0.5.
- `fusion_type` (`string`, optional): How keyword and vector scores are combined: relativeScoreFusion (the default since Weaviate 1.24) or rankedFusion. Example: relativeScoreFusion. One of: `relativeScoreFusion`, `rankedFusion`.
- `limit` (`integer`, optional): Maximum number of objects to return. Example: 10. Default: `10`.
- `offset` (`integer`, optional): Number of top results to skip, for paging. Example: 10.
- `properties` (`array`, optional): Text properties to search on the keyword side; append ^N to boost one, such as title^2. Leave blank to search all text properties. Example: ["title^2", "body"].
- `target_vector` (`string`, optional): For a collection with named vectors, the vector name to search. Leave blank for a collection with a single vector. Example: title_vector.
- `tenant` (`string`, optional): Tenant to search in. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.
- `where_filter` (`string`, optional): Optional filter, written as a GraphQL where object literal (not JSON: operator values are unquoted). It sets path (property name array), operator (Equal, NotEqual, GreaterThan, GreaterThanEqual, LessThan, LessThanEqual, Like, ContainsAny, ContainsAll, IsNull, And, Or) and a typed value field such as valueText, valueInt, valueNumber, valueBoolean or valueDate; And/Or take an operands list. Example: {path: ["wordCount"], operator: GreaterThan, valueInt: 1000}.

Example input: `{"collection":"<collection>","query":"<query>","return_properties":["title","summary"]}`

### `weaviate_object_search_near_text`

Semantic Search (nearText) · Read-only

Search a Weaviate collection by meaning (vector similarity) with a nearText query; the collection needs a text vectorizer.
Returns data.Get. as a list of objects with the requested properties and _additional.id and _additional.distance (lower is closer), plus an errors array if the query failed.
Use weaviate_object_search_near_text for pure semantic search. Use weaviate_object_search_hybrid to mix meaning and keywords, and weaviate_object_search_bm25 for keyword-only search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection` (`string`, required): Name of the collection to search (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `concepts` (`array`, required): Text to search for by meaning; one or more phrases that are vectorized and combined. Example: ["renewable energy policy"].
- `return_properties` (`array`, required): Properties to return for each matching object; the object id and score or distance are always returned under _additional. Get property names from weaviate_collection_get. Example: ["title", "summary"].
- `distance` (`number`, optional): Maximum vector distance for a match; lower is more similar (cosine distance ranges 0-2). Leave blank for no cut-off. Example: 0.6.
- `limit` (`integer`, optional): Maximum number of objects to return. Example: 10. Default: `10`.
- `offset` (`integer`, optional): Number of top results to skip, for paging. Example: 10.
- `target_vector` (`string`, optional): For a collection with named vectors, the vector name to search. Leave blank for a collection with a single vector. Example: title_vector.
- `tenant` (`string`, optional): Tenant to search in. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.
- `where_filter` (`string`, optional): Optional filter, written as a GraphQL where object literal (not JSON: operator values are unquoted). It sets path (property name array), operator (Equal, NotEqual, GreaterThan, GreaterThanEqual, LessThan, LessThanEqual, Like, ContainsAny, ContainsAll, IsNull, And, Or) and a typed value field such as valueText, valueInt, valueNumber, valueBoolean or valueDate; And/Or take an operands list. Example: {path: ["wordCount"], operator: GreaterThan, valueInt: 1000}.

Example input: `{"collection":"<collection>","concepts":["renewable energy policy"],"return_properties":["title","summary"]}`

### `weaviate_object_validate`

Validate Object · Read-only

Check whether an object would be accepted by a Weaviate collection's schema, without storing it.
Returns an empty response (HTTP 200) when the object is valid, or a 422 error listing what is wrong.
Use weaviate_object_validate to test property names and types before weaviate_object_create or weaviate_object_batch_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection` (`string`, required): Name of the collection to validate against (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `properties` (`object`, required): Property values to check, as property name to value pairs. Example: {"title": "Vector search explained", "wordCount": 1200}.
- `object_id` (`string`, optional): Optional UUID to validate along with the object. Example: 36ddd591-2dee-4e7e-a3cc-eb86d30a4303.
- `tenant` (`string`, optional): Tenant the object would belong to. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.

Example input: `{"collection":"<collection>","properties":{"title":"Vector search explained","wordCount":1200}}`

### `weaviate_tenant_get`

Get Tenant · Read-only

Get one tenant of a multi-tenant Weaviate collection by name.
Returns the tenant's name and activityStatus; responds 404 if the tenant does not exist.
Use weaviate_tenant_get to check that a tenant exists and is active. Use weaviate_tenant_list to list all tenants.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection` (`string`, required): Name of the multi-tenant collection (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `tenant` (`string`, required): Name of the tenant, from weaviate_tenant_list. Example: tenantA.

Example input: `{"collection":"<collection>","tenant":"<tenant>"}`

### `weaviate_tenant_list`

List Tenants · Read-only

List the tenants of a multi-tenant Weaviate collection.
Returns an array of tenants, each with its name and activityStatus (for example ACTIVE, INACTIVE or OFFLOADED).
Use weaviate_tenant_list to find tenant names for object and search tools. Use weaviate_tenant_get to check one tenant.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection` (`string`, required): Name of the multi-tenant collection (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.

Example input: `{"collection":"<collection>"}`

### `weaviate_collection_create`

Create Collection · Write

Create a new collection (class) in Weaviate with its properties, vectorizer and multi-tenancy setting.
Returns the created collection definition, including the defaults Weaviate filled in.
Use weaviate_collection_create to set up a new collection. Use weaviate_collection_property_add to add a property to an existing collection.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `collection` (`string`, required): Name of the new collection. Must start with an uppercase letter and contain only letters, digits and underscores; use CamelCase for several words. Example: Article.
- `description` (`string`, optional): Free-text description of the collection, stored as metadata. Example: News articles with title and body.
- `module_config` (`object`, optional): Collection-level module settings, keyed by module name, such as the model for a vectorizer or a generative module. Example: {"text2vec-openai": {"model": "text-embedding-3-small"}}.
- `multi_tenancy_enabled` (`boolean`, optional): Set to true to make the collection multi-tenant, so each tenant's objects are stored separately and every object request must name a tenant. This cannot be changed after the collection is created. Example: true.
- `properties` (`array`, optional): Properties (fields) of the collection. Each property needs a name in camelCase and a dataType array with one type such as ["text"], ["int"], ["number"], ["boolean"], ["date"], ["text[]"], ["uuid"], ["geoCoordinates"], ["object"], or the name of another collection for a cross-reference. A text property can also set tokenization (word, lowercase, whitespace, field, trigram). Leave blank to let Weaviate infer properties from the first objects you add (auto-schema). Example: [{"name": "title", "dataType": ["text"]}, {"name": "wordCount", "dataType": ["int"]}].
- `replication_factor` (`integer`, optional): Number of copies of each shard to keep across the cluster's nodes. Leave blank for the server default (usually 1). Example: 3.
- `vector_config` (`object`, optional): Named vector configuration: an object keyed by vector name, where each entry sets a vectorizer (module name mapped to its settings) and a vectorIndexType such as hnsw or flat. Use it instead of vectorizer when the collection needs one or more named vectors. Example: {"title_vector": {"vectorizer": {"text2vec-openai": {"properties": ["title"]}}, "vectorIndexType": "hnsw"}}.
- `vectorizer` (`string`, optional): Vectorizer module that turns objects into vectors, for a collection with one unnamed vector. Use none to supply your own vectors. The module must be enabled on the instance (see weaviate_meta_get). Do not combine with vector_config. Example: text2vec-openai.

Example input: `{"collection":"<collection>"}`

### `weaviate_collection_property_add`

Add Collection Property · Write

Add a new property (field) to an existing Weaviate collection.
Returns the added property definition.
Use weaviate_collection_property_add to extend a collection's schema. Use weaviate_collection_create to define a new collection. Existing objects are not re-vectorized or back-filled for the new property.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `collection` (`string`, required): Name of the collection to add the property to (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `data_type` (`array`, required): Data type of the property as a one-element array: text, text[], int, int[], number, number[], boolean, boolean[], date, date[], uuid, uuid[], geoCoordinates, phoneNumber, blob, object, object[], or the name of another collection for a cross-reference. Example: ["date"].
- `name` (`string`, required): Name of the new property in camelCase, unique within the collection. Example: publishedAt.
- `description` (`string`, optional): Free-text description of the property. Example: Date the article was published.
- `index_filterable` (`boolean`, optional): Whether the property gets a filter index so it can be used in where filters. Defaults to true. Example: true.
- `index_searchable` (`boolean`, optional): Whether a text property is indexed for keyword (BM25) and hybrid search. Defaults to true. Example: true.
- `nested_properties` (`array`, optional): For an object or object[] property, the properties of the nested object, each with a name and dataType. Example: [{"name": "city", "dataType": ["text"]}].
- `tokenization` (`string`, optional): How a text or text[] property is split into tokens for keyword (BM25) search and filters: word (alphanumeric, lowercased; the default), lowercase, whitespace, field (whole value as one token), trigram, or a language tokenizer (gse, gse_ch, kagome_ja, kagome_kr). Example: word. One of: `word`, `lowercase`, `whitespace`, `field`, `trigram`, `gse`, `kagome_kr`, `kagome_ja`, `gse_ch`.

Example input: `{"collection":"<collection>","data_type":["date"],"name":"<name>"}`

### `weaviate_object_batch_create`

Batch Create Objects · Write

Create or overwrite many Weaviate objects in one request; an object whose id already exists is replaced.
Returns one result per object with its id and a result.errors entry for each object that failed, so check every item even when the request succeeds.
Use weaviate_object_batch_create to import many objects. Use weaviate_object_create for a single object.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `objects` (`array`, required): Objects to store. Each object has a class (collection name; can be left out when collection is set), properties, and optionally an id (UUID), a vector or vectors, and a tenant. Keep a batch to a few hundred objects. Example: [{"class": "Article", "properties": {"title": "First"}}, {"class": "Article", "properties": {"title": "Second"}}].
- `collection` (`string`, optional): Collection to use for every object that has no class of its own. Example: Article.
- `consistency_level` (`string`, optional): How many replicas must acknowledge the request: ONE, QUORUM or ALL. Leave blank for the server default (QUORUM). Only matters on a cluster with replication. Example: QUORUM. One of: `ONE`, `QUORUM`, `ALL`.
- `tenant` (`string`, optional): Tenant to use for every object that has no tenant of its own. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.

Example input: `{"objects":[{"class":"Article","properties":{"title":"First"}},{"class":"Article","properties":{"title":"Second"}}]}`

### `weaviate_object_create`

Create Object · Write

Create one object in a Weaviate collection; the collection's vectorizer creates its vector unless you pass one.
Returns the stored object with its id, class, properties and creation time.
Use weaviate_object_create for a single object. Use weaviate_object_batch_create to add many objects in one request.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `collection` (`string`, required): Name of the collection to add the object to (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `properties` (`object`, required): The object's data as property name to value pairs, matching the collection's properties (see weaviate_collection_get). Dates are RFC 3339 strings; a cross-reference is an array of {"beacon": "weaviate://localhost//<uuid>"}. Example: {"title": "Vector search explained", "wordCount": 1200}.
- `consistency_level` (`string`, optional): How many replicas must acknowledge the request: ONE, QUORUM or ALL. Leave blank for the server default (QUORUM). Only matters on a cluster with replication. Example: QUORUM. One of: `ONE`, `QUORUM`, `ALL`.
- `object_id` (`string`, optional): UUID to give the new object. Leave blank and Weaviate generates one. Creating an object with an id that already exists fails. Example: 36ddd591-2dee-4e7e-a3cc-eb86d30a4303.
- `tenant` (`string`, optional): Tenant to store the object in. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.
- `vector` (`array`, optional): Your own vector for the object, as an array of numbers whose length matches the collection's vector index. Leave blank to let the collection's vectorizer create it. Example: [0.12, -0.03, 0.88].
- `vectors` (`object`, optional): Your own vectors for a collection with named vectors, keyed by vector name. Leave blank to let the vectorizers create them. Example: {"title_vector": [0.12, -0.03, 0.88]}.

Example input: `{"collection":"<collection>","properties":{"title":"Vector search explained","wordCount":1200}}`

### `weaviate_object_reference_add`

Add Object Reference · Write

Add a cross-reference from one Weaviate object to another, through a reference property of the source object.
Returns an empty response on success.
Use weaviate_object_reference_add to link objects, for example an Article to its Author. The reference property must already exist in the source collection with the target collection as its data type.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `collection` (`string`, required): Name of the source object's collection (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `object_id` (`string`, required): UUID of the source object, from the id field returned by weaviate_object_list or a search tool. Example: 36ddd591-2dee-4e7e-a3cc-eb86d30a4303.
- `property` (`string`, required): Name of the reference property on the source object. Example: hasAuthor.
- `target_collection` (`string`, required): Collection of the object to link to. Example: Author.
- `target_id` (`string`, required): UUID of the object to link to. Example: 8f1e3b44-7c58-4c1b-9d1e-2f6a8f9e0b12.
- `consistency_level` (`string`, optional): How many replicas must acknowledge the request: ONE, QUORUM or ALL. Leave blank for the server default (QUORUM). Only matters on a cluster with replication. Example: QUORUM. One of: `ONE`, `QUORUM`, `ALL`.
- `tenant` (`string`, optional): Tenant of the source object. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.

Example input: `{"collection":"<collection>","object_id":"<object_id>","property":"<property>","target_collection":"<target_collection>","target_id":"<target_id>"}`

### `weaviate_object_replace`

Replace Object · Write

Replace an existing Weaviate object with a new set of properties; properties you leave out are removed.
Returns the replaced object with its id, class, properties and update time.
Use weaviate_object_replace to overwrite an object completely. Use weaviate_object_update to change only some properties.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection` (`string`, required): Name of the collection the object belongs to (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `object_id` (`string`, required): UUID of the object to replace, from the id field returned by weaviate_object_list or a search tool. Example: 36ddd591-2dee-4e7e-a3cc-eb86d30a4303.
- `properties` (`object`, required): The complete new set of property values; any property you leave out is removed from the object. Example: {"title": "Vector search explained", "wordCount": 1350}.
- `consistency_level` (`string`, optional): How many replicas must acknowledge the request: ONE, QUORUM or ALL. Leave blank for the server default (QUORUM). Only matters on a cluster with replication. Example: QUORUM. One of: `ONE`, `QUORUM`, `ALL`.
- `tenant` (`string`, optional): Tenant the object belongs to. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.
- `vector` (`array`, optional): Your own vector for the object, as an array of numbers whose length matches the collection's vector index. Leave blank to let the collection's vectorizer create it. Example: [0.12, -0.03, 0.88].
- `vectors` (`object`, optional): Your own vectors for a collection with named vectors, keyed by vector name. Leave blank to let the vectorizers create them. Example: {"title_vector": [0.12, -0.03, 0.88]}.

Example input: `{"collection":"<collection>","object_id":"<object_id>","properties":{"title":"Vector search explained","wordCount":1350}}`

### `weaviate_object_update`

Update Object · Write

Update some properties of an existing Weaviate object, keeping the properties you leave out (JSON merge patch). The object is re-vectorized if a vectorized property changes.
Returns an empty response (HTTP 204) on success.
Use weaviate_object_update to change a few fields. Use weaviate_object_replace to overwrite the whole object.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `collection` (`string`, required): Name of the collection the object belongs to (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `object_id` (`string`, required): UUID of the object to update, from the id field returned by weaviate_object_list or a search tool. Example: 36ddd591-2dee-4e7e-a3cc-eb86d30a4303.
- `properties` (`object`, required): Only the properties to change, as property name to value pairs; properties you leave out keep their current values. Example: {"wordCount": 1350}.
- `consistency_level` (`string`, optional): How many replicas must acknowledge the request: ONE, QUORUM or ALL. Leave blank for the server default (QUORUM). Only matters on a cluster with replication. Example: QUORUM. One of: `ONE`, `QUORUM`, `ALL`.
- `tenant` (`string`, optional): Tenant the object belongs to. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.
- `vector` (`array`, optional): Your own vector for the object, as an array of numbers whose length matches the collection's vector index. Leave blank to let the collection's vectorizer create it. Example: [0.12, -0.03, 0.88].
- `vectors` (`object`, optional): Your own vectors for a collection with named vectors, keyed by vector name. Leave blank to let the vectorizers create them. Example: {"title_vector": [0.12, -0.03, 0.88]}.

Example input: `{"collection":"<collection>","object_id":"<object_id>","properties":{"wordCount":1350}}`

### `weaviate_tenant_create`

Create Tenants · Write

Create one or more tenants in a multi-tenant Weaviate collection.
Returns the created tenants with their names and activity status.
Use weaviate_tenant_create before adding objects for a new tenant. The collection must have been created with multi-tenancy enabled.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `collection` (`string`, required): Name of the multi-tenant collection (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `tenant_names` (`array`, required): Names of the tenants to create. Each name is 1-64 characters of letters, digits, underscores and hyphens. Example: ["tenantA", "tenantB"].
- `activity_status` (`string`, optional): Initial activity status for all the new tenants: ACTIVE (queryable; the default) or INACTIVE (stored but not loaded). Example: ACTIVE. One of: `ACTIVE`, `INACTIVE`.

Example input: `{"collection":"<collection>","tenant_names":["tenantA","tenantB"]}`

### `weaviate_collection_delete`

Delete Collection · Destructive

Delete a Weaviate collection (class) together with all of its objects and tenants. This cannot be undone.
Returns an empty response on success.
Use weaviate_collection_delete to remove a whole collection. Use weaviate_object_delete to remove a single object.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `collection` (`string`, required): Name of the collection to delete (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.

Example input: `{"collection":"<collection>"}`

### `weaviate_object_delete`

Delete Object · Destructive

Delete one object from a Weaviate collection by UUID.
Returns an empty response (HTTP 204) on success, or 404 if the object does not exist.
Use weaviate_object_delete to remove a single object. Use weaviate_collection_delete to remove a whole collection.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `collection` (`string`, required): Name of the collection the object belongs to (Weaviate calls it a class). Case-sensitive and starts with an uppercase letter; get names from weaviate_collection_list. Example: Article.
- `object_id` (`string`, required): UUID of the object to delete, from the id field returned by weaviate_object_list or a search tool. Example: 36ddd591-2dee-4e7e-a3cc-eb86d30a4303.
- `consistency_level` (`string`, optional): How many replicas must acknowledge the request: ONE, QUORUM or ALL. Leave blank for the server default (QUORUM). Only matters on a cluster with replication. Example: QUORUM. One of: `ONE`, `QUORUM`, `ALL`.
- `tenant` (`string`, optional): Tenant the object belongs to. Required for a multi-tenant collection, and must be left blank for a collection without multi-tenancy. Get tenant names from weaviate_tenant_list. Example: tenantA.

Example input: `{"collection":"<collection>","object_id":"<object_id>"}`

## Related

Other Databases connectors ([all 39](/agentkit/connectors/?category=databases)):

- [AWS Redshift](/agentkit/connectors/redshift/): Scalekit connector, Trusted identity provider, 10 tools
- [Google BigQuery](/agentkit/connectors/bigquery/): Scalekit connector, OAuth, 47 tools
- [Airtable](/agentkit/connectors/airtable/): Scalekit connector, OAuth, 26 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
