Overview
OmniMux uses a single gateway Base URL:
https://api.omnimux.ai (OpenAI-compatible clients typically use https://api.omnimux.ai/v1). Console: omnimux.ai/dashboard. Model IDs in this guide are examples — confirm with the console or GET /v1/models.- Installing and configuring OpenClaw Gateway
- Creating a Feishu enterprise application with bot capability
- Setting up OmniMux API as a custom model provider
- Verifying the connection and getting started
System Environment Check
Before installation, it’s recommended to run the environment checker tool to ensure your system meets OpenClaw’s requirements.Download Checker Tool
Download the checker tool for your platform from GitHub Releases:Check Items
The tool automatically checks the following:- ✅ Node.js version (requires >= 22.12.0)
- ✅ npm available
- ✅ Git available
- ✅ Network connectivity (github.com, npmjs.org, omnimux.ai)
Prerequisites
Before configuring, make sure you have:1. Install Node.js
OpenClaw is installed via npm and requires Node.js 22 or higher. Visit Node.js official website, download the Windows installer (.msi file), and run the installation program. After installation, open PowerShell to verify:sudo before the command.
2. Get OmniMux API Key
- Log in to OmniMux Console
- Find API Keys in the dashboard, click ‘Create New Key’ button, then copy the generated Key
- API Key usually starts with
sk-
3. Prepare a Feishu Account
You need a Feishu enterprise account to create applications on the Feishu Open Platform.Step 1: Install OpenClaw
Run the following command in your terminal:Step 2: Onboarding
Run the onboarding command. OpenClaw will guide you through the initial setup and install the background daemon service:1. Confirm Installation
The system will display a risk disclaimer. Confirm to proceed:2. Select Installation Mode
When prompted to choose an installation mode, select Quickstart:3. Select Provider
When prompted to choose a model provider, select Skip. We will manually configure OmniMux as a custom provider later:4. Select Models
When prompted to choose which models to enable, select All:5. Select Default Model
When prompted to choose a default model, select Keep current:Step 3: Create Feishu Application
1. Log in to Feishu Open Platform
Visit the Feishu Open Platform and log in with your Feishu account. For Lark (international version), use https://open.larksuite.com/app and setdomain: "lark" in the configuration.
2. Create Application
Click Create Enterprise Self-Built Application, fill in the application name and description, and choose an icon.3. Get Credentials
On the Credentials & Basic Info page, copy:- App ID (format:
cli_xxx) - App Secret
4. Configure Permissions
On the Permission Management page, click Batch Import and paste the following JSON to import all required permissions:5. Enable Bot Capability
In the left sidebar, click App Capabilities, find the Bot card, and toggle the menu status to enabled. Once enabled, fill in the bot name and description — users will see these when searching for or chatting with the bot in Feishu.6. Configure Event Subscriptions
Before configuring event subscriptions, make sure you have:- Completed the Feishu channel configuration (see Step 4)
- The gateway is running (check with
openclaw gateway status)
- Select Use Long Connection to Receive Events (WebSocket mode)
- Add event:
im.message.receive_v1(Receive Message)
7. Publish Application
Go to Version Management & Release, create a version, submit for review and publish. Enterprise self-built applications are usually approved automatically.Step 4: Configure OpenClaw
OpenClaw’s configuration is centralized in~/.openclaw/openclaw.json. There are three key configuration domains:
plugins.entries.*— Controls which plugins to loadchannels.*— Controls channel connections and account credentialsmodels.providers.*— Controls model providers
1. Add Feishu Channel
Open~/.openclaw/openclaw.json:
Enable the Feishu plugin (plugins.entries):
channels.feishu):
channels.feishu.accounts, NOT under plugins.entries.feishu. Placing them in the wrong location will cause an Unrecognized key error.
You can also configure via environment variables:
2. Configure OmniMux API
In the sameopenclaw.json, find the models field and add OmniMux as a custom model provider:
"your-omnimux-api-key" with the actual API Key from your OmniMux Console.
3. Configure Default Model
In theagents field, set the default model:
4. Restart Gateway
Restart the OpenClaw Gateway to apply the configuration:openclaw gateway restart instead of manually starting another process, otherwise you will get a port conflict error.
Verify the configuration is loaded correctly:
Step 5: Verify Connection
1. Find the Bot in Feishu
Open Feishu, search for the bot name you created, and start a conversation.2. Get Pairing Code
Send any message to the bot. It will return a pairing code.3. Complete Pairing
Open a new terminal window and run:<>.
4. Test Connection
After pairing is complete, send a message to the bot in Feishu:Access Control
Direct Message Access
DefaultdmPolicy: "pairing" — unknown users will receive a pairing code that must be approved by an admin:
channels.feishu.allowFrom.
Group Access
Group policy is controlled viachannels.feishu.groupPolicy:
"open"— Allow all users in the group (default)"allowlist"— Only allow users ingroupAllowFrom"disabled"— Disable group messages
requireMention: true).