Chat Completions
https://api.tokenbay.com/v1/chat/completionsOpenAI 兼容的聊天补全入口
Chat Completions
该路径已在 TokenBay Gateway 注册,走 OpenAI 平台编排链。
网关会完成 API Key 鉴权、分组校验、模型解析、账号调度、必要的协议转换或透传,再把上游响应返回给客户端。
/v1/chat/completions请求
字段modelstringRequired线上 Models 页面或控制台展示的可用模型 ID。
messagesarray<object>Required
OpenAI 兼容 messages 数组,支持 system、user、assistant、tool 等角色。
messages[].rolestringRequired消息角色:system、developer、user、assistant、tool 等。
messages[].contentstring | array<object>Required
纯文本或多模态内容数组。
content[].typestringOptional内容块类型,例如 text、image_url、input_audio。
content[].textstringOptional文本内容块。
content[].image_urlobjectOptional图片 URL 或 data URL 输入;支持情况由模型决定。
content[].input_audioobjectOptional音频输入块,通常包含 data 与 format。
messages[].namestringOptional可选参与者名称。
messages[].tool_call_idstringOptionaltool 角色消息对应的工具调用 ID。
messages[].tool_callsarray<object>Optionalassistant 发起的工具调用结果。
streambooleanOptional设为 true 时返回 SSE 流式响应。
temperaturenumberOptional采样温度;是否生效取决于实际模型。
top_pnumberOptional核采样参数;通常不要和 temperature 同时大幅调整。
max_tokens / max_completion_tokensintegerOptional最大输出 token 数。不同模型可能只支持其中一种字段。
stopstring | string[]Optional停止生成的序列。
presence_penalty / frequency_penaltynumberOptional复读与主题惩罚参数;支持范围由上游模型决定。
response_formatobjectOptional
用于 JSON object / JSON schema 等结构化输出能力。
response_format.typestringOptionaltext、json_object 或 json_schema。
response_format.json_schema.namestringOptionalJSON Schema 名称。
response_format.json_schema.schemaobjectOptionalJSON Schema 定义。
response_format.json_schema.strictbooleanOptional是否要求严格遵循 schema。
tools / tool_choicearray<object> | object | stringOptional
函数调用 / 工具调用配置。
tools[].typestringOptional通常为 function。
tools[].function.namestringOptional函数名称。
tools[].function.descriptionstringOptional函数描述。
tools[].function.parametersobjectOptional函数参数 JSON Schema。
tool_choicestring | objectOptionalauto、none、required,或指定某个函数。
parallel_tool_callsbooleanOptional是否允许并行工具调用。
stream_options.include_usagebooleanOptional流式响应中请求 usage 统计;是否返回由上游决定。
seedintegerOptional尽力复现输出;并非所有上游都支持。
logprobs / top_logprobsboolean | integerOptional请求 token 概率信息;支持情况按模型而定。
modalities / audioarray<string> | objectOptional多模态输出或音频输出相关字段。
reasoning_effortstringOptional推理强度控制,适用于支持 reasoning 的模型。
metadata / userobject | stringOptional客户端侧追踪信息;不要放入敏感数据。
响应
字段非流式响应通常保持 OpenAI Chat Completions 形态;流式响应返回 SSE chunk。流式响应头写出后,网关不能再切换账号重试。
idstringOptional上游返回的响应 ID。
objectstringOptional通常为 chat.completion 或 chat.completion.chunk。
createdintegerOptional创建时间戳。
modelstringOptional实际响应模型名。
choices[]array<object>Optional
候选输出;非流式通常包含 message,流式通常包含 delta。
choices[].indexintegerOptional候选序号。
choices[].message.rolestringOptional非流式消息角色。
choices[].message.contentstring | arrayOptional非流式消息内容。
choices[].message.tool_callsarray<object>Optional模型请求调用的工具。
choices[].deltaobjectOptional流式增量内容。
choices[].finish_reasonstringOptional停止原因,如 stop、length、tool_calls、content_filter 等。
choices[].logprobsobjectOptionaltoken 概率信息;仅在模型支持并请求时返回。
usageobjectOptional
token 用量;部分流式场景可能只在最终事件或上游支持时返回。
usage.prompt_tokensintegerOptional输入 token 数。
usage.completion_tokensintegerOptional输出 token 数。
usage.total_tokensintegerOptional总 token 数。
该入口可以调度到不同上游账号。客户端仍使用 OpenAI 兼容请求体;是否发生协议转换取决于 provider、账号协议组和模型配置。
