Suanlimao
← Back to all tutorials

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

Models → provider OpenAI
1

Provider

OpenAI
2
Add model
Diagram only — the real screen in your version may differ

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.

Create a key →

Step 2 · STEP 0x02

Fill in the model details

Add model
1

Model name

Anything (shown inside MaxKB)
2

Model type

LLM
3

Base model

<MODEL_NAME> (custom input allowed)
4

API domain

https://api.suanlimao.shop/v1
5

API Key

<YOUR_API_KEY>
6
Add
Diagram only — the real screen in your version may differ
  • 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”.
Don't guess the model name: open the model plaza, click “Copy model id” on a model card and paste it. A wrong model name is the most common error.

Open the model plaza →

Step 3 · STEP 0x03

Use it in an application

Application → AI model
1

AI model

Your model
2

Debug chat

Hello
Diagram only — the real screen in your version may differ
  • 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).