API Keys

In order to access the Fireraven Guardrails API, you have to create and manage your API keys. These keys allow to authenticate and identify which organization is making requests. You can manage you API keys by heading to the API Keys section in the left side menu.

Remember that an API key is linked to an organization, not to a user. Make sure the correct organization is selected in the left organization selector list.

warning

API keys are meant to be kept secret. Do not share your API keys with anyone who should not have access to your Fireraven organization.

Create a key

Once in the API Keys section, you can create a new key by clicking the Generate new API Key button. You will then be asked to give the key a name. The name is simply there as a personal note or where the key is used. Once the name is entered, you can click Generate.

Your newly created API Key is displayed right away. You can use the copy button to copy the key to your clipboard if needed.

Deleting a key

A key can be deleted using the deletion button next to the creation date from the API keys' list.

warning

Be cautious when deleting an API key since the action cannot be undone

Using a key

Any request made to the Fireraven Guardrails API needs to provide the X-Api-Key header which includes the API key used for the request.