Public API v1 — Resume Matching
Public API v1 — Resume Matching

Match resumes against a job description

Match up to 10 resumes against a job description. Returns ranked candidates with fit scores, requirements checklist, strengths, concerns, and suggested Round 1 interview questions.

Results are cached — same resume + JD won't re-run analysis.

Use the returned match_id to screen or schedule top candidates.

post/api/public/v1/match

Request

  • Base URL: https://api.thebetterhire.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.thebetterhire.ai/api/public/v1/match
  • Auth: HTTP bearer

Request body

rolestring required

Job title.

job_descriptionstring required

Full job description text.

Example request

{
  "role": "Senior Backend Engineer"
}

Response

Successful Response

rolestring required
candidates_matchedinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.