API 文档

快速开始

1

注册账号

访问 Dashboard 注册，充值后即可使用。

2

获取 API Key

在 Dashboard 点击「+ New Key」，复制 sk-cg-xxxx... 保存好（只显示一次）。

3

调用 API

用你的 Key 调用任意端点：

curl https://xiaoclaw.com/v1/chat/completions \
  -H "Authorization: Bearer sk-cg-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-4-5-20250929",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

支持的模型

厂商	模型 ID	说明
Anthropic	`claude-opus-4-6-20260205`	Claude Opus 4.6 — 最强推理
Anthropic	`claude-opus-4-5-20251101`	Claude Opus 4.5
Anthropic	`claude-sonnet-4-5-20250929`	Claude Sonnet 4.5 — 性价比之选
Anthropic	`claude-haiku-4-5-20251001`	Claude Haiku 4.5 — 快速轻量
OpenAI	`gpt-5.2`	GPT-5.2 — 旗舰推理
OpenAI	`gpt-5`	GPT-5 — 主力模型
OpenAI	`gpt-5.2-codex`	GPT-5.2 Codex — 代码专用
OpenAI	`gpt-4o`	GPT-4o — 多模态轻量
OpenAI	`gpt-4o-image`	GPT-4o Image — 图片理解
OpenAI	`gpt-image-1`	GPT Image — AI 生图
Google	`gemini-3-pro-preview`	Gemini 3 Pro — 最新旗舰
Google	`gemini-2.5-pro`	Gemini 2.5 Pro — 长上下文
Google	`gemini-3-flash-preview`	Gemini 3 Flash — 极速
Google	`gemini-2.5-flash`	Gemini 2.5 Flash — 超值
xAI	`grok-4`	Grok 4 — 实时信息
xAI	`grok-3`	Grok 3

完整列表请调用 GET /v1/models 获取。

POST /v1/chat/completions

OpenAI 兼容格式。适用于所有模型（Claude、GPT、Gemini、Grok）。

curl https://xiaoclaw.com/v1/chat/completions \
  -H "Authorization: Bearer sk-cg-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-4-5-20250929",
    "max_tokens": 1024,
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "用 Python 写一个快排"}
    ]
  }'

请求参数

参数	类型	必填	说明
model	string		模型 ID
messages	array		对话消息数组
max_tokens	integer	-	最大输出 token 数
temperature	number	-	采样温度 0-2
stream	boolean	-	是否流式输出

POST /v1/messages

Anthropic 原生格式。适用于 Claude 系列模型。

curl https://xiaoclaw.com/v1/messages \
  -H "x-api-key: sk-cg-YOUR_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-4-5-20250929",
    "max_tokens": 1024,
    "messages": [
      {"role": "user", "content": "解释量子计算"}
    ]
  }'

POST /v1/responses

Codex 格式（OpenAI Responses API）。

也支持 /codex/v1/responses 路径。

curl https://xiaoclaw.com/v1/responses \
  -H "Authorization: Bearer sk-cg-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.2-codex",
    "input": "Write a Python function to merge two sorted lists"
  }'

POST /v1beta/models/{model}:generateContent

Google Gemini SDK 兼容格式。直接用 Gemini SDK 或 curl 调用。

curl 示例

curl https://xiaoclaw.com/v1beta/models/gemini-2.5-pro:generateContent \
  -H "x-goog-api-key: sk-cg-YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contents": [{"parts": [{"text": "Hello"}]}]
  }'

Python (Google Gemini SDK)

from google import genai

client = genai.Client(
    api_key="sk-cg-YOUR_KEY",
    http_options={"api_version": "v1beta", "base_url": "https://xiaoclaw.com"}
)
response = client.models.generate_content(
    model="gemini-2.5-pro",
    contents="你好"
)
print(response.text)

🔗 LangChain 接入

支持 ChatOpenAI 和 ChatAnthropic 两种模式，改 base_url 即可接入 XiaoClaw。

ChatOpenAI 模式

from langchain_openai import ChatOpenAI

llm = ChatOpenAI(
    base_url="https://xiaoclaw.com/v1",
    api_key="sk-cg-YOUR_KEY",
    model="claude-sonnet-4-5-20250929"
)
response = llm.invoke("你好")
print(response.content)

ChatAnthropic 模式

from langchain_anthropic import ChatAnthropic

llm = ChatAnthropic(
    base_url="https://xiaoclaw.com",
    api_key="sk-cg-YOUR_KEY",
    model="claude-sonnet-4-5-20250929"
)
response = llm.invoke("你好")
print(response.content)

💡 安装依赖：pip install langchain-openai langchain-anthropic

GET /v1/models

获取当前可用的模型列表。

curl https://xiaoclaw.com/v1/models \
  -H "Authorization: Bearer sk-cg-YOUR_KEY"

认证方式

XiaoClaw 支持两种认证方式，任选其一：

方式一：Bearer Token（推荐）

适用于 OpenAI 兼容客户端（ChatGPT 插件、Cursor、Continue 等）

Authorization: Bearer sk-cg-YOUR_KEY

方式二：x-api-key Header

适用于 Anthropic 原生客户端（Claude Code 等）

x-api-key: sk-cg-YOUR_KEY

️ 错误码

HTTP 状态码	含义	处理建议
400	请求格式错误	检查 JSON 格式和必填参数
401	认证失败	检查 API Key 是否正确
402	余额不足	前往 Dashboard 充值
404	模型不存在	调用 /v1/models 查看可用模型
429	请求过于频繁	降低请求频率，稍后重试
500	服务器内部错误	稍后重试，如持续请联系支持
502/503	上游模型服务不可用	上游 API 暂时不可用，稍后重试

错误响应格式

{
  "error": {
    "message": "Insufficient credits",
    "type": "insufficient_credits",
    "code": 402
  }
}