====== API 接口文档 ======

本平台完全兼容 OpenAI API 格式，可直接使用 OpenAI SDK 或任何兼容客户端。

===== 基本信息 =====

^ 项目 ^ 内容 ^
| Base URL | ''https://api.huanyuf.top'' |
| 认证方式 | Bearer Token (API Key) |
| 请求格式 | JSON |
| 响应格式 | JSON / SSE (流式) |

===== Chat Completions =====

**请求地址：** ''POST /v1/chat/completions''

**请求头：**
<code>
Authorization: Bearer sk-你的密钥
Content-Type: application/json
</code>

**请求示例：**
<code javascript>
{
  "model": "claude-opus-4-6",
  "messages": [
    {"role": "system", "content": "你是一个有用的助手"},
    {"role": "user", "content": "你好，请介绍一下自己"}
  ],
  "stream": false,
  "max_tokens": 4096
}
</code>

**curl 示例：**
<code bash>
curl https://api.huanyuf.top/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-你的密钥" \
  -d '{
    "model": "claude-opus-4-6",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'
</code>

**Python 示例：**
<code python>
from openai import OpenAI

client = OpenAI(
    api_key="sk-你的密钥",
    base_url="https://api.huanyuf.top/v1"
)

response = client.chat.completions.create(
    model="claude-opus-4-6",
    messages=[
        {"role": "user", "content": "你好"}
    ]
)

print(response.choices[0].message.content)
</code>

===== 流式响应 =====

设置 ''"stream": true'' 即可获得 SSE 流式响应：

<code python>
stream = client.chat.completions.create(
    model="claude-opus-4-6",
    messages=[{"role": "user", "content": "写一首诗"}],
    stream=True
)

for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="")
</code>

===== 错误码说明 =====

^ 状态码 ^ 含义 ^ 解决方法 ^
| 400 | 请求参数错误 | 检查模型名称和请求格式 |
| 401 | 认证失败 | 检查 API Key 是否正确 |
| 429 | 请求频率超限 | 降低请求频率，稍后重试 |
| 500 | 服务器内部错误 | 联系管理员 |