Managing Vortex API Keys

​Vortex acts as a secure intermediary between your application and Large Language Model (LLM) providers by using Vortex API keys linked to specific consumers.

When your application needs to communicate with LLM providers, Vortex automatically exchanges your Vortex API key for the corresponding provider API key, ensuring secure and seamless access.

Generating Vortex API Keys​

Before you generate a Vortex API key, please make sure you have at least one consumer and one channel configured.

Steps to Generate a Key:​

1. Navigate to Consumers from the side navigation bar.
2. Click on Create a Vortex Key.
3. Set a key name. Key names help identify a Vortex key for tracking usage and costs.
4. Choose the relevant consumer(s). You can generate multiple Vortex keys at once by selecting multiple consumers.
5. Select a channel you want to grant access to this key to from the list.
6. Apply a template to the key.
7. Click Create.

Make sure to copy the generated Vortex keys and share them securely with the intended consumer.

Viewing Existing Vortex API Keys​

To view all Vortex API keys associated with a consumer:

1. Select Consumer from the side navigation.
2. Click the key icon next to a consumer. A table listing all linked Vortex API keys is displayed.
   

Editing Existing Vortex API Keys​

You can edit Vortex API keys to change their name, associated channel, or resource limits.

Editing Process:​

1. Click on the edit icon next to the key you wish to modify.
2. Update the key name, channel, and/or resource limits as necessary.
3. Confirm the changes by clicking Update.

Deleting Existing Vortex API Keys​

Deleting a Vortex API key is a permanent action that results in the loss of all associated data.

How to Delete a Key:​

1. Press the delete icon next to the key you want to remove.
2. Confirm your action by clicking Delete.