Documentation
Remote APIs
OpenAI API

OpenAI API

The OpenAI Extension can be used for any OpenAI-compatible API endpoints.

How to Integrate OpenAI API with Jan

This guide provides step-by-step instructions for integrating the OpenAI API with Jan, allowing users to utilize OpenAI's capabilities within Jan's conversational interface.

Integration Steps

Step 1: Configure OpenAI API Key

  1. Obtain OpenAI API Key from your OpenAI Platform (opens in a new tab) dashboard.
  2. Copy your OpenAI API Key.
  3. There are three ways to configure your API Key in Jan app:
  • Navigate to the Jan app > Gear Icon (⚙️) > My Models tab > Add Icon (➕) next to OpenAI.
  • Navigate to the Jan app > Thread > Model tab > Add Icon (➕) next to OpenAI.
  • Navigate to the Jan app > Gear Icon (⚙️) > OpenAI section under Model Providers.
  1. Insert your OpenAI API Key.

Step 2: Start Chatting with the Model

  1. Select the OpenAI model you want to use.

The OpenAI is the default extension for the Jan application. All the OpenAI models are automatically installed when you install the Jan application.

  1. Specify the model's parameters.
  2. Start the conversation with the OpenAI model.

OpenAI Models

You can also use specific OpenAI models you cannot find in the Hub section by customizing the model.yaml file, which you can see in the ~/jan/data/models/. Follow the steps in the Manage Models to manually add a model.

Troubleshooting

If you encounter any issues during the integration process or while using OpenAI with Jan, consider the following troubleshooting steps:

  • Double-check your API credentials to ensure they are correct.
  • Check for error messages or logs that may provide insight into the issue.
  • Reach out to OpenAI API support for assistance if needed.