API Docs
Back to Resume Parsing & Intelligence

Resume Analysis

Returns AI-generated analysis of a parsed resume, including career progression, skill alignment, and role fit.

The response includes experience level, education level, industry tags, suitable job titles, and core technologies. It also provides a career progression rating, AI-generated summary, key highlights, and any detected red flags. If parsing inferred a location, it will be included.

See the ResumeAnalysis schema for the full response structure.

Request Details

path Parameters

FieldTypeRequiredDescription
id
string
YesThe unique identifier of the resume

Sample Request & Response

GET
/v1/resumes/{id}/analysis
Sample Request

Headers:

{
  "Authorization": "Bearer <YOUR_API_KEY>"
}

Path Parameters:

{
  "id": "string (required) - The unique identifier of the resume"
}
Sample Response (200)
{
  "id": "analysis_8f92c1b1e7",
  "resumeId": "resume_4b3e2a7d9c",
  "experienceLevel": "Mid",
  "educationLevel": "Bachelor's",
  "totalYearsExperience": 5,
  "industryTags": [
    "Software Engineering",
    "Web Development",
    "SaaS"
  ],
  "suitableJobTitles": [
    "Frontend Developer",
    "Full Stack Engineer",
    "React Developer"
  ],
  "coreTechnologies": [
    "JavaScript",
    "TypeScript",
    "React",
    "Node.js",
    "GraphQL"
  ],
  "aiSummary": "Experienced frontend engineer with a strong background in building responsive web applications using modern JavaScript frameworks. Demonstrated ability to work across the stack and collaborate with cross-functional teams.",
  "keyHighlights": [
    "Led development of a customer-facing dashboard used by over 10,000 users",
    "Improved page load performance by 40% through frontend optimization",
    "Collaborated with designers to revamp UI using Tailwind CSS and React Hooks"
  ],
  "careerProgression": "Upward",
  "redFlags": [
    "Two roles under one year with no explanation",
    "Vague achievements in early career roles"
  ],
  "biasAnalysis": {
    "detected": true,
    "biases": [
      {
        "category": "Gender-coded",
        "phrase": "rockstar developer",
        "recommendation": "Use more neutral terms to appeal to a wider talent pool."
      },
      {
        "category": "Age-revealing",
        "phrase": "young and dynamic team",
        "recommendation": "Avoid language that may imply age preferences."
      }
    ]
  },
  "inferredLocation": "Toronto, Canada",
  "createdAt": 1692351200000,
  "updatedAt": 1692351300000
}