# WorkBuddy

> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。

本文介绍如何在 WorkBuddy 中配置并使用方舟 按量计费模型服务。

<span id="pre-operation"></span>
# 前提条件

在配置工具前，需要 [开通所需的模型服务](https://ark.volcengine.com/region:cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false)。

<span id="install-workbuddy"></span>
# 安装 WorkBuddy

访问 [WorkBuddy 官网](https://www.workbuddy.ai/)，下载并安装适合您操作系统的版本。安装完成后按提示登录。

<span id="92b07719"></span>
# 配置 WorkBuddy

<span id="a1c53f01"></span>
## 手动配置

1. 启动 WorkBuddy，单击左下角账户头像，选择 **设置**。

![](https://arkdocs.tos-cn-beijing.volces.com/images/agent-plan/workbuddy-settings-v2.png)

2. 在左侧导航中选择 **模型**，在自定义模型区域单击 **添加模型**。

![](https://arkdocs.tos-cn-beijing.volces.com/images/agent-plan/workbuddy-add-model-menu.png)

3. 在提供商中选择 **自定义 / Custom**，填写以下字段并保存：

    * **接口地址**：`https://ark.cn-beijing.volces.com/api/v3`
    * **API Key**：API Key（[获取地址](https://ark.volcengine.com/region:cn-beijing/apikey)）。

    * **模型名称**：按需填写模型的 Model ID，模型列表参见 [模型列表](/docs/model-list)。
    * **高级工具**：非必填，按需勾选。按需开启 **工具调用**、**图片输入**、**思考模式**。
    * **自定义协议**：当模型服务使用非标准 URL 路径（如经过网关或代理层封装）时，可在高级配置中开启自定义协议开关。开启后 Tencent WorkBuddy 将直接按填写的 URL 发起请求，跳过路径校验与自动补全。关闭（默认）：使用标准 `/chat/completions` 路径，自动校验并补全接口地址。开启：直接使用用户填写的接口地址发起请求，跳过路径校验与自动补全逻辑。

    ![](https://arkdocs.tos-cn-beijing.volces.com/images/agent-plan/workbuddy-custom-protocol-v2.png)

    除了在客户端 UI 中添加自定义模型，也可以直接编辑本地配置文件 `~/.workbuddy/models.json` 来接入 按量计费模型服务，保存后，WorkBuddy 会自动监听并热加载新配置（**无需重启**）。返回主界面的模型下拉列表中显示的即为 `name` 字段。

`~/.workbuddy/models.json` 示例

```JSON
[
  {
    "id": "doubao-seed-evolving​",
    "name": "doubao-seed-evolving​",
    "vendor": "Custom",
    "url": "https://ark.cn-beijing.volces.com/api/v3",
    "apiKey": "<YOUR_API_KEY>",
    "supportsToolCall": true,
    "supportsImages": false,
    "supportsReasoning": false,
    "useCustomProtocol": false
  }
]
```

4. 保存后返回 WorkBuddy 主界面。

<span id="use-workbuddy"></span>
# 使用 WorkBuddy

1. 在主界面顶部的模型下拉中，选中刚添加的模型。
2. 在输入框用一句话描述你的任务（如生成周报、数据分析、整理文件、代码生成 / 重构 / 修 Bug），回车即可启动，WorkBuddy 会自主规划执行并产出文档、表格、代码文件等结果，在右侧结果区可查看生成内容与文件变更。

> 更多使用技巧和场景参见 [WorkBuddy 官方文档](https://www.workbuddy.ai/docs/zh/workbuddy/Quickstart)。