README

Hr Job Description Generator API for PHP

💼 Generate professional job descriptions using AI - creates detailed JD from parameters

Check the full documentation on the Hr Job Description Generator API for PHP API page.

Quick Links

Resource	Link
Main API Documentation	Authorization, Webhooks, Polling & More
Postman Documentation	View Docs
Product Details	SharpAPI.com
SDK Libraries	GitHub - SharpAPI SDKs

Requirements

PHP >= 8.0

Installation

Step 1. Install the package via Composer:

composer require sharpapi/php-hr-job-description-generator

Step 2. Visit SharpAPI to get your API key.

Laravel Integration

Building a Laravel application? Check the Laravel package version for better integration.

What it does

Generate professional job descriptions using AI - creates detailed JD from parameters

Usage

<?php

require __DIR__ . '/vendor/autoload.php';

use SharpAPI\HRJobDescription\JobDescriptionGeneratorClient;
use GuzzleHttp\Exception\GuzzleException;

$apiKey = 'your_api_key_here';
$client = new JobDescriptionGeneratorClient(apiKey: $apiKey);

try {
    $params = new \SharpAPI\HRJobDescription\DTO\JobDescriptionParameters(
        name: 'Senior PHP Developer',
        companyName: 'ACME Corp',
        minimumWorkExperience: '5 years',
        requiredSkills: ['PHP', 'Laravel', 'MySQL'],
        country: 'United States',
        remote: true
    );

    $statusUrl = $client->generateJobDescription($params);

    // Optional: Configure polling
    $client->setApiJobStatusPollingInterval(10);
    $client->setApiJobStatusPollingWait(180);

    // Fetch results (polls automatically)
    $result = $client->fetchResults($statusUrl);
    $resultData = $result->getResultJson();

    echo $resultData;
} catch (GuzzleException $e) {
    echo "API error: " . $e->getMessage();
}

Example Response

{
    "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."
            }
        }
    }
}

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

A2Z WEB LTD
Dawid Makowski
Boost your PHP AI capabilities!

License

The MIT License (MIT). Please see License File for more information.

Social Media

🚀 For the latest news, tutorials, and case studies, don't forget to follow us on:

sharpapi / php-hr-job-description-generator

Maintainers

Details