How to Generate an OpenAI API Key for LLM Integration in Pyramid Analytics

Omri_Zach
updated 8 days ago

Pyramid Analytics supports integration with OpenAI's Large Language Models (LLMs), enabling AI-powered capabilities such as generating scripts, formulas, translations, and other content using natural language.

To use OpenAI as an LLM provider in Pyramid, you must first generate an OpenAI API key and configure it in Pyramid's LLM Manager.

This article explains how to generate an OpenAI API key, configure it in Pyramid Analytics, and verify the connection.

Important Notice: The instructions below are provided as general guidance and reflect the OpenAI platform at the time of writing. OpenAI is a third-party service, and its interface, configuration options, and API requirements may change without notice. Customers are responsible for reviewing and verifying the latest instructions, requirements, and supported configurations directly with OpenAI before proceeding.

Step 1: Access the OpenAI API Platform

Navigate to the OpenAI API Platform.
Sign in with your existing OpenAI account or create a new account.
Once signed in, open the OpenAI API dashboard.

Note: An OpenAI API account is required to generate an API key. A ChatGPT subscription is not required.

Step 2: Generate an OpenAI API Key

Navigate to the OpenAI API Keys page.
Select the appropriate OpenAI project. You can use an existing project or create a dedicated project for Pyramid Analytics.
Click Create new secret key.
Enter a descriptive name, such as Pyramid-Analytics.
Select the appropriate permissions:
- All: Grants full API permissions.
- Restricted: Allows permissions to be limited to specific API resources and operations.
- Read Only: Does not provide the permissions required to generate LLM responses.
Click Create secret key.
Copy the generated key and store it securely.

Important: OpenAI displays the full secret key only once when it is created. If the key is lost, a new one must be generated.

Step 3: Configure OpenAI in Pyramid Analytics

Once the API key has been generated, configure it in Pyramid.

Log in to Pyramid Analytics with an administrator account.
Open the Admin Console.
Navigate to AI → LLM Manager.
Click Add LLM Provider.
Select OpenAI from the Vendor dropdown.
Enter a name for the provider, such as OpenAI.
Paste the generated API key into the API Key field.
Click Save.

The OpenAI provider should now appear in the list of configured LLM providers.

Step 4: Enable AI Features and Test the Connection

After configuring the OpenAI provider, ensure the appropriate AI features are enabled in Pyramid.

Navigate to Admin Console → AI → AI Settings.
Enable the main Generative AI and Natural Language options.
Enable the relevant Chatbot and Generative AI functionality as required.
Select the configured OpenAI provider as the default LLM provider for the desired features.
Save the settings.
Return to AI → LLM Manager, select the OpenAI provider, and click Test to verify the connection.

A successful test confirms that Pyramid can communicate with the configured OpenAI service.

Note: The LLM provider test may fail if the main Generative AI and Natural Language options are disabled in Pyramid's AI Settings. Available settings may vary depending on the Pyramid version.