Pixel API
使用指南钱包与商城福利与邀请API 参考帮助支持
聊天(Chat)

ChatCompletions 格式

根据 messages 对话历史创建模型回复,适合 OpenAI SDK、Cherry Studio、沉浸式翻译、通用聊天客户端和脚本调用。

POST/v1/chat/completions
AuthorizationBearerAuth
BearerAuth

使用 Bearer Token 认证。

Authorization: Bearer sk-xxxxxx

使用 Bearer Token 认证,格式:Authorization: Bearer sk-xxxxxx。

Bodyapplication/json
参数会同步到右侧示例代码。
modelrequired
string

模型名称。必须属于当前 API Key 可访问分组支持的模型。

对话消息数组,常见 role 包括 system、user、assistant、tool。

字段结构
rolestring

消息角色,例如 system、user、assistant、tool。

contentstring | array<object>

消息内容。可为纯文本,也可为包含 text/image 的多模态数组。

namestring

可选的发送者名称,常用于区分同一 role 下的多个参与者。

tool_call_idstring

role 为 tool 时,对应的工具调用 ID。

stream
boolean

是否启用 SSE 流式响应。客户端支持流式输出时可设为 true。

流式响应的附加选项,仅在 stream=true 时生效。

字段结构
include_usageboolean

是否在流结束时附带一条 usage 统计块。

temperature
number

采样温度。是否生效取决于真实上游和模型能力。

max_tokens
integer

最大输出 Token。不同模型可能使用 max_completion_tokens 等兼容字段。

Authorization

BearerAuth

请求头使用 Authorization,值为 Bearer <token>。 Token 来自控制台“API 密钥”,不是登录态,也不是管理员密钥。

In: header

Request Body

application/json
modelrequired

模型名称。必须属于当前 API Key 可访问分组支持的模型。

messagesrequired

对话消息数组,常见 role 包括 system、user、assistant、tool。

stream

是否启用 SSE 流式响应。客户端支持流式输出时可设为 true。

stream_options

流式响应的附加选项,仅在 stream=true 时生效。

temperature

采样温度。是否生效取决于真实上游和模型能力。

max_tokens

最大输出 Token。不同模型可能使用 max_completion_tokens 等兼容字段。

tools

工具调用定义。适合函数调用、代码工具或客户端插件场景。

tool_choice

控制是否强制调用工具。

Response Body

application/json
id

响应 ID。

object

通常为 chat.completion 或 chat.completion.chunk。

choices

模型输出结果。非流式通常读取 choices[0].message.content。

usage

Token 消耗统计。

说明

Pixel API 会根据 API Key 绑定的分组自动选择真实上游账号。OpenAI 分组直连 OpenAI 兼容链路,非 OpenAI 分组会转换为对应平台格式。