Skip to content
Stoic AI Docs

Openai Configuration

This guide explains how to configure the OpenAI connector for your service using the configuration interface.

Steps to Configure

  1. Go to the OpenAI Configuration section by navigating to Settings -> OpenAI Configuration.

  2. Click on New to create a new configuration or Edit to modify an existing one.

  3. Fill out the form fields:

    • Enter a Display Name for easy identification.
    • Input your OpenAI Organization ID.
    • (Optional) Enter an OpenAI Project ID.
    • Select the Model you wish to use.
    • Paste your API Key.

  4. Click Save to store the configuration.

Example Configuration

Here’s an example setup for a production environment:

  • Display Name: Production
  • OpenAI Organization ID: org-XXXXXXXXXXXXX
  • OpenAI Project ID: (Leave blank if not applicable)
  • Model: GPT-4
  • API Key: sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Configuration Fields

Below is a description of each field in the configuration form:

Display Name

  • Purpose: A user-friendly name for the configuration.
  • Example: Production Setup or Development Environment.

OpenAI Organization ID

  • Purpose: Your OpenAI organization ID, used to authenticate with OpenAI’s API.
  • Example: org-XXXXXXXXXXXXXXXXXX.

OpenAI Project ID (Optional)

  • Purpose: The project ID associated with your OpenAI account.
  • Note: Leave this blank if it’s not required.

Model

  • Purpose: The OpenAI model to use for completion tasks.
  • Example: GPT-4 or GPT-3.5.

API Key

  • Purpose: Your OpenAI API key for authentication.
  • Important: Keep the API key secure and do not share it publicly.
  • Where to get it: You can obtain your API key from OpenAI by visiting this link.

Notes and Troubleshooting

  • Verify Inputs: Ensure that your API key and organization ID are correct before saving.
  • Testing the Configuration: Use the To Playground option to test your setup.
  • API Key Access: If you haven’t created an API key yet, visit OpenAI’s API key page to generate one.

If issues persist:

  • Confirm your API key is active.
  • Double-check your organization ID.
  • Ensure the selected model is supported by your OpenAI plan.