POST
/
api
/
project
/
{projectId}
/
integration
/
api
/
chat
/
completions
curl --request POST \
  --url https://app.pathors.com/api/project/{projectId}/integration/api/chat/completions \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "messages": [
    {}
  ],
  "stream": true,
  "session_id": "<string>"
}'
{
  "id": "<string>",
  "object": "<string>",
  "created": 123,
  "model": "<string>",
  "choices": [
    {}
  ],
  "session_id": "<string>"
}

API 整合提供了一個 OpenAI 兼容的聊天完成端點，您可以用它來與您的 Pathors 專案進行互動。

​
聊天完成

​
路徑參數

​
projectId
string
required

您的專案 ID

​
請求頭

​
Authorization
string
required

使用您的 API 金鑰進行 Bearer 令牌認證

​
X-Session-ID
string

會話 ID，用於對話連續性。強烈建議使用此標頭傳遞會話 ID，而不是請求體中的 session_id 參數。

​
請求體

​
messages
array
required

對話中的訊息陣列。每條訊息都應該有一個 role（“system”、“user” 或 “assistant”）和 content。

​
stream
boolean

是否流式傳輸回應。默認為 false。

​
session_id
string

(deprecated) 會話 ID，用於對話連續性。建議使用 X-Session-ID 標頭代替。僅在不支持自訂標頭的環境中使用此參數。

請求範例：

{
  "messages": [
    {
      "role": "user",
      "content": "你好！"
    }
  ],
  "stream": false
}

​
回應頭

​
X-Session-ID
string

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

​
回應

​
id
string

完成的唯一標識符

​
object
string

物件類型（“chat.completion”）

​
created
number

完成創建時的 Unix 時間戳

​
model
string

用於完成的模型

​
choices
array

完成選項陣列

​
session_id
string

對話的會話 ID

回應範例：

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1677858242,
  "model": "pathway-default",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "你好！我能幫你什麼忙？"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": -1,
    "completion_tokens": -1,
    "total_tokens": -1
  },
  "session_id": "session-xyz789"
}

​
流式回應

當 stream 設置為 true 時，回應將以伺服器發送事件（SSE）的形式流式傳輸。每個事件包含以下格式的回應塊：

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion.chunk",
  "created": 1677858242,
  "model": "pathway-default",
  "choices": [
    {
      "index": 0,
      "delta": {
        "content": "你好"
      },
      "finish_reason": null
    }
  ],
  "session_id": "session-xyz789"
}

最後一個塊將有 finish_reason: "stop"，並跟隨 data: [DONE]。

​
錯誤回應

狀態碼描述
400無效的請求體
401無效的認證
500內部伺服器錯誤

​
設置指南

  1. 在您的 Pathors 專案設置中啟用 API 整合
  2. 在您專案的整合設置中生成 API 金鑰
  3. 在您的請求中使用 API 金鑰作為 Authorization 頭部