Skip to main content
post/ai/ats-reviews
Request example
Response
post/ai/ats-reviews

Authorization

x-api-keystringheaderrequired#
The API key to authenticate requests.

2 alternative authorization methods available — see the spec for details.

Body

application/json
aiProviderIdstring#
extractedTextstringrequired#

Length: 1–50000

findingsobject[]#

Default: []

Items: max 120

jobDescriptionstring#

Length: max 20000

passagesobject[]#
Bullets and paragraphs the review may rewrite. A suggestion that rewrites one names it in passageId, with the whole new passage in rewrite.

Default: []

Items: max 120

Responses

application/json
Qualitative review returned successfully.
summarystringrequired#
suggestionsany#
strengthsany#
jdAlignmentobject · nullrequired#