curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/employees/{employee_external_id}/recommended_courses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": [
    {
      "filter": "custom_property",
      "property_name": "yearly_salary",
      "operator": "gte",
      "property_value": true
    }
  ],
  "weights": [
    {
      "weight": "skills_match",
      "value": 1
    }
  ]
}'
{
  "results": [
    {
      "score": 0.8,
      "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
employee_external_id
string
required

Unique external ID linked to this Employee, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Query Parameters

​
limit
integer
default:
10

The maximal number of results returned.

Required range: 1 < x < 100
​
score_min_threshold
number
default:
0.5

The minimum score of the results. Due to approximations for fast result-delivery, there might be records with a score slightly lower than the minimum.

Required range: 0 < x < 1
​
response_format
enum<string>
default:
simple

If set to explained, the response will include an explanation of the recommendation.

Available options:
simple,
explained
​
use_adjacent_skills
boolean
default:
true

If set to true, Course recommendations will consider adjacent Skills in addition to literal Skill overlap. If set to false, recommendations will be based solely on literal Skill overlap.

​
include
enum<string>[]

Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes. When include entity is used, the response will include the titles and descriptions of the recommended Courses.

Available options:
custom_properties,
entity

Body

application/json
​
filters
object[]
required
​
weights
object[]
required

Response

200
application/json
OK
​
results
object[]
required

List of match results.

Was this page helpful?