Skip to main content

Weaviate API

Nexla's bi-directional connectors can both send data to and receive data from any data system. This means that once a user has created or gained access to a credential for any data system, building any data flow to ingest data from or send data to a location within that data system requires only a few simple steps.

weaviate_api.png

1. Credentials​

This section provides information about and step-by-step instructions for creating a new Weaviate API credential in Nexla.

  • After selecting the data source/destination type, click AddANewCredential.png in the Authenticate screen. This will open the Add New Credential window.

Configure the Credential​

  1. Enter a name for the credential in the Credential Name field.

  2. Optional: Enter a description for the credential in the Credential Description field.

    Resource Descriptions

    Resource descriptions should provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.


  1. Enter or select the following information in the displayed fields:

    • The Weaviate Instance URL – To connect to your Weaviate instance, you need the instance and connection details and a client to connect with.
    • API Key Value – Weaviate API Key, this can be obtained by singing up at Weaviate account.
    • API Version – Version of The Weaviate API
    • Open AI API Key – This is required for using OpenAI models and can be obtained by signing up at OpenAI
    • Cohere Api Key – Cohere related actions and models will require their Api Key.
    • Hugging Face Api Key – Hugging Face related services Api Key.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save.png button at the bottom of the Add New Credential screen to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.


2. Data Source​

To ingest data from a Weaviate API location, follow the instructions in Section 2 of Common Setup for REST API-Based Systems.


3. Data Destination​

To send data to a Weaviate API location, follow the instructions in Section 3 of Common Setup for Databases and Data Warehouses.