About this endpoint
What it does
Generates an executive-level shortlist from the submitted resumes and job title. The response returns a ranked set of top candidates plus an executive summary report.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| resumes | String Array | No | Array of resume texts to evaluate. |
| jobTitle | String | No | The target job title used to guide the shortlist. |
Response
Returns a JSON object with a topCandidates array field and an executiveReport string field. Each item in topCandidates is an object containing name (string), rank (integer), and fitReason (string).
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| topCandidates | Object Array | No | Ranked shortlist of candidates. Each object includes:<br>- name (String): Candidate name or label.<br>- rank (Integer): Candidate ranking.<br>- fitReason (String): Reason this candidate was selected. |
| executiveReport | String | No | Executive summary of the candidate pool. |