概览

MaaSLink 在线文档

从账户开通、密钥管理到主流开发工具配置,快速开始统一模型服务接入。

01

快速开始

注册后,请按账户身份完成相应操作。企业用户可直接配置调用;渠道用户需先提交渠道申请。

企业用户

完成注册后,可直接进入控制台配置模型调用。

  1. 01

    注册并登录

    完成账号注册并登录 MaaSLink 控制台。

  2. 02

    创建 API Key

    在控制台的密钥管理中创建 API Key,并妥善保存完整密钥。

    API Key 仅在创建时完整展示,请勿提交到代码仓库或发送给无关人员。

  3. 03

    选择模型并发起调用

    在模型广场或控制台确认当前站点可用的模型 ID,按页面给出的 Base URL 配置应用或工具。

打开控制台

渠道用户

提交渠道申请后,可查看申请状态并按要求补充材料;审核通过后即可使用渠道功能。

  1. 01

    注册并提交渠道申请

    使用渠道身份完成注册,并按页面要求提交合作和资质信息。

  2. 02

    查看申请状态

    在申请状态页查看待审核、待补充、已驳回或已通过状态;如需补充材料,请在页面中完成补件。

  3. 03

    审核通过后开始使用

    审核通过后即可进入渠道功能,关联客户、配置额度和查看用量;申请被驳回后可按页面指引重新提交。

注册并提交申请
02

接入工具

接口选择取决于客户端:Cursor 使用 OpenAI Chat Completions,Claude Code 使用 Anthropic Messages,Codex 使用 OpenAI Responses。请按各工具的字段要求填写本页给出的地址、密钥和模型 ID。

API / SDK 基础

API / SDK 基础

  • 服务地址:页面会根据当前访问站点显示连接地址。OpenAI 兼容调用、Cursor 和 Codex 使用以 /v1 结尾的 Base URL;Claude Code 的 ANTHROPIC_BASE_URL 不带 /v1。
  • 认证信息:在控制台创建 API Key,并只在受控的服务端或工具配置中使用。
  • 模型 ID:使用控制台当前可用的模型 ID 替换示例中的 MODEL_ID。

连接参数

API Base URL
https://api-cn.rightmaas.com/v1
API Key
YOUR_API_KEY
模型
MODEL_ID

发送第一个请求

curl https://api-cn.rightmaas.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_ID",
    "messages": [{ "role": "user", "content": "Hello" }]
  }'
OpenAI Chat Completions

Cursor

通过 Cursor 的 Custom Model(OpenAI)配置接入。自定义模型入口是否可见取决于 Cursor 版本和套餐;若看不到相关设置或保存后提示套餐限制,请先核对 Cursor 账户权益。

Override OpenAI Base URL
https://api-cn.rightmaas.com/v1
OpenAI API Key
YOUR_API_KEY
模型
MODEL_ID

配置步骤

  1. 01

    确认自定义模型可用

    在 Cursor 中确认账户和当前版本允许使用 Custom Model;若 Models 页没有自定义模型入口或出现套餐错误,请先处理 Cursor 侧限制。

  2. 02

    添加 OpenAI 自定义模型

    打开 Settings → Models,选择 Add Custom Model,并选择 OpenAI 协议。

  3. 03

    填写密钥与 Override Base URL

    将控制台创建的密钥填入 OpenAI API Key;在 Override OpenAI Base URL 中粘贴本页地址(必须保留末尾 /v1)。不要在此处填写 Claude Code 的 Anthropic 地址。

  4. 04

    输入准确模型 ID

    在模型名称字段中粘贴模型广场或控制台显示的完整模型 ID,注意大小写、连字符和版本后缀必须完全一致。

  5. 05

    保存并验证

    保存 Provider,在 Cursor 聊天中选择该模型,发送一条不含敏感信息的简单请求确认返回正常。

Anthropic Messages

Claude Code

Claude Code 使用 Anthropic Messages 协议。请把本页展示的不带 /v1 的地址设置为 ANTHROPIC_BASE_URL;Claude Code 会在其后请求 /v1/messages。

ANTHROPIC_BASE_URL
https://api-cn.rightmaas.com
ANTHROPIC_AUTH_TOKEN
YOUR_API_KEY
模型
MODEL_ID

配置步骤

  1. 01

    安装或更新 Claude Code

    按 Claude Code 官方安装方式完成安装;配置前不要用默认登录流启动,以免混入其他账号凭据。

  2. 02

    打开 settings.json

    macOS/Linux 使用 ~/.claude/settings.json,Windows 使用用户目录下的 .claude/settings.json;文件不存在时新建。

  3. 03

    写入 env 配置

    在 settings.json 的 env 对象中设置 ANTHROPIC_AUTH_TOKEN、ANTHROPIC_BASE_URL 和三个默认模型变量。下方示例会自动带入当前访问站点的地址;不要自行补 /v1。

  4. 04

    映射可用模型

    将 ANTHROPIC_DEFAULT_OPUS_MODEL、ANTHROPIC_DEFAULT_SONNET_MODEL 和 ANTHROPIC_DEFAULT_HAIKU_MODEL 设置为控制台支持的精确模型 ID;可先使用同一个 MODEL_ID。

  5. 05

    重启终端并测试

    关闭当前终端后重新打开项目目录,执行 claude 并完成一次非敏感测试任务;如提示使用 API key,选择确认。

配置示例

{
  "env": {
    "ANTHROPIC_AUTH_TOKEN": "YOUR_API_KEY",
    "ANTHROPIC_BASE_URL": "https://api-cn.rightmaas.com",
    "ANTHROPIC_DEFAULT_OPUS_MODEL": "MODEL_ID",
    "ANTHROPIC_DEFAULT_SONNET_MODEL": "MODEL_ID",
    "ANTHROPIC_DEFAULT_HAIKU_MODEL": "MODEL_ID"
  }
}
OpenAI Responses

Codex

Codex 使用 OpenAI Responses 协议;对应入口是 /v1/responses,因此 provider 的 base_url 必须保留 /v1,且 wire_api 必须设置为 responses。

base_url
https://api-cn.rightmaas.com/v1
experimental_bearer_token
YOUR_API_KEY
模型
MODEL_ID

配置步骤

  1. 01

    安装或更新 Codex

    按 Codex 官方安装方式安装 CLI,并确认可在新的终端窗口执行 codex。

  2. 02

    打开配置文件

    macOS/Linux 使用 ~/.codex/config.toml,Windows 使用 C:\Users\<用户名>\.codex\config.toml;目录或文件不存在时新建。

  3. 03

    添加 MaaSLink Provider

    将下方 TOML 示例写入 config.toml,把 YOUR_API_KEY 和 MODEL_ID 分别替换为控制台创建的密钥和可用模型 ID。

  4. 04

    保留 Responses 协议和 /v1

    不要把 wire_api 改为 chat 或 completions;base_url 末尾的 /v1 对应 /v1/responses 路由。

  5. 05

    重启并验证

    关闭所有已打开的 Codex 进程,在新的项目终端执行 codex 并运行一个非敏感任务;认证或模型错误时先检查密钥、模型 ID 和 TOML 格式。

配置示例

model_provider = "maaslink"
model = "MODEL_ID"

[model_providers.maaslink]
name = "MaaSLink"
base_url = "https://api-cn.rightmaas.com/v1"
experimental_bearer_token = "YOUR_API_KEY"
wire_api = "responses"
OpenAI Chat Completions

OpenClaw

OpenClaw 通过 openai-completions provider 接入 OpenAI 兼容服务。教程选用 maaslink 作为自定义 provider ID,配置中的 provider key 与 agents.defaults.model.primary 前缀必须保持一致。

baseUrl
https://api-cn.rightmaas.com/v1
apiKey
YOUR_API_KEY
模型
MODEL_ID

配置步骤

  1. 01

    安装 OpenClaw

    在 macOS、Linux 或 WSL2 执行 curl -fsSL https://openclaw.ai/install.sh | bash,并按安装脚本提示完成安装。

  2. 02

    更新并确认版本

    运行 openclaw update 更新 CLI,再执行 openclaw --version 确认安装成功。

  3. 03

    编辑配置文件

    打开 ~/.openclaw/openclaw.json(文件不存在时新建),在 models.providers.maaslink 中填写本页的 /v1 地址、YOUR_API_KEY、模型 id 和 name。

  4. 04

    设置 provider 与默认模型

    使用 JSON5 示例中的 models.mode: merge、api: openai-completions,并将 agents.defaults.model.primary 设置为 maaslink/MODEL_ID。maaslink 是本教程选用的自定义 ID,不是官方保留名称;如果改名,provider key 与 primary 前缀必须同步。

  5. 05

    验证与排障

    运行 openclaw models list、openclaw models set maaslink/MODEL_ID、openclaw models status、openclaw doctor 和 openclaw gateway status,按输出检查模型、密钥和网关状态。API Key 可使用 YOUR_API_KEY 或官方支持的 ${VAR_NAME} / SecretRef 引用。

配置示例

{
  models: {
    mode: "merge",
    providers: {
      maaslink: {
        baseUrl: "https://api-cn.rightmaas.com/v1",
        apiKey: "YOUR_API_KEY",
        api: "openai-completions",
        models: [{ id: "MODEL_ID", name: "MODEL_NAME" }],
      },
    },
  },
  agents: {
    defaults: {
      model: { primary: "maaslink/MODEL_ID" },
    },
  },
}
OpenAI Chat Completions

Hermes Agent

Hermes Agent 使用 Custom endpoint 接入兼容 Chat Completions 的服务。推荐先运行 hermes model 完成 provider、认证和模型配置,再按需检查 ~/.hermes/config.yaml。

base_url
https://api-cn.rightmaas.com/v1
api_key
YOUR_API_KEY
模型
MODEL_ID

配置步骤

  1. 01

    安装 Hermes Agent

    在 macOS、Linux 或 WSL2 执行 curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash,完成后重新加载 shell。

  2. 02

    更新并验证环境

    运行 hermes update 更新 CLI,再执行 hermes doctor 检查依赖和环境。

  3. 03

    运行配置向导

    在普通终端执行 hermes model,选择 Custom endpoint,填写本页当前站点的 /v1 地址、YOUR_API_KEY 和可用的 MODEL_ID。hermes model 是完整的 provider/model 配置向导,可新增 provider、执行认证并保存全局默认值。

  4. 04

    理解会话切换

    活动聊天会话中的 /model <model> --provider <provider> 只切换已经配置的 provider/model;使用 /model <model> --provider <provider> --global 会同时切换当前会话并持久化到 ~/.hermes/config.yaml。/model 不能新增 provider、执行 OAuth 或提示录入 API Key,这些操作回到 hermes model。

  5. 05

    检查手工配置

    等价地编辑 ~/.hermes/config.yaml,将 model.default、provider: custom、base_url、api_key 和 api_mode: chat_completions 写入 model 节点;使用 hermes config get model --json、hermes status 和 hermes doctor 检查结果。API Key 可使用 YOUR_API_KEY 或 ${VAR_NAME} / ${env:VAR_NAME} 引用。

配置示例

model:
  default: MODEL_ID
  provider: custom
  base_url: https://api-cn.rightmaas.com/v1
  api_key: YOUR_API_KEY
  api_mode: chat_completions
03

常见问题

以下内容帮助您快速排查常见配置与账户问题。

如何获取 API Key?

登录控制台后,在密钥管理中创建 API Key。请只在受控环境中使用密钥,避免把密钥写入前端代码、公开仓库或截图。

API Base URL 应该填写哪个?

请使用本页展示的当前访问站点地址。OpenAI 兼容调用、Cursor、OpenClaw 和 Hermes Agent 使用以 /v1 结尾的地址;Codex 使用 OpenAI Responses,也必须保留 /v1;Claude Code 的 ANTHROPIC_BASE_URL 不带 /v1,由客户端拼接 /v1/messages。不要混用不同站点的账号、密钥和地址。

模型 ID 从哪里获取?

以当前站点模型广场或控制台展示的可用模型 ID 为准。模型供给可能变化,请不要把示例中的 MODEL_ID 直接用于生产。

请求如何认证?

在服务端请求中通过 Authorization: Bearer YOUR_API_KEY 传递 API Key。若工具使用自己的认证字段,请参照该工具官方文档映射配置。

渠道申请审核期间可以做什么?

审核期间可以查看申请状态并按要求补充材料。只有审核通过后,渠道账号才能进入客户关联、额度配置和用量查看等业务流程。

如何查看用量和费用?

请在控制台查看账户余额、调用用量和账单信息。渠道相关的额度和客户维度数据以审核通过后的渠道业务页面为准。