接入文档

端点与 Base URL

区分根地址、SDK 地址和完整端点。

地址速查

用途地址
Claude Code / Anthropic SDK 根地址https://api.neatrouter.com
OpenAI SDK / OpenAI 兼容客户端https://api.neatrouter.com/v1
Messages 完整端点https://api.neatrouter.com/v1/messages
Chat Completions 完整端点https://api.neatrouter.com/v1/chat/completions
模型列表https://api.neatrouter.com/v1/models
Responses / Codexhttps://api.neatrouter.com/v1/responses
Key 余额与已用额度https://api.neatrouter.com/v1/balance
当前 Key 的最近用量https://api.neatrouter.com/v1/usage

Base URL 使用上表的根地址或 SDK 地址,不包含完整接口路径;不要重复拼接 /v1。Responses 使用 GPT 模型;Messages 使用 Claude 模型。

模型目录

用当前 Key 查询实际允许调用的模型 ID,价格以模型价格页为准。Claude 示例可使用 claude-sonnet-5-5,GPT 示例可使用 gpt-6.1-sol。显示名称与请求里的模型 ID 分别展示,复制 ID 后使用。

bash
curl --fail-with-body "https://api.neatrouter.com/v1/models" \
  -H "Authorization: Bearer $RELAY_API_KEY"

Responses

bash
curl --fail-with-body "https://api.neatrouter.com/v1/responses" \
  -H "Authorization: Bearer $RELAY_API_KEY" \
  -H 'content-type: application/json' \
  -d '{"model":"gpt-6.1-sol","input":"Hello","max_output_tokens":128}'

余额与用量

这两个只读接口均使用 Authorization: Bearer <API_KEY>。金额以 USD 十进制字符串返回,避免金额精度丢失;不消耗模型 Token。余额、已用额度与过期时间属于当前 Key,不接受请求参数切换到别的账号或 Key。

bash
curl --fail-with-body "https://api.neatrouter.com/v1/balance" \
  -H "Authorization: Bearer $RELAY_API_KEY"

key.remaining 是 Key 剩余额度,key.used 是 Key 累计用量金额。无限额度 Key 的 remaining 和 limit 为 null,不代表账号余额无限。只有对该 Key 开启“允许查询用户额度”时才返回 account 余额;请求仍受账号实际余额限制。expires_at=0 表示未设置到期时间。

bash
curl --fail-with-body "https://api.neatrouter.com/v1/usage" \
  -H "Authorization: Bearer $RELAY_API_KEY"

data 按时间从新到旧返回当前 Key 的最近记录,limit 表示服务端上限;不提供分页。每条记录包含本平台 request id、模型、输入/输出 Token、实际金额 cost、流式标记与耗时。完整历史及筛选导出在控制台“调用日志”中查看。

按当前定价策略结算的记录另含 pricing:list_price_cost 为正式标价金额,savings 为本次优惠金额,price_version 为请求采用的费率版本。cost 始终为实际扣款,金额均为 USD 字符串。新客与用量优惠择优使用、不叠加;资格、有效期及剩余额度在控制台钱包中查看,详见计费说明。

余额耗尽或到期的 Key 仍可查询自己的余额和用量;禁用的 Key、封禁账号及不符合 IP 白名单的请求会被拒绝。响应使用 Cache-Control: no-store,不要把带 Key 的请求放入公共缓存。

认证

OpenAI 兼容请求使用 Authorization: Bearer <API_KEY>。Messages 支持 x-api-key,并需设置 anthropic-version: 2023-06-01。JSON 请求使用 content-type: application/json。请求必须使用本平台创建的完整 Key。

模型与流式

model 必须是账号有权限的准确模型 ID。不要使用显示名称代替 ID。协议与能力以模型实际支持情况为准。

流式请求设置 stream: true,按 SSE 事件读取,保留取消机制。客户端已收到内容后,不自动重发整次请求,以免重复输出和额外用量。

本地 request id

发生问题时保留本地 request id、时间与模型,便于客服查找。不要发送完整 Key 或敏感提示词。参见错误码。

仍有问题?

支持信息暂未公布

本页目录