Get Widget Session

GET/v1/widget/sessions/{session_id}

Retrieve details of a widget 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

Request Example

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

Response

FieldTypeDescription
session_idstringUnique identifier of the widget session
agentic_avatar_idstringThe unique identifier of the agentic avatar associated with this session
statusstringCurrent status of the session (e.g., active)
created_atstringISO 8601 timestamp of when the session was created
expires_atstringISO 8601 timestamp of when the session expires

Sample Successful Response

json
{
  "session_id": "session-789",
  "agentic_avatar_id": "3deccfb2-cf96-459c-8b69-f601d6767ea5",
  "status": "active",
  "created_at": "2024-01-01T00:00:00Z",
  "expires_at": "2024-01-01T01:00:00Z"
}

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 retrieve.
  • The session_id must be a valid session ID from your account.
  • The status field indicates whether the session is currently active or has been terminated.
  • For error descriptions, see Error Responses.

Table of Contents