Add LLM Provider Keys to Run Tests and Deploy Prompts

In order to run tests and deploy your prompts, you will need to first add API keys for any Large Language Model providers (i.e. OpenAI) used by your prompts. Note, Shiro also uses API keys to access the Shiro API so don't confuse the two. In this article, I will be referring to LLM Provider API Keys.

For each LLM provider, you can add two provider keys:
  • Development API Key (used when running tests in workshops)
  • Production API Key (used for deployed prompts)

Only accounts with admin permissions can manage Provider Keys.

To add a new provider key, click the "Provider Keys" tab.

Click the Provider Keys tab

Click the "New Provider Key" button to create a new provider key. Then on the next screen, enter the API key and select a provider and an Environment Type:

Enter API Key Details

Provider keys must be assigned to either the PRODUCTION or DEVELOPMENT environment. Workshops and test cases will always use the DEVELOPMENT environment provider key. Prompts can be deployed to either environment and the prompt will use the corresponding provider key for that environment when executed. The environment must also be specified when generating completions for a prompt deployment through the Shiro API GenerateCompletion endpoint.

Encryption at Rest

We care about data security and all of your Provider API keys are stored using encryption-at-rest at the database level. In addition, we also utilize Application-level encryption which adds an additional security layer. For example, if an attacker gained access to our database, a snapshot of it, or our application logs, they wouldn't be able to make sense of the encrypted information. 

Also, the values for all provider API Keys are masked in the Shiro UI and cannot be viewed in full after they have been entered. To update a provider API Key users must re-enter the full key.

Subscribe to our newsletter

The latest prompt engineering best practices and resources, sent to your inbox weekly.