Profiles

A user does not require a profile, providing this information is optional. Providing profile information is recommended. Accurate profile information helps to train the speech models and improves the quality.

Create a profile

Link a profile to a user. If a user already has a profile, modified parameters will be overwritten.

URL

POST /users/:userId/profile HTTP/1.1

Input

Name	Type	Description
birthYear	int	Optional The user's year of birth.
gender	string	Optional The user's gender ("m" = male, "f" = female, "x" = other).
country	string	Optional The country of the user's mother tongue.
language	string	Optional The language of the user's mother tongue. In ISO 639-2 format.
cefr	int	Optional The user's CEFR level.

cefr

The "cefr" input parameter is an integer value which maps to official CEFR values, for more information see: CEFR (Common European Framework of Reference).

int	Value
0	no score
1	< A1
2	A1
3	A2
4	A2+
5	B1
6	B1+
7	B2
8	B2+
9	C1
10	C2

Request

POST /users HTTP/1.1
Accept: application/json
Content-Type: application/json

{
  "birthYear": 1923,
  "gender": "m",
  "country": "Netherlands",
  "language": "nld",
  "cefr": 1
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

{
  "birthYear": 1923,
  "gender": "m",
  "country": "Netherlands",
  "language": "nld",
  "cefr": 1,
  "created": "2016-12-22T02:14:05Z",
  "updated": "2016-12-22T02:14:05Z"
}

Get the profile of a user

URL

GET /users/:userId/profile HTTP/1.1

Request

GET /users/user_23/profile HTTP/1.1
Accept: application/json

Response

HTTP/1.1 200 Created
Content-Type: application/json

{
  "birthYear": 1923,
  "gender": "m",
  "country": "Netherlands",
  "language": "nld",
  "cefr": 1,
  "created": "2017-01-03T12:16:55Z",
  "updated": "2017-01-03T12:16:55Z"
}

Get the profile of the current user

URL

GET /user/profile HTTP/1.1

Request

GET /user/profile HTTP/1.1
Accept: application/json

Response

HTTP/1.1 200 Created
Content-Type: application/json

{
  "birthYear": 1923,
  "gender": "m",
  "country": "Netherlands",
  "language": "nld",
  "cefr": 1,
  "created": "2017-01-03T12:16:55Z",
  "updated": "2017-01-03T12:16:55Z"
}