常见场景导览

本页按“任务 → 直接可用示例”的方式，帮助你快速完成高频操作。

—

连接官方 SDK（OpenAI 兼容）

export OPENAI_API_KEY="sk-Xvs..."
export OPENAI_BASE_URL="https://api.xaixapi.com/v1"

Node.js：

import OpenAI from "openai";
const client = new OpenAI({ apiKey: process.env.OPENAI_API_KEY, baseURL: process.env.OPENAI_BASE_URL });
const chat = await client.chat.completions.create({
  model: "gpt-4o-mini",
  messages: [{ role: "user", content: "你好" }]
});

Python：

import os
from openai import OpenAI

client = OpenAI(api_key=os.getenv("OPENAI_API_KEY"), base_url=os.getenv("OPENAI_BASE_URL"))
resp = client.chat.completions.create(model="gpt-4o-mini", messages=[{"role":"user","content":"你好"}])

—

按模型路由到不同 Level（LEVEL_MAPPER）

目标：gpt-4* 用 Level 2，claude* 用 Level 3。

curl -X PUT https://api.xaixapi.com/x-config \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "LEVEL_MAPPER": "gpt-4*=2, claude*=3"
  }'

—

设置模型别名（MODEL_MAPPER）

目标：将历史中的 gpt-3.5* 透明映射到 gpt-4o-mini。

curl -X PUT https://api.xaixapi.com/x-config \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "MODEL_MAPPER": "gpt-3.5*=gpt-4o-mini"
  }'

—

限制昂贵模型的速率（MODEL_LIMITS）

curl -X PUT https://api.xaixapi.com/x-config \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "MODEL_LIMITS": "{\n  \"gpt-4o\": {\"rpm\": 30, \"tpm\": 90000}\n}"
  }'

—

添加 Provider 密钥并自动补全映射

curl -X POST https://api.xaixapi.com/x-keys \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "SecretKey": "sk-...",
    "Name": "OpenAI 主池",
    "Level": 1,
    "Provider": "https://api.openai.com",
    "Status": true
  }'

—

限制访问范围（AllowModels/AllowIPs/Resources）

curl -X PUT https://api.xaixapi.com/x-users/42 \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "AllowModels": "gpt-4* claude-3*",
    "AllowIPs": "192.168.1.0/24 10.0.0.5",
    "Resources": "/v1/chat/completions, /v1/embeddings"
  }'

—

查询 30 天用量/账单（/x-bill）

curl "https://api.xaixapi.com/x-bill?days=30" -H "Authorization: Bearer $API_KEY"

—

自助轮换密钥（/x-self）

curl -X POST https://api.xaixapi.com/x-self \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"confirm": "$(date +%F)-ROTATE-SELF"}'

—

发布系统/定向新闻（/x-news）

# 系统新闻（仅 root）
curl -X POST https://api.xaixapi.com/x-news \
  -H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" \
  -d '{"title":"更新","content":"...","days":7}'

# 指定用户
curl -X POST https://api.xaixapi.com/x-news/42 \
  -H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" \
  -d '{"title":"账户","content":"..."}'

—

导出休眠/禁用密钥与阈值（/x-conf）

curl https://api.xaixapi.com/x-conf -H "Authorization: Bearer $API_KEY" | jq .