文档目录
本页目录

集成

编码 Agent 配置

选择要使用的 Agent,按对应章节填写 KHaiXAPI 的 Base URL、API Key 和模型。配置完成后,用文字请求、流式输出和一次只读工具调用检查连接。

先选择协议

Agent推荐协议Base URL
Codex、OpenCode、Kilo、OpenClaw、PiOpenAI Responseshttps://api.khaix.net/v1
Hermes AgentResponses 或 Chat Completions,二选一https://api.khaix.net/v1
Cline、AiderOpenAI Chat Completionshttps://api.khaix.net/v1

表中给出的是 Base URL。客户端会自行拼接 /responses/chat/completions;字段名为 Base URL 时,地址填到 /v1 即可。

Codex

Codex CLI、IDE 插件和 App 都读取当前用户的 .codex 配置。Windows 路径为 %USERPROFILE%\.codex\;macOS、Linux、WSL 和 SSH 环境使用 ~/.codex/

config.toml 中加入以下字段:

~/.codex/config.toml
model = "gpt-5.6-sol"
model_provider = "openai"
openai_base_url = "https://api.khaix.net/v1"

再通过 Codex 登录命令写入密钥:

Terminal
export KHAIX_API_KEY="sk-请替换为你的密钥"
printenv KHAIX_API_KEY | codex login --with-api-key
codex login status

重启 Codex 后,用 /status 检查当前模型。审批策略、沙箱、Web Search 和命令联网权限可在 API 接通后分别设置。

OpenCode

编辑 ~/.config/opencode/opencode.json,通过 @ai-sdk/openai Responses provider 接入。已有配置时,把下面的 provider 合并进去,保留原有字段。

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "model": "api/gpt-5.6-sol",
  "provider": {
    "api": {
      "npm": "@ai-sdk/openai",
      "name": "KHaiXAPI",
      "options": {
        "baseURL": "https://api.khaix.net/v1"
      },
      "models": {
        "gpt-5.6-sol": {
          "name": "GPT-5.6 Sol",
          "reasoning": true,
          "options": {
            "store": false,
            "reasoningEffort": "high",
            "reasoningSummary": "auto"
          }
        }
      }
    }
  }
}
Terminal
opencode auth login
opencode auth list

认证时选择配置中的 api provider。进入 OpenCode 后可用 /models 检查模型;需要移除旧认证时,运行 opencode auth logout 并按提示选择 provider。

Hermes Agent

Hermes Agent 支持 Responses 和 Chat Completions 两种模式。先用 Responses;如果工具调用出现协议兼容问题,再切换到 Chat Completions 单独测试。

Responses 模式

~/.hermes/config.yaml
custom_providers:
  - name: khaix-responses
    base_url: https://api.khaix.net/v1
    key_env: KHAIX_API_KEY
    api_mode: codex_responses

model:
  provider: custom:khaix-responses
  default: gpt-5.6-sol

Chat Completions 模式

~/.hermes/config.yaml
custom_providers:
  - name: khaix-chat
    base_url: https://api.khaix.net/v1
    key_env: KHAIX_API_KEY
    api_mode: chat_completions

model:
  provider: custom:khaix-chat
  default: gpt-5.6-sol

KHAIX_API_KEY=sk-请替换为你的密钥 写入 ~/.hermes/.env。Responses 会请求 /v1/responses,Chat 模式会请求 /v1/chat/completions。如果模型没有自动出现,保留配置中的手工模型 ID 并直接测试对话。

Cline

Cline 通过 OpenAI Compatible 的 Chat Completions 路径接入:

  1. 打开 Cline 设置,将 API Provider 选为 OpenAI Compatible
  2. Base URL 填写 https://api.khaix.net/v1
  3. 填写 API Key,Model ID 填写 gpt-5.6-sol
  4. 高级模型参数保持默认,然后执行 Verify。
  5. 连接通过后测试文字任务和一次只读工具调用。

Base URL 填到 /v1 即可,Cline 会自动拼接 /chat/completions

Kilo Code

以下配置适用于当前 Kilo Code VS Code 版和 CLI。JetBrains 版的 provider 能力与界面不同,本节字段不适用。

  1. 打开 Settings → Providers,选择 Custom provider
  2. Provider ID 填写 khaix,Display name 填写 KHaiXAPI
  3. Provider API 选择 OpenAI Responses
  4. Base URL 填写 https://api.khaix.net/v1
  5. 填写 API Key,Model 填写 gpt-5.6-sol
  6. 保存后发送一条短文字任务;模型没有自动出现时,手工添加模型 ID。

OpenClaw

按照 OpenClaw 自定义 provider 格式编辑 ~/.openclaw/openclaw.json。下面只启用文字输入,密钥从环境变量读取。

openclaw.json
{
  "models": {
    "providers": {
      "api": {
        "baseUrl": "https://api.khaix.net/v1",
        "apiKey": "${KHAIX_API_KEY}",
        "auth": "api-key",
        "api": "openai-responses",
        "authHeader": true,
        "models": [
          {
            "id": "gpt-5.6-sol",
            "name": "GPT-5.6 Sol",
            "reasoning": true,
            "input": ["text"]
          }
        ]
      }
    }
  },
  "agents": {
    "defaults": {
      "model": {
        "primary": "api/gpt-5.6-sol"
      }
    }
  }
}

启动前设置 KHAIX_API_KEY,也可以改用 OpenClaw SecretRef。保存后重启 gateway 或主进程,再测试文字输出和工具调用。

Pi 与 Aider

Pi Agent

编辑 ~/.pi/agent/models.json。下面使用 Responses;如需 Chat Completions,将 api 改为 openai-completions

models.json
{
  "providers": {
    "khaix": {
      "baseUrl": "https://api.khaix.net/v1",
      "api": "openai-responses",
      "apiKey": "$KHAIX_API_KEY",
      "models": [
        {
          "id": "gpt-5.6-sol",
          "reasoning": true
        }
      ]
    }
  }
}

Aider

Terminal
export OPENAI_API_BASE="https://api.khaix.net/v1"
export OPENAI_API_KEY="sk-请替换为你的密钥"
aider --model openai/gpt-5.6-sol

验证与权限

  1. 文字:要求 Agent 回复固定短语,核对模型、状态码和控制台记录。
  2. 流式:发送一条较长的纯文字任务,检查是否中途断开或重复输出。
  3. 工具:只允许读取当前目录中的一个无敏感文件,检查工具参数、结果回传和下一轮模型请求。
  4. 错误:填写一个不存在的模型,确认客户端会显示错误,而非切换到其他 provider。

认证、URL、状态码或断流问题可按排错与安全中的“先 cURL、后客户端”顺序检查。