Related Job Positions Generator API

Artificial Intelligence Data Extraction HR

#cv #hr #resume

job

SharpAPI

1000 atoms

AI tier

About

This API generates related job positions with relevance scores based on a given job title.

This API is ideal for developers working on job recommendation engines, HR platforms, resume analysis tools, or career planning applications. By returning similar job roles with float-based relevance scores (1.0 to 10.0), this API enables smarter job matching, better role discovery, and enhanced candidate experience. It supports use cases like identifying alternative roles, improving job search features, and building adaptive career path suggestions.

Try out the Related Job Positions Generator API in the API playground for free to enrich HR applications, optimize job matching logic, and streamline career guidance tools.

Apy Jobs are long running calls which are split into two actions:
1. Submitting the job
2. Checking the status of the job and receiving the response on successful completion of the job.

Select API Endpoints

Input(s)

submit

check

API Playground

Related Job Positions Generator Submit Job

POST

https://api.apyhub.com/sharpapi/api/v1/hr/related_job_positions

Request example

1
```cURL
2

3
curl --location --request POST 'https://api.apyhub.com/sharpapi/api/v1/hr/related_job_positions' \
4
--header 'apy-token: {{token}}' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
    "content": "Flutter Mobile Developer",
8
    "language": "German",
9
    "max_quantity": 4
10
}'

Method: POST

Content Type: application/json

Request Body

Attribute	Type	Mandatory	Description
content	String	Yes	Provide job position/role to generate related job positions
language	String	No	Specify the language of the output, defaults to `English`
max_quantity	Number	No	Maximum number of related job positions to generate

Sample Response

1
{
2
  "status_url": "https://api.apyhub.com/sharpapi/api/v1/hr/related_job_positions/job/status/5de4887a-0dfd-49b6-8edb-9280e468c210",
3
  "job_id": "5de4887a-0dfd-49b6-8edb-9280e468c210"
4
}

HTTP Response Codes

The method may return one of the following HTTP status codes:

Status Code	Description
202	The job was submitted successfully.
401	Required authentication information is either missing or not valid for the resource.
400	Invalid input - if the file is invalid or corrupted
500	If any unexpected error occurs while submitting the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".

Points to note:

Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
Use the apy-token as the header parameter to pass the token.
Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}

To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.

Search by code

Table of contents

AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles

Related Job Positions Generator API

About

API Playground

Request example

HTTP Response Codes

Authentication

Error codes

101 - Missing parameters

102 - Invalid JSON

103 - Invalid input

104 - Invalid file

105 - Invalid URL

109 - Invalid input format

110 - Server error