End an existing session when the conversation is complete. This is useful for cleanup and resource management.
Base URL
End Session
DELETE https://api.pathors.com/project/{projectId}/integration/api/session
Path Parameters
Bearer token authentication using your API key
Request Body
The unique identifier of the session to end
Response
Indicates whether the session was successfully ended
The ID of the ended session
Confirmation message that the session has been ended
Example
Request
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"
}'
Response
{
"success": true,
"sessionId": "user-123-session-456",
"message": "Session ended successfully"
}
Usage Notes
- Resource Cleanup: Ending sessions helps free up server resources and should be done when conversations are complete
- Session Variables: All session variables and conversation context are permanently removed when a session is ended
- Session Management: The API will attempt to end the specified session. Success is returned regardless of whether the session was active
Error Responses
| Status Code | Description |
| 400 | Missing or invalid session_id |
| 401 | Invalid authentication |
| 500 | Internal server error |
Example error responses:
400 Bad Request:
{
"error": "session_id is required"
}
401 Unauthorized:
{
"error": {
"message": "Invalid authentication"
}
}
Best Practices
- Always End Sessions: End sessions when conversations are complete to prevent resource leaks
- Error Handling: Handle errors gracefully and implement appropriate retry logic for failed requests
- Session Tracking: Keep track of active session IDs in your application to manage them properly