apyhub
Back
▣ ARTIFICIAL INTELLIGENCE · HR

Bias and Inclusion Scan API

What it does

Bias and Inclusion Scan reviews a job description for biased or exclusionary language. Send the text of a role description, and you get back biasedPhrases — each flagged phrase with the reason it was flagged and a suggested replacement — an isInclusive verdict, and revisedText containing the whole posting rewritten with those suggestions applied.

Use it when you want to screen hiring copy before it goes live, clean up an inherited job template, or check whether your wording discourages part of your candidate pool. The response is designed for downstream review flows: biasedPhrases shows a reviewer exactly what to look at and why, while revisedText gives you a ready-to-use rewrite.

This is useful for recruiting teams, ATS integrations, and internal HR tooling that need a fast consistency check on job ads. It helps you catch gender-coded terms, unrealistic hour expectations, and other wording that may deter qualified applicants — and it explains each call so reviewers can accept or override it.

Bias and Inclusion Scan is a simple way to turn subjective job-post review into a repeatable API step.

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

QUICKSTART

GUIDE

Quickstart

Scan a job description for biased or exclusionary wording.

curl -X POST "https://api.eu.apyhub.com/namastesumalya/scan-bias-and-inclusion" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text":"We are looking for a rockstar developer who can work 80 hours a week."}'

What you'll get back

Returns a JSON object with biasedPhrases (the flagged wording, each with a reason and a suggested replacement), an isInclusive boolean, and revisedText containing the rewritten job description.

{
  "biasedPhrases": [
    {
      "original": "rockstar",
      "reason": "This is a gender-coded term often associated with masculine-leaning language, which can discourage qualified female candidates.",
      "suggestion": "developer"
    },
    {
      "original": "work 80 hours a week",
      "reason": "This creates a legal risk regarding labor laws and creates an environment hostile to caregivers, people with disabilities, or anyone seeking a sustainable work-life balance.",
      "suggestion": "work full-time hours"
    }
  ],
  "isInclusive": false,
  "revisedText": "We are looking for a dedicated developer to join our team for a full-time position."
}
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 a job description for biased or exclusionary wording and returns the phrases it flagged, why each is a problem, a suggested replacement, and a rewritten version of the whole text.

Request Body

ParameterTypeDescription
textStringThe job description text to scan for bias and inclusivity.

Response

Returns a JSON object with the flagged phrases, an overall verdict, and a rewritten version of the submitted text.

ParameterTypeDescription
biasedPhrasesObject ArrayOne entry per phrase flagged as biased or exclusionary. Empty when nothing was flagged.
biasedPhrases[].originalStringThe phrase as it appeared in the submitted text.
biasedPhrases[].reasonStringWhy the phrase was flagged.
biasedPhrases[].suggestionStringSuggested replacement wording.
isInclusiveBooleanfalse when at least one phrase was flagged, true when the text passed.
revisedTextStringThe submitted text rewritten with the suggestions applied.
▣ 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.