文档

文本生成(Chat)

使用 OpenAI Chat Completions 兼容格式生成文本

POSThttps://api.tokenbyte.ai/v1/chat/completions

使用统一的 OpenAI Chat Completions 格式调用支持该协议的模型。请先从模型列表复制完整模型 ID。

Header 参数

参数必填说明
AuthorizationBearer <TOKENBYTE_API_KEY>
Content-Typeapplication/json

Body 参数

参数类型必填说明
modelstring模型完整 ID
messagesarray按时间顺序排列的消息
streamboolean是否使用 SSE 增量响应
temperaturenumber采样随机度,支持范围取决于模型
max_tokensinteger最大输出 Token 数
max_completion_tokensinteger新版模型的最大输出 Token 数
top_pnumber核采样概率阈值
stopstring/array停止生成的字符串
response_formatobject文本、JSON 对象或 JSON Schema
toolsarrayOpenAI 函数工具声明
tool_choicestring/object工具选择方式

messages

每条消息至少包含 rolecontent。支持的多模态内容与特殊字段以模型专题页为准。

role 可为 systemuserassistanttool。工具结果使用 tool_call_id 与助手消息中的调用关联。

流式响应

设置 stream: true 后,接口通过 SSE 返回 chat.completion.chunk。逐块读取 choices[0].delta,收到 data: [DONE] 后结束。需要在最后一个数据块获取用量时,可设置 stream_options.include_usage: true