Skip to main content
POST
Parse a DOCX file into resume data

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Body

application/json
file
object
required
mediaType
enum<string>
required
Available options:
application/msword,
application/vnd.openxmlformats-officedocument.wordprocessingml.document
aiProviderId
string

Response

The DOCX was successfully parsed into structured resume data.

picture
object
required

Configuration for photograph displayed on the resume

basics
object
required

Basic information about the author, such as name, email, phone, location, and website

summary
object
required

Summary section of the resume, useful for a short bio or introduction

sections
object
required

Various sections of the resume, such as experience, education, projects, etc.

customSections
object[]
required

Custom sections of the resume, such as a custom section for notes, etc.

metadata
object
required

Metadata for the resume, such as template, layout, typography, etc. This section describes the overall design and appearance of the resume.

{key}
any