深色模式
快速开始
欢迎使用 NexusKey!本指南将帮助你快速上手,从注册到发起第一个 API 请求,一步步引导你使用 NexusKey 的全部能力。
四步即可开始
- 登录 NexusKey:访问 NexusKey 控制台,使用邮箱注册并登录。
- 充值余额:NexusKey 采用按量付费(PAYG),在控制台「兑换」或「充值」页为账户余额到账(详见 计费与套餐)。
- 获取 API 密钥:在「API 密钥」页创建 Key 并分配分组(详见 API Key 管理)。
- 发起第一个请求:选择下面的接入方式,复制配置或代码示例,替换你的 API Key 即可运行。
选择接入方式
NexusKey 提供两种接入方式,适配不同的使用场景:
方式一:代码接入(API 直连)
适用场景:生产环境、自研应用与服务、Agent 框架
- 与 OpenAI / Anthropic 官方 SDK 完全兼容,只需修改
base_url与api_key两个参数即可无缝切换; - 按 Token 精确计费,成本透明可控(详见 计费与套餐);
- 示例代码见本页 支持的 API 协议,完整参数说明见 API 参考。
方式二:工具接入(现有 AI 工具)
适用场景:Claude Code、Cursor、Cline、Cherry Studio 等 AI 编程与对话工具的日常使用
- 在控制台「API 密钥 → 使用密钥」中按客户端获取环境变量或配置文件片段,复制即用;
- 各工具的详细配置见 工具接入。
两种方式对比
| 对比维度 | 代码接入 | 工具接入 |
|---|---|---|
| 适用场景 | 自研应用 / 服务 / Agent 框架 | 现有 AI 编程与对话工具 |
| 配置入口 | SDK 的 base_url + api_key | 控制台「使用密钥」配置片段 |
| 参考文档 | API 参考 | 工具接入 |
支持的 API 协议
NexusKey 采用各官方 SDK 的原生路径拼接规则,改 base_url 与 api_key 两个参数即可无缝切换:
| 协议 | Base URL | 兼容 SDK | 端点 |
|---|---|---|---|
| OpenAI Chat Completions | https://api.nexuskey.cn/v1 | OpenAI SDK | /chat/completions、/models、/embeddings、/images/* |
| OpenAI Responses | https://api.nexuskey.cn/v1 | OpenAI SDK | /responses |
| Anthropic Messages | https://api.nexuskey.cn | Anthropic SDK | /v1/messages、/v1/messages/count_tokens(SDK 自拼 /v1) |
| Google Gemini | — | — | 暂不开通 |
认证头
OpenAI 协议使用 Authorization: Bearer sk-…;Anthropic 协议同时接受 x-api-key: sk-…(附 anthropic-version: 2023-06-01)与 Bearer 头。
跨协议调用
NexusKey 的核心优势之一是协议无关性——你可以通过任意支持的协议调用任意模型。例如,用 OpenAI SDK 调用 Claude 模型,或用 Anthropic SDK 调用 OpenAI 系模型;详见 跨协议调用。
协议一:OpenAI Chat Completions
兼容性说明
NexusKey 的 API 端点与 OpenAI Chat Completions API 完全兼容,只需修改 base_url 和 api_key 两个参数即可无缝切换。
python
from openai import OpenAI
# 1. 初始化 OpenAI 客户端
client = OpenAI(
# 2. 将基础 URL 指向 NexusKey 端点
base_url="https://api.nexuskey.cn/v1",
# 3. 替换为你从 NexusKey 获取的 API Key
api_key="<你的 NEXUSKEY_API_KEY>",
)
# 4. 发起 Chat Completion 请求
completion = client.chat.completions.create(
model="claude-sonnet-4-5",
messages=[{"role": "user", "content": "生命的意义是什么?"}],
)
print(completion.choices[0].message.content)typescript
import OpenAI from "openai";
// 1. 初始化 OpenAI 客户端
const openai = new OpenAI({
// 2. 将基础 URL 指向 NexusKey 端点
baseURL: "https://api.nexuskey.cn/v1",
// 3. 替换为你从 NexusKey 获取的 API Key
apiKey: "<你的 NEXUSKEY_API_KEY>",
});
async function main() {
// 4. 发起 Chat Completion 请求
const completion = await openai.chat.completions.create({
model: "claude-sonnet-4-5",
messages: [{ role: "user", content: "生命的意义是什么?" }],
});
console.log(completion.choices[0].message.content);
}
main();bash
curl https://api.nexuskey.cn/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $NEXUSKEY_API_KEY" \
-d '{
"model": "claude-sonnet-4-5",
"messages": [{"role": "user", "content": "生命的意义是什么?"}]
}'协议二:OpenAI Responses
兼容性说明
NexusKey 同样兼容 OpenAI 新一代 Responses API。Base URL 与 Chat Completions 相同,调用方式更加简洁。
python
from openai import OpenAI
client = OpenAI(
base_url="https://api.nexuskey.cn/v1",
api_key="<你的 NEXUSKEY_API_KEY>",
)
# 使用 Responses API 发起请求
response = client.responses.create(
model="gpt-5",
input="生命的意义是什么?",
)
print(response.output_text)typescript
import OpenAI from "openai";
const openai = new OpenAI({
baseURL: "https://api.nexuskey.cn/v1",
apiKey: "<你的 NEXUSKEY_API_KEY>",
});
async function main() {
const response = await openai.responses.create({
model: "gpt-5",
input: "生命的意义是什么?",
});
console.log(response.output_text);
}
main();bash
curl https://api.nexuskey.cn/v1/responses \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $NEXUSKEY_API_KEY" \
-d '{
"model": "gpt-5",
"input": "生命的意义是什么?"
}'协议三:Anthropic Messages
Base URL 不同
Anthropic 协议的 base_url 填到域名为止(https://api.nexuskey.cn),SDK 会自动拼接 /v1/messages。
兼容性说明
NexusKey 完全支持 Anthropic Messages 协议,可以无缝集成到 Claude Code、Cursor 等工具中。
python
from anthropic import Anthropic
# 1. 初始化 Anthropic 客户端
client = Anthropic(
# 2. 将基础 URL 指向 NexusKey 端点(到域名为止)
base_url="https://api.nexuskey.cn",
# 3. 替换为你从 NexusKey 获取的 API Key
api_key="<你的 NEXUSKEY_API_KEY>",
)
# 4. 发起 Messages 请求
message = client.messages.create(
model="claude-sonnet-4-5",
max_tokens=1024,
messages=[{"role": "user", "content": "生命的意义是什么?"}],
)
print(message.content[0].text)typescript
import Anthropic from "@anthropic-ai/sdk";
// 1. 初始化 Anthropic 客户端
const client = new Anthropic({
// 2. 将基础 URL 指向 NexusKey 端点(到域名为止)
baseURL: "https://api.nexuskey.cn",
// 3. 替换为你从 NexusKey 获取的 API Key
apiKey: "<你的 NEXUSKEY_API_KEY>",
});
async function main() {
// 4. 发起 Messages 请求
const message = await client.messages.create({
model: "claude-sonnet-4-5",
max_tokens: 1024,
messages: [{ role: "user", content: "生命的意义是什么?" }],
});
console.log(message.content[0].text);
}
main();bash
curl https://api.nexuskey.cn/v1/messages \
-H "content-type: application/json" \
-H "x-api-key: $NEXUSKEY_API_KEY" \
-H "anthropic-version: 2023-06-01" \
-d '{
"model": "claude-sonnet-4-5",
"max_tokens": 1024,
"messages": [{"role": "user", "content": "生命的意义是什么?"}]
}'Platform API
NexusKey 提供一组只读 Platform API,让你能够通过编程方式查询生效费率与用量信息,方便集成到你的监控和对账系统中。只需鉴权,不消耗余额。
查询生效费率
返回当前 Key 生效的费率倍率与峰时配置,用于成本预测:
bash
curl https://api.nexuskey.cn/v1/platform/billing \
-H "Authorization: Bearer $NEXUSKEY_API_KEY"查询用量摘要
返回 Key 级用量摘要(今日/累计、每日序列、模型统计):
bash
curl "https://api.nexuskey.cn/v1/usage?days=7" \
-H "Authorization: Bearer $NEXUSKEY_API_KEY"完整文档
字段说明与响应示例请参考 计费与用量查询。
模型 Slug 说明
NexusKey 透传上游模型原名(claude-*、gpt-* 等),不做别名映射。你的 Key 可用模型为其绑定分组的模型并集,可通过 GET /v1/models 查询,或在控制台「API 密钥 → 使用配置」中查看。