About this endpoint
What it does
Creates an executive-level shortlist from submitted resume text for a given job title. The response returns a ranked list of top candidates and an executive summary report.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| resumes | String Array | No | Array of resume text strings to evaluate. |
| jobTitle | String | No | Target job title used to guide the shortlist. |
Response
Returns a JSON object with two top-level fields: topCandidates and executiveReport. topCandidates is an array of candidate objects, and executiveReport is a string containing the summary assessment.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| topCandidates | Object Array | No | Array of shortlisted candidate objects. Each item includes name (string), rank (integer), and fitReason (string). |
| topCandidates[].name | String | No | Candidate name. |
| topCandidates[].rank | Integer | No | Rank assigned to the candidate. |
| topCandidates[].fitReason | String | No | Reason the candidate fits the role. |
| executiveReport | String | No | Summary of the overall candidate pool. |