Job Description Generator API - ApyHub

Job Description Generator API

Artificial IntelligenceData ExtractionHR#cv#hr#resume
job
SharpAPI
SharpAPI
verified icon
1000 atoms
AI tier

About

The Job Description Generator API generates a concise, comprehensive job description based on input parameters like job title, company, education, experience, and required skills. This API is ideal for creating consistent and high-quality job postings, significantly simplifying the hiring process.
Developers can use this API to enhance HR applications, recruitment platforms, or job boards. It streamlines the creation of job descriptions, saving time and ensuring accuracy. The API is particularly useful for automating job postings, integrating with applicant tracking systems, and improving HR software solutions.
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)

API Playground

API Documentation

Job Description Generator Submit Job
POST
https://api.apyhub.com/sharpapi/api/v1/hr/job_description

Request example

1
```cURL
2


3
curl --location --request POST 'https://api.apyhub.com/sharpapi/api/v1/hr/job_description' \
4
--header 'apy-token: {{token}}' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
    "name": "Senior PHP Software Engineer",
8
    "company_name": "Apple Inc",
9
    "minimum_education": "Bachelor Degree",
10
    "minimum_work_experience": "5 years",
11
    "employment_type": "full time",
12
    "country": "United Kingdom",
13
    "remote": true,
14
    "visa_sponsored": true,
15
    "required_skills": [
16
		"PHP8",
17
		"Laravel",
18
		"MySQL"
19
    ],
20
    "optional_skills": [
21
		"AWS RDS",
22
		"AWS Aurora",
23
		"GitFlow"
24
    ],
25
    "language": "English",
26
    "voice_tone": "neutral",
27
    "context": "add requirement of C-class driving license"
28
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
nameStringYesThe job title for the position (e.g., Senior PHP Software Engineer).
company_nameStringNoThe name of the company offering the position (e.g., Apple Inc).
minimum_educationStringNoThe minimum required education level (e.g., Bachelor Degree).
minimum_work_experienceStringNoThe minimum required work experience (e.g., 5 years).
employment_typeStringNoType of employment (e.g., full time, part time, contract).
countryStringNoThe country where the job is located (e.g., United Kingdom).
remoteBooleanNoSpecifies if the job is remote (true or false).
visa_sponsoredBooleanNoSpecifies if visa sponsorship is available (true or false).
required_skillsArray of StringsNoA list of required skills for the position (e.g., { "PHP8", "Laravel"}).
optional_skillsArray of StringsNoA list of optional skills for the position (e.g., {"AWS RDS", "GitFlow"}).
languageStringNoThe language for the job description (e.g., English).
voice_toneStringNoThe tone of voice for the description (e.g., neutral, professional).
contextStringNoAdditional context or requirements (e.g., add requirement of C-class driving license).
Sample Response
1
{
2
  "status_url": "https://api.apyhub.com/sharpapi/api/v1/hr/job_description/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 CodeDescription
202The job was submitted successfully.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - if the file is invalid or corrupted
500If 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.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles