API 文档

快速上手 KiroGate API

🔑

认证方式

所有 API 请求需要在 Header 中携带 API Key。支持三种认证模式：

模式 1: 用户 API Key（sk-xxx 格式）⭐ 推荐

# OpenAI 格式
Authorization: Bearer sk-xxxxxxxxxxxxxxxx

# Anthropic 格式
x-api-key: sk-xxxxxxxxxxxxxxxx

登录后在用户中心生成，自动使用您添加的 Token 或公开 Token 池。

模式 2: 组合模式（用户自带 REFRESH_TOKEN）

# OpenAI 格式
Authorization: Bearer YOUR_PROXY_API_KEY:YOUR_REFRESH_TOKEN

# Anthropic 格式
x-api-key: YOUR_PROXY_API_KEY:YOUR_REFRESH_TOKEN

模式 3: 简单模式（使用服务器配置的 REFRESH_TOKEN）

# OpenAI 格式
Authorization: Bearer YOUR_PROXY_API_KEY

# Anthropic 格式
x-api-key: YOUR_PROXY_API_KEY

💡 推荐使用方式

  • • 普通用户：登录后生成 sk-xxx 格式的 API Key，最简单易用
  • • 自部署用户：使用组合模式，自带 REFRESH_TOKEN，无需服务器配置
  • • 缓存优化：每个用户的认证信息会被缓存（最多100个用户），提升性能
📡

端点列表

GET
/

健康检查端点

GET
/health

详细健康检查，返回 token 状态和缓存信息

GET
/v1/models

获取可用模型列表 (需要认证)

POST
/v1/chat/completions

OpenAI 兼容的聊天补全 API (需要认证)

POST
/v1/messages

Anthropic 兼容的消息 API (需要认证)

💡

使用示例

🐍 OpenAI SDK (Python) 

from openai import OpenAI

client = OpenAI(
    base_url="http://localhost:8000/v1",
    api_key="YOUR_PROXY_API_KEY"
)

response = client.chat.completions.create(
    model="claude-sonnet-4-5",
    messages=[{"role": "user", "content": "Hello!"}],
    stream=True
)

for chunk in response:
    print(chunk.choices[0].delta.content, end="")

🤖 Anthropic SDK (Python) 

import anthropic

client = anthropic.Anthropic(
    base_url="http://localhost:8000",
    api_key="YOUR_PROXY_API_KEY"
)

message = client.messages.create(
    model="claude-sonnet-4-5",
    max_tokens=1024,
    messages=[{"role": "user", "content": "Hello!"}]
)

print(message.content[0].text)

$ cURL 

curl http://localhost:8000/v1/chat/completions \
  -H "Authorization: Bearer YOUR_PROXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-4-5",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'
🤖

可用模型

claude-opus-4-5
claude-opus-4-5-20251101
claude-haiku-4-5
claude-sonnet-4-5
claude-sonnet-4-5-20250929
claude-sonnet-4
claude-sonnet-4-20250514
claude-3-7-sonnet-20250219