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]=maximum_hours&job[expected_weekly_hours]=16&job[title]=Principal+Technician&job[description]=Decumbo+aperio+vicissitudo.+Deserunt+libero+turpis.&job[postcode]=CF10+1AA&job[industries][]=hgv&job[industries][]=private_hire&job[drivers_required]=3&job[start_date]=2025-07-31&job[end_date]=2025-09-18&job[min_rating]=1.4&job[licenses][]=c1&job[licenses][]=d1&job[job_type]=fixed_term_contract&job[status]=published&job[published_at]=2025-07-23+09%3A23%3A27+UTC

Headers

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

Query Parameters

job={"show_by"=>"maximum_hours", "expected_weekly_hours"=>"16", "title"=>"Principal Technician", "description"=>"Decumbo aperio vicissitudo. Deserunt libero turpis.", "postcode"=>"CF10 1AA", "industries"=>["hgv", "private_hire"], "drivers_required"=>"3", "start_date"=>"2025-07-31", "end_date"=>"2025-09-18", "min_rating"=>"1.4", "licenses"=>["c1", "d1"], "job_type"=>"fixed_term_contract", "status"=>"published", "published_at"=>"2025-07-23 09:23:27 UTC"}

Body

{
}

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: 9a088f7c-bcca-4da2-b268-2b5417db6ae5
x-runtime: 0.009094
content-length: 52

Body

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