Job Description Generator API
SharpAPI
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.
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
Method:
POST
Content Type:
application/json
Request Body
Attribute | Type | Mandatory | Description |
---|---|---|---|
name | String | Yes | The job title for the position (e.g., Senior PHP Software Engineer). |
company_name | String | No | The name of the company offering the position (e.g., Apple Inc). |
minimum_education | String | No | The minimum required education level (e.g., Bachelor Degree). |
minimum_work_experience | String | No | The minimum required work experience (e.g., 5 years). |
employment_type | String | No | Type of employment (e.g., full time, part time, contract). |
country | String | No | The country where the job is located (e.g., United Kingdom). |
remote | Boolean | No | Specifies if the job is remote (true or false). |
visa_sponsored | Boolean | No | Specifies if visa sponsorship is available (true or false). |
required_skills | Array of Strings | No | A list of required skills for the position (e.g., { "PHP8", "Laravel"}). |
optional_skills | Array of Strings | No | A list of optional skills for the position (e.g., {"AWS RDS", "GitFlow"}). |
language | String | No | The language for the job description (e.g., English). |
voice_tone | String | No | The tone of voice for the description (e.g., neutral, professional). |
context | String | No | Additional context or requirements (e.g., add requirement of C-class driving license). |
Sample Response
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
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