AOK API · AI Coding Guide

Quick Start

30 秒极速上手

先装客户端，再选一套配置方式。大多数用户只要把地址和 API Key 填对，就可以直接跑起来。管理员侧需要先在 AOK API 后台准备可用渠道和令牌。

Claude Code

安装 Claude Code

Claude 官方终端编码工具。建议先确认 Git、Node.js 可用，再执行安装。

bash

npm install -g @anthropic-ai/claude-code

Codex CLI

安装 Codex CLI

OpenAI 的终端编码工具，适合复杂编程和高推理任务。

bash

npm install -g @openai/codex

OpenClaw

安装 OpenClaw

把模型能力接到飞书、Telegram、Discord 或多终端工作流时更方便。

bash

npm install -g openclaw@latest

Headers

外接场景必看：User-Agent

当你不是用官方客户端直连，而是通过 OpenClaw、第三方网关或自定义外壳转发请求时，建议补齐对应的 User-Agent，以免被外接策略或风控规则拦截。

Claude 外接

Claude Code / Anthropic Messages

通过外部壳、网关或自定义桥接转发 Anthropic Messages 请求时，建议带上 Claude CLI 风格 UA。

json

{
  "headers": {
    "Authorization": "Bearer sk-你的API密钥",
    "User-Agent": "claude-cli/2.0.76 (external, cli)"
  }
}

Codex 外接

Codex / OpenAI Responses

通过外部客户端调用 Responses 接口时，建议补齐 Codex CLI 风格 UA。

json

{
  "headers": {
    "Authorization": "Bearer sk-你的API密钥",
    "User-Agent": "codex_cli_rs/0.77.0 (Windows 10.0.26100; x86_64) WindowsTerminal"
  }
}

AOK API 后台

管理员应先完成的准备

普通调用方只需要 Key 和地址。管理员则应先在后台准备上游渠道，再创建供客户端使用的令牌。

links

控制台: https://aokapi.com/console
令牌管理: https://aokapi.com/console/token
渠道管理: https://aokapi.com/console/channel
使用日志: https://aokapi.com/console/log

Guides

详细配置指南

按实际要用的客户端看对应一节。每一节都给了最常见、最直接能跑起来的配置方式，并统一替换为 aokapi.com 的接入地址。

Anthropic Workflow

Claude Code 配置

官方文档

如果你主要在终端里做需求拆解、读代码、改代码、跑命令，Claude Code 仍然是最稳的一条线。对 AOK API 来说，关键是把 Base URL 指向站点根路径，而不是 /v1。

支持超长上下文适合 MCP / Hooks Base URL 不带 /v1

Step 1

环境准备

Claude Code 对本地命令环境有依赖，至少先确认 Git 和 Node 已经装好。

先安装 Git，再安装 Node.js LTS。
确保 git --version、node -v、npm -v 都能正常输出。
建议提前配置全局 Git 用户名和邮箱。

环境检查

git --version
node -v
npm -v

Step 2

接入 AOK API

最简单是通过环境变量或本地设置文件写入 AOK API 地址和令牌。

Claude 这一类接口使用站点根路径：https://aokapi.com。
不要给 Claude 再额外拼 /v1。
使用 AOK API 在令牌管理页面生成的 Key。

~/.claude/settings.json

{
  "env": {
    "ANTHROPIC_BASE_URL": "https://aokapi.com",
    "ANTHROPIC_API_KEY": "sk-你的API密钥"
  }
}

macOS / Linux 环境变量

echo 'export ANTHROPIC_BASE_URL="https://aokapi.com"' >> ~/.zshrc
echo 'export ANTHROPIC_API_KEY="sk-你的API密钥"' >> ~/.zshrc
source ~/.zshrc

Step 3

首次启动

装好后直接启动，平时最常用的是模型切换、成本查看和上下文压缩。

常用命令

claude
/model sonnet
/cost
/compact

OpenAI Workflow

Codex CLI 配置

官方文档

Codex CLI 对复杂推理和深度编码任务更直接。对 AOK API 来说，最容易错的一件事是：OpenAI 风格接口必须走带 /v1 的地址。

Responses 协议可调推理深度 Base URL 需要 /v1

Step 1

安装

安装完成后先用 codex --version 验证命令是否可用。

安装命令

npm install -g @openai/codex
codex --version

Step 2

配置 API 地址

Codex 和 Claude 最大的区别，就是 OpenAI 风格接口一定要带 /v1。

~/.codex/config.toml

model_provider = "aokapi"
model = "gpt-5.3-codex"
model_reasoning_effort = "high"
disable_response_storage = true

[model_providers.aokapi]
name = "aokapi"
base_url = "https://aokapi.com/v1"
wire_api = "responses"
requires_openai_auth = true

~/.codex/auth.json

{
  "OPENAI_API_KEY": "sk-你的API密钥"
}

Step 3

基础使用

Codex 的核心差异化能力是推理深度，你可以按任务复杂度切换。

常用启动方式

codex --reasoning-effort low
codex --reasoning-effort medium
codex --reasoning-effort high
codex --model gpt-5.3-codex

Gateway / Channel Workflow

OpenClaw 配置

官方文档

OpenClaw 更像一个 AI Coding 渠道网关。它不是单纯本地 CLI，而是把 Claude / Codex 的能力映射到飞书、TG、Discord 等消息端。

适合通知 / 渠道接入常见于飞书 / TG 外接时需补 UA

Step 1

初始化 OpenClaw

新手阶段先把本地服务和配置文件跑起来，不必一开始就把所有渠道都接好。

初始化

openclaw onboard --install-daemon
openclaw gateway

Step 2

配置模型提供方

如果你要把 AOK API 接进 OpenClaw，最省心的做法是分别按 Claude / Codex 两种协议配置 provider。

Claude provider 示例

{
  "api": "anthropic-messages",
  "apiKey": "sk-你的API密钥",
  "baseUrl": "https://aokapi.com",
  "headers": {
    "Authorization": "Bearer sk-你的API密钥",
    "User-Agent": "claude-cli/2.0.76 (external, cli)"
  }
}

Codex provider 示例

{
  "api": "openai-responses",
  "apiKey": "sk-你的API密钥",
  "baseUrl": "https://aokapi.com/v1",
  "headers": {
    "Authorization": "Bearer sk-你的API密钥",
    "User-Agent": "codex_cli_rs/0.77.0 (Windows 10.0.26100; x86_64) WindowsTerminal"
  }
}

Step 3

通知渠道和 Pairing

飞书、TG、Discord 都能接。先把渠道 token 配好，再做 pairing。

飞书 approve 示例

openclaw pairing approve feishu 你的配对码

Local Agent Workflow

Hermes 配置

官方文档

Hermes 更偏向本地 Agent 和编辑器协同。接 AOK API 时按 OpenAI 兼容自定义端点配置最稳，Base URL 直接写带 /v1 的地址。

适合本地 Agent Custom endpoint Base URL 需要 /v1

Step 1

选择自定义端点

交互式配置

hermes model
# Select: Custom endpoint (self-hosted / VLLM / etc.)
# Base URL: https://aokapi.com/v1
# API Key: sk-你的API密钥
# Model: your-model-id

Step 2

手动写配置

~/.hermes/config.yaml

model:
  provider: custom
  default: your-model-id
  base_url: https://aokapi.com/v1
  api_key: sk-你的API密钥

Step 3

验证是否接通

简单测试

hermes chat --message "hello"

Desktop App Workflow

Cherry Studio 配置

官方文档

Cherry Studio 适合桌面多模型切换、对话调试和轻量工作流。这里最重要的是 API 地址只填根地址，不要把完整请求路径整段填进去。

桌面多模型 OpenAI 类型服务商 API 地址填根路径

Step 1

新增服务商

打开设置，进入模型服务商。
新增一个 OpenAI 类型提供方。
Provider Name 可以写 AOK API。

Step 2

填写地址和密钥

填写示例

Provider Type: OpenAI
API Key: sk-你的API密钥
API Address: https://aokapi.com

Step 3

添加模型并启用

常见排查

1. 模型列表为空：先同步或手动添加模型
2. Check 失败：确认地址只填了根路径
3. 看不到服务商模型：确认服务商已开启

Desktop / Multi-platform

Chatbox 配置

官方文档

Chatbox 适合轻量桌面聊天、多端同步和快速切模型。接 AOK API 时走 OpenAI API compatible 最稳，API Host 填根地址，默认 API Path 一般保持不动。

多平台客户端 OpenAI API compatible API Host 填根路径

Step 1

新增模型提供方

进入 Model Provider。
点击 Add。
Provider Type 选择 OpenAI API compatible。

Step 2

填写 API Host

填写示例

Provider Type: OpenAI API compatible
API Key: sk-你的API密钥
API Host: https://aokapi.com
API Path: /v1/chat/completions

Step 3

添加模型并检查

常见问题

1. 连接失败：先确认 API Host 没填成 https://aokapi.com/v1
2. 模型不可用：确认该模型已对当前分组开放
3. 已保存但首页没出现：回主页新建一个会话再选模型

Ecosystem

常见问题

下面这些问题，是接入 AOK API 时最容易遇到的几类。

为什么外接之后返回 403 或 Connection blocked？

先检查是不是通过第三方壳、OpenClaw 或自定义桥接转发。如果是，优先补齐对应的 User-Agent。其次确认你用的是 AOK API 令牌，而不是其他站点或上游厂商的原生 Key。

Claude Code 和 Codex 的 Base URL 为什么不一样？

Claude / Anthropic 风格接口使用站点根路径：https://aokapi.com。OpenAI 兼容接口使用带 /v1 的地址：https://aokapi.com/v1。这不是同一个接口路径体系。

改完配置为什么不生效？

常见原因有三类：一是环境变量未重新加载；二是客户端本身有缓存，需要重启；三是后台渠道没有准备好。建议到 https://aokapi.com/console/log 看有没有真实请求打进来。

Cherry Studio 和 Chatbox 为什么不是统一填 /v1？

因为这类桌面客户端通常会自己补默认请求路径。它们有时只需要根地址，有时会单独提供 API Path 字段。关键不是机械地统一，而是按客户端字段设计填写，避免把路径重复拼接。

应该优先用环境变量、配置文件还是 CC Switch？

如果你只想尽快用起来，优先用图形化工具。需要版本化、可审计、可复制的开发环境时，再写配置文件。环境变量适合简单直连，但长期维护时容易和其他配置来源混用。

AI Coding文档中心

30 秒极速上手

安装 Claude Code

安装 Codex CLI

安装 OpenClaw

外接场景必看：User-Agent

Claude Code / Anthropic Messages

Codex / OpenAI Responses

管理员应先完成的准备

详细配置指南

Claude Code 配置

环境准备

接入 AOK API

首次启动

Codex CLI 配置

安装

配置 API 地址

基础使用

OpenClaw 配置

初始化 OpenClaw

配置模型提供方

通知渠道和 Pairing

Hermes 配置

选择自定义端点

手动写配置

验证是否接通

Cherry Studio 配置

新增服务商

填写地址和密钥

添加模型并启用

Chatbox 配置

新增模型提供方

填写 API Host

添加模型并检查

推荐工具

CC Switch

ZCF

MICUCODELINE

AI Session Viewer

常见问题