Skip to main content
DELETE
/
project
/
{projectId}
/
session
结束会话
curl --request DELETE \
  --url https://api.pathors.com/project/{projectId}/session \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_id": "<string>"
}
'
{
  "success": true,
  "sessionId": "<string>",
  "message": "<string>"
}
当对话完成时结束现有会话。这对于资源清理和管理很有用。

结束会话

DELETE /project/{projectId}/session

路径参数

projectId
string
required
您的项目 ID

请求头

Authorization
string
required
使用您的 Project API Key(以 sk_ 开头)进行 Bearer 令牌认证。格式:Bearer {your-api-key}

请求体

session_id
string
required
要结束的会话的唯一标识符

响应

success
boolean
指示会话是否成功结束
sessionId
string
已结束会话的 ID
message
string
会话已结束的确认消息

示例

请求

curl -X DELETE https://api.pathors.com/project/{projectId}/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,以便正确管理它们