Skip to main content
POST
document.resume.parse

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
url
string

Public URL of the resume document. Send this or content.

content
string

The resume file's bytes, base64-encoded, up to 10 MiB. Send this or url.

extension
string

File type of content, like "pdf" or "docx".

Required string length: 1 - 8
Pattern: ^[a-z0-9]{1,8}$

Response

The result

fullName
string
required

The candidate's full name.

skills
string[]
required

Skills named in the resume.

workExperience
object[]
required

Work history, in resume order.

education
object[]
required

Education history, in resume order.

firstName
string

First name.

lastName
string

Last name.

email
string

Email address from the resume.

phone
string

Phone number from the resume.

location
object

Where the candidate is based, as written in the resume.

title
string

Current or most recent job title.

summary
string

Summary or objective text from the resume.

languages
string[]

Languages the candidate speaks.

Links the resume gives.

confidence
number

How confident the data source is in this parse, 0 to 1, when it reports one.

Required range: 0 <= x <= 1