FlashApply API Docs
Need help?
Back to Search & Ranking

Job Ranking API

Scores and ranks jobs against a specific resume.

Sample Request & Response

POST
/v1/search/rank/jobs
Sample Request

Headers:

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

Body:

{
  "resumeId": "resume_789",
  "topK": 10,
  "filters": {
    "location": "Remote",
    "employmentType": "Full-time"
  },
  "include": [
    "highlights"
  ]
}
Sample Response (200)
{
  "resumeId": "resume_789",
  "results": [
    {
      "jobId": "job_789",
      "score": 0.88,
      "matchedSkills": [
        "PostgreSQL",
        "System Design"
      ],
      "missingSkills": [
        "Kubernetes"
      ],
      "highlights": [
        "Role requires strong <em>System Design</em> for distributed services"
      ],
      "metadata": {
        "title": "Senior Backend Engineer",
        "company": "Acme Corp",
        "location": "Remote"
      }
    }
  ]
}