apyhub
ARTIFICIAL INTELLIGENCE · HR

Bias and Inclusion Scan API

What it does

Inclusive Job Scan checks a job description for biased or exclusionary language and returns an analysis you can use to rewrite it. Send a single text field in the request body, and you get back a winner, a rationale, and a comparisonMatrix with experience, softSkills, and technicalSkills guidance.

Use it when you want to review hiring copy before publishing it to a careers site, ATS, or internal recruitment workflow. It helps surface language that may overemphasize seniority, culture fit, or specific work styles, so you can make the description more inclusive without changing the role's intent.

The response is structured for quick human review. winner gives the selected result, rationale explains the decision, and the comparison matrix breaks the analysis into the main dimensions reviewers usually care about. That makes it easier to plug the output into moderation tools, editorial review steps, or HR content checks.

Inclusive Job Scan is best suited for teams that want a lightweight text analysis step in their hiring pipeline, especially when drafting new roles or auditing existing postings for bias.

POST
Scan job descriptions for bias and inclusivity
https://api.eu.apyverse.com/namastesumalya/scan-bias-and-inclusion

QUICKSTART

GUIDE

Quickstart

Send the text to analyze for bias and inclusion as a simple JSON body.

curl -X POST "https://api.eu.apyverse.com/namastesumalya/scan-bias-and-inclusion" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text":"We are looking for a software engineer with strong teamwork skills and experience building inclusive products."}'

What you'll get back

Returns a JSON object with winner and rationale string fields, plus an optional comparisonMatrix object. When present, comparisonMatrix contains experience, softSkills, and technicalSkills string fields.

{
  "winner": "B",
  "rationale": "Candidate B's alignment with modern cloud-native practices makes them a better fit for our future-state architecture.",
  "comparisonMatrix": {
    "experience": "A has deeper tenure (15y vs 8y), but B has more relevant modern stack experience.",
    "softSkills": "Both demonstrate strong leadership, but B shows better alignment with modern agile engineering cultures.",
    "technicalSkills": "A is legacy-enterprise focused; B is cloud-native and high-performance focused."
  }
}
TRY ITLIVE · 1000 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*

About this endpoint

What it does

Scans the submitted job-description text for bias and inclusivity issues and returns a structured assessment. The response includes a top-level winner string, a rationale string, and a comparisonMatrix object with category-level strings.

Request Body

ParameterTypeMandatoryDescription
textStringYesThe job-description text to scan for bias and inclusivity.

Response

Returns a JSON object with three top-level fields: winner as a string, rationale as a string, and comparisonMatrix as an object. comparisonMatrix contains three string fields: experience, softSkills, and technicalSkills.

ParameterTypeMandatoryDescription
winnerStringNoThe winner label returned by the scan result.
rationaleStringNoA textual explanation of the result.
comparisonMatrixObjectNoCategory-level comparison details.
comparisonMatrix.experienceStringNoComparison details for experience.
comparisonMatrix.softSkillsStringNoComparison details for soft skills.
comparisonMatrix.technicalSkillsStringNoComparison details for technical skills.

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.