Dashboard Sign InKR

Get User

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

1. Request

1.1 URL

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

1.2 Header

FieldTypeRequiredDescription
x-api-keyStringOAPI Key

1.3 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>"

2. Response

2.1 200 OK

  • Successful retrieval of user information

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

Field

Type

Description

session_id

String

session id

inference_type

String

format of the audio data uploaded in the session

service

String

name of the service specified when creating the session

start_time

String (YYYY-MM-DDThh:mm:ssZ)

start time of the session

end_time

String (YYYY-MM-DDThh:mm:ssZ)?

end time of the session

state

String (OPEN,CLOSED,COMPLETE)

state of the session

complete_time

String (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"
    }
  }
}

2.2 401 Unauthorized

  • The x-user-id header value is missing or in the wrong format
{
  "detail": "invalid user id"
}

2.3 404 Not Found

  • User does not exist
{
  "detail": "user not exist"
}