▣ DEVELOPER TOOLS · HR

Related Skills Generator API

What it does

Related Job Skills takes a job title or role description and returns a ranked list of related job positions or skills. Send content, and optionally set language and max_quantity; you get back a job ID immediately, then poll the status URL for the finished result.

The completed response includes a status value and a result array. Each item in result contains a name and a weight, so you can sort or filter the suggestions by relevance. This makes it useful when you want to expand a role into adjacent titles for search, recommendation, taxonomy building, or internal HR workflows.

Use it to suggest similar positions around a seed role like "Frontend Developer" or "Sales Manager" when building job matching features, career-path navigation, or role discovery tools. Because the output is structured and weighted, you can plug it directly into ranking logic instead of parsing free text.

Related Job Skills is asynchronous, so it fits longer-running generation tasks without blocking your app. Submit a job, poll until status becomes success, and read the returned related positions from the result array.

▣ ENDPOINT 01 / 02

POST

Related Skills Generator - Submit Job

https://api.eu.apyverse.com/sharpapi/related-skills-generator

QUICKSTART

GUIDE

Quickstart

Submit a job to generate related job positions from a role title.

curl -X POST "https://api.eu.apyverse.com/sharpapi/related-skills-generator" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"content":"Product Manager","language":"English","max_quantity":5}'

What you'll get back

Returns a JSON object with a job_id string and a status_url string. job_id is the unique identifier of the submitted job, and status_url is the URL you can poll for the job's status and result.

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status_url": "https://example.com/jobs/550e8400-e29b-41d4-a716-446655440000"
}

TRY ITLIVE · 50 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Submits an asynchronous job to generate related skills based on a provided job position or role. The request sends the role details and returns a JSON object with the submitted job’s identifier and a status URL for polling the result.

Request Body

Parameter	Type	Mandatory	Description
content	String	Yes	Provide a job position/role to generate related job positions for.
language	String	No	Specify the language of the output. Default: `English`.
max_quantity	Number	No	Maximum number of related job positions to generate. Minimum: `1`.

Response

Returns a JSON object with two string fields: job_id and status_url. job_id is the unique identifier of the submitted job, and status_url is the URI used to poll for the job’s status and result.

Parameter	Type	Mandatory	Description
job_id	String	No	The unique identifier of the submitted job. Format: UUID.
status_url	String	No	URL to poll for the job's status and result. Format: URI.

Notes

This endpoint kicks off an async job and returns immediately with a job identifier; the actual work runs in the background. Pair this call with the corresponding job_check endpoint — poll that until the status reaches a terminal state to retrieve the result. Extract the job identifier from job_id.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ ENDPOINT 02 / 02

GET

Related Skills Generator - Check Job Status

https://api.eu.apyverse.com/sharpapi/related-skills-generator/job/status/:job_id

QUICKSTART

GUIDE

Quickstart

Check the status of a related-skills generation job by its job ID.

curl -X GET "https://api.eu.apyverse.com/sharpapi/related-skills-generator/job/status/:job_id" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a data object. data contains id and type, plus an attributes object with type, result, and status. attributes.result is an array of related skill/job objects, each with name and weight.

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "api_job_result",
    "attributes": {
      "type": "hr_related_skills",
      "result": [
        {
          "name": "Talent Acquisition Specialist",
          "weight": 0.92
        }
      ],
      "status": "success"
    }
  }
}

TRY ITLIVE · 1 ATOM

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Checks the status of a related-skills-generation job using its UUID job ID. The response returns the job result wrapper and, once the job completes successfully, the related skills data in the result array.

Path Parameter(s)

Attribute	Type	Mandatory	Description
job_id	String	Yes	Job identifier, UUID format.

Response

Returns a JSON object with a data object field. data contains id and type, plus an attributes object with type, result, and status; attributes.result is an array of objects with name and weight, and attributes.status is one of running, failed, queued, or success.

Attribute	Type	Mandatory	Description
data	Object	No	Wrapper object containing the job result payload.
data.id	String	No	Job result identifier, UUID format.
data.type	String	No	Resource type for the job result.
data.attributes	Object	No	Job attributes wrapper containing the result metadata.
data.attributes.type	String	No	Result type value.
data.attributes.result	Object Array	No	Related job positions/skills returned when the job succeeds. Each item includes `name` and `weight`.
data.attributes.result[].name	String	No	Name of the related job position/skill.
data.attributes.result[].weight	Number	No	Relevance weight of the related job position/skill.
data.attributes.status	ENUM	No	Job status. Allowed values: `running`, `failed`, `queued`, `success`.

Path parameters

Name

Type

Description

job_idREQUIRED

string

—

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.