API Codex
Resume Parser API

Schemas


Person

  • namestring · required

    Full name of the person

  • emailstring | null · required

    Email address if available

  • phonestring | null · required

    Phone number if available

  • linkedinstring | null · required

    LinkedIn URL if available

  • addressstring | null · required

    Address if available

  • statestring | null · required

    State if available

  • countrystring | null · required

    Country if available

Experience

  • titlestring · required

    Job title

  • companystring · required

    Company name

  • locationstring | null · required

    City, State, Country or Remote (if available)

  • start_datestring | null · required

    Start date of employment

  • end_datestring | null · required

    End date of employment

  • descriptionstring | null · required

    Description of responsibilities and achievements

Education

  • degreestring | null · required

    Degree name

  • institutionstring · required

    School/University name

  • locationstring | null · required

    City, State, Country (if available)

  • start_datestring | null · required

    Start date of education

  • end_datestring | null · required

    End date of education

  • gpastring | null · required

    GPA if available

Certification

  • namestring · required

    Certification name

  • issuerstring | null · required

    Issuing organization

  • start_datestring | null · required

    Start date if applicable

  • end_datestring | null · required

    End date if applicable

  • expiresstring | null · required

    Expiration date if applicable

Project

  • namestring · required

    Project name

  • descriptionstring | null · required

    Brief description of the project

  • start_datestring | null · required

    Start date if applicable

  • end_datestring | null · required

    End date if applicable

  • urlstring | null · required

    Project URL if available

ResumeData

  • personobject · required
  • summarystring | null · required

    Professional summary or objective statement

  • skillsstring[] · required

    List of skills extracted from the resume

  • experienceobject[] · required
  • educationobject[] · required
  • certificationsobject[] · required
  • languagesstring[] · required

    Languages known by the person

  • projectsobject[] · required

ResumeResponse

  • successboolean

    Whether the parsing was successful

    Example: true
  • parsed_atstring · date-time

    Timestamp when the resume was parsed

    Example: 2025-03-10T11:17:03+03:00
  • dataobject

Error

  • errorstring

    Error message