接入文档 / 开始

快速开始

1. 注册并创建密钥

注册账号后进入控制台「API 密钥」，新建一个密钥。建议每个项目或每台设备单独一把，可以分别设置额度、过期时间和可用模型，出问题时只停用这一把。

2. 充值

在「钱包」页充值，按 ¥1.00 / 美元换算；余额长期有效。想要固定价格的周期额度，可以看看「套餐」。

3. 接入客户端

两种协议共用同一把 sk- 密钥：

协议: OpenAI 兼容
Base URL: https://api.compassapi.ai/v1
适用客户端: OpenAI SDK、Codex CLI、Cursor、Cherry Studio

协议: Anthropic Messages
Base URL: https://api.compassapi.ai
适用客户端: Claude Code、Anthropic SDK（仅 Claude 模型）

协议	Base URL	适用客户端
OpenAI 兼容	https://api.compassapi.ai/v1	OpenAI SDK、Codex CLI、Cursor、Cherry Studio
Anthropic Messages	https://api.compassapi.ai	Claude Code、Anthropic SDK（仅 Claude 模型）

按你用的工具选择对应页面：

4. 发出第一个请求

curl https://api.compassapi.ai/v1/chat/completions \
  -H "Authorization: Bearer $COMPASS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "claude-sonnet-5-5",
       "messages": [{"role": "user", "content": "你好"}]}'

返回正常内容后，到控制台「用量」可以看到这次调用的明细。