Get Session

Getting an existing session

This method simply allows you to get the session information given if you provide the correct session id
Parameter NameDefault ValueRequiredDescription
session_idNULLTrueThe Session ID given when creating a session with the Create Session method

Example Success Response

This response is given when a session was successfully found
{
  "success": true,
  "response_code": 200,
  "results": {
    "session_id": "46db504f80a9eadd0fbec43ff4f75690962242b5c57fb23f6e4f2a23423bcab8",
    "language": "en",
    "available": true,
    "expires": 1581899765
  }
}

Session Object Structure

NameTypeDescription
session_idstringThe ID of the session that must be used for requests like "Think Thought"
languagestringThe ISO 639-1 Language code that this session is based in
availablebooleanIndicates if this session is available or not. A session can be unavailable if it has expired or a session error raises
expiresintegerThe Unix Timestamp for when this session will expire

Example Session Not Found Response

This response is given when the given session id was not found
{
  "success": false,
  "response_code": 404,
  "error": {
    "error_code": 4,
    "type": "CLIENT",
    "message": "The session was not found"
  }
}