开发者文档与兼容性

面向 OpenAI、Claude、CLI 和 SSE 流式请求的端点兼容说明。

兼容性

兼容性

Nodex AI 的 relay 层兼容主流模型 API,同时保留统一鉴权、幂等和计费元数据。

示例
base_url=https://api.nodex-ai.net/v1
auth=Bearer $NODEX_API_KEY
streaming=SSE
idempotency=required

认证与 Headers

所有 API 请求都必须在 Authorization HTTP header 中包含 Bearer token。浏览器端不要存储 runtime API key。

示例
curl https://api.nodex-ai.net/v1/models \
  -H "Authorization: Bearer $NODEX_API_KEY"

OpenAI API 兼容

将 OpenAI SDK 的 base URL 指向 Nodex,即可继续使用 chat/completions 请求格式。

示例
POST https://api.nodex-ai.net/v1/chat/completions
Authorization: Bearer $NODEX_API_KEY

{
  "model": "gpt-5.4",
  "messages": [{"role": "user", "content": "Explain routing."}]
}

Claude API 兼容

Claude Messages API 会在 relay 边界完成规范转换,同时保留请求级计费元数据。

示例
POST https://api.nodex-ai.net/v1/messages
x-api-key: $NODEX_API_KEY
anthropic-version: 2023-06-01

{
  "model": "claude-sonnet-4.5",
  "max_tokens": 1024,
  "messages": [{"role": "user", "content": "Hello"}]
}

CLI Provider

CLI Provider 共享同一账号与额度,适合 Codex、Claude Code 与本地脚本工作流。

示例
nodex login
nodex use gpt-5.4
nodex env export

SSE 流式响应

SSE 流式响应支持中断恢复,客户端可使用 Last-Event-ID 继续读取。

示例
Last-Event-ID: evt_01HY...
X-Idempotency-Key: req_...

参数映射

参数必填说明
Authorization你的 secret API key。不要提交到公开仓库或客户端代码。
X-Idempotency-Key付费请求必须提供,避免重试造成重复扣费。
Last-Event-ID用于流式请求断点续传。
安全提醒

API keys 权限较高。如果怀疑泄露,请立即在 Console 中撤销并重新生成。