首批通过分布式安全可靠测评,为关键业务系统打造
Create Chat Completion - OpenAI 聊天补全
更新时间:2026-05-25 16:12:56
功能说明
OpenAI 兼容聊天补全接口,支持流式与非流式响应。适用于需要调用大语言模型进行对话、内容生成等场景。
调用说明
接口约束
- 调用者需要拥有 API Key,详情请参见 管理 AI API Key。
请求路径
POST {BASE_URL}/api/v1/chat/completions
请求头
| 名称 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|
| Authorization | 是 | Bearer {token} | 鉴权信息 |
| Content-Type | 否 | application/json | 请求体格式 |
请求参数
Path 参数
无
Query 参数
无
Body 参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| model | string | 是 | gpt-3.5-turbo | 模型名称 |
| messages | array[object] | 是 | [{"role": "user", "content": "Hello!"}] | 消息列表 |
| stream | boolean | 否 | false | 是否启用流式输出 |
| max_tokens | integer | 否 | 2048 | 生成的最大令牌数 |
| max_completion_tokens | integer | 否 | 512 | 补全部分的最大令牌数 |
| temperature | number | 否 | 1.0 | 采样温度,介于0和2之间 |
| top_p | number | 否 | 1.0 | 核采样参数 |
| user | string | 否 | user-123 | 代表最终用户的标识符 |
返回结果
返回参数
| 名称 | 类型 | 描述 |
|---|---|---|
| success | boolean | 请求是否成功 |
| code | string | 返回码 |
| message | string | 返回信息 |
| data | object | 业务返回数据 |
data 字段说明
| 名称 | 类型 | 描述 |
|---|---|---|
| id | string | 聊天补全的唯一ID |
| object | string | 对象类型,例如 "chat.completion" |
| created | integer | 创建时间戳 |
| model | string | 使用的模型 |
| choices | array[object] | 生成的选择列表 |
| usage | object | 令牌使用情况 |
请求示例
curl --request POST '{BASE_URL}/api/v1/chat/completions' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"model": "gpt-3.5-turbo",
"messages": [
{"role": "user", "content": "Hello!"}
],
"stream": false,
"max_tokens": 2048,
"temperature": 1.0
}'
返回示例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"id": "chatcmpl-123",
"object": "chat.completion",
"created": 1677652288,
"model": "gpt-3.5-turbo",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "Hello there! How can I assist you today?"
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 9,
"completion_tokens": 12,
"total_tokens": 21
}
}
}