ai-review1

Authentication12

billing8

Bots5

Calendar9

campaign36

candidates20

compare-internal2

competencies10

Dashboard5

debrief1

Email2

Evaluations4

frameworks13

Health5

Hiring Decisions3

Internal — Shadow Eval5

Internal — Staff Tools8

Internal OAuth3

Interview Stages4

interview-join9

interview-prep2

Interviews36

Invitations11

JD Quality2

Job Roles24

meeting-join1

Organizations16

Public API v19

Public API v1 — Artifacts1

Public API v1 — Candidate Feedback2

Public API v1 — Candidates1

Public API v1 — Comparison1

post/api/public/v1/compareCompare candidates side by side

Public API v1 — Debrief4

Public API v1 — Downloads2

Public API v1 — Feedback1

Public API v1 — File Uploads6

Public API v1 — Job Roles3

Public API v1 — Resume Matching1

Public API v1 — Scheduling2

Public API v1 — Screening1

Public API v1 — Skills1

Public API v1 — Webhooks4

question-bank2

recordings5

screening-questions6

settings20

Support2

Team6

test-data12

voice1

webhooks4

Public API v1 — Comparison

Compare candidates side by side

Compare 2-4 candidates with overall ranking, competency matrix, head-to-head on overlapping rounds, communication comparison, and risk assessment. Handles candidates at different interview stages with confidence flags and warnings.

post/api/public/v1/compare

Request

Base URL: https://api.thebetterhire.ai (the document declares no server; this is the origin it was published from)
URL: https://api.thebetterhire.ai/api/public/v1/compare
Auth: HTTP bearer

Request body

candidate_idsstring[] required

List of 2-4 candidate IDs to compare. All must belong to your organization.

Response

Successful Response

rolestring nullable

Primary role being compared.

candidates_comparedinteger required

Number of candidates in comparison.

warningsstring[]

Warnings about comparison fairness (e.g., different round counts).

ai_summarystring nullable

AI-generated comparison narrative.

Changes

No recorded changes to this operation across all 1 revision of this API.