# LobeChat Integration Guide

LobeChat is a modern open-source chat framework that supports web deployment and desktop clients. This article explains how to use it to call models through the UModelverse platform.

## **System Requirements**

-   A network connection.
    
-   For self-hosted deployment, either [Docker](https://www.docker.com/) or [Node.js](https://nodejs.org/) is required (choose one).
    

## **1. Obtain an API Key**

Visit the [UModelverse Console](https://console.ucloud.cn/modelverse/api) to obtain your API key. For available models, see the [supported models](https://api-us-ca.umodelverse.ai/v1/models) on the UModelverse platform.

## **2. Deploy and Configure**

LobeChat connects to OpenAI-compatible services via environment variables. Replace `YOUR_API_KEY` with your UModelverse API Key.

### Option 1: Docker Deployment

```
docker run -d -p 3210:3210 \
  -e OPENAI_API_KEY=YOUR_API_KEY \
  -e OPENAI_PROXY_URL=https://api-us-ca.umodelverse.ai/v1 \
  -e OPENAI_MODEL_LIST="+claude-sonnet-4-6,+gpt-5.2" \
  lobehub/lobe-chat
```

After deployment, visit `http://localhost:3210` to start using it.

### Option 2: Environment Variable Reference

| Environment Variable | Value |
| --- | --- |
| `OPENAI_API_KEY` | Your UModelverse API Key |
| `OPENAI_PROXY_URL` | `https://api-us-ca.umodelverse.ai/v1` |
| `OPENAI_MODEL_LIST` | Add UModelverse [supported models](https://api-us-ca.umodelverse.ai/v1/models) in the format `+model-name`, separated by commas for multiple entries |

## **3. Using Models**

After opening the page, select the UModelverse model you added under the OpenAI provider to start a conversation. If it does not appear, go to "Settings → Language Models → OpenAI" to confirm that the API Key, proxy URL, and model list are filled in correctly.

## **Frequently Asked Questions**

### Getting an authentication failure or connection error?

Please check each of the following:

1.  `OPENAI_API_KEY` is from the UModelverse platform, copied in full with no extra spaces.
    
2.  `OPENAI_PROXY_URL` is set to `https://api-us-ca.umodelverse.ai/v1`.
    
3.  The model in `OPENAI_MODEL_LIST` is one of the [supported models](https://api-us-ca.umodelverse.ai/v1/models) on the UModelverse platform.