開發者文件與兼容性

面向 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 中撤銷並重新生成。