Using Hanzo Cloud OpenAI API Compatible Interface
Learn how to connect external chat UIs to Hanzo Cloud using OpenAI API compatibility.
This document is a step-by-step tutorial designed for beginners. It will guide you through the process of connecting external chat UIs to Hanzo Cloud using its OpenAI API compatibility feature.
Introduction
Hanzo Cloud now supports integration with external chat UIs through OpenAI API compatibility. This feature allows you to use popular open-source chat interfaces with Hanzo Cloud's backend, giving you more flexibility in how you interact with your knowledge base system.
If you're looking to use your preferred chat UI with Hanzo Cloud, this guide will walk you through the simple setup process.
Step 1: Set Up Hanzo Cloud with a Model Provider
Before connecting an external UI, ensure you have Hanzo Cloud properly set up with a model provider. If you haven't done this yet, please refer to the Add an AI Model Provider tutorial.
Step 2: Get Your OpenAI-compatible API Key
When you create a model provider in Hanzo Cloud, an API key is automatically generated. This key allows external applications to communicate with Hanzo Cloud using the OpenAI API format.
Step 2.1: Access Your API Key
Navigate to the Providers section and select your model provider. Only administrators can view and modify API keys.
Tip
If the API key field is empty, Hanzo Cloud will automatically generate a new key when you save the provider.
Step 3: Configure Your External Chat UI
Once you have your API key, you can configure your external chat UI to connect to Hanzo Cloud.
Step 3.1: Configure with chatgpt-web
For this example, we'll use chatgpt-web, a popular open-source ChatGPT interface.
- Locate the
service/.envfile in your chatgpt-web installation - Modify the following variables:
OPENAI_API_KEY: Set this to your Hanzo Cloud-generated API keyOPENAI_API_BASE_URL: Set this tohttp://your-cloud-backend:port/api
# Example configuration
OPENAI_API_KEY=sk-UflKsbiYjzBvjeUFJbDpxuKg
OPENAI_API_BASE_URL=http://localhost:14000/api
Make sure your Hanzo Cloud backend is accessible from the machine running your chat UI. Check firewall settings if you encounter connection issues.
### Step 4: Test Your Integration
Start your chat UI application and test the connection. You should now be able to interact with Hanzo Cloud through your preferred interface. If everything is set up correctly, you should see responses from Hanzo Cloud in your chat UI.
## Compatible Chat UIs
Hanzo Cloud's OpenAI API compatibility has been tested with these popular chat interfaces:
- [chatgpt-web](https://github.com/Chanzhaoyu/chatgpt-web)
Other chat UIs that use the standard OpenAI API format should also work with Hanzo Cloud.How is this guide?
Last updated on