Competency Framework

Adding Competencies

The essential first step of any flow with the Skill Engine API is creating the Entities within the system.

For example, to create a Competency you can simply submit a POST request to /competencies:

{
  "external_id": "CP-001",
  "competency_name": "Data Science Modelling",
  "competency_description": "The ability to use machine learning algorithms to extract value from data"
}

The sequence diagram below shows the communication steps:

Your SystemSkill Engine APIPOST /competenciesSkill Extraction✅ HTTP 204 No ContentSkill Extraction Failed❌ HTTP 422 Unprocessable Entity❌ HTTP 409 Conflictalt[Creation Successful][Creation Failed][Entity Already Exists]Your SystemSkill Engine API

After the initial creation, the Competency can be updated by sending a PATCH request to /competencies/CP-001. More information can be found at the endpoint specification .

The lifecycle of each Entity is managed explicitly, meaning that you cannot overwrite an existing Entity with a POST message. To update an Entity, you can execute a PATCH call at its specific endpoint.