> ## Documentation Index
> Fetch the complete documentation index at: https://docs.modellix.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Modellix LLM with WorkBuddy

> Add Modellix as a WorkBuddy custom OpenAI-compatible model with Endpoint, models.json, and provider/name model IDs.

Configure [WorkBuddy](https://www.codebuddy.cn/work/) to call the Modellix LLM gateway. WorkBuddy supports OpenAI-compatible custom models in the UI and in `~/.workbuddy/models.json`, pointed at Chat Completions on [`POST /v1/chat/completions`](/llm/chat-completions).

<Note>
  This page covers **LLM text** only (`https://llm.modellix.ai`).

  Modellix model IDs are `provider/name` (for example `openai/gpt-5.5`). Enter that full string as the Model Name / `id`. Set Endpoint / `url` to `https://llm.modellix.ai/v1` (include `/v1`). With **Custom Protocol** off (default), WorkBuddy uses the standard `/chat/completions` path. See [Models & Pricing](/llm/overview#models-and-pricing).
</Note>

## Set Up WorkBuddy

<Steps>
  <Step title="Get a Modellix API Key">
    Create a Modellix API key in the [console](https://modellix.ai/console/api-key) and store it securely. You will paste it into the WorkBuddy custom model form or `models.json`.
  </Step>

  <Step title="Add a Custom Model in the UI">
    In WorkBuddy, open the model picker (for example **Auto** near the input box), scroll to the bottom, and choose **Configure custom models** → **Add Model**.

    You can also open **Settings → Model** (or **Settings → Models**) and add a custom model there.

    Set **Provider** to **Custom**, then fill in:

    | Field             | Value                                                                                                      |
    | ----------------- | ---------------------------------------------------------------------------------------------------------- |
    | Endpoint          | `https://llm.modellix.ai/v1`                                                                               |
    | API Key           | Your Modellix API Key                                                                                      |
    | Model Name        | Exact Modellix Model ID (for example `openai/gpt-5.5`)                                                     |
    | Advanced Settings | Enable **Tool Calling** for agent tool use; enable Image Input / Reasoning only if the model supports them |
    | Custom Protocol   | Leave **off** (default) so WorkBuddy uses `/chat/completions`                                              |

    Save the model. Include `/v1` in the Endpoint.

    <Tip>
      If your gateway requires a non-standard path, enable **Custom Protocol** and set Endpoint to the exact URL WorkBuddy should call (for example the full `https://llm.modellix.ai/v1/chat/completions`). For Modellix, leaving Custom Protocol off with Endpoint `https://llm.modellix.ai/v1` is the usual setup.
    </Tip>
  </Step>

  <Step title="Persist with models.json">
    WorkBuddy stores custom models in a local JSON **array** (not the CodeBuddy `{ "models": [...] }` object shape):

    * macOS / Linux: `~/.workbuddy/models.json`
    * Windows: `%USERPROFILE%\.workbuddy\models.json`

    Example:

    ```json theme={null}
    [
      {
        "id": "openai/gpt-5.5",
        "name": "GPT 5.5",
        "vendor": "Custom",
        "url": "https://llm.modellix.ai/v1",
        "apiKey": "mdlx-xxxxxxxx",
        "supportsToolCall": true,
        "supportsImages": false,
        "supportsReasoning": false,
        "useCustomProtocol": false
      }
    ]
    ```

    Replace `mdlx-xxxxxxxx` with your Modellix API key. Append additional objects to the array for more Modellix IDs (for example `anthropic/claude-sonnet-5`, `google/gemini-3.6-flash`).

    | Field               | Value                                          |
    | ------------------- | ---------------------------------------------- |
    | `id` / `name`       | Exact Modellix Model ID (`provider/name`)      |
    | `vendor`            | `Custom`                                       |
    | `url`               | `https://llm.modellix.ai/v1`                   |
    | `apiKey`            | Modellix API Key                               |
    | `useCustomProtocol` | `false` (default OpenAI Chat Completions path) |
    | `supportsToolCall`  | `true` recommended for agent tool use          |

    <Warning>
      Do not use a built-in vendor that points at OpenAI or Anthropic directly. Choose **Custom** / `vendor: "Custom"` so traffic goes to Modellix. Do not set `url` to the media API host (`https://api.modellix.ai`).
    </Warning>

    After saving, restart WorkBuddy or reopen the model picker so the list refreshes. Full catalog: [Models & Pricing](/llm/overview#models-and-pricing).
  </Step>

  <Step title="Select and Start">
    Open the model picker, choose your model under **Custom Models**, and send a short test message to confirm the gateway responds.
  </Step>
</Steps>

## Troubleshooting

| Symptom                    | Check                                                                                        |
| -------------------------- | -------------------------------------------------------------------------------------------- |
| 401 / auth errors          | Key is a valid Modellix API Key                                                              |
| Model not found / 404      | Model Name / `id` is a full ID like `openai/gpt-5.5`, not bare `gpt-5.5`                     |
| Endpoint / URL errors      | Endpoint or `url` includes `/v1`: `https://llm.modellix.ai/v1`                               |
| Model missing after save   | Reopen the model picker and check **Custom Models**; confirm `models.json` is valid JSON     |
| Wrong host                 | Not using the media API (`https://api.modellix.ai`)                                          |
| Non-standard path failures | Enable **Custom Protocol** and use the full Chat Completions URL if auto-completion is wrong |

## Related

* [WorkBuddy](https://www.codebuddy.cn/work/) — product home
* [Models & Pricing](/llm/overview#models-and-pricing) — Model IDs and rates
* [LLM API guide](/llm/api/api) — protocols and curl examples
* [CodeBuddy](/llm/agent/codebuddy) — related Tencent custom-model setup (different `models.json` shape)