通用模型
通用对话接口(默认流式)
统一的 OpenAI Chat Completions 兼容入口;同一路由支持流式和非流式;成功响应为 OpenAI 原始协议,不包 code/data。
- 路由:
POST /v1/chat/completions - 同一路由同时支持流式和非流式;本页展示流式调用
- 成功响应为 OpenAI 原始协议,不会额外包一层
code/data
请求示例
curl --request POST \
--url https://api.magickapi.com/v1/chat/completions \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"model": "gpt-5",
"stream": true,
"stream_options": { "include_usage": true },
"messages": [
{
"role": "system",
"content": "你是一个专业的 AI 助手。"
},
{
"role": "user",
"content": "介绍一下人工智能的发展历史。"
}
]
}'流式响应示例
data: {"id":"chatcmpl_123","object":"chat.completion.chunk","created":1712345678,"model":"gpt-5","choices":[{"index":0,"delta":{"role":"assistant","content":""},"finish_reason":null}]}
data: {"id":"chatcmpl_123","object":"chat.completion.chunk","created":1712345678,"model":"gpt-5","choices":[{"index":0,"delta":{"content":"人工智能"},"finish_reason":null}]}
data: {"id":"chatcmpl_123","object":"chat.completion.chunk","created":1712345678,"model":"gpt-5","choices":[{"index":0,"delta":{},"finish_reason":"stop"}],"usage":{"prompt_tokens":28,"completion_tokens":18,"total_tokens":46}}
data: [DONE]错误响应示例
{
"error": {
"message": "Invalid request",
"type": "invalid_request_error",
"param": null,
"code": "invalid_request"
}
}认证
- 请求头:
Authorization: Bearer YOUR_API_KEY - API Key 请使用 Magick API 后台生成的密钥
常用参数
model
-
类型:
string -
必填:是
传入具体模型 ID。项目会按渠道映射和分发规则选择上游模型。
messages
-
类型:
array -
必填:是
与 OpenAI Chat Completions 协议一致。每条消息至少包含
role和content。
stream
-
类型:
boolean -
默认值:
true是否使用流式输出。省略时,很多客户端会按自己的默认行为发送;如果你想强制流式,建议显式传
true。
stream_options
-
类型:
object当前项目支持 OpenAI 风格的
stream_options。常见写法:
{
"stream_options": {
"include_usage": true
}
}其他常用字段
下列 OpenAI 兼容字段可直接使用,是否最终被上游接受取决于模型和渠道能力:
temperaturetop_pmax_tokensmax_completion_tokenstoolstool_choiceresponse_formatreasoning_effort
兼容说明
POST /v1/completions也仍然存在,但推荐新接入统一使用POST /v1/chat/completions
最后更新于