Skip to main content
POST
/
api
/
public
/
ai
/
parse-jd
Parse Job Description
curl --request POST \
  --url https://api.tidyhire.app/api/public/ai/parse-jd \
  --header 'Content-Type: application/json' \
  --header 'x-tidyhire-api-key: <api-key>' \
  --data '
{
  "job_description": "We are looking for a Senior Software Engineer with 5+ years of experience in Node.js, React, and MongoDB. The ideal candidate will design and build scalable backend services..."
}
'
{
  "success": true,
  "data": {
    "experience_level": "3-5 Years",
    "seniority_level": "Senior",
    "work_type": "Remote",
    "employment_type": "Full Time",
    "location": "San Francisco, CA",
    "must_have_skills": [
      "JavaScript",
      "React",
      "Node.js"
    ],
    "good_to_have_skills": [
      "TypeScript",
      "GraphQL",
      "AWS"
    ]
  }
}
This endpoint is AI-powered. It uses a large language model to intelligently extract structured job requirements from free-text job descriptions.
What it extracts:
  • Experience & seniority level
  • Work type & employment type
  • Location
  • Must-have and good-to-have skills

Authorizations

x-tidyhire-api-key
string
header
required

Your Tidyhire API key

Body

application/json
job_description
string
required

The full job description text to extract requirements from.

Minimum string length: 1
Example:

"We are looking for a Senior Software Engineer with 5+ years of experience in Node.js, React, and MongoDB. The ideal candidate will design and build scalable backend services..."

Response

Job requirements generated successfully.

success
boolean
Example:

true

data
object

AI-generated structured job requirements extracted from the job description.