Generate job description using AI
Jobs
GET ai description
Endpoint
GET /api/v1/jobs/ai_description
Parameters
| Name | Description |
|---|---|
| job[title] required | Job title |
| job[drivers_required] required | Job drivers required |
| job[industries] required | Job industries |
| job[start_date] required | Job start date |
| job[end_date] | Job end date |
| job[ongoing] | Job ongoing |
| job[postcode] required | Job postcode |
| job[description] required | Job description |
| job[licenses] required | Job licenses |
| job[min_rating] required | Job min rating |
| job[young_drivers] | Job young drivers |
| job[inexperienced_drivers] | Job inexperienced drivers |
| job[job_type] required | Job job type |
| job[show_by] required | Job show by |
| job[expected_weekly_hours] | Job expected weekly hours |
| job[hours_from] | Job hours from |
| job[hours_to] | Job hours to |
| job[wages_attributes] required | Job wages attributes |
| job[overtime_after] | Job overtime after |
| job[overtime_rate] | Job overtime rate |
| job[dbs_check] | Job dbs check |
| job[dbs_last_performed_months] | Job dbs last performed months |
Request
Route
GET /api/v1/jobs/ai_description?job[show_by]=minimum_hours&job[expected_weekly_hours]=23&job[title]=Mining+Coordinator&job[description]=Capitulus+suggero+adnuo.+Charisma+absorbeo+arbor.&job[postcode]=NG1+1AA&job[industries][]=courier&job[industries][]=rail_replacement&job[drivers_required]=7&job[start_date]=2025-01-27&job[end_date]=2025-11-27&job[min_rating]=4.5&job[licenses][]=ce&job[licenses][]=d&job[job_type]=part_time&job[status]=published&job[published_at]=2025-01-22+12%3A12%3A59+UTC
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjYzIiwic2NwIjoidXNlciIsImF1ZCI6bnVsbCwiaWF0IjoxNzM3NTUxNTc5LCJleHAiOjE3NDAxNDM1NzksImp0aSI6IjUzYzU0NjlhLTc3YzgtNGI0Ni1hN2Y5LWI1Njg4YTgxOTEyYSJ9.Hc3UOAo72u3Qh5XSfAQBZqvyEtJ_YF8WF2MeF5XlFO0
Host: example.org
Cookie: Query Parameters
job={"show_by"=>"minimum_hours", "expected_weekly_hours"=>"23", "title"=>"Mining Coordinator", "description"=>"Capitulus suggero adnuo. Charisma absorbeo arbor.", "postcode"=>"NG1 1AA", "industries"=>["courier", "rail_replacement"], "drivers_required"=>"7", "start_date"=>"2025-01-27", "end_date"=>"2025-11-27", "min_rating"=>"4.5", "licenses"=>["ce", "d"], "job_type"=>"part_time", "status"=>"published", "published_at"=>"2025-01-22 12:12:59 UTC"}
Response
Simulated Response
Status
200Headers
x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/json; charset=utf-8
vary: Accept, Origin
etag: W/"ed3b53f9ba829476f6bd61a09ec6f1ac"
cache-control: max-age=0, private, must-revalidate
x-request-id: 9310900f-9be8-4f54-b736-dedd3dc00aee
x-runtime: 0.005299
content-length: 52Body
{
"description": "Nice description generated with AI"
}