Resume Ranking API

Scores and ranks resumes against a specific job

Sample Request & Response

POST

/v1/search/rank/resumes

Sample Request

Headers:

{
  "Authorization": "Bearer <YOUR_API_KEY>"
}

Body:

{
  "jobId": "job_456",
  "topK": 10,
  "filters": {
    "location": "Canada",
    "seniority": "mid"
  },
  "include": [
    "highlights"
  ]
}

Sample Response (200)

{
  "jobId": "job_456",
  "results": [
    {
      "resumeId": "resume_123",
      "score": 0.91,
      "matchedSkills": [
        "React",
        "TypeScript",
        "Node.js"
      ],
      "missingSkills": [
        "GraphQL"
      ],
      "highlights": [
        "Built a <em>React</em> + <em>TypeScript</em> platform used by 50k users"
      ],
      "metadata": {
        "name": "Jane Doe",
        "title": "Frontend Engineer",
        "location": "Toronto, Canada"
      }
    }
  ]
}