Skip to main content
DELETE
/
api
/
project
/
{projectId}
/
integration
/
api
/
session
End 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>"
}'
{
  "success": true,
  "sessionId": "<string>",
  "message": "<string>"
}
End an existing session when the conversation is complete. This is useful for cleanup and resource management.

​
End Session

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

​
Path Parameters

​
projectId
string
required
The ID of your project

​
Request Headers

​
Authorization
string
required
Bearer token authentication using your API key

​
Request Body

​
session_id
string
required
The unique identifier of the session to end

​
Response

​
success
boolean
Indicates whether the session was successfully ended
​
sessionId
string
The ID of the ended session
​
message
string
Confirmation message that the session has been ended

​
Example

​
Request

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"
  }'

​
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 CodeDescription
400Missing or invalid session_id
401Invalid authentication
500Internal server error
Example error responses: 400 Bad Request: 
{
  "error": "session_id is required"
}
401 Unauthorized: 
{
  "error": {
    "message": "Invalid authentication"
  }
}

​
Best Practices

  1. Always End Sessions: End sessions when conversations are complete to prevent resource leaks
  2. Error Handling: Handle errors gracefully and implement appropriate retry logic for failed requests
  3. Session Tracking: Keep track of active session IDs in your application to manage them properly
⌘I