Based on the list of extensive parameters this endpoint provides concise job details in the response format, including the short description, job requirements, and job responsibilities.
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.
Only the name parameter is required.
You can set your preferred writing style by providing a voice_tone parameter. It can be adjectives like funny or joyous, or even the name of a famous writer.
This API method also provides an optional context parameter, which can be used to supply additional flexible instructions for content processing.
-full_size.jpg)
Check Postman Documentation
Your data is your data. Learn more about how we handle data with care and comply with privacy standards in our Data Handling and Compliance policy.
Endpoint: POST - /v1/hr/job_description
| Parameter | 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). |
REQUEST EXAMPLE:
{
"name": "Senior PHP Software Engineer",
"company_name": "Apple Inc",
"minimum_education": "Bachelor Degree",
"minimum_work_experience": "5 years",
"employment_type": "full time",
"country": "United Kingdom",
"remote": true,
"visa_sponsored": true,
"required_skills": [
"PHP8",
"Laravel",
"MySQL"
],
"optional_skills": [
"AWS RDS",
"AWS Aurora",
"GitFlow"
],
"language": "English",
"voice_tone": "neutral",
"context": "add requirement of C-class driving license"
}
RESPONSE EXAMPLE:
{
"status_url": "https://sharpapi.com/api/v1/content/translate/job/status/5de4887a-0dfd-49b6-8edb-9280e468c210",
"job_id": "5de4887a-0dfd-49b6-8edb-9280e468c210"
}
RESULT EXAMPLE:
{
"data": {
"type": "api_job_result",
"id": "081d6ba5-329d-4723-b88f-a8c88bc3a9cb",
"attributes": {
"status": "success",
"type": "hr_job_description",
"result": {
"job_requirements": "- Minimum of 5 years of experience in software engineering\n- Bachelor's Degree in Computer Science or related field\n- Proficiency in PHP8, Laravel, and MySQL\n- Familiarity with AWS RDS, AWS Aurora, and GitFlow is a plus\n- Strong problem-solving skills and attention to detail\n- Excellent communication and teamwork abilities\n- C-class driving license",
"job_responsibilities": "- Develop, test, and maintain high-quality PHP applications\n- Collaborate with cross-functional teams to define and implement new features\n- Optimize application performance and scalability\n- Ensure code quality and maintainability through code reviews and best practices\n- Troubleshoot and resolve software defects and issues\n- Stay updated with the latest industry trends and technologies\n- Mentor and guide junior developers",
"job_short_description": "We are seeking a highly skilled Senior PHP Software Engineer to join our remote team in the United Kingdom. This full-time position requires a minimum of 5 years of experience and a Bachelor's Degree. The ideal candidate will have expertise in PHP8, Laravel, and MySQL, with additional skills in AWS RDS, AWS Aurora, and GitFlow being advantageous. Visa sponsorship is available."
}
}
}
}
SharpAPI is a powerful AI-powered API, which provides a range of workflow automation endpoints to help improve efficiency across various industries. It has features for E-commerce, Content & Marketing Automation, SEO, HR Tech, and Travel & Hospitality industries.
Discover the impact of AI-powered HR tech stacks on modern recruitment challenges and how top HR APIs are reshaping the hiring landscape in 2024. Enhance candidate experience, improve efficiency, and stay competitive with innovative HR technology solutions.
So, you’re neck-deep in resumes and job descriptions, and your only defense against the deluge is a lukewarm cup of coffee. Enter SharpAPI. This isn’t just any old toolkit – this is a turbo-charged, HR tech hero. Here’s how each of these endpoint superheroes (cue dramatic music) can turn your hiring process from drudgery to, well, semi-automated bliss.
Alright, so you’ve got a stack of resumes to sift through, and you're feeling that slight existential dread knowing there are only so many hours in a day. What if you could slice through all that resume clutter with an AI-powered razor that picks out the gems for you?
HR tech is about more than just hunting for the perfect hire – it’s about creating content that attracts them and keeps them glued to your brand. Enter SharpAPI’s content automation tools, here to make your marketing team and your brand look like absolute rockstars. Imagine having a set of tools so sharp, they could slice through a clunky sentence or rescue a dull job ad, turning it into a showstopper. Let’s dive in.