API 文档

Base URL：https://platform.yongzheng.online · 所有接口返回 JSON，兼容 OpenAI 协议

1. 快速开始

1. 注册账号并登录 控制台
2. 在「API 密钥」中创建一个密钥（sk-yong-...）
3. 使用下方任意示例发起调用

2. 认证

所有请求必须在 Authorization 请求头中携带 Bearer 令牌：

Authorization: Bearer sk-yong-xxxxxxxxxxxxxxxx

密钥无效、缺失或被吊销时返回 401 invalid_api_key。

3. 接口一览

4. 模型列表

GET /v1/models

返回当前可用模型列表：

[
  { "id": "yong-v1-chat",       "object": "model", "owned_by": "yong", "kind": "local",  "title": "YONG V1 Chat" },
  { "id": "qwen-0.5b-chat",     "object": "model", "owned_by": "yong", "kind": "local",  "title": "YONG-Qwen 0.5B" },
  { "id": "YONG-1.0-chat",      "object": "model", "owned_by": "yong", "kind": "manual", "title": "YONG-1.0 专业服务" }
]

5. 对话补全

POST /v1/chat/completions

请求体参数：

参数	类型	必填	说明
model	string	是	模型 ID，如 qwen-0.5b-chat / YONG-1.0-chat
messages	array	是	消息列表，每项含 role 与 content
temperature	number	否	采样温度，默认 0.7
top_p	number	否	核采样，默认 0.9
max_tokens	integer	否	最大输出长度 1-2048，默认 200（建议 ≤512 以获得更快响应）
stream	boolean	否	是否流式返回（SSE），默认 false

流式输出（stream: true）以 Server-Sent Events 返回，逐块输出内容，最后以 data: [DONE] 结束：

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"role":"assistant"},"finish_reason":null}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"你好"},"finish_reason":null}]}

...
data: [DONE]

Python 流式接入（OpenAI SDK）：

from openai import OpenAI
client = OpenAI(base_url="https://platform.yongzheng.online/v1", api_key="sk-yong-xxxxxx")
stream = client.chat.completions.create(
    model="qwen-0.5b-chat",
    messages=[{"role": "user", "content": "讲个笑话"}],
    stream=True,
)
for chunk in stream:
    piece = chunk.choices[0].delta.content
    if piece:
        print(piece, end="")

示例（curl）：

curl https://platform.yongzheng.online/v1/chat/completions \
  -H "Authorization: Bearer sk-yong-xxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "qwen-0.5b-chat",
    "messages": [{"role": "user", "content": "用一句话介绍你自己"}],
    "max_tokens": 200
  }'

响应结构：

{
  "id": "chatcmpl-xxxxx",
  "object": "chat.completion",
  "model": "qwen-0.5b-chat",
  "choices": [{
    "index": 0,
    "message": { "role": "assistant", "content": "..." },
    "finish_reason": "stop"
  }],
  "usage": { "prompt_tokens": 33, "completion_tokens": 22, "total_tokens": 55 }
}

Python 接入（OpenAI SDK）：

from openai import OpenAI

client = OpenAI(base_url="https://platform.yongzheng.online/v1",
                api_key="sk-yong-xxxxxx")
resp = client.chat.completions.create(
    model="qwen-0.5b-chat",
    messages=[{"role": "user", "content": "你好"}],
)
print(resp.choices[0].message.content)

Node.js 接入：

const OpenAI = require("openai");
const client = new OpenAI({
  baseURL: "https://platform.yongzheng.online/v1",
  apiKey: "sk-yong-xxxxxx",
});
const resp = await client.chat.completions.create({
  model: "qwen-0.5b-chat",
  messages: [{ role: "user", content: "你好" }],
});
console.log(resp.choices[0].message.content);

6. 专业服务模型（YONG-1.0-chat）

调用 YONG-1.0-chat 时，请求将进入平台专业服务通道，由平台团队保障高质量响应。调用方式与普通模型一致，请求可能需短时等待；如超过等待时限，接口返回 408 request_timeout 并携带 request_id，可通过回调轮询结果：

GET /v1/chat/completions/{request_id}

未完成时返回 status: "pending"；完成后返回与对话补全一致的完整响应。

7. 错误码

所有错误均返回统一结构：

{ "error": { "message": "错误说明", "type": "invalid_request_error", "param": null, "code": "invalid_api_key" } }

HTTP	code	说明

8. 速率限制

模型	RPM（次/分钟）
yong-v1-chat	60
qwen-0.5b-chat	60
YONG-1.0-chat	10

超出限制返回 429 rate_limit_exceeded。

9. 计费说明

按 Token 精确计费，注册即送 ¥10 体验额度。具体价格见 定价页。余额不足时返回 403 insufficient_quota。

10. 账户安全

登录后进入「控制台 → 账户」或「管理后台 → 账户安全」即可修改登录密码（需验证原密码）。