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
| Parameter | Type | Description |
|---|---|---|
| text | String | The 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.
| Parameter | Type | Description |
|---|---|---|
| biasedPhrases | Object Array | One entry per phrase flagged as biased or exclusionary. Empty when nothing was flagged. |
| biasedPhrases[].original | String | The phrase as it appeared in the submitted text. |
| biasedPhrases[].reason | String | Why the phrase was flagged. |
| biasedPhrases[].suggestion | String | Suggested replacement wording. |
| isInclusive | Boolean | false when at least one phrase was flagged, true when the text passed. |
| revisedText | String | The submitted text rewritten with the suggestions applied. |


