Skip to main content

Authorization

Follow this guide to create a new Voyage AI credential that will allow Nexla to authenticate to and exchange data with your Voyage AI account.
voyage_ai_api_auth.png

Voyage AI

Prerequisites​

Before creating a Voyage AI credential, you'll need to obtain an API key from your Voyage AI account. Voyage AI provides API keys for programmatic access to their embedding and reranking services through the Voyage AI dashboard.

To obtain a Voyage AI API key:

  1. Log in to your Voyage AI account at https://www.voyageai.com or navigate to the Voyage AI dashboard.

  2. Navigate to your account settings or API dashboard. This is typically accessible from the user menu or dashboard navigation.

  3. In the API settings or API Keys section, locate the option to create or manage API keys.

  4. Click Create API Key or Generate New Key to create a new API key for your application. You may need to provide a name or description for the API key.

  5. Copy the API key immediately after generation, as it may only be displayed once for security purposes. Store it securely, as you'll need it to authenticate API requests.

  6. Note your Base URL and API Version. The base URL is typically https://api.voyageai.com and the API version is typically v1. These values may vary depending on your Voyage AI deployment.

Voyage AI API keys are used as Bearer tokens in the Authorization header for all API requests. The API key is sensitive information and should be kept secure. If you've lost your API key, you'll need to generate a new one in your Voyage AI account settings.

For detailed information about Voyage AI API authentication and API key management, refer to the Voyage AI Documentation.

Create a Voyage AI Credential​

  • To create a new Voyage AI credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Voyage AI

VoyageAICred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Credential Settings​

  1. In the Voyage AI API Key field, enter the API key that you obtained from your Voyage AI account. This is the secret API key used to authenticate requests to the Voyage AI API.

  2. In the Base URL field, enter the base URL for the Voyage AI API. The default value is https://api.voyageai.com, which is the standard base URL for Voyage AI API services.

  3. In the API Version field, enter the API version for Voyage AI API requests. The default value is v1.

  4. In the API Version field (labeled as "Embeddings payload to test a connection"), enter a sample JSON payload to test the connection. A default payload is provided:

    {
      "input": [
        "Sample text 1",
        "Sample text 2"
      ],
      "model": "voyage-3.5"
    }

    The API key is sensitive information and should be kept secure. If you've lost your API key, you'll need to generate a new one in your Voyage AI account settings. API keys are used as Bearer tokens in the Authorization header for all API requests.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay 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.