创建聊天对话

post/v1/chat/completions

根据对话历史创建模型响应。支持流式和非流式响应。

兼容 OpenAI Chat Completions API。

鉴权

把 OLETOKEN 的 API Key 作为 Bearer Token 放进 Authorization 请求头。密钥在控制台的「API 密钥」页创建。

Authorization: Bearer $OLETOKEN_API_KEY

请求体

Content-Type:application/json

字段类型必填说明
modelstring模型 ID
messagesMessage[]对话消息列表
rolestringsystemuserassistanttooldeveloper消息角色
contentstring | MessageContent[]消息内容
typestringtextimage_urlinput_audiofilevideo_url——
textstring——
image_urlobject——
urlstring—图片 URL 或 base64
detailstringlowhighauto——
input_audioobject——
datastring—Base64 编码的音频数据
formatstringwavmp3——
fileobject——
filenamestring——
file_datastring——
file_idstring——
video_urlobject——
urlstring——
namestring—发送者名称
tool_callsToolCall[]——
idstring——
typestring——
functionobject——
namestring——
argumentsstring——
tool_call_idstring—工具调用 ID(用于 tool 角色消息)
reasoning_contentstring—推理内容
temperaturenumber0–2default: 1—采样温度
top_pnumber0–1default: 1—核采样参数
ninteger≥ 1default: 1—生成数量
streambooleandefault: false—是否流式响应
stream_optionsobject——
include_usageboolean——
stopstring | string[]—停止序列
max_tokensinteger—最大生成 Token 数
max_completion_tokensinteger—最大补全 Token 数
presence_penaltynumber-2–2default: 0——
frequency_penaltynumber-2–2default: 0——
logit_biasobject——
userstring——
toolsTool[]——
typestring——
functionobject——
namestring——
descriptionstring——
parametersobject—JSON Schema 格式的参数定义
tool_choicestring | objectnoneautorequired——
typestring——
functionobject——
namestring——
response_formatResponseFormat——
typestringtextjson_objectjson_schema——
json_schemaobject—JSON Schema 定义
seedinteger——
reasoning_effortstringlowmediumhigh—推理强度 (用于支持推理的模型)
modalitiesstring[]——
audioobject——
voicestring——
formatstring——

响应

200成功创建响应

字段类型必填说明
idstring——
objectstring——
createdinteger——
modelstring——
choicesobject[]——
indexinteger——
messageMessage——
rolestringsystemuserassistanttooldeveloper消息角色
contentstring | MessageContent[]消息内容
typestringtextimage_urlinput_audiofilevideo_url——
textstring——
image_urlobject——
urlstring—图片 URL 或 base64
detailstringlowhighauto——
input_audioobject——
datastring—Base64 编码的音频数据
formatstringwavmp3——
fileobject——
filenamestring——
file_datastring——
file_idstring——
video_urlobject——
urlstring——
namestring—发送者名称
tool_callsToolCall[]——
idstring——
typestring——
functionobject——
namestring——
argumentsstring——
tool_call_idstring—工具调用 ID(用于 tool 角色消息)
reasoning_contentstring—推理内容
finish_reasonstringstoplengthtool_callscontent_filter——
usageUsage——
prompt_tokensinteger—提示词 Token 数
completion_tokensinteger—补全 Token 数
total_tokensinteger—总 Token 数
prompt_tokens_detailsobject——
cached_tokensinteger——
text_tokensinteger——
audio_tokensinteger——
image_tokensinteger——
completion_tokens_detailsobject——
text_tokensinteger——
audio_tokensinteger——
reasoning_tokensinteger——
system_fingerprintstring——

400请求参数错误

字段类型必填说明
errorobject——
messagestring—错误信息
typestring—错误类型
paramstring | null—相关参数
codestring | null—错误代码

429请求频率限制

字段类型必填说明
errorobject——
messagestring—错误信息
typestring—错误类型
paramstring | null—相关参数
codestring | null—错误代码

请求示例

curl -X POST 'https://api.oletoken.ai/v1/chat/completions' \
  -H "Authorization: Bearer $OLETOKEN_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "model": "gpt-4",
    "messages": []
  }'