Reference - Skill Enrichment API

Reference information for the Skill Enrichment API

Endpoint

The endpoint for the Skill Enrichment API is v5/skill/enrich.

Billing and Access

This API is currently in production and users can access it using their API key.

When a matching job title is returned, the HTTP response code will be 200, and when no matching job title is found or returned, the HTTP response code will be a 404. We charge per match.

Rate Limiting

Our default limit for free customers is 100/min. Our default limit for paying customers is 5000/min.

Input Parameters

📘

For More Details, See Skill Enrichment API - Input Parameters

You can also click on the individual parameter names in the table below to view more information.

Parameter Name

Required

Description

Default

Example

skill

Yes

The skill that you are enriching.

None

pyspark

pretty

No

Whether the output should have human-readable indentation.

False

True

api_key

No

Not required as part of the request parameters. But if not provided here, then it must be provided in the headers using the x-api-key field. For more information, see the Authentication page.

None

Output Response

Response Fields

📘

For More Details, See Skill Enrichment API - Output Response.

You can also click the field names in the table below to view more information.

Field Name

Type

Description

cleaned_skill

String

The skill that matches the API input skill after it's passed through our internal skill cleaner.

similar_skills

Array (String)

A list of up to five other skills.

relevant_job_titles

Array (String)

A list of up to five of the most contextually-similar job titles to the cleaned_skill, determined using PDL’s global resume data.

Full Example Response

Input Query (click to toggle)
import requests

url = "https://api.peopledatalabs.com/v5/skill/enrich"

query_string = {"skill": "ai"}

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'x-api-key': "YOUR_API_KEY"
    }

response = requests.request("GET", url, headers=headers, params=query_string)

print(response.text)

Output Response (full):

{
  "cleaned_skill": "ai",
  "similar_skills": [
    "machine learning",
    "artificial intelligence",
    "deep learning",
    "data science",
    "iot"
  ],
  "relevant_job_titles": [
    "data scientist",
    "software engineer",
    "senior data scientist",
    "chief technology officer",
    "senior software engineer"
  ]
}

Did this page help you?