API keys & Endpoints

Use orq.ai's integration to setup your personal API keys and endpoints.

In this guide, we will see how key management works in orq.ai and how you can integrate your own API keys from your LLM providers.

Why use your own API Keys

For testing purposes, you can use orq.ai shared API keys. We want to make it as easy as possible for you to start using models for which you might not have your own API key yet.

For production workloads, we highly recommend that you use your own API keys and Endpoints.

This is because the keys and providers will have different rate limits, which you can hit when using our shared key. If you're using your own API keys or endpoint, you have full control over those limits.

Another important reason is costs and control. Having set up your own API key, the billing will be handled by the provider itself, allowing you to configure your limits.

Setting up an API key

To set up your own API Key, head to the orq.ai panel and to the Integrations section.

Choose the provider you wish to set an API key for and press View Integration, then select Setup your own API Key

Here you can configure your API key and endpoint, fields to configure will vary depending on the provider (here Azure is pictured).

Configure your API integration based on the criteria set by the provider. In this image, AWS is shown.


Having Multiple API Keys

You can decide to configure multiple API for a single provider, to do so, select Add a new API key.

Benefits of using multiple API Keys

Credential Failure

Having a different API key available to use models can be useful in case one becomes invalid or for instance runs out of credit. Having an extra key configured on a fallback model can make sure you respond in all cases.

Multiple Environments

In case you have multiple API keys used for different purposes, this lets you organize your orq.ai models to use the credentials dedicated to the correct environment.

Using API keys in model configuration

Once your API keys are configured within the Integration panel, you can use them within Playgrounds, Experiments and Deployments.

This feature is accessible to any model, including Fallback models.

Walkthrough from the creation of multiple API keys to the usage within a Deployment.

Walkthrough of choosing a default API key and selecting it within a Deployment's variant fallback.