apyhub
ARTIFICIAL INTELLIGENCE · HR

Advanced Shortlist API

What it does

Executive Candidate Shortlist ranks resumes against a job title and returns a concise shortlist with an executive summary of the pool.

Send a jobTitle and an array of resumes as plain text. The service evaluates the candidates for the role, then returns topCandidates with each candidate’s name, rank, and fitReason, plus an executiveReport that highlights the overall strengths and gaps in the pool.

Use Executive Candidate Shortlist when you need a fast first pass on a hiring slate for a senior engineering, product, or leadership role. It is useful for screening large batches of resume text before a recruiter or hiring manager spends time on deeper review.

The response is structured for downstream automation: you can sort, display, or route the ranked candidates into an internal hiring workflow, while the executive report gives a compact readout on how well the group matches the role.

POST
Get an executive-level shortlist of top candidates
https://api.eu.apyverse.com/namastesumalya/executive-level-shortlist

QUICKSTART

GUIDE

Quickstart

Send a JSON list of resumes and a job title to rank executive-level candidates.

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

What you'll get back

Returns a JSON object with two top-level fields: topCandidates is an array of candidate objects, and executiveReport is a string summary of the shortlist.

{
  "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

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

ParameterTypeMandatoryDescription
resumesString ArrayNoArray of resume text strings to evaluate.
jobTitleStringNoTarget 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.

ParameterTypeMandatoryDescription
topCandidatesObject ArrayNoArray of shortlisted candidate objects. Each item includes name (string), rank (integer), and fitReason (string).
topCandidates[].nameStringNoCandidate name.
topCandidates[].rankIntegerNoRank assigned to the candidate.
topCandidates[].fitReasonStringNoReason the candidate fits the role.
executiveReportStringNoSummary of the overall 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.