Connect your tools
MaxKB
Add a model in MaxKB under the OpenAI provider with our address as the API domain.
About 5 minFor:Admins who self-host the MaxKB knowledge-base assistant
Before you start
- A MaxKB admin account
- A key and a model name
Step 1 · STEP 0x01
Pick the OpenAI provider and add a model
Provider
Open model management, choose All models on the left, select the OpenAI provider and click Add model. MaxKB has no separate “OpenAI-compatible” provider; the official docs use the OpenAI provider with a reverse-proxy address for third parties.
Step 2 · STEP 0x02
Fill in the model details
Model name
Model type
Base model
API domain
API Key
- The Base model dropdown lists common names and accepts custom input: paste the name copied from the plaza. The docs warn it must match what the service supports or validation fails.
- API domain is
https://api.suanlimao.shop/v1— in the docs' words, a domestic proxy's API domain is usually “reverse-proxy address/v1”.
Step 3 · STEP 0x03
Use it in an application
AI model
Debug chat
- In the application settings switch the AI model to the one you added and try the debug chat.
✓ How to tell it worked
- Validation passes on add, app chats answer and the Usage page shows the request.
FAQ
Validation fails on add?
Per the docs a base-model name mismatch fails validation. Copy it again from the plaza; then check the API domain is https://api.suanlimao.shop/v1 and the key is complete.
Need an embedding model for the knowledge base?
Add it the same way with model type Embedding and a base model from the plaza; if the plaza has none, use MaxKB's built-in local embedding model.
Related tutorials
Still stuck?
Read the troubleshooting tutorials first. If that does not help, open a ticket with the request_id, time, model and the exact error (never paste your key).