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,以便正确管理它们