Suggest Skills

The /professions/suggest_skills endpoint provides skills related to a given profession. The service returns salient skills that are strongly associated with the profession, but not too generic either.

Endpoint

Method	Media	URL
POST	application/json	https://api.textkernel.nl/professions/v1/suggest_skills

Input parameters

Parameter	Type	Default	Description
code_ids	list str	None (required)	The profession code IDs for which the service should return related skills. The list can contain up to 10 profession codes.
limit	int	10	The maximum amount of suggested skills returned. This parameter can be set either as URL parameter (as in the example below) or in the request body. The URL parameter will take precedence over the value set in the request body.
output_language	str	None (optional)	Parameter to set the language of the returned descriptions. If not set, the service will return no descriptions. Expects a language in ISO 639-1 format (e.g. "en", "nl").

Response

Status	Content type	Content description
200 (OK)	application/json	A JSON object containing: suggested_skills: the list of related skills with their relation strength meta: meta information of the service version
400 (Bad request)		The input request body is incorrect
422 (Validation error)		The input code IDs are not a valid code IDs in the Textkernel profession taxonomy.

Example

curl -X POST "https://api.textkernel.nl/professions/v1/suggest_skills?limit=3" \
        -H "Authorization: Bearer $TOKEN"\
        -H "accept: application/json" \
        -H "Content-Type: application/json" \
        -d "{\"code_ids\":[\"696\"]}"


{
  "meta": {
    "service_version": "1.0.0",
    "taxonomy_release": "2021-07-05"
  },
  "suggested_skills": [
    {
      "score": 0.9763952055685978,
      "code_id": "KS120076FGP5WGWYMP0F"
    },
    {
      "score": 0.9664422072950023,
      "code_id": "KS125HH5XDBPZT3RFGZZ"
    },
    {
      "score": 0.9658592140936507,
      "code_id": "KS124PR62MV42B5C9S9F"
    }
  ]
}

Response fields

Field	Type	Value
suggested_skills.code_id	str	The code ID of the related Skill in the Textkernel Skill taxonomy.
suggested_skills.score	float	An association score indicating the relationship strength between profession and skill. The score is a value in the range [0 - 1].
suggested_skills.description	str	The skill description as per the TK taxonomy in the specified output_language. Will only be returned if output_language is specified.

Rate limits

Accounts have a limited request rate. If you exceed the limit you will receive 429 Too Many Requests HTTP responses.

Plan	Limit	Units
Standard	1000	Minute
Demo	30	Minute

Remember to send your authentication token with each request (see Authentication).