跳轉到主要內容
DELETE
/
project
/
{projectId}
/
integration
/
api
/
session
結束會話
curl --request DELETE \
  --url https://app.pathors.com/project/{projectId}/integration/api/session \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "session_id": "<string>"
}'
{
  "success": true,
  "sessionId": "<string>",
  "message": "<string>"
}
當對話完成時結束現有會話。這對於資源清理和管理很有用。

​
基礎 URL

https://api.pathors.com

​
結束會話

DELETE /project/{projectId}/integration/api/session

​
路徑參數

​
projectId
string
required
您的專案 ID

​
請求標頭

​
Authorization
string
required
使用您的 API 金鑰進行 Bearer 權杖認證

​
請求內容

​
session_id
string
required
要結束的會話的唯一識別符

​
回應

​
success
boolean
指示會話是否成功結束
​
sessionId
string
已結束會話的 ID
​
message
string
會話已結束的確認訊息

​
範例

​
請求

curl -X DELETE https://api.pathors.com/project/{projectId}/integration/api/session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "session_id": "user-123-session-456"
  }'

​
回應

{
  "success": true,
  "sessionId": "user-123-session-456",
  "message": "Session ended successfully"
}

​
使用說明

  • 資源清理: 結束會話有助於釋放伺服器資源，應該在對話完成時執行
  • 會話變數: 當會話結束時，所有會話變數和對話上下文都將被永久刪除
  • 會話管理: API將嘗試結束指定的會話。無論會話是否處於活躍狀態，都會回傳成功回應

​
錯誤回應

狀態碼描述
400缺少或無效的 session_id
401無效的身份驗證
500內部伺服器錯誤
錯誤回應範例： 400 請求錯誤: 
{
  "error": "session_id is required"
}
401 身份驗證失敗: 
{
  "error": {
    "message": "Invalid authentication"
  }
}

​
最佳實踐

  1. 始終結束會話: 在對話完成時結束會話以防止資源洩漏
  2. 錯誤處理: 優雅地處理錯誤並為失敗的請求實施適當的重試邏輯
  3. 會話追蹤: 在您的應用程式中追蹤活躍的會話 ID，以便正確管理它們