原生 OpenAI 格式
ChatCompletions 格式
根据对话历史创建模型响应。支持流式和非流式响应。
兼容 OpenAI Chat Completions API。
接口描述
POST /v1/chat/completions
Headers:
Authorization: Bearer <Token>
Body:
┣━ model string (必填) 模型 ID (例如: gpt-4)
┣━ messages array[object] (必填) 对话消息列表
┃ ┣━ role enum
┃ ┃ 枚举值 system, user, assistant, tool, developer
┃ ┣━ content string (必填) 消息内容
┃ ┣━ name string (可选) 为角色命名的名称
┃ ┣━ tool_calls array[object] (可选) 模型生成的工具调用
┃ ┃ ┣━ id string 工具调用 ID
┃ ┃ ┣━ type string 工具类型,目前仅支持 function
┃ ┃ ┣━ function object 函数调用详情
┃ ┃ ┃ ┣━ name string 函数名称
┃ ┃ ┃ ┣━ arguments string JSON 格式的函数参数
┃ ┣━ tool_call_id string (可选) 此次消息响应的工具调用 ID
┃ ┣━ reasoning_content string (可选) 模型推理内容
┣━ temperature number (可选) 采样温度,介于 0 到 2 之间
┣━ top_p number (可选) 核采样概率阈值
┣━ n integer (可选) 为每条输入消息生成的回复选项数量
┣━ stream boolean (可选) 是否流式传输
┣━ stream_options object (可选) 流式传输选项
┃ ┣━ include_usage boolean 是否包含 Token 使用情况统计
┣━ stop string/array (可选) 停止序列,模型将停止生成后续 Token
┣━ max_tokens integer (可选) 已弃用,建议使用 max_completion_tokens
┣━ max_completion_tokens integer (可选) 生成的最大 Token 数限制
┣━ presence_penalty number (可选) 存在惩罚系数,介于 -2.0 到 2.0 之间
┣━ frequency_penalty number (可选) 频率惩罚系数,介于 -2.0 到 2.0 之间
┣━ logit_bias object (可选) 修改指定 Token 出现的概率
┣━ user string (可选) 代表终端用户的唯一标识符
┣━ tools array[object] (可选) 模型可以调用的工具列表
┃ ┣━ type string 工具类型,通常为 function
┃ ┣━ function object 函数定义
┃ ┃ ┣━ name string 函数名称
┃ ┃ ┣━ description string 函数功能描述
┃ ┃ ┣━ parameters object JSON Schema 格式的参数定义
┣━ tool_choice string/object (可选) 控制模型如何调用工具
┃ (none/auto/required/object)
┃ ┣━ type string
┃ ┣━ fuction object
┃ ┃ ┣━ name string
┣━ response_format object (可选) 指定输出格式
┃ ┣━ type enum
┃ ┃ 枚举值 text json_object json_schema
┃ ┣━ json_schema object 当类型为 json_schema 时的具体定义
┣━ seed integer (可选) 随机种子,用于生成确定性结果
┣━ reasoning_effort enum
┃ 枚举值 low medium high
┣━ modalities array[string] (可选) 输出模态列表 (例如: ["text"])
┣━ audio object (可选) 音频输出配置
┃ ┣━ voice string 声音类型
┃ ┣━ format string 音频格式输出 (例如: wav, mp3)
Response 200:
┣━ id string 该次请求的唯一标识符
┣━ object string 对象类型,固定为 chat.completion
┣━ created integer 创建回复时的 Unix 时间戳(秒)
┣━ model string 使用的模型 ID
┣━ choices array[object] 生成的回复选项列表
┃ ┣━ index integer 选项在列表中的索引
┃ ┣━ message object 模型生成的回复消息
┃ ┃ ┣━ role enum
┃ ┃ ┃ 枚举值: system, user, assistant, tool, developer
┃ ┃ ┣━ content string 消息内容
┃ ┃ ┣━ name string (可选) 角色名称
┃ ┃ ┣━ tool_calls array[object] (可选) 模型生成的工具调用列表
┃ ┃ ┃ ┣━ id string 工具调用 ID
┃ ┃ ┃ ┣━ type string 工具类型,目前仅支持 function
┃ ┃ ┃ ┣━ function object 模型生成的函数详情
┃ ┃ ┃ ┃ ┣━ name string 函数名称
┃ ┃ ┃ ┃ ┣━ arguments string JSON 格式的函数参数
┃ ┃ ┣━ tool_call_id string (可选) 对应的工具调用 ID
┃ ┃ ┣━ reasoning_content string (可选) 模型生成的推理思维链内容
┃ ┣━ finish_reason enum
┃ ┃ 枚举值: stop, length, tool_calls, content_filter, sensitive
┣━ usage object Token 使用情况统计
┃ ┣━ prompt_tokens integer 输入(提示)所使用的 Token 总数
┃ ┣━ completion_tokens integer 输出(回复)所使用的 Token 总数
┃ ┣━ total_tokens integer 总 Token 使用数 (prompt + completion)
┃ ┣━ prompt_tokens_details object 输入 Token 的详细统计
┃ ┃ ┣━ cached_tokens integer 缓存的 Token 数量
┃ ┃ ┣━ text_tokens integer 文本 Token 数量
┃ ┃ ┣━ audio_tokens integer 音频 Token 数量
┃ ┃ ┣━ image_tokens integer 图像 Token 数量
┃ ┣━ completion_tokens_details object 输出 Token 的详细统计
┃ ┃ ┣━ text_tokens integer 文本 Token 数量
┃ ┃ ┣━ audio_tokens integer 音频 Token 数量
┃ ┃ ┣━ reasoning_tokens integer 推理过程中消耗的 Token 数量
┣━ system_fingerprint string 系统指纹,代表后端配置的确定性标识
Response 400
┣━ error object 错误详情对象
┃ ┣━ message string 错误信息的简短描述,解释发生错误的原因
┃ ┣━ type string 错误的类型(例如:invalid_request_error, authentication_error 等)
┃ ┣━ param string (可选) 导致错误的请求参数名称
┃ ┣━ code string (可选) 错误的错误代码(例如:invalid_api_key, model_not_found 等)
Responses 格式
OpenAI Responses API,用于创建模型响应。支持多轮对话、工具调用、推理等功能。
接口描述
POST /v1/chat/completions
Headers:
Authorization: Bearer <Token>
Body:
┣━ model string (必填) 模型 ID
┣━ input string 输入的文本内容或提示词
┣━ instructions string 系统指令或任务说明
┣━ max_output_tokens integer 最大输出 Token 数量限制
┣━ temperature number 采样温度,控制生成结果的随机性
┣━ top_p number 核采样概率阈值
┣━ stream boolean 是否启用流式输出
┣━ tools array[object] 可选的工具列表
┣━ tool_choice string 工具选择策略(如:none, auto, required)
┣━ reasoning object 推理配置
┃ ┣━ effort enum
┃ ┣━ summary string 推理过程的摘要说明
┣━ previous_response_id string 前一个响应的 ID,用于多轮对话关联
┣━ truncation string 上下文截断策略(如:auto)
Response 200
┣━ id string 响应的唯一标识符
┣━ object string 对象类型,固定为 response
┣━ created_at integer 响应创建时的 Unix 时间戳(秒)
┣━ status string 响应状态 (例如: completed, failed, cancelled)
┣━ model string 使用的模型 ID
┣━ output array[object] 生成的输出内容列表
┃ ┣━ type string 输出项的类型
┃ ┣━ id string 输出项的唯一标识符
┃ ┣━ status string 输出项的状态
┃ ┣━ role string 角色 (例如: assistant)
┃ ┣━ content array[object] 具体内容块列表
┃ ┃ ┣━ type string 内容块类型 (例如: text)
┃ ┃ ┣━ text string 文本内容
┣━ usage object Token 使用情况统计
┃ ┣━ prompt_tokens integer 输入 Token 总数
┃ ┣━ completion_tokens integer 输出 Token 总数
┃ ┣━ total_tokens integer 总 Token 使用数
┃ ┣━ prompt_tokens_details object 输入 Token 详细统计
┃ ┃ ┣━ cached_tokens integer 缓存的 Token 数量
┃ ┃ ┣━ text_tokens integer 文本 Token 数量
┃ ┃ ┣━ audio_tokens integer 音频 Token 数量
┃ ┃ ┣━ image_tokens integer 图像 Token 数量
┃ ┣━ completion_tokens_details object 输出 Token 详细统计
┃ ┃ ┣━ text_tokens integer 文本 Token 数量
┃ ┃ ┣━ audio_tokens integer 音频 Token 数量
┃ ┃ ┣━ reasoning_tokens integer 推理 Token 数量