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

結束會話

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

路徑參數

projectId
string
required
您的專案 ID

請求標頭

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

請求內容

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

回應

message
string
會話已結束的確認訊息
sessionId
string
已結束會話的 ID

範例

請求

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

回應

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

使用說明

  • 資源清理: 結束會話有助於釋放伺服器資源,應該在對話完成時執行
  • 會話變數: 當會話結束時,所有會話變數和對話上下文都將被永久刪除
  • 冪等操作: 嘗試結束已經結束或不存在的會話將回傳適當的錯誤

錯誤回應

狀態碼描述
400缺少或無效的 session_id
401無效的身份驗證
404會話未找到
500內部伺服器錯誤
錯誤回應範例:
{
  "error": "Session not found"
}

最佳實踐

  1. 始終結束會話: 在對話完成時結束會話以防止資源洩漏
  2. 錯誤處理: 優雅地處理 404 錯誤,因為會話可能已經被結束
  3. 會話追蹤: 在您的應用程式中追蹤活躍的會話 ID,以便正確管理它們