Public REST/JSON reference

Job Description Bias Scanner API

Scans job descriptions for biased, exclusionary, or unclear language and suggests inclusive replacements with issue severity. Use this API to submit job descriptions, identify biased terms or requirements, generate revised copy, and track review status before publishing roles. Part of the Logic Igniter HR & Workforce Suite.

Access boundary

These examples describe public API calls only. Use the service output to review, score, summarize, analyze, or recommend; do not treat the API reference as permission for an assistant to write, send, publish, charge, schedule, notify, delete, or modify records.

Base URL

https://api.logicigniter.com

Auth

Authorization: Bearer YOUR_API_KEY

Version

OpenAPI 3.0.3 · 1.0.0

Spec

/api-specs/jdbiasscanner.json

Operations rendered

Response models rendered

GET/api/v1/jdbiasscanner/scans

List scans

Return recent job-description bias scans.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`page_size`	query	integer
`page_token`	query	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/jdbiasscanner/scans" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200JobDescriptionScans

Successful response

400Error

Invalid request payload or query parameter.

401Error

Missing, expired, or invalid bearer token.

402Error

Active HR & Workforce Suite subscription required.

404Error

Requested resource was not found for this workspace.

500Error

Unexpected service error.

POST/api/v1/jdbiasscanner/scans

Scan job description

Analyze job description text for biased or exclusionary language.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: ScanJobDescriptionRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/jdbiasscanner/scans" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

201JobDescriptionScan

Successful response

400Error

Invalid request payload or query parameter.

401Error

Missing, expired, or invalid bearer token.

402Error

Active HR & Workforce Suite subscription required.

404Error

Requested resource was not found for this workspace.

500Error

Unexpected service error.

GET/api/v1/jdbiasscanner/scans/{id}

Get scan detail

Return bias score, findings, and rewrite state for one scan.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/jdbiasscanner/scans/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200JobDescriptionScan

Successful response

400Error

Invalid request payload or query parameter.

401Error

Missing, expired, or invalid bearer token.

402Error

Active HR & Workforce Suite subscription required.

404Error

Requested resource was not found for this workspace.

500Error

Unexpected service error.

GET/api/v1/jdbiasscanner/scans/{id}/findings

List scan findings

Return detected biased terms, severity, and rationale.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type
`id`required	path	string
`page_size`	query	integer
`page_token`	query	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/jdbiasscanner/scans/:id/findings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200BiasFindings

Successful response

400Error

Invalid request payload or query parameter.

401Error

Missing, expired, or invalid bearer token.

402Error

Active HR & Workforce Suite subscription required.

404Error

Requested resource was not found for this workspace.

500Error

Unexpected service error.

POST/api/v1/jdbiasscanner/scans/{id}/rewrite

Generate inclusive rewrite

Generate an inclusive rewrite that preserves role requirements.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string

Request body (required)

Schema: RewriteJobDescriptionRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/jdbiasscanner/scans/:id/rewrite" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

201JobDescriptionRewrite

Successful response

400Error

Invalid request payload or query parameter.

401Error

Missing, expired, or invalid bearer token.

402Error

Active HR & Workforce Suite subscription required.

404Error

Requested resource was not found for this workspace.

500Error

Unexpected service error.

GET/api/v1/jdbiasscanner/rewrites/{id}

Get rewrite

Return a generated rewrite and change explanations.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

Name	In	Type	Notes
`id`required	path	string

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/jdbiasscanner/rewrites/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200JobDescriptionRewrite

Successful response

400Error

Invalid request payload or query parameter.

401Error

Missing, expired, or invalid bearer token.

402Error

Active HR & Workforce Suite subscription required.

404Error

Requested resource was not found for this workspace.

500Error

Unexpected service error.

Data models

Error

Field	Type	Notes
`code`required	string	Example: "invalid_request"
`message`required	string	Example: "The request body is missing a required field."
`request_id`	string	Example: "req_01HX7K9Z8W"

JobDescriptionScan

Field	Type	Notes
`scan_id`required	string	Example: "jdscan_583"
`role_title`required	string	Example: "Frontend Engineer"
`bias_score`required	integer	Example: 31
`finding_count`required	integer	Example: 4
`status`required	string	Example: "needs_revision"
`inclusive_readability_grade`required	string	Example: "clear"

JobDescriptionScans

Field	Type	Notes
`items`required	array<JobDescriptionScan>
`next_page_token`	string	Example: "eyJvZmZzZXQiOjI1fQ=="

ScanJobDescriptionRequest

Field	Type	Notes
`role_title`required	string	Example: "Frontend Engineer"
`description_text`required	string	Example: "We need a rockstar engineer who can dominate ambiguous problems."
`locale`required	string	Example: "en-US"

BiasFindings

Field	Type	Notes
`items`required	array<object>
`next_page_token`	string	Example: null

RewriteJobDescriptionRequest

Field	Type	Notes
`role_title`required	string	Example: "Frontend Engineer"
`description_text`required	string	Example: "We need a rockstar engineer who can dominate ambiguous problems."
`locale`required	string	Example: "en-US"