Delete Widget Session

DELETE/v1/widget/sessions/{session_id}

Terminate an active widget session.

About Session Termination

Deleting a widget session immediately terminates the session and prevents the widget from functioning. This is useful when you need to:

  • Revoke access for security reasons
  • End a session before its natural expiration
  • Clean up unused or expired sessions
  • Force logout of all users using a specific session

Request History

Log in to see full request history

TIMESTATUSUSER AGENT
Make a request to see history.

0 Requests This Month

Path Parameters

ParameterTypeDescription
session_idstringThe unique identifier of the session to delete. This is the same session_id returned when creating the session.

Request Example

shell
curl -X DELETE https://api.konpro.ai/v1/widget/sessions/{session_id} \
  -H "x-api-key: <your-api-key>" \
  -H "Content-Type: application/json"

Response

FieldTypeDescription
messagestringSuccess message confirming the session termination (e.g., "Session terminated successfully")
session_idstringThe unique identifier of the terminated session

Sample Successful Response

json
{
  "message": "Session terminated successfully",
  "session_id": "session-789"
}

Notes

  • This endpoint requires authentication using the x-api-key header.
  • Replace {session_id} in the URL with the actual session ID you want to delete.
  • You can only delete sessions that belong to your account.
  • Once a session is deleted, the widget will immediately stop functioning for all users using that session token.
  • This action is permanent and cannot be undone. The session cannot be reactivated after deletion.
  • If you need to use the widget again after deletion, you'll need to create a new session using the Create Widget Session endpoint.
  • Deleting a session does not affect the agentic avatar itself - only the session token is terminated.
  • For error descriptions, see Error Responses.

Table of Contents