PHPackages                             sharpapi/laravel-hr-job-description - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. sharpapi/laravel-hr-job-description

ActiveLibrary[API Development](/categories/api)

sharpapi/laravel-hr-job-description
===================================

AI Job Description Generator for Laravel powered by SharpAPI.com

v1.0.3(1mo ago)00MITPHPPHP ^8.1

Since Jan 9Pushed 1mo agoCompare

[ Source](https://github.com/sharpapi/laravel-hr-job-description)[ Packagist](https://packagist.org/packages/sharpapi/laravel-hr-job-description)[ Docs](https://github.com/sharpapi/laravel-hr-job-description)[ RSS](/packages/sharpapi-laravel-hr-job-description/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)Dependencies (6)Versions (5)Used By (0)

[![SharpAPI GitHub cover](https://camo.githubusercontent.com/82bb36706c1e71276b3dca4ec9120353bb51c8f22bb62543bf056db5c28da36d/68747470733a2f2f73686172706170692e636f6d2f73686172706170692d6769746875622d6c61726176656c2d62672e6a7067 "SharpAPI Laravel Client")](https://camo.githubusercontent.com/82bb36706c1e71276b3dca4ec9120353bb51c8f22bb62543bf056db5c28da36d/68747470733a2f2f73686172706170692e636f6d2f73686172706170692d6769746875622d6c61726176656c2d62672e6a7067)

AI Job Description Generator for Laravel
========================================

[](#ai-job-description-generator-for-laravel)

🚀 Leverage AI API to streamline job description creation in your HR Tech applications.
--------------------------------------------------------------------------------------

[](#-leverage-ai-api-to-streamline-job-description-creation-in-your-hr-tech-applications)

[![Latest Version on Packagist](https://camo.githubusercontent.com/e827d91c2d33e154320b0be036ce1011a347e80c75f118549ee34c558f43017e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f73686172706170692f6c61726176656c2d68722d6a6f622d6465736372697074696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/sharpapi/laravel-hr-job-description)[![Total Downloads](https://camo.githubusercontent.com/f19a62bac26eb07f855c77d11d94934276395c2284313bb460fd41ae3217ac64/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f73686172706170692f6c61726176656c2d68722d6a6f622d6465736372697074696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/sharpapi/laravel-hr-job-description)

Check the details at SharpAPI's [Job Description Generator API](https://sharpapi.com/en/catalog/ai/hr-tech) page.

---

Requirements
------------

[](#requirements)

- PHP >= 8.1
- Laravel >= 10.48.29

---

Installation
------------

[](#installation)

Follow these steps to install and set up the SharpAPI Laravel Job Description Generator package.

1. Install the package via `composer`:

```
composer require sharpapi/laravel-hr-job-description
```

2. Register at [SharpAPI.com](https://sharpapi.com/) to obtain your API key.
3. Set the API key in your `.env` file:

```
SHARP_API_KEY=your_api_key_here
```

4. **\[OPTIONAL\]** Publish the configuration file:

```
php artisan vendor:publish --tag=sharpapi-hr-job-description
```

---

Key Features
------------

[](#key-features)

- **AI-Powered Job Description Generation**: Efficiently create comprehensive job descriptions with customizable parameters.
- **Customizable Output**: Control various aspects of the job description including required skills, experience, education, and more.
- **Voice Tone Control**: Set your preferred writing style for the job description.
- **Robust Polling for Results**: Polling-based API response handling with customizable intervals.
- **API Availability and Quota Check**: Check API availability and current usage quotas with SharpAPI's endpoints.

---

Usage
-----

[](#usage)

You can inject the `HrJobDescriptionService` class to access job description generation functionality. For best results, especially with batch processing, use Laravel's queuing system to optimize job dispatch and result polling.

### Basic Workflow

[](#basic-workflow)

1. **Create Parameters**: Create a JobDescriptionParameters object with your job details.
2. **Dispatch Job**: Send the parameters to the API using `generateJobDescription`, which returns a status URL.
3. **Poll for Results**: Use `fetchResults($statusUrl)` to poll until the job completes or fails.
4. **Process Result**: After completion, retrieve the results from the `SharpApiJob` object returned.

> **Note**: Each job typically takes a few seconds to complete. Once completed successfully, the status will update to `success`, and you can process the results as JSON, array, or object format.

---

### Controller Example

[](#controller-example)

Here is an example of how to use `HrJobDescriptionService` within a Laravel controller:

```