Documentation
Remote Engines
OpenAI API

OpenAI API

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 Key and the endpoint URL you want to use.
  3. Navigate to the Jan app > Settings.
  4. Select the OpenAI Inference Engine.
  5. Insert the API Key and the endpoint URL into their respective fields.

You can also manually edit the JSON file in ~/jan/settings/@janhq.

Step 2: Select Model

  1. Navigate to the Hub section.
  2. Ensure you have downloaded the OpenAI model you want to use.

The OpenAI Inference Engine is the default extension for the Jan application. All OpenAI models are automatically installed with the Jan application.

Step 3: Start the Model

  1. Navigate to the Thread section.
  2. Under the Model section, select the OpenAI model you want to use.
  3. 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.json file, which you can see in the ~/jan/models/. Follow the steps explained in the Using Models to add a model manually.

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.