简体中文

English

简体中文

English

主题

对话接口 ​

使用 OpenAI Chat Completions 兼容格式发起对话，支持一次性完整响应与 SSE 流式返回；可选模型见下方「当前可用模型」。

http
POST /v1/chat/completions

可通过统一对话格式调用 GPT 等上游模型。stream 决定返回方式：省略或传 false 时一次性返回完整 chat.completion 对象，适合后台任务、结构化输出和短问答；传 true 时以 SSE 流式返回增量片段，适合边生成边展示的聊天、Agent 和长文本场景。

未传 stream 时按非流式处理。若需固定流式响应，请显式传入 "stream": true。

默认模型为 。

当前可用模型 ​

模型说明
旗舰 5.6 系列最新
高规格 5.5 系列
通用 5.4 系列
轻量版 5.4
代码专项 5.3
更小规格 5 系列
通用多模态模型
通用文本 / 工具调用模型

请求头 ​

名称类型必填说明
string是请求身份认证。使用 Bearer Token，示例：
string是请求内容类型，必须设置为

请求体 ​

名称类型必填说明
string是模型 ID，默认示例 ；可选值见上方「当前可用模型」
array是按时间顺序排列的对话消息列表
boolean否是否流式返回；默认按非流式处理
object否流式附加选项，仅 时生效
integer否生成 token 上限（含可见输出与推理 token）；推理模型建议使用
integer否最大生成 token 数；已弃用，推荐改用
number否采样温度，范围 –，默认
number否核采样，范围 –，默认 ；通常只调 或 其一
integer否候选结果数，范围 –，默认
string | array否最多 4 个停止序列
number否范围 –，默认
number否范围 –，默认
object否指定 token 出现概率偏置
boolean否是否返回输出 token 对数概率，默认
integer否–；使用时须将 设为
integer否随机种子（Beta），尽力确定性采样
object否输出格式，常用于 JSON / 结构化输出
array否模型可调用的工具列表
string | object否控制是否调用工具： / / ，或指定函数
boolean否是否允许并行工具调用，默认
string否推理强度： / / / / / /
string否回复详略： / / ；GPT-5 系列支持
array否输出类型，默认 ；音频模型可含
object否音频输出参数； 含 时必填
object否预测输出配置，可降低可预知内容的时延
boolean否是否存储本次输出，默认
object否最多 16 组键值对附加信息
string否处理层级： / / / / /
object否联网搜索选项（搜索类模型）
string否提示词缓存键
string否终端用户稳定标识，最长 64 字符
string否终端用户标识；已弃用，请用 /

messages 消息项 ​

名称类型必填说明
string是、、、、
string | array | null是纯文本字符串，或多模态片段数组（ / / / 等）；工具调用时 可为
string否参与者可选名称
array否仅 ：模型发起的工具调用列表
string条件仅 消息必填：对应的工具调用 ID

stream_options ​

名称类型必填说明
boolean否在 前额外推送含 的片段
boolean否流混淆，归一化负载大小

response_format ​

名称类型必填说明
string否（默认）、 或
object条件 为 时提供，含 、 等

tools 工具项 ​

名称类型必填说明
string是函数工具固定为
object是含 、、（JSON Schema），可选

请求示例 ​

bash
curl -X POST https://octopusx.ai/v1/chat/completions \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.6-terra",
    "messages": [
      { "role": "system", "content": "你是一个 API 文档助手。" },
      { "role": "user", "content": "生成一个接口说明摘要。" }
    ],
    "stream": false
  }'
bash
curl -X POST https://octopusx.ai/v1/chat/completions \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.6-terra",
    "messages": [
      { "role": "user", "content": "用一句话介绍 Chat Completions。" }
    ],
    "stream": true,
    "stream_options": {
      "include_usage": true
    }
  }'
bash
curl -X POST https://octopusx.ai/v1/chat/completions \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.6-terra",
    "messages": [
      {
        "role": "user",
        "content": [
          { "type": "text", "text": "描述这张图片。" },
          {
            "type": "image_url",
            "image_url": { "url": "https://example.com/image.png" }
          }
        ]
      }
    ]
  }'
bash
curl -X POST https://octopusx.ai/v1/chat/completions \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.6-terra",
    "messages": [
      { "role": "user", "content": "提取联系人姓名与邮箱。" }
    ],
    "response_format": {
      "type": "json_schema",
      "json_schema": {
        "name": "contact",
        "strict": true,
        "schema": {
          "type": "object",
          "properties": {
            "name": { "type": "string" },
            "email": { "type": "string" }
          },
          "required": ["name", "email"],
          "additionalProperties": false
        }
      }
    }
  }'

响应示例 ​

非流式成功 ​

json
{
  "id": "chatcmpl_abc123",
  "object": "chat.completion",
  "created": 1735689600,
  "model": "gpt-5.6-terra",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "该接口接收统一对话消息，并根据模型生成一次性完整回复。"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 31,
    "completion_tokens": 24,
    "total_tokens": 55
  }
}

流式片段（示意） ​

text
data: {"id":"chatcmpl_abc123","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"role":"assistant","content":"该"},"finish_reason":null}]}

data: {"id":"chatcmpl_abc123","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"接口"},"finish_reason":null}]}

data: [DONE]

响应字段 ​

名称类型说明
string本次生成的响应 ID
string非流式为 ；流式为
integer创建时间戳（秒）
string实际使用的模型 ID
array候选结果数组
object非流式：模型生成的消息
string | null文本内容；工具调用时可能为
array模型请求调用的函数工具
object流式：增量内容（ / / / ）
string结束原因：、、 等
objecttoken 用量；流式需上游返回且常配合
integer输入 token 数
integer输出 token 数
integer总 token 数

注意事项 ​

TIP

接口页中标记为「可选」的参数，不代表所有模型都支持。最终是否透传、是否生效，取决于实际分发到的模型能力。

WARNING

流式响应为 text/event-stream，客户端需按 SSE 解析 data: 行，并以 data: [DONE] 作为结束标记。

相关接口 ​