Jobs

Generate job description using AI

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] 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]=fixed_hours&job[expected_weekly_hours]=39&job[title]=Consulting+Manager&job[description]=Synagoga+ullam+peior.+Antiquus+pecto+adipisci.&job[postcode]=B1+1AA&job[industries][]=rail_replacement&job[industries][]=van&job[drivers_required]=3&job[start_date]=2025-03-24&job[end_date]=2025-12-15&job[min_rating]=3.5&job[licenses][]=d1e&job[licenses][]=b1&job[job_type]=part_time&job[status]=published&job[published_at]=2025-03-20+09%3A02%3A17+UTC

Headers

Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjcwIiwic2NwIjoidXNlciIsImF1ZCI6bnVsbCwiaWF0IjoxNzQyNDY0OTM3LCJleHAiOjE3NDUwNTY5MzcsImp0aSI6IjZkYzI0MzFlLWE2MDctNDY3MS04MjBhLTliYTVjZDQ3MjQwYiJ9.E_MR7489f2jntsAoNV72C4SyRhxAZbac7r4iFr01S_I
Host: example.org
Cookie: 

Query Parameters

job={"show_by"=>"fixed_hours", "expected_weekly_hours"=>"39", "title"=>"Consulting Manager", "description"=>"Synagoga ullam peior. Antiquus pecto adipisci.", "postcode"=>"B1 1AA", "industries"=>["rail_replacement", "van"], "drivers_required"=>"3", "start_date"=>"2025-03-24", "end_date"=>"2025-12-15", "min_rating"=>"3.5", "licenses"=>["d1e", "b1"], "job_type"=>"part_time", "status"=>"published", "published_at"=>"2025-03-20 09:02:17 UTC"}

Response

Simulated Response

Status

200

Headers

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: f9964382-f93f-4f9f-ba3a-518663dcd84f
x-runtime: 0.006952
content-length: 52

Body

{
  "description": "Nice description generated with AI"
}