兼容 OpenAI Chat Completions 风格的接口说明
列出当前可用的模型。
{
"object": "list",
"data": [
{
"id": "Mini-v1-chat",
"object": "model",
"owned_by": "MiniStudio",
"created": 1700000000,
"ready": false
}
]
}
对话补全,返回标准的 chat.completion 结构。
POST /v1/chat/completions
Authorization: Bearer sk-miniai-xxx
Content-Type: application/json
{
"model": "Mini-v1-chat",
"messages": [
{"role": "user", "content": "你好"}
]
}
{
"id": "chatcmpl-xxxxxxxx",
"object": "chat.completion",
"created": 1700000000,
"model": "Mini-v1-chat",
"choices": [
{
"index": 0,
"finish_reason": "stop",
"message": {"role": "assistant", "content": "……"}
}
],
"usage": {"prompt_tokens": 102, "completion_tokens": 13, "total_tokens": 115},
"latency": 3.1
}
返回标准 chat.completion 结构,多一个 latency 字段表示本次模型耗时(秒)。
请求体里加 "stream": true,就会以 text/event-stream 逐段返回,格式和 OpenAI 一致。
POST /v1/chat/completions
Authorization: Bearer sk-miniai-xxx
Content-Type: application/json
{
"model": "Mini-v1-chat",
"messages": [{"role": "user", "content": "你好"}],
"stream": true
}
data: {"choices":[{"index":0,"delta":{"role":"assistant"},"finish_reason":null}]}
data: {"choices":[{"index":0,"delta":{"content":"你好"},"finish_reason":null}]}
data: {"choices":[{"index":0,"delta":{"content":"!"},"finish_reason":null}]}
data: {"choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}
data: [DONE]
末尾一定会有 data: [DONE]。想让最后一个数据块带上 usage,
再加 "stream_options": {"include_usage": true}(和 OpenAI 相同)。
usage 里的 token 数是真实的统计结果,也是扣费依据:按
输入 tokens × 输入单价 + 输出 tokens × 输出单价 从账户余额扣除。
不同模型的单价可能不同,以控制台显示为准。
在请求头中携带密钥,二选一即可:
Authorization: Bearer <你的密钥>
或
X-API-Key: <你的密钥>
密钥在控制台的「API keys」页面创建,完整密钥只在创建时显示一次,请立刻复制保存。若怀疑泄露,可随时吊销后重新创建。
| 状态码 | 含义 |
|---|---|
| 400 | 参数错误,例如 messages 为空或格式不正确 |
| 401 | 缺少密钥,或密钥无效 / 已吊销 |
| 402 | 账户余额不足,请先充值 |
| 403 | 账号被禁用 |
| 429 | 超出今日额度或超过每秒限制 |
| 500 | 服务器内部错误 |
错误响应统一形如:
{"error": {"message": "...", "type": "..."}}
其中 type 会标明错误类别,例如 auth_error(鉴权)、insufficient_balance(余额不足)、rate_limit(超限)、invalid_request(参数错误)。
按 token 用量计费,输入与输出分开计价:
| 项目 | 单价 |
|---|---|
| 输入(prompt) | 0.0002 元 / 1000 tokens |
| 输出(completion) | 0.0008 元 / 1000 tokens |
以上为对外公示单价,以控制台实际显示为准。新用户需先充值后才能调用接口。
充值入口在控制台的「充值」页面:
默认每个密钥每秒 5 次、每天 1000 次调用,具体以控制台里密钥的实际配置为准。超出今日额度或超过每秒限制会返回 429。