Skip to main content
GET
/
resumes
/
{id}
/
analysis
Get latest resume analysis
curl --request GET \
  --url http://localhost:3000/api/openapi/resumes/{id}/analysis \
  --header 'x-api-key: <api-key>'
{
  "overallScore": 50,
  "scorecard": [
    {
      "dimension": "<string>",
      "score": 50,
      "rationale": "<string>"
    }
  ],
  "suggestions": [
    {
      "title": "<string>",
      "impact": "high",
      "why": "<string>",
      "exampleRewrite": "<string>",
      "copyPrompt": "<string>"
    }
  ],
  "strengths": [
    "<string>"
  ],
  "updatedAt": "2023-11-07T05:31:56Z",
  "modelMeta": {
    "provider": "<string>",
    "model": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.rxresu.me/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Path Parameters

id
string
required

The unique identifier of the resume.

Response

200 - application/json
object | null

The latest persisted resume analysis, or null if no analysis has been saved yet.

overallScore
integer
required
Required range: 0 <= x <= 100
scorecard
object[]
required
Minimum array length: 1
suggestions
object[]
required
Maximum array length: 10
strengths
string[]
required
Maximum array length: 10
Minimum string length: 1
updatedAt
string<date-time>
required
modelMeta
object
required