API Keys
API Keys are the credentials that are used to authenticate the requests to FloTorch Gateway. Usually, these are used with OpenAI API Client as OPENAI_API_KEY
environment variable.
Creating an API Key
Section titled “Creating an API Key”To create an API Key,
- Click on the
New API Key
button in the top right corner of the FloTorch Console. - Provide a name for the API Key
- Click on
Create
button
Once an API Key is created, you will be shown a secret key. This secret key is not shown again, so please save it in a secure location.
Using an API Key
Section titled “Using an API Key”To use an API Key, you can set the OPENAI_API_KEY
environment variable to the secret key.
export OPENAI_API_KEY=<secret-key>
Regenerating an API Key
Section titled “Regenerating an API Key”To regenerate an API Key,
- Identify the API Key you want to regenerate
- Click on
Actions
dropdown and click onRefresh
- The API Key will get regenerated.
Deactivate/Activate an API Key
Section titled “Deactivate/Activate an API Key”To deactivate/activate an API Key,
- Identify the API Key you want to deactivate/activate
- Click on
Actions
dropdown and click onActivate
(if deactivated) orDeactivate
(if activated). - The API Key will get deactivated/activated.
Deleting an API Key
Section titled “Deleting an API Key”To delete an API Key,
- Identify the API Key you want to delete
- Click on
Actions
dropdown and click onDelete API Key
- The API Key will get deleted.