Skip to main content
POST
Review extracted resume text

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Body

application/json
extractedText
string
required
Required string length: 1 - 50000
aiProviderId
string
findings
object[]
Maximum array length: 120
jobDescription
string
Maximum string length: 20000
passages
object[]

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

Maximum array length: 120

Response

Qualitative review returned successfully.

summary
string
required
jdAlignment
object | null
required
suggestions
any
strengths
any