建立對話補全

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—Prompt 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": []
  }'