Skip to main content
POST
Completions API
已棄用。 此端點已棄用,將於 2026-07-11 下架。在此之前仍可使用。請改用 V1 路徑—完整的新舊路徑對照見遷移指南
API 整合提供了一個 OpenAI 兼容的聊天完成端點,您可以用它來與您的 Pathors 專案進行互動。

基礎 URL

聊天完成

路徑參數

string
必填
您的專案 ID

請求頭

string
必填
使用您的 Project API Key(以 sk_ 開頭)進行 Bearer 令牌認證。格式:Bearer {your-api-key}
string
會話 ID,用於對話連續性。強烈建議使用此標頭傳遞會話 ID,而不是請求體中的 session_id 參數。

請求體

array
必填
對話中的訊息陣列。每條訊息都應該有一個 role(“system”、“user” 或 “assistant”)和 content
boolean
是否流式傳輸回應。默認為 false。
string
(deprecated) 會話 ID,用於對話連續性。建議使用 X-Session-ID 標頭代替。僅在不支持自訂標頭的環境中使用此參數。
array
可供助手使用的外部工具定義陣列。每個工具應該有一個 type(目前僅支持 “function”)和一個包含 namedescriptionparameters(JSON Schema 格式)的 function 物件。
請求範例:
帶工具的請求範例:

回應頭

string
對話的會話 ID。此頭部會在回應中返回,可用於後續請求。

回應

string
完成的唯一標識符
string
物件類型(“chat.completion”)
number
完成創建時的 Unix 時間戳
string
用於完成的模型
array
完成選項陣列
string
對話的會話 ID
array
助手進行的工具調用陣列(當提供並使用工具時)
string
完成終止的原因。正常完成時為 “stop”,調用工具時為 “tool_calls”。
回應範例:
帶工具調用的回應範例:

流式回應

stream 設置為 true 時,回應將以伺服器發送事件(SSE)的形式流式傳輸。每個事件包含以下格式的回應塊:
最後一個塊將有 finish_reason: "stop",並跟隨 data: [DONE]

錯誤回應

使用工具

當您在請求中提供工具時,助手可以在對話中調用它們。在收到帶有 tool_calls 的回應後,您應該:
  1. 使用提供的參數執行請求的工具
  2. 在後續請求中以 “tool” 角色訊息發送工具結果
  3. 助手然後將使用工具結果來製定其最終回應

工具訊息格式

收到工具調用後,發送結果:

設置指南

  1. 前往 Project Settings > API Keys 建立新的 API 金鑰
  2. 立即複製金鑰(金鑰僅顯示一次)
  3. 在請求中使用 Authorization: Bearer {your-api-key} 頭部
  4. (可選)使用會話 API建立會話以維持對話連續性
  5. (可選)定義並提供工具以擴展功能