CodeBuddy | 文档中心

一、通用准备

在接入 AI 工具前，请先完成以下准备工作。

1.获取 API Key

平台支持按量付费/模型资源包、Token Plan 两种计费方式，对应的凭证获取方式不同：

使用方式

说明

获取方式（以下 API Key 均为示例）

按量付费 API 调用

按实际使用量计费，适合轻度使用

Base URL OpenAI 兼容协议：https://maas-api.unisound.com/v1
API Key
格式：sk-xxxxx

前往 API Key 管理创建 API Key

Token Plan

固定订阅费，按套餐限量调用

Base URL OpenAI 兼容协议：https://maas-api.unisound.com/v1
API Key
格式：tp-xxxxx

成功订阅Token Plan 后，前往订阅管理获取专属 API Key

按量付费支持使用所有模态模型，包括文本、语音、视觉等。

Token Plan Key 用于 Token Plan 额度。它可以在付费资源可用之前就存在；当您拥有 Token Plan Credits 时才可实际使用资源。详情见 Token Plan 订阅概要。

2.选择 Base URL

平台提供一个 Base URL：

OpenAI 兼容协议：https://maas-api.unisound.com/v1

3.查询 Model ID

'<'MODEL_ID'>' 请替换为控制台「模型广场」中目标模型的 Model ID。

二、安装 CodeBuddy

CodeBuddy 插件支持 VS Code 与 JetBrains 系列 IDE：

VS Code：在扩展市场搜索 CodeBuddy 进行安装。
JetBrains 系列 IDE：在插件市场搜索“腾讯云代码助手”进行安装。

如需在终端中使用，可安装 CodeBuddy Code：先安装或更新 Node.js（v18.0 或更高版本），然后在终端中执行以下命令。

Bash

npm install -g @tencent-ai/codebuddy-code

三、配置目标模型

CodeBuddy 插件与 CodeBuddy Code 均通过 ~/.codebuddy/models.json 管理自定义模型（Windows 路径：C:\Users\<用户名>\.codebuddy\models.json）。

将以下内容完整复制到配置文件中（实际使用时按需更换 UNISOUND_API_KEY 及各占位标识）：

JSON

{
  "models": [
    {
      "id": "<MODEL_ID>",
      "name": "<MODEL_ID>",
      "vendor": "OpenAI",
      "apiKey": "UNISOUND_API_KEY",
      "maxInputTokens": 128000,
      "maxOutputTokens": 4096,
      "url": "https://maas-api.unisound.com/v1/chat/completions",
      "supportsToolCall": true,
      "supportsImages": true,
      "supportsReasoning": true
    }
  ]
}

其中 url 为完整接口地址，以 /chat/completions 结尾；id 与 name 填写目标模型的 Model ID；maxInputTokens、maxOutputTokens、supportsToolCall、supportsImages、supportsReasoning 请按目标模型的参数说明填写，仅支持对应能力的模型设置为 true。

API Key 的获取方式与 Key 格式参见通用准备。注意，codebuddy仅支持 OpenAI 兼容协议 API