API 接口文档

# 示例：用 curl 发送第一个请求
curl -X POST https://www.llmgateway.cn/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "claude-sonnet-4-6", "messages": [{"role": "user", "content": "Hello!"}]}'

curl -X POST https://www.llmgateway.cn/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-4-6",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "Hello!"}
    ],
    "stream": false
  }'

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1713000000,
  "model": "claude-sonnet-4-6",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! How can I help you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 20,
    "completion_tokens": 10,
    "total_tokens": 30
  }
}

curl -X POST https://www.llmgateway.cn/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-4-6",
    "messages": [
      {"role": "user", "content": "Hello!"}
    ],
    "stream": true
  }'

curl -X POST https://www.llmgateway.cn/v1/messages \
  -H "x-api-key: YOUR_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-4-6",
    "max_tokens": 1024,
    "messages": [
      {"role": "user", "content": "Hello!"}
    ]
  }'

{
  "id": "msg_abc123",
  "type": "message",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "Hello! How can I help you today?"
    }
  ],
  "model": "claude-sonnet-4-6",
  "stop_reason": "end_turn",
  "usage": {
    "input_tokens": 10,
    "output_tokens": 12
  }
}

curl -X POST https://www.llmgateway.cn/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4",
    "input": [
      {"role": "user", "content": "Hello!"}
    ]
  }'

{
  "id": "resp_abc123",
  "object": "response",
  "status": "completed",
  "model": "gpt-5.4",
  "output": [
    {
      "type": "message",
      "id": "msg_abc123",
      "role": "assistant",
      "content": [
        {"type": "output_text", "text": "Hello! How can I help you?"}
      ],
      "status": "completed"
    }
  ],
  "usage": {
    "input_tokens": 10,
    "output_tokens": 12,
    "total_tokens": 22
  }
}

# 提交生成任务（立即返回任务 ID，不阻塞）
curl -X POST https://www.llmgateway.cn/v1/images/tasks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-image-2",
    "prompt": "a red apple on a wooden table, studio lighting",
    "size": "1024x1024",
    "n": 2
  }'

{
  "id": 123,
  "status": "pending"
}

# 提交编辑任务（输入图用 URL 或 base64，可混用，最多 4 张、单张 ≤ 25MB）
curl -X POST https://www.llmgateway.cn/v1/images/tasks/edits \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-image-2",
    "prompt": "make the background pure white",
    "size": "1024x1024",
    "n": 1,
    "image_urls": ["https://example.com/cat.png"],
    "image_base64s": [],
    "mask_base64": ""
  }'

# 轮询任务状态（建议 2-5 秒一次，直到 completed / failed）
curl https://www.llmgateway.cn/v1/images/tasks/123 \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "id": 123,
  "type": "generate",
  "status": "completed",
  "model": "gpt-image-2",
  "prompt": "a red apple on a wooden table, studio lighting",
  "size": "1024x1024",
  "image_count": 2,
  "result_urls": [
    "https://llm-gateway-images.tos-cn-beijing.volces.com/xxx-1.png",
    "https://llm-gateway-images.tos-cn-beijing.volces.com/xxx-2.png"
  ],
  "cost": 0.16,
  "created_at": "2026-06-21T12:00:00Z",
  "completed_at": "2026-06-21T12:01:30Z"
}

# 删除任务（仅 pending / completed / failed 可删；处理中返回 409）
curl -X DELETE https://www.llmgateway.cn/v1/images/tasks/123 \
  -H "Authorization: Bearer YOUR_API_KEY"
# 成功返回 204 No Content

curl https://www.llmgateway.cn/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "object": "list",
  "data": [
    {"id": "claude-sonnet-4-6", "object": "model", "created": 1712973600, "owned_by": "llm-gateway"},
    {"id": "gpt-5.4", "object": "model", "created": 1712973600, "owned_by": "llm-gateway"},
    ...
  ]
}

curl https://www.llmgateway.cn/v1/balance \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "type": "user",
  "balance": 100.50,
  "frozen": 5.00,
  "available": 95.50,
  "currency": "CNY"
}

npm install -g @anthropic-ai/claude-code

# 设置环境变量（macOS / Linux 写入 ~/.zshrc 或 ~/.bashrc 永久生效）
export ANTHROPIC_BASE_URL="https://www.llmgateway.cn"
export ANTHROPIC_AUTH_TOKEN="YOUR_API_KEY"
# ANTHROPIC_MODEL 可设置为网关中任意聊天模型
# 例如：claude-sonnet-4-6, gpt-5.4, gemini-3.1-pro-preview, glm-5.1 等
export ANTHROPIC_MODEL="claude-sonnet-4-6"

# 让 Claude Code 内置档位（Sonnet / Opus / Haiku）映射到网关模型
export ANTHROPIC_DEFAULT_SONNET_MODEL="claude-sonnet-4-6"
export ANTHROPIC_DEFAULT_OPUS_MODEL="claude-opus-4-6"
export ANTHROPIC_DEFAULT_HAIKU_MODEL="claude-haiku-4-5-20251001"

# 可用模型（根据网关实际配置，完整列表请调用 GET /v1/models）

# Claude 系列
claude-sonnet-4-6           # Sonnet 4.6
claude-opus-4-6             # Opus 4.6
claude-haiku-4-5-20251001   # Haiku 4.5

# OpenAI 系列
gpt-5.4                     # GPT-5.4
gpt-5.4-codex               # GPT-5.4 Codex
gpt-5.4-codex-high          # GPT-5.4 Codex High

# Gemini 系列
gemini-3.1-pro-preview      # Gemini 3.1 Pro Preview

# 智谱 GLM 系列
glm-5.1                     # GLM 5.1

# 启动 Claude Code
claude

# 或直接在项目目录中启动
cd your-project && claude

# 方式一：写入 shell 配置文件（推荐，永久生效）
echo 'export ANTHROPIC_BASE_URL="https://www.llmgateway.cn"' >> ~/.bashrc
echo 'export ANTHROPIC_AUTH_TOKEN="YOUR_API_KEY"' >> ~/.bashrc
echo 'export ANTHROPIC_MODEL="claude-sonnet-4-6"' >> ~/.bashrc  # 可替换为任意聊天模型

# 让 Claude Code 内置档位（Sonnet / Opus / Haiku）映射到网关模型
echo 'export ANTHROPIC_DEFAULT_SONNET_MODEL="claude-sonnet-4-6"' >> ~/.bashrc
echo 'export ANTHROPIC_DEFAULT_OPUS_MODEL="claude-opus-4-6"' >> ~/.bashrc
echo 'export ANTHROPIC_DEFAULT_HAIKU_MODEL="claude-haiku-4-5-20251001"' >> ~/.bashrc

source ~/.bashrc

# 方式二：在 Claude Code 内切换模型
# 启动后输入 /model 命令即可交互选择模型
# 支持所有网关中的聊天模型，如 gpt-5.4、gemini-3.1-pro-preview 等

# 方式一：桌面版（推荐）
# 从 GitHub 下载对应平台的安装包：
# https://github.com/farion1231/cc-switch/releases

# 方式二：CLI 版
npm install -g cc-switch-cli

# 在 cc-switch 中添加 Provider 时填写以下信息：
#
# Provider 名称:  LLM Gateway（或自定义名称）
# Base URL:       https://www.llmgateway.cn
# API Key:        在控制台「API 密钥」页面创建的 sk-xxx 密钥
# 模型列表:       点击「获取模型」自动拉取，或手动输入

# 本网关支持以下工具，cc-switch 均可一键切换：
#
# 工具            API 格式                端点
# ─────────────  ─────────────────────  ──────────────────────
# Claude Code    Anthropic Messages     /v1/messages
# Codex CLI      OpenAI Responses       /v1/responses
# Cursor         OpenAI Chat            /v1/chat/completions
# Copilot CLI    Anthropic Messages     /v1/messages  (BYOK type=anthropic)
# Trae           OpenAI Chat            /v1/chat/completions
# OpenCode       OpenAI Chat            /v1/chat/completions
# Windsurf       OpenAI Chat            /v1/chat/completions
# Gemini CLI     Google Gemini          /gemini/v1/

# 如果不使用 cc-switch，也可以手动配置环境变量：

# Claude Code
export ANTHROPIC_BASE_URL="https://www.llmgateway.cn"
export ANTHROPIC_AUTH_TOKEN="sk-your-api-key"
export ANTHROPIC_MODEL="claude-sonnet-4-6"

# Codex CLI
export OPENAI_BASE_URL="https://www.llmgateway.cn/v1"
export OPENAI_API_KEY="sk-your-api-key"

# Cursor / Windsurf
# 在设置中将 Base URL 设为 https://www.llmgateway.cn/v1
# API Key 填写 sk-your-api-key

npm install -g @openai/codex

# 设置环境变量
export OPENAI_BASE_URL="https://www.llmgateway.cn/v1"
export OPENAI_API_KEY="YOUR_API_KEY"

# ~/.codex/config.toml
[model_providers.gateway]
name = "LLM Gateway"
base_url = "https://www.llmgateway.cn/v1"
env_key = "OPENAI_API_KEY"

profile = "default"

[profiles.default]
model = "gpt-5.4"
model_provider = "gateway"
wire_api = "chat"

// ~/.codex/auth.json — Codex 启动时需要此文件
{
  "auth_mode": "apikey",
  "OPENAI_API_KEY": "YOUR_API_KEY"
}

# 设置配置文件中引用的环境变量
export OPENAI_API_KEY="YOUR_API_KEY"

# OpenAI 系列（推荐用于 Codex）
gpt-5.4             # GPT-5.4
gpt-5.4-codex       # GPT-5.4 Codex — 代码专用
gpt-5.4-codex-high  # GPT-5.4 Codex High

# Claude 系列（同样支持）
claude-sonnet-4-6   # Sonnet 4.6
claude-opus-4-6     # Opus 4.6

# 其他模型
gemini-3.1-pro-preview  # Gemini 3.1 Pro Preview
glm-5.1                 # GLM 5.1

# 使用默认模型启动
codex

# 指定模型启动
codex --model gpt-5.4

# 直接提问
codex --model gpt-5.4 "explain this codebase"

# 写入 shell 配置文件（永久生效）
echo 'export OPENAI_BASE_URL="https://www.llmgateway.cn/v1"' >> ~/.bashrc
echo 'export OPENAI_API_KEY="YOUR_API_KEY"' >> ~/.bashrc
source ~/.bashrc

// Cursor Settings → Models → OpenAI API Key
// 1. 填入你的网关 API Key
// 2. 勾选 "Override OpenAI Base URL"
// 3. 填入网关地址（带 /v1）：
https://www.llmgateway.cn/v1
// 4. 点击 Verify，绿色勾即可

// Cursor 添加自定义模型时，模型名【必须】带 gw/ 前缀
// 否则 Cursor 会按官方 OpenAI 模型名拦截/改写，导致 Verify 失败或调不到对应模型

// ✅ 正确
gw/claude-sonnet-4-6
gw/gpt-5.4-codex

// ❌ 错误（会被 Cursor 拦截）
claude-sonnet-4-6
gpt-5.4-codex

# Cursor 中所有模型名都要带 gw/ 前缀

# OpenAI 系列
gw/gpt-5.4
gw/gpt-5.4-codex
gw/gpt-5.4-codex-high

# Claude 系列（通过 OpenAI 协议透传，由网关自动转换）
gw/claude-sonnet-4-6
gw/claude-opus-4-6

# 其他
gw/gemini-3.1-pro-preview
gw/glm-5.1

# 推荐配置：BYOK 走 Anthropic 协议（兼容性最佳）
export COPILOT_PROVIDER_TYPE="anthropic"
export COPILOT_PROVIDER_BASE_URL="https://www.llmgateway.cn"
export COPILOT_PROVIDER_API_KEY="YOUR_API_KEY"
export COPILOT_MODEL="claude-sonnet-4-6"

# 上下文与输出长度上限（按所选模型实际能力调整）
export COPILOT_PROVIDER_MAX_PROMPT_TOKENS="200000"
export COPILOT_PROVIDER_MAX_OUTPUT_TOKENS="8192"

# 与其他工具一致，可使用网关中所有聊天模型

# Claude 系列（推荐，配合 type=anthropic 体验最完整）
claude-sonnet-4-6           # Sonnet 4.6
claude-opus-4-6             # Opus 4.6
claude-haiku-4-5-20251001   # Haiku 4.5

# OpenAI 系列
gpt-5.4
gpt-5.4-codex
gpt-5.4-codex-high

# Gemini 系列
gemini-3.1-pro-preview      # Gemini 3.1 Pro Preview

# 智谱 GLM 系列
glm-5.1

# 启动 Copilot CLI（按账户偏好可能是 `copilot` 或 `gh copilot`）
copilot

# 直接提问
copilot "解释这个仓库的目录结构"

# 写入 shell 配置文件（永久生效）
{
  echo 'export COPILOT_PROVIDER_TYPE="anthropic"'
  echo 'export COPILOT_PROVIDER_BASE_URL="https://www.llmgateway.cn"'
  echo 'export COPILOT_PROVIDER_API_KEY="YOUR_API_KEY"'
  echo 'export COPILOT_MODEL="claude-sonnet-4-6"'
  echo 'export COPILOT_PROVIDER_MAX_PROMPT_TOKENS="200000"'
  echo 'export COPILOT_PROVIDER_MAX_OUTPUT_TOKENS="8192"'
} >> ~/.bashrc
source ~/.bashrc

# 备选方案：BYOK 走 OpenAI 协议
# 注意：部分非 OpenAI 上游对 type=openai 的请求会返回 400，
# 因此推荐默认使用 type=anthropic。仅在确认所选模型走 OpenAI 兼容上游时再用此方式。
export COPILOT_PROVIDER_TYPE="openai"
export COPILOT_PROVIDER_BASE_URL="https://www.llmgateway.cn/v1"
export COPILOT_PROVIDER_API_KEY="YOUR_API_KEY"
export COPILOT_MODEL="gpt-5.4-codex"

// Trae UI 配置步骤
// 步骤 1：打开 Trae 侧边栏聊天框右上角齿轮 → Settings → Models
// 步骤 2：点击 + Add Model
// 步骤 3：Provider 选择 OpenAI 或 OpenAI Compatible
// 步骤 4：填入下列字段并保存
//   - API Key:  YOUR_API_KEY（控制台 API 密钥页创建）
//   - Base URL: https://www.llmgateway.cn/v1
//   - Model:    claude-sonnet-4-6（或网关中其他聊天模型）
// 步骤 5：保存后回到聊天框右上角，重新选择刚添加的模型

# Trae 可用网关中所有聊天模型
claude-sonnet-4-6
claude-opus-4-6
gpt-5.4
gpt-5.4-codex
gemini-3.1-pro-preview
glm-5.1

// OpenCode TUI 添加 Provider
// 步骤 1：启动 opencode（交互模式）
// 步骤 2：按 / 或对应快捷键打开命令面板，进入 Settings
//        （部分版本叫 Providers / Models / Custom Endpoints）
// 步骤 3：选择 Add Provider → 选 OpenAI Compatible
// 步骤 4：依次填入下列字段并保存
//   - Name:    LLM Gateway（自定义）
//   - Base URL: https://www.llmgateway.cn/v1
//   - API Key:  YOUR_API_KEY
//   - Model:    claude-sonnet-4-6（或其他网关模型名）
// 步骤 5：保存后 OpenCode 自动测试连接，重启 opencode 后
//        在模型选择面板中即可看到 LLM Gateway 分组

# 启动 OpenCode，选择网关模型即可使用
opencode

# 直接执行任务
opencode run "解释这个仓库结构"

curl -X POST "https://www.llmgateway.cn/gemini/v1/models/gemini-2.5-flash:generateContent" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contents": [
      {"parts": [{"text": "Hello!"}]}
    ]
  }'

curl -X POST "https://www.llmgateway.cn/gemini/v1/models/gemini-2.5-flash:streamGenerateContent?alt=sse" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contents": [
      {"parts": [{"text": "Hello!"}]}
    ]
  }'

curl -X POST "https://www.llmgateway.cn/gemini/v1beta/models/gemini-3.1-flash-image-preview:generateContent" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contents": [
      {"parts": [{"text": "画一只可爱的猫咪"}]}
    ],
    "generationConfig": {
      "responseModalities": ["TEXT", "IMAGE"]
    }
  }'

from google import genai

client = genai.Client(
    api_key="YOUR_API_KEY",
    http_options={"api_version": "v1beta",
                  "url": "https://www.llmgateway.cn/gemini"},
)

# 文本生成
response = client.models.generate_content(
    model="gemini-2.5-flash",
    contents="Hello!",
)
print(response.text)

# 图像生成（需要 v1beta）
from google.genai import types

response = client.models.generate_content(
    model="gemini-3.1-flash-image-preview",
    contents="画一只可爱的猫咪",
    config=types.GenerateContentConfig(
        response_modalities=["TEXT", "IMAGE"],
    ),
)
for part in response.candidates[0].content.parts:
    if part.inline_data:
        # part.inline_data.data 为图片的 base64 编码
        print(f"图片 MIME: {part.inline_data.mime_type}")
    elif part.text:
        print(part.text)