Skip to content
Tx Platform
Suggest Skills From Skills

Suggest Skills From Skills🔗︎

HTTP Verb Path
POST /v10/ontology/suggest-skills-from-skills

Returns skills related to a given skill or set of skills. The service returns closely related skills in a sense that knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably easier to acquire knowledge about them.


Scope of use🔗︎

The purpose of this endpoint is to provide insights or enrich data records using our Ontology. You may store the parts of the response that are relevant to individual data records - such as candidate or employee profiles - within these records. It is not permitted to cache, store, or utilize responses from this endpoint for the purpose of limiting request volume, or to create replicas or derivatives of the Service and the Ontology.

Request Body🔗︎

Skills 🔗︎ object[] required


The skills for which the service should return related skills. The list can contain up to 50 skills.

Skills properties

Id 🔗︎ string required


The ID of the skill in the skills taxonomy.

Score 🔗︎ float


The weight that will be applied to the skill. Must be in the range [0 - 1]. These values are relative, so SkillA.Score = 0.2; SkillB.Score = 0.4; is equivalent to SkillA.Score = 0.5; SkillB.Score = 1.0;.

Limit 🔗︎ int


The maximum amount of suggested skills returned. If not specified this parameter defaults to 25. This value cannot exceed 25.

OutputLanguage 🔗︎ string


The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO codes.

Sample JSON
  "Skills": [
      "Id": "",
      "Score": 0.0
  "Limit": 25,
  "OutputLanguage": ""

Response Body🔗︎

Info 🔗︎ object


Information explaining the outcome of the transaction.

Info properties

Code 🔗︎ string


Code Description
Success Successful transaction
MissingParameter A required parameter wasn't provided
InvalidParameter A parameter was incorrectly specified
AuthenticationError An error occurred with the credentials provided
Message 🔗︎ string


This message further describes the code providing additional detail.

TransactionId 🔗︎ string


The (GUID) id for a specific API transaction. Use this when contacting about issues.

EngineVersion 🔗︎ string


The version of the parsing/matching engine running under-the-hood.

ApiVersion 🔗︎ string


The version of the API.

TotalElapsedMilliseconds 🔗︎ integer


How long the transaction took on Textkernel's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

TransactionCost 🔗︎ decimal


How many credits the transaction costs.How many credits the transaction costs.

CustomerDetails 🔗︎ object


Information about the customer who made the API call.

CustomerDetails properties

AccountId 🔗︎ string


The AccountId for the account.

Name 🔗︎ string


The customer name on the account.

IPAddress 🔗︎ string


The client IP Address where the API call originated.

Region 🔗︎ string


The region for the account, also known as the 'Data Center'.

CreditsRemaining 🔗︎ decimal


The number of credits remaining to be used by the account.

CreditsUsed 🔗︎ decimal


The number of credits used by the account.

MaximumConcurrentRequests 🔗︎ integer


The number of requests that can be made at one time. If using sub-accounts, this is the maximum number of concurent requests across all accounts, not just this single sub-account.

ExpirationDate 🔗︎ date


The date that the current credits expire.

Value 🔗︎ object


Contains response data for the transaction.

Value properties

SuggestedSkills 🔗︎ object[]


A list of skills related to the given skills.

SuggestedSkills properties

Score 🔗︎ float


A value from [0 - 1] indicating how relative this skill is to the given skills.

Id 🔗︎ string


The ID of the skill in the skills taxonomy.

Description 🔗︎ string


The description of the skill in the Skills Taxonomy. Will only be returned if OutputLanguage is specified.

Sample JSON
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "TransactionCost": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
  "Value": {
    "SuggestedSkills": [
        "Score": 0.0,
        "Id": "string",
        "Description": "string"