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]=minimum_hours&job[expected_weekly_hours]=15&job[title]=Real-Estate+Orchestrator&job[description]=Quasi+maxime+ullus.+Soluta+adaugeo+animadverto.&job[postcode]=M1+1AE&job[industries][]=van&job[industries][]=private_hire&job[drivers_required]=9&job[start_date]=2025-06-02&job[end_date]=2025-11-28&job[min_rating]=4.6&job[licenses][]=c1&job[licenses][]=c1e&job[job_type]=part_time&job[status]=published&job[published_at]=2025-05-29+10%3A02%3A04+UTC

Headers

Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjgyIiwic2NwIjoidXNlciIsImF1ZCI6bnVsbCwiaWF0IjoxNzQ4NTE2NTI0LCJleHAiOjE3NTExMDg1MjQsImp0aSI6IjIyZDI5OGVjLTlmOTItNDgyZS04NGZhLTI0ZWJmMWVmMmM4MSJ9.6pnGFvFA6f5Ub-MArPVrNSz9u7Ia_WCapqCx3GPDEdk
Host: example.org
Cookie: 

Query Parameters

job={"show_by"=>"minimum_hours", "expected_weekly_hours"=>"15", "title"=>"Real-Estate Orchestrator", "description"=>"Quasi maxime ullus. Soluta adaugeo animadverto.", "postcode"=>"M1 1AE", "industries"=>["van", "private_hire"], "drivers_required"=>"9", "start_date"=>"2025-06-02", "end_date"=>"2025-11-28", "min_rating"=>"4.6", "licenses"=>["c1", "c1e"], "job_type"=>"part_time", "status"=>"published", "published_at"=>"2025-05-29 10:02:04 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: 41dc9224-ab5d-41dc-96cb-47f283334202
x-runtime: 0.005597
content-length: 52

Body

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