Weaviate

Vector database: store objects with embeddings, hybrid search, and schema management

Weaviate API referenceAPI checked August 18, 2026

Signs in with: API token
Runs on: Cloud or On-Prem Worker
Operations: 111
Ready-made triggers: 0

Connect Weaviate

In Neblex open Connect › Connections and click New Connection.
Search for Weaviate and give the connection a clear name.
Fill in the fields. Secret values are encrypted and never shown again.
Click Test, then Create Connection.

If the system is only reachable inside your network, choose an On-Prem Worker under Test from and run the flow on that Worker. See On-Prem Workers.

Field	What to enter
Host (your Weaviate URL host)Required
API keyRequiredSecret

Use it in a flow

Open a flow, open the node library and search for Weaviate.
Drag it onto the canvas and choose an Operation and your connection.
Map the operation's fields from earlier steps, or click Map with Matt.
Use Test this step to see what it returns, then save.

To start a flow from Weaviate without a ready-made trigger: a Poll for changes trigger on Weaviate with your own query passes on new or changed records.

Operations

111 operations in 19 groups. Each one is a step you can add to a flow.

Authz18

Add permissions to a role`addPermissions`	POST	Add new permissions to an existing role without affecting current permissions.
Assign a role to a group`assignRoleToGroup`	POST	Assign roles to the specified group.
Assign a role to a user`assignRoleToUser`	POST	Assign one or more roles to a user.
Check whether a role possesses a permission`hasPermission`	POST	Check whether a role has the specified permissions.
Create new role`createRole`	POST	Create a new role with the specified permissions.
Delete a role`deleteRole`	DELETE	Deleting a role will remove it from the system, and revoke the associated permissions from all users who had this role.
Get a role`getRole`	GET	Fetch a role by its name.
Get all roles`getRoles`	GET	Get all roles and their assigned permissions.
Get groups that have a specific role assigned`getGroupsForRole`	GET	Retrieves a list of all groups that have been assigned a specific role, identified by its name.
Get roles assigned to a specific group`getRolesForGroup`	GET	Retrieves a list of all roles assigned to a specific group.
Get roles assigned to a user`getRolesForUser`	GET	Get all the roles for a specific user (db or oidc).
Get roles assigned to a user`getRolesForUserDeprecated`	GET	Retrieve the roles assigned to a specific user (db + oidc).
Get users assigned to a role`getUsersForRole`	GET	Fetch a list of users which have the specified role.
Get users assigned to a role`getUsersForRoleDeprecated`	GET	Get all the users (db + oidc) who have been assigned a specific role.
List all groups of a specific type`getGroups`	GET	Retrieves a list of all available group names for a specified group type (oidc or db).
Remove permissions from a role`removePermissions`	POST	Permissions can be revoked from a specified role.
Revoke a role from a group`revokeRoleFromGroup`	POST	Revoke roles from the specified group.
Revoke a role from a user`revokeRoleFromUser`	POST	Remove one or more roles from a user.

Backup7

Cancel a backup`backups_cancel`	DELETE	Cancels an ongoing backup operation identified by its ID.
Cancel a backup restoration`backups_restore_cancel`	DELETE	Cancels an ongoing backup restoration process identified by its ID on the specified backend storage.
Create a backup`backups_create`	POST	Initiates the creation of a backup for specified collections on a designated backend storage.
Get backup creation status`backups_create_status`	GET	Checks the status of a specific backup creation process identified by its ID on the specified backend.
Get backup restoration status`backups_restore_status`	GET	Checks the status of a specific backup restoration process identified by the backup ID on the specified backend.
List all created backups`backups_list`	GET	List all created backups IDs, Status
Restore from a backup`backups_restore`	POST	Initiates the restoration of collections from a specified backup located on a designated backend.

Batch3

Create cross-references in bulk`batch_references_create`	POST	Batch create cross-references between collection items in bulk.
Create objects in batch`batch_objects_create`	POST	Registers multiple data objects in a single request for efficiency.
Delete objects in batch`batch_objects_delete`	DELETE	Removes multiple data objects based on a filter specified in the request body.

Classification2

Get classification status`classifications_get`	GET	Retrieves the status, metadata, and results (if completed) of a classification task identified by its unique ID.
Start a classification`classifications_post`	POST	Initiates a background classification task based on the provided parameters.

Cluster1

Get cluster statisticscluster_get_statistics GET Provides statistics about the internal Raft consensus protocol state for the Weaviate cluster.

DistributedTask1

Lists all distributed tasks in the clusterdistributedTasks_get GET

Export3

Cancel an export`export_cancel`	DELETE	Cancels an ongoing export operation identified by its ID.
Get export status`export_status`	GET	Retrieves the current status of an export operation, including progress for each collection being exported.
Start a new export`export_create`	POST	Initiates an export operation on the specified backend storage (S3, GCS, Azure, or filesystem).

Graphql2

Perform a GraphQL query`graphql_post`	POST	Executes a single GraphQL query provided in the request body.
Perform batched GraphQL queries`graphql_batch`	POST	Executes multiple GraphQL queries provided in the request body as an array.

Mcp3

Mcp mcp`mcp_delete`	DELETE	Terminates an MCP session.
Mcp mcp`mcp_get`	GET	Opens an SSE stream for receiving MCP server-sent events.
Mcp mcp`mcp_post`	POST	MCP Streamable HTTP endpoint.

Meta1

Get instance metadatameta_get GET Provides meta-information about the running Weaviate instance, including its version, loaded modules, and network hostname.

Namespace5

Create a new namespace`createNamespace`	POST	Create a new cluster-level namespace with the given name.
Delete a namespace`deleteNamespace`	DELETE	Mark a namespace for deletion.
Get a namespace`getNamespace`	GET	Retrieve details about a specific namespace by its name.
List namespaces`listNamespaces`	GET	Retrieve the list of all namespaces the caller has permission to see.
Update a namespace`updateNamespace`	PUT	Update a namespace's home node.

Node2

Get node status`nodes_get`	GET	Retrieves status information about all nodes in the cluster.
Get node status by collection`nodes_get_class`	GET	Retrieves status information only for the nodes that host shards for the specified collection (className).

Object17

Add an object reference`objects_class_references_create`	POST	Adds a new reference to a reference property (propertyName) on a source data object.
Add an object reference`objects_references_create`	POST	Add a reference to a specific property of a data object.
Create an object`objects_create`	POST	Creates a new data object.
Delete an object`objects_class_delete`	DELETE	Removes a data object from a specific collection, identified by its collection name (className) and UUID (id).
Delete an object`objects_delete`	DELETE	Deletes an object from the database based on its UUID.
Delete an object reference`objects_class_references_delete`	DELETE	Removes a specific reference from a reference property (propertyName) of a source data object.
Delete an object reference`objects_references_delete`	DELETE	Delete the single reference that is given in the body from the list of references that this property has.
Get an object`objects_class_get`	GET	Get a data object based on its collection name (className) and UUID (id).
Get an object`objects_get`	GET	Get a specific object based on its UUID.
List objects`objects_list`	GET	Retrieves a list of data objects.
Patch an object`objects_class_patch`	PATCH	Updates specific properties of an existing data object using JSON merge patch semantics (RFC 7396).
Patch an object`objects_patch`	PATCH	Update an object based on its UUID (using patch semantics).
Replace an object`objects_class_put`	PUT	Replaces properties of an existing data object.
Replace object references`objects_class_references_put`	PUT	Replaces all existing references for a specific reference property (propertyName) on a source data object.
Replace object references`objects_references_update`	PUT	Replace all references in cross-reference property of an object.
Update an object`objects_update`	PUT	Updates an object based on its UUID.
Validate an object`objects_validate`	POST	Checks if a data object's structure conforms to the specified collection schema and metadata rules without actually storing the object.

Replication10

Apply replication scaling plan`applyReplicationScalePlan`	POST	Apply a replication scaling plan that specifies nodes to add or remove per shard for a given collection.
Cancel a replication operation`cancelReplication`	POST	Requests the cancellation of an active replication operation identified by its ID.
Delete a replication operation`deleteReplication`	DELETE	Removes a specific replication operation.
Delete all replication operations`deleteAllReplications`	DELETE	Schedules all replication operations for deletion across all collections, shards, and nodes.
Force delete replication operations`forceDeleteReplications`	POST	USE AT OWN RISK!
Get replication scale plan`getReplicationScalePlan`	GET	Computes and returns a replication scale plan for a given collection and desired replication factor.
Get sharding state`getCollectionShardingState`	GET	Fetches the current sharding state, including replica locations and statuses, for all collections or a specified collection.
Initiate a replica movement`replicate`	POST	Begins an asynchronous operation to move or copy a specific shard replica from its current node to a designated target node.
List replication operations`listReplication`	GET	Retrieves a list of currently registered replication operations, optionally filtered by collection, shard, or node ID.
Retrieve a replication operation`replicationDetails`	GET	Fetches the current status and detailed information for a specific replication operation, identified by its unique ID.

Schema23

Add a property to a collection`schema_objects_properties_add`	POST	Adds a new property definition to an existing collection (className) definition.
Create a new alias`aliases_create`	POST	Create a new alias mapping between an alias name and a collection (class).
Create a new collection`schema_objects_create`	POST	Defines and creates a new collection (class).
Create a new tenant`tenants_create`	POST	Creates one or more new tenants for a specified collection (className).
Delete a collection (and all associated data)`schema_objects_delete`	DELETE	Removes a collection definition from the schema.
Delete a collection's vector index.`schema_objects_vectors_delete`	DELETE	Deletes a specific vector index within a collection (className).
Delete a property's inverted index`schema_objects_properties_delete`	DELETE	Deletes an inverted index of a specific property within a collection (className).
Delete an alias`aliases_delete`	DELETE	Remove an existing alias from the system.
Delete tenants`tenants_delete`	DELETE	Deletes one or more specified tenants from a collection (className).
Get a single collection`schema_objects_get`	GET	Retrieve the definition of a specific collection (className), including its properties, configuration, and vectorizer settings.
Get a specific tenant`tenants_get_one`	GET	Retrieves details about a specific tenant within the given collection (className), such as its current activity status.
Get all collection definitions`schema_dump`	GET	Retrieves the definitions of all collections (classes) currently in the database schema.
Get an alias`aliases_get_alias`	GET	Retrieve details about a specific alias by its name, including which collection (class) it points to.
Get index status for all properties of a collection`schema_objects_indexes_get`	GET	Returns per-property index state including active reindex progress.
Get the list of tenants`tenants_get`	GET	Retrieves a list of all tenants currently associated with the specified collection.
Get the shards status of a collection`schema_objects_shards_get`	GET	Retrieves the status of all shards associated with the specified collection (className).
List aliases`aliases_get`	GET	Retrieve a list of all aliases in the system.
Tokenize text using a property's configuration`schema_objects_properties_tokenize`	POST	Tokenizes the provided text using the tokenization method configured for the specified property.
Update a shard status`schema_objects_shards_update`	PUT	Updates the status of a specific shard within a collection (e.g., sets it to READY or READONLY).
Update a tenant`tenants_update`	PUT	Updates the activity status (e.g., ACTIVE, INACTIVE, etc.) of one or more specified tenants within a collection (className).
Update an alias`aliases_update`	PUT	Update an existing alias to point to a different collection (class).
Update collection definition`schema_objects_update`	PUT	Updates the configuration settings of an existing collection (className) based on the provided definition.
Update index configuration for a property (triggers reindex)`schema_objects_indexes_update`	PUT	Declaratively sets the desired index state for a property.

Tokenize1

Tokenize texttokenize POST Tokenizes the provided text using the specified tokenization method.

User8

Activate a user`activateUser`	POST	Activate a deactivated database user (db user type).
Create a new user`createUser`	POST	Create a new database (db user type) user with the specified name.
Deactivate a user`deactivateUser`	POST	Deactivate a database user (db user type).
Delete a user`deleteUser`	DELETE	Delete a database user.
Get current user info`getOwnInfo`	GET	Get information about the currently authenticated user, including username and assigned roles.
Get user info`getUserInfo`	GET	Retrieve detailed information about a specific database user (db user type), including their roles, status, and type.
List all users`listAllUsers`	GET	Retrieves a list of all database (db user type) users with their roles and status information.
Rotate API key of a user`rotateUserApiKey`	POST	Revoke the current API key for the specified database user (db user type) and generate a new one.

Well Known3

Get OIDC configuration`getwell_known_openid_configuration`	GET	Provides OpenID Connect (OIDC) discovery information if OIDC authentication is configured for Weaviate.
Live well known`weaviate_wellknown_liveness`	GET	Indicates if the Weaviate instance is running and responsive to basic HTTP requests.
Ready well known`weaviate_wellknown_readiness`	GET	Indicates if the Weaviate instance has completed its startup routines and is prepared to accept user traffic (data import, queries, etc.).

General1

List generalsweaviate_root GET Get links to other endpoints to help discover the REST API.