apyhub
ARTIFICIAL INTELLIGENCE · HR

Advanced Shortlist API

What it does

Executive Shortlist ranks a set of resumes against a job title and returns the strongest matches, plus a short report you can use to review the overall pool.

Send a jobTitle and an array of resumes as plain text. The response gives you topCandidates, each with a name, rank, and fitReason, so you can surface the best-fit people and see why they were chosen. It also returns an executiveReport string that summarizes the strengths and gaps across the candidate pool.

Use Executive Shortlist when you need a fast first pass on a hiring pipeline: screening applicants for a senior ML role, comparing internal candidates for promotion, or preparing a concise briefing for recruiters and hiring managers. The output is structured enough to feed into an HR workflow, shortlist dashboard, or internal review tool without extra parsing.

Because the service works from resume text rather than parsed CV fields, it fits early-stage triage and bulk review where you already have candidate summaries and want an ordered shortlist with a brief rationale.

POST
Get an executive-level shortlist of top candidates
http://localhost:8080/namastesumalya/executive-level-shortlist
QUICKSTARTGUIDE

Quickstart

Send a job title and a list of resumes to get an executive shortlist.

curl -X POST "http://localhost:8080/namastesumalya/executive-level-shortlist" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"jobTitle":"Senior ML Engineer","resumes":["PhD background with massive data experience at Uber.","Strong production ML experience at FAANG scale."]}'

What you'll get back

Returns a JSON object with topCandidates and executiveReport fields. topCandidates is an array of candidate objects with name, rank, and fitReason; executiveReport is a string summary of the pool.

{
  "topCandidates": [
    {
      "name": "Candidate 1",
      "rank": 1,
      "fitReason": "PhD background with massive data experience at Uber."
    }
  ],
  "executiveReport": "The candidate pool is exceptionally strong in algorithmic theory but lacks practical experience in MLOps pipelines."
}
TRY ITLIVE · 500 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
resumes

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

ParameterTypeMandatoryDescription
resumesString ArrayNoArray of resume texts to evaluate.
jobTitleStringNoThe 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).

ParameterTypeMandatoryDescription
topCandidatesObject ArrayNoRanked 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.
executiveReportStringNoExecutive summary of the candidate pool.

Body

Name
Type
Description
bodyREQUIRED
object
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.