Skip to content

POST /v1/chat/completions

OpenAI Chat Completions 兼容接口。后端会读取模型名、消息、流式标记和用量字段;其他 OpenAI 兼容字段会随请求透传给上游。

请求

内容
方法POST
路径/v1/chat/completions
鉴权API Key 或登录 JWT
Content-Typeapplication/json

Header 参数

参数必填说明
AuthorizationBearer sk-...Bearer <jwt>
x-api-key可替代 Authorization
Content-Typeapplication/json

Query 参数

参数必填说明
key可替代 Header,值为 sk-...

Body 参数

参数必填类型说明
modelstring平台模型名。
messagesarrayOpenAI 消息数组。
messages[].rolestringsystemuserassistanttool 等。
messages[].contentstring/array/object/null消息内容;后端计费文本会从该字段抽取。
messages[].namestringOpenAI 兼容字段,透传。
messages[].tool_callsarray工具调用,透传或协议转换。
messages[].tool_call_idstring工具消息关联 ID。
streamboolean是否返回 SSE。
temperaturenumber透传给上游。
top_pnumber透传给上游。
ninteger透传给上游。
stopstring/array透传给上游。
max_tokensinteger后端协议转换会读取;透传。
max_completion_tokensinteger后端协议转换会读取;透传。
presence_penaltynumber透传给上游。
frequency_penaltynumber透传给上游。
logit_biasobject透传给上游。
userstring透传给上游。
toolsarray工具定义,透传或协议转换。
tool_choicestring/object工具选择,透传。
response_formatobject响应格式,透传。
seedinteger透传给上游。
stream_optionsobject透传;OpenAI 上游可用 include_usage

未列出的 OpenAI 兼容字段也会保留在请求体中转发。

返回值

非流式返回 OpenAI Chat Completions 格式:

json
{
  "id": "chatcmpl_xxx",
  "object": "chat.completion",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "total_tokens": 2
  }
}

流式返回 text/event-stream

基于 MIT 协议发布(社区版)