跳到主要内容

配置 API

GET /api/config​

获取当前服务器配置。

请求示例​

curl http://localhost:3456/api/config \
-H "x-api-key: your-api-key"

响应示例​

{
"HOST": "0.0.0.0",
"PORT": 3456,
"APIKEY": "sk-xxxxx",
"Providers": [
{
"name": "openai",
"baseUrl": "https://api.openai.com/v1",
"apiKey": "sk-...",
"models": ["gpt-4", "gpt-3.5-turbo"]
}
],
"Router": {
"default": "openai,gpt-4"
},
"transformers": [
"anthropic"
]
}

POST /api/config​

更新服务器配置。更新后会自动备份旧配置。

请求示例​

curl -X POST http://localhost:3456/api/config \
-H "x-api-key: your-api-key" \
-H "content-type: application/json" \
-d '{
"HOST": "0.0.0.0",
"PORT": 3456,
"Providers": [
{
"name": "openai",
"baseUrl": "https://api.openai.com/v1",
"apiKey": "$OPENAI_API_KEY",
"models": ["gpt-4"]
}
],
"Router": {
"default": "openai,gpt-4"
}
}'

配置对象结构​

基础配置​

字段类型必需说明
HOSTstring否监听地址(默认 127.0.0.1)
PORTinteger否监听端口(默认 3456)
APIKEYstring否API 密钥
LOGboolean否是否启用日志(默认 true)
LOG_LEVELstring否日志级别(debug/info/warn/error)
REASONING_AUTO_SUMMARYboolean | string否为 true(或 "auto" / "detailed" / "concise")时,在客户端开启 reasoning effort 但未带 reasoning.summary 时自动注入。对所有客户端协议与目标提供商生效。可用 Providers[].reasoningSummary 按提供商覆盖;客户端显式 reasoning.summary(含 "none")优先。Codex 提供商还会据此推出 text.verbosity(detailed → high、auto → medium、concise → low),除非客户端或 Providers[].verbosity 已设置。
WEB_SEARCH_MAX_USESinteger否路由到 Anthropic 的 Responses web_search 工具与 Chat web_search_options 每个请求的托管搜索次数上限(以 max_uses 发送)。未设置则不限制。Anthropic Messages 客户端沿用其 web_search_* 工具自带的 max_uses。

Providers 配置​

{
"Providers": [
{
"name": "provider-name",
"baseUrl": "https://api.example.com/v1",
"apiKey": "your-api-key",
"models": ["model-1", "model-2"]
}
]
}
字段类型必需说明
namestring是提供商名称
baseUrlstring是API 基础 URL
apiKeystring是API 密钥
modelsarray是支持的模型列表

Router 配置​

{
"Router": {
"default": "provider,model",
"longContextThreshold": 100000,
"routes": {
"background": "lightweight-model",
"think": "powerful-model",
"longContext": "long-context-model",
"webSearch": "search-model",
"image": "vision-model"
}
}
}

Transformers 配置​

{
"transformers": [
{
"name": "anthropic",
"provider": "provider-name",
"models": ["model-1"],
"options": {}
}
]
}

响应示例​

成功:

{
"success": true,
"message": "Config saved successfully"
}

配置备份​

每次更新配置时,旧配置会自动备份到:

~/.claude-code-router/config.backup.{timestamp}.json

保留最近 3 个备份。

GET /api/transformers​

获取服务器加载的所有转换器列表。

请求示例​

curl http://localhost:3456/api/transformers \
-H "x-api-key: your-api-key"

响应示例​

{
"transformers": [
{
"name": "anthropic",
"endpoint": null
},
{
"name": "openai",
"endpoint": null
},
{
"name": "gemini",
"endpoint": "https://generativelanguage.googleapis.com"
}
]
}

转换器列表​

内置转换器:

  • anthropic - Anthropic Claude 格式
  • openai - OpenAI 格式
  • deepseek - DeepSeek 格式
  • gemini - Google Gemini 格式
  • openrouter - OpenRouter 格式
  • groq - Groq 格式
  • maxtoken - 调整 max_tokens 参数
  • tooluse - 工具使用转换
  • reasoning - 推理模式转换
  • enhancetool - 增强工具功能

环境变量插值​

配置支持环境变量插值:

{
"Providers": [
{
"apiKey": "$OPENAI_API_KEY"
}
]
}

或使用 ${VAR_NAME} 格式:

{
"baseUrl": "${API_BASE_URL}"
}