Dashboard Sign InKR

[GET] Get User

You can retrieve the information of an existing user using the user identifier.

Request

URL

GET https://api.asleep.ai/ai/v1/users/{user_id}

Header

FieldTypeRequiredDescription
x-api-keyStringOAPI Key

Path Parameter

FieldTypeRequiredDescription
user_idStringOuser id

Example

curl "https://api.asleep.ai/ai/v1/users/{user_id}" -XGET \
  -H "x-api-key: <YOUR_API_KEY>"

Response

200 OK

Body (result field)

FieldTypeDescription
user_idStringuser id
to_be_deletedBooleanwhether the user is marked for deletion
last_session_infoSession Object or nullinformation about the last session

Session Object

if state == OPEN: session_end_time is null

if state != COMPLETE: complete_end_time is null

FieldTypeDescription
session_idStringsession id
inference_typeStringformat of the audio data uploaded in the session
serviceStringname of the service specified when creating the session
start_timeString (YYYY-MM-DDThh:mm:ssZ)start time of the session
end_timeString (YYYY-MM-DDThh:mm:ssZ)?end time of the session
stateString (OPEN,CLOSED,COMPLETE)state of the session
complete_timeString (YYYY-MM-DDThh:mm:ssZ)?completion time of the final session analysis
if state != COMPLETE complete_tims is null
{
  "detail": "success",
  "result": {
    "user_id": "<USER_ID>",
    "to_be_deleted": false,
    "last_session_info": {
      "session_id": "20230630224117",
      "inference_type": "MELSPECTROGRAM",
      "service": "NOSERVICE",
      "start_time": "2023-06-30T22:41:17",
      "end_time": "2023-07-01T05:36:12",
      "state": "COMPLETE",
      "complete_time": "2023-07-01T05:41:12"
    }
  }
}

404 Not Found

  • user corresponding to x-user-id does not exist
{
  "detail": "user does not exist"
}