> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peopledatalabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Reference - Skill Enrichment API

> ❗️ The Skill Enrichment API is now fully removed
>
> This endpoint was removed in our April 2025 (v30.0) Release and is no longer available. This page is retained for historical documentation purposes.
>
> For more information, please see our [April 2025 Release Notes (v30.0)](https://docs.peopledatalabs.com/changelog/april-2025-release-notes-v300).

## Endpoint

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

## Billing and Access

This API is currently in production, and you can access it by using your API key.

The HTTP response code will be `200` when the API returns a matching job title, and the response code will be `404` when the API neither finds nor returns a matching job title. We charge per match.

## Rate Limiting

Our default limit for free customers is 100 per minute. Our default limit for paying customers is 5,000 per minute.

## Input Parameters

> 📘 For More Details, See [Skill Enrichment API - Input Parameters](https://docs.peopledatalabs.com/docs/input-parameters-skill-enrichment-api)
>
> You can also click on the individual parameter names in the table below to view more information on them.

<Table align={["left","left","left","left","left"]}>
  <thead>
    <tr>
      <th>
        Parameter Name
      </th>

      <th>
        Required
      </th>

      <th>
        Description
      </th>

      <th>
        Default
      </th>

      <th>
        Example
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        [`skill`](https://docs.peopledatalabs.com/docs/input-parameters-skill-enrichment-api#skill)
      </td>

      <td>
        Yes
      </td>

      <td>
        The skill that you are enriching.
      </td>

      <td />

      <td>
        `pyspark`
      </td>
    </tr>

    <tr>
      <td>
        [`api_key`](https://docs.peopledatalabs.com/docs/input-parameters-skill-enrichment-api#api_key)
      </td>

      <td>
        No\*
      </td>

      <td>
        Your secret API key.

        While we do not require this as part of the request parameters, if you do not provide it here, then you must provide it using an alternative means, such as in the headers using the `x-api-key` field. For more information, see the [Authentication](https://docs.peopledatalabs.com/docs/authentication) page.
      </td>

      <td />

      <td />
    </tr>

    <tr>
      <td>
        [`pretty`](https://docs.peopledatalabs.com/docs/input-parameters-skill-enrichment-api#pretty)
      </td>

      <td>
        No
      </td>

      <td>
        Whether the output should have human-readable indentation.
      </td>

      <td>
        `false`
      </td>

      <td>
        `true`
      </td>
    </tr>

    <tr>
      <td>
        [`titlecase`](https://docs.peopledatalabs.com/docs/input-parameters-skill-enrichment-api#titlecase)
      </td>

      <td>
        No
      </td>

      <td>
        All text in the API responses returns as lowercase by default. Setting `titlecase` to `true` will titlecase the text in `200` responses.
      </td>

      <td>
        `false`
      </td>

      <td>
        `true`
      </td>
    </tr>
  </tbody>
</Table>

## Output Response

### Response Fields

> 📘 For More Details, See [Skill Enrichment API - Output Response](https://docs.peopledatalabs.com/docs/output-response-skill-enrichment-api).
>
> You can also click the field names in the table below to view more information on them.

| Field Name                                                                                                             | Type             | Description                                                                                                                       |
| :--------------------------------------------------------------------------------------------------------------------- | :--------------- | :-------------------------------------------------------------------------------------------------------------------------------- |
| [`cleaned_skill`](https://docs.peopledatalabs.com/docs/output-response-skill-enrichment-api#cleaned_skill)             | `String`         | The skill that matches the API input `skill` after passing it through our internal skill cleaner.                                 |
| [`similar_skills`](https://docs.peopledatalabs.com/docs/output-response-job-title-enrichment-api#similar_job_titles)   | `Array (String)` | A list of up to five other skills.                                                                                                |
| [`relevant_job_titles`](https://docs.peopledatalabs.com/docs/output-response-skill-enrichment-api#relevant_job_titles) | `Array (String)` | A list of up to five of the most contextually-similar job titles to the `cleaned_skill`, determined using our global resume data. |

### Full Example Response

<details>
  <summary>Input Query (click to toggle)</summary>

  ```python
  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)
  ```
</details>

Output Response (full):

```json
{
  "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"
  ]
}
```