Parse a PDF file into resume data
Extracts structured resume data from a PDF file with one of the user’s saved AI providers: the one named by
aiProviderId, or their default. Send the file as a base64-encoded string. Returns a complete ResumeData object and saves nothing.1 min read
post/ai/pdf-parses
Request example
curl --request POST "https://rxresu.me/api/openapi/ai/pdf-parses" --header "x-api-key: <api-key>" --header "Content-Type: application/json" --data '{
"file": {
"name": "<string>",
"data": "<string>"
}
}'Response
{
"picture": {
"hidden": true,
"fit": "cover",
"url": "<string>",
"size": 32,
"rotation": 0,
"aspectRatio": 0.5,
"borderRadius": 0,
"borderColor": "<string>",
"borderWidth": 0,
"shadowColor": "<string>",
"shadowWidth": 0
},
"basics": {
"name": "<string>",
"headline": "<string>",
"email": "<string>",
"phone": "<string>",
"location": "<string>",
"website": {
"url": "<string>",
"label": "<string>"
},
"customFields": [
{
"id": "<string>",
"icon": "<string>",
"text": "<string>",
"link": "<string>"
}
]
},
"summary": {
"title": "<string>",
"icon": "<string>",
"columns": 1,
"hidden": true,
"showHeading": true,
"keepTogether": true,
"startOnNewPage": true,
"content": "<string>"
},
"sections": {
"profiles": {
"title": "<string>",
"icon": "<string>",
"columns": 1,
"hidden": true,
"showHeading": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"icon": "<string>",
"iconColor": "<string>",
"network": "<string>",
"username": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
}
}
]
},
"experience": {
"title": "<string>",
"icon": "<string>",
"columns": 1,
"hidden": true,
"showHeading": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"company": "<string>",
"position": "<string>",
"location": "<string>",
"period": "<string>",
"dates": {
"start": "<string>",
"end": "<string>",
"present": true,
"raw": "<string>"
},
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>",
"roles": [
{
"id": "<string>",
"position": "<string>",
"period": "<string>",
"dates": {
"start": "<string>",
"end": "<string>",
"present": true,
"raw": "<string>"
},
"description": "<string>"
}
]
}
]
},
"education": {
"title": "<string>",
"icon": "<string>",
"columns": 1,
"hidden": true,
"showHeading": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"school": "<string>",
"degree": "<string>",
"area": "<string>",
"grade": "<string>",
"location": "<string>",
"period": "<string>",
"dates": {
"start": "<string>",
"end": "<string>",
"present": true,
"raw": "<string>"
},
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"projects": {
"title": "<string>",
"icon": "<string>",
"columns": 1,
"hidden": true,
"showHeading": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"name": "<string>",
"period": "<string>",
"dates": {
"start": "<string>",
"end": "<string>",
"present": true,
"raw": "<string>"
},
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"skills": null,
"languages": {
"title": "<string>",
"icon": "<string>",
"columns": 1,
"hidden": true,
"showHeading": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"language": "<string>",
"fluency": "<string>",
"level": 0
}
]
},
"interests": {
"title": "<string>",
"icon": "<string>",
"columns": 1,
"hidden": true,
"showHeading": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"icon": "<string>",
"iconColor": "<string>",
"name": "<string>",
"keywords": [
"<string>"
]
}
]
},
"awards": {
"title": "<string>",
"icon": "<string>",
"columns": 1,
"hidden": true,
"showHeading": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"title": "<string>",
"awarder": "<string>",
"date": "<string>",
"dates": {
"start": "<string>",
"end": "<string>",
"present": true,
"raw": "<string>"
},
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"certifications": {
"title": "<string>",
"icon": "<string>",
"columns": 1,
"hidden": true,
"showHeading": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"title": "<string>",
"issuer": "<string>",
"date": "<string>",
"dates": {
"start": "<string>",
"end": "<string>",
"present": true,
"raw": "<string>"
},
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"publications": {
"title": "<string>",
"icon": "<string>",
"columns": 1,
"hidden": true,
"showHeading": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"title": "<string>",
"publisher": "<string>",
"date": "<string>",
"dates": {
"start": "<string>",
"end": "<string>",
"present": true,
"raw": "<string>"
},
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"volunteer": {
"title": "<string>",
"icon": "<string>",
"columns": 1,
"hidden": true,
"showHeading": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"organization": "<string>",
"location": "<string>",
"period": "<string>",
"dates": {
"start": "<string>",
"end": "<string>",
"present": true,
"raw": "<string>"
},
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"description": "<string>"
}
]
},
"references": {
"title": "<string>",
"icon": "<string>",
"columns": 1,
"hidden": true,
"showHeading": true,
"keepTogether": true,
"startOnNewPage": true,
"items": [
{
"id": "<string>",
"hidden": true,
"name": "<string>",
"position": "<string>",
"website": {
"url": "<string>",
"label": "<string>",
"inlineLink": true
},
"phone": "<string>",
"description": "<string>"
}
]
}
},
"customSections": [
{
"title": "<string>",
"icon": "<string>",
"columns": 1,
"hidden": true,
"showHeading": true,
"keepTogether": true,
"startOnNewPage": true,
"keywordLayout": null,
"id": "<string>",
"type": "cover-letter",
"items": [
{
"id": "<string>",
"hidden": true,
"recipient": "<string>",
"content": "<string>"
}
]
}
],
"metadata": {
"template": "azurill",
"layout": {
"sidebarWidth": 10,
"sidebarSide": "left",
"pages": [
{
"fullWidth": true,
"main": [
"<string>"
],
"sidebar": [
"<string>"
]
}
]
},
"page": {
"gapX": 0,
"gapY": 0,
"marginX": 0,
"marginY": 0,
"format": "a4",
"locale": "<string>",
"dateFormat": "short",
"hideLinkUnderline": true,
"hideIcons": true,
"hideSectionIcons": true
},
"design": {
"level": {
"icon": "<string>",
"type": "hidden"
},
"colors": {
"primary": "<string>",
"text": "<string>",
"background": "<string>"
},
"entry": {
"layout": "stacked",
"lead": "organization",
"accent": "none"
}
},
"typography": {
"body": {
"fontFamily": "<string>",
"fontWeights": [
"100"
],
"fontSize": 6,
"lineHeight": 0.5
},
"heading": {
"fontFamily": "<string>",
"fontWeights": [
"100"
],
"fontSize": 6,
"lineHeight": 0.5
},
"hyphenation": true
},
"notes": "<string>",
"styleRules": null,
"stylesheet": {
"mode": "legacy",
"source": {
"languageVersion": -9007199254740991,
"text": "<string>"
}
},
"web": {
"showCredit": true
},
"check": {
"ignored": [
"<string>"
],
"hiddenTerms": [
"<string>"
]
}
}
}{
"defined": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "The AI response wasn't in the expected format. Try again, or choose another model.",
"data": null
}{
"defined": true,
"code": "BAD_GATEWAY",
"status": 502,
"message": "The AI provider returned an error or couldn't be reached. Try again, or check its settings.",
"data": null
}{
"defined": true,
"code": "<string>",
"status": 1,
"message": "<string>",
"data": null
}post/ai/pdf-parses
Authorization
The API key to authenticate requests.
2 alternative authorization methods available — see the spec for details.
Body
application/jsonResponses
application/json
The PDF was successfully parsed into structured resume data.
Configuration for photograph displayed on the resume
Show child attributesHide child attributes
Whether to hide the picture from the resume.
How the picture fits its frame: cover crops overflow, while contain preserves the whole image.
Options:
covercontainThe URL to the picture to display on the resume. Prefer local app-served paths (for example /uploads/...) populated via upload.
The size of the picture to display on the resume, defined in points (pt).
Range: 32–512
The rotation of the picture to display on the resume, defined in degrees (°).
Range: 0–360
The aspect ratio of the picture to display on the resume, defined as width / height (e.g. 1.5 for 1.5:1 or 0.5 for 1:2).
Range: 0.5–2.5
The border radius of the picture to display on the resume, defined in points (pt).
Range: 0–100
The color of the border of the picture to display on the resume, defined as rgba(r, g, b, a).
The width of the border of the picture to display on the resume, defined in points (pt).
Range: >= 0
The color of the shadow of the picture to display on the resume, defined as rgba(r, g, b, a).
The width of the shadow of the picture to display on the resume, defined in points (pt).
Range: >= 0
Basic information about the author, such as name, email, phone, location, and website
Show child attributesHide child attributes
The full name of the author of the resume.
The headline of the author of the resume.
The email address of the author of the resume.
The phone number of the author of the resume.
The location of the author of the resume.
The website of the author of the resume.
The custom fields to display on the resume.
Show child attributesHide child attributes
The unique identifier for the custom field. Usually generated as a UUID.
The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
The text to display for the custom field.
If the custom field should be a link, the URL to link to.
Summary section of the resume, useful for a short bio or introduction
Show child attributesHide child attributes
The title of the summary of the resume.
Phosphor icon name to display before the summary section title in the PDF output. Empty string uses the default summary icon; 'none' hides the icon.
Whether to hide the summary from the resume.
Whether to show the summary heading, icon, and decoration while retaining summary content.
If true, the summary is kept on a single page instead of splitting across a page break.
If true, the summary always begins on a new page.
The content of the summary of the resume. This should be a HTML-formatted string.
Various sections of the resume, such as experience, education, projects, etc.
Show child attributesHide child attributes
The section to display the profiles of the author.
Show child attributesHide child attributes
The title of the section.
Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
Whether to hide the section from the resume.
Whether to show the section heading, icon, and decoration while retaining section content.
If true, the section is kept on a single page instead of splitting across a page break.
If true, the section always begins on a new page.
The items to display in the profiles section.
Show child attributesHide child attributes
The unique identifier for the item. Usually generated as a UUID.
Whether to hide the item from the resume.
The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color.
The name of the network or platform. Empty while the entry is a draft, which isn't printed.
The username of the author on the network or platform.
The link to the profile of the author on the network or platform, if any.
Show child attributesHide child attributes
The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
The label to display for the URL. Leave blank to display the URL as-is.
If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
The section to display the experience of the author.
Show child attributesHide child attributes
The title of the section.
Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
Whether to hide the section from the resume.
Whether to show the section heading, icon, and decoration while retaining section content.
If true, the section is kept on a single page instead of splitting across a page break.
If true, the section always begins on a new page.
The items to display in the experience section.
Show child attributesHide child attributes
The unique identifier for the item. Usually generated as a UUID.
Whether to hide the item from the resume.
The name of the company or organization. Empty while the entry is a draft, which isn't printed.
The position held at the company or organization. Used when there is only a single role. If multiple roles are provided in the 'roles' field, this serves as a summary title or can be left blank.
The location of the company or organization.
The overall period of time at the company, as text. When multiple roles are used, this should reflect the total tenure. Written from
dates on every save; write dates instead.Structured dates. Write these rather than the legacy text field (
period or date), which is kept in sync from them.Show child attributesHide child attributes
When it started, or the date itself for single-date entries (awards, certifications, publications).
When it ended. Null while ongoing or for single dates.
Whether it's ongoing, printed as 'Present'.
The original text when it couldn't be read exactly, such as 'Summer 2016'. It's printed as written until the dates are edited, which removes it.
The website of the company or organization, if any.
Show child attributesHide child attributes
The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
The label to display for the URL. Leave blank to display the URL as-is.
If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
The description of the experience. This should be a HTML-formatted string.
List of individual roles held at this company to show career progression.
Show child attributesHide child attributes
The unique identifier for the role. Usually generated as a UUID.
The position or job title for this role.
The period of time this role was held, as text. Written from
dates on every save; write dates instead.Structured dates. Write these rather than the legacy text field (
period or date), which is kept in sync from them.Show child attributesHide child attributes
When it started, or the date itself for single-date entries (awards, certifications, publications).
When it ended. Null while ongoing or for single dates.
Whether it's ongoing, printed as 'Present'.
The original text when it couldn't be read exactly, such as 'Summer 2016'. It's printed as written until the dates are edited, which removes it.
The description of this specific role. This should be a HTML-formatted string.
The section to display the education of the author.
Show child attributesHide child attributes
The title of the section.
Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
Whether to hide the section from the resume.
Whether to show the section heading, icon, and decoration while retaining section content.
If true, the section is kept on a single page instead of splitting across a page break.
If true, the section always begins on a new page.
The items to display in the education section.
Show child attributesHide child attributes
The unique identifier for the item. Usually generated as a UUID.
Whether to hide the item from the resume.
The name of the school or institution. Empty while the entry is a draft, which isn't printed.
The degree or qualification obtained.
The area of study or specialization.
The grade or score achieved.
The location of the school or institution.
The period of time the education was obtained over, as text. Written from
dates on every save; write dates instead.Structured dates. Write these rather than the legacy text field (
period or date), which is kept in sync from them.Show child attributesHide child attributes
When it started, or the date itself for single-date entries (awards, certifications, publications).
When it ended. Null while ongoing or for single dates.
Whether it's ongoing, printed as 'Present'.
The original text when it couldn't be read exactly, such as 'Summer 2016'. It's printed as written until the dates are edited, which removes it.
The website of the school or institution, if any.
Show child attributesHide child attributes
The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
The label to display for the URL. Leave blank to display the URL as-is.
If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
The description of the education. This should be a HTML-formatted string.
The section to display the projects of the author.
Show child attributesHide child attributes
The title of the section.
Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
Whether to hide the section from the resume.
Whether to show the section heading, icon, and decoration while retaining section content.
If true, the section is kept on a single page instead of splitting across a page break.
If true, the section always begins on a new page.
The items to display in the projects section.
Show child attributesHide child attributes
The unique identifier for the item. Usually generated as a UUID.
Whether to hide the item from the resume.
The name of the project. Empty while the entry is a draft, which isn't printed.
The period of time the project was worked on, as text. Written from
dates on every save; write dates instead.Structured dates. Write these rather than the legacy text field (
period or date), which is kept in sync from them.Show child attributesHide child attributes
When it started, or the date itself for single-date entries (awards, certifications, publications).
When it ended. Null while ongoing or for single dates.
Whether it's ongoing, printed as 'Present'.
The original text when it couldn't be read exactly, such as 'Summer 2016'. It's printed as written until the dates are edited, which removes it.
The link to the project, if any.
Show child attributesHide child attributes
The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
The label to display for the URL. Leave blank to display the URL as-is.
If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
The description of the project. This should be a HTML-formatted string.
The section to display the skills of the author.
The section to display the languages of the author.
Show child attributesHide child attributes
The title of the section.
Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
Whether to hide the section from the resume.
Whether to show the section heading, icon, and decoration while retaining section content.
If true, the section is kept on a single page instead of splitting across a page break.
If true, the section always begins on a new page.
The items to display in the languages section.
Show child attributesHide child attributes
The unique identifier for the item. Usually generated as a UUID.
Whether to hide the item from the resume.
The name of the language the author knows. Empty while the entry is a draft, which isn't printed.
The fluency level of the language. Can be any text, such as 'Native', 'Fluent', 'Conversational', etc. or can also be a CEFR level (A1, A2, B1, B2, C1, C2).
The proficiency level of the language, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden.
Range: 0–5
The section to display the interests of the author.
Show child attributesHide child attributes
The title of the section.
Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
Whether to hide the section from the resume.
Whether to show the section heading, icon, and decoration while retaining section content.
If true, the section is kept on a single page instead of splitting across a page break.
If true, the section always begins on a new page.
The items to display in the interests section.
Show child attributesHide child attributes
The unique identifier for the item. Usually generated as a UUID.
Whether to hide the item from the resume.
The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color.
The name of the interest/hobby. Empty while the entry is a draft, which isn't printed.
The keywords associated with the interest/hobby, if any. These are displayed as tags below the name.
The section to display the awards of the author.
Show child attributesHide child attributes
The title of the section.
Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
Whether to hide the section from the resume.
Whether to show the section heading, icon, and decoration while retaining section content.
If true, the section is kept on a single page instead of splitting across a page break.
If true, the section always begins on a new page.
The items to display in the awards section.
Show child attributesHide child attributes
The unique identifier for the item. Usually generated as a UUID.
Whether to hide the item from the resume.
The title of the award. Empty while the entry is a draft, which isn't printed.
The awarder of the award.
The date when the award was received, as text. Written from
dates on every save; write dates instead.Structured dates. Write these rather than the legacy text field (
period or date), which is kept in sync from them.Show child attributesHide child attributes
When it started, or the date itself for single-date entries (awards, certifications, publications).
When it ended. Null while ongoing or for single dates.
Whether it's ongoing, printed as 'Present'.
The original text when it couldn't be read exactly, such as 'Summer 2016'. It's printed as written until the dates are edited, which removes it.
The website of the award, if any.
Show child attributesHide child attributes
The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
The label to display for the URL. Leave blank to display the URL as-is.
If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
The description of the award. This should be a HTML-formatted string.
The section to display the certifications of the author.
Show child attributesHide child attributes
The title of the section.
Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
Whether to hide the section from the resume.
Whether to show the section heading, icon, and decoration while retaining section content.
If true, the section is kept on a single page instead of splitting across a page break.
If true, the section always begins on a new page.
The items to display in the certifications section.
Show child attributesHide child attributes
The unique identifier for the item. Usually generated as a UUID.
Whether to hide the item from the resume.
The title of the certification. Empty while the entry is a draft, which isn't printed.
The issuer of the certification.
The date when the certification was received, as text. Written from
dates on every save; write dates instead.Structured dates. Write these rather than the legacy text field (
period or date), which is kept in sync from them.Show child attributesHide child attributes
When it started, or the date itself for single-date entries (awards, certifications, publications).
When it ended. Null while ongoing or for single dates.
Whether it's ongoing, printed as 'Present'.
The original text when it couldn't be read exactly, such as 'Summer 2016'. It's printed as written until the dates are edited, which removes it.
The website of the certification, if any.
Show child attributesHide child attributes
The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
The label to display for the URL. Leave blank to display the URL as-is.
If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
The description of the certification. This should be a HTML-formatted string.
The section to display the publications of the author.
Show child attributesHide child attributes
The title of the section.
Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
Whether to hide the section from the resume.
Whether to show the section heading, icon, and decoration while retaining section content.
If true, the section is kept on a single page instead of splitting across a page break.
If true, the section always begins on a new page.
The items to display in the publications section.
Show child attributesHide child attributes
The unique identifier for the item. Usually generated as a UUID.
Whether to hide the item from the resume.
The title of the publication. Empty while the entry is a draft, which isn't printed.
The publisher of the publication.
The date when the publication was published, as text. Written from
dates on every save; write dates instead.Structured dates. Write these rather than the legacy text field (
period or date), which is kept in sync from them.Show child attributesHide child attributes
When it started, or the date itself for single-date entries (awards, certifications, publications).
When it ended. Null while ongoing or for single dates.
Whether it's ongoing, printed as 'Present'.
The original text when it couldn't be read exactly, such as 'Summer 2016'. It's printed as written until the dates are edited, which removes it.
The link to the publication, if any.
Show child attributesHide child attributes
The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
The label to display for the URL. Leave blank to display the URL as-is.
If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
The description of the publication. This should be a HTML-formatted string.
The section to display the volunteer experience of the author.
Show child attributesHide child attributes
The title of the section.
Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
Whether to hide the section from the resume.
Whether to show the section heading, icon, and decoration while retaining section content.
If true, the section is kept on a single page instead of splitting across a page break.
If true, the section always begins on a new page.
The items to display in the volunteer section.
Show child attributesHide child attributes
The unique identifier for the item. Usually generated as a UUID.
Whether to hide the item from the resume.
The name of the organization or company. Empty while the entry is a draft, which isn't printed.
The location of the organization or company.
The period of time the author was volunteered at the organization or company, as text. Written from
dates on every save; write dates instead.Structured dates. Write these rather than the legacy text field (
period or date), which is kept in sync from them.Show child attributesHide child attributes
When it started, or the date itself for single-date entries (awards, certifications, publications).
When it ended. Null while ongoing or for single dates.
Whether it's ongoing, printed as 'Present'.
The original text when it couldn't be read exactly, such as 'Summer 2016'. It's printed as written until the dates are edited, which removes it.
The link to the organization or company, if any.
Show child attributesHide child attributes
The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
The label to display for the URL. Leave blank to display the URL as-is.
If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
The description of the volunteer experience. This should be a HTML-formatted string.
The section to display the references of the author.
Show child attributesHide child attributes
The title of the section.
Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon.
Whether to hide the section from the resume.
Whether to show the section heading, icon, and decoration while retaining section content.
If true, the section is kept on a single page instead of splitting across a page break.
If true, the section always begins on a new page.
The items to display in the references section.
Show child attributesHide child attributes
The unique identifier for the item. Usually generated as a UUID.
Whether to hide the item from the resume.
The name of the reference, or a note such as 'Available upon request'. Empty while the entry is a draft, which isn't printed.
The position or job title of the reference.
The website or LinkedIn profile of the reference, if any.
Show child attributesHide child attributes
The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).
The label to display for the URL. Leave blank to display the URL as-is.
If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom.
The phone number of the reference.
The description of the reference. Can be used to display a quote, a testimonial, etc. This should be a HTML-formatted string.
Custom sections of the resume, such as a custom section for notes, etc.
Show child attributesHide child attributes
Metadata for the resume, such as template, layout, typography, etc. This section describes the overall design and appearance of the resume.
Show child attributesHide child attributes
The template to use for the resume. Determines the overall design and appearance of the resume.
Options:
azurillbronzorchikoritaditgardittogengarglaliekakunalaprasleafishmeowthonyxpersianpikachuporygonrhyhornscizorsmeargleThe layout of the resume. Determines the structure and arrangement of the sections on the resume.
Show child attributesHide child attributes
The width of the sidebar column, defined as a percentage of the page width.
Range: 10–50
Which side of the page the sidebar column sits on in two-column templates. When unset, each template uses its own side (and right-to-left resumes mirror it).
Options:
leftrightThe pages to display in the layout.
Show child attributesHide child attributes
Whether the layout of the page should be full width. If true, the main column will span the entire width of the page. This means that there should be no items in the sidebar column.
The items to display in the main column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections).
The items to display in the sidebar column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections).
The page settings of the resume. Determines the margins, format, and locale of the resume.
Show child attributesHide child attributes
The horizontal gap between the sections of the page, defined in points (pt).
Range: >= 0
The vertical gap between the sections of the page, defined in points (pt).
Range: >= 0
The format of the page. Can be 'a4', 'letter', or 'free-form'.
Options:
a4letterfree-formThe locale of the page. Used for displaying pre-translated section headings, if not overridden.
How dates print: 'short' (Mar 2022), 'long' (March 2022), 'numeric' (03/2022) or 'iso' (2022-03). When missing, it's read from how the dates were typed.
Options:
shortlongnumericisoWhether to hide the underlines of the links.
Whether to hide the item-level icons (skills, profiles, interests).
Whether to hide the section heading icons displayed before section titles.
The design settings of the resume. Determines the colors, level designs, and typography of the resume.
Show child attributesHide child attributes
Show child attributesHide child attributes
The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
The type of the level design. 'hidden' will hide the level design, 'circle' will display a circle, 'square' will display a square, 'rectangle' will display a rectangle, 'rectangle-full' will display a full rectangle, 'progress-bar' will display a progress bar, and 'icon' will display an icon. If 'icon' is selected, the icon to display should be specified in the 'icon' field.
Options:
hiddencirclesquarerectanglerectangle-fullprogress-bariconShow child attributesHide child attributes
The primary color of the design, defined as rgba(r, g, b, a).
The text color of the design, defined as rgba(r, g, b, a). Usually set to black: rgba(0, 0, 0, 1).
The background color of the design, defined as rgba(r, g, b, a). Usually set to white: rgba(255, 255, 255, 1).
How entry headers are arranged and decorated. When missing, entries use the stacked layout.
Show child attributesHide child attributes
How the header of each Experience, Education and Volunteer entry is arranged. 'stacked' is two rows (name and location, then role and date), 'inline' puts everything on one row, 'compact' puts the lead and the date on top with the rest grouped below, 'date-column' sets dates in a column on the left, and 'eyebrow' puts a small line above a larger lead. Dates also move to the left column for Projects, Awards, Certifications and Publications with 'date-column'.
Options:
stackedinlinecompactdate-columneyebrowWhich comes first in Experience and Education entries: the organization (company, school) or the role (position, field of study).
Options:
organizationroleDecoration in the accent color around each entry header: 'none', 'rule' (a line under it), 'bar' (a bar beside it) or 'band' (a tinted background).
Options:
nonerulebarbandThe typography settings of the resume. Determines the fonts and sizes of the body and headings of the resume.
Show child attributesHide child attributes
The typography for the body of the resume.
Show child attributesHide child attributes
The family of the font to use. Must be a supported resume font.
The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font.
The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x).
Range: 0.5–4
The typography for the headings of the resume.
Show child attributesHide child attributes
The family of the font to use. Must be a supported resume font.
The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font.
The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x).
Range: 0.5–4
Enable automatic PDF hyphenation using the resume language. Defaults to false.
Personal notes for the resume. Can be used to add any additional information or instructions for the resume. These notes are not displayed on the resume, they are only visible to the author of the resume when editing the resume. This should be a HTML-formatted string.
Structured style rules that target semantic resume sections and slots for PDF rendering.
Settings for the resume's public web page, which uses the resume's template. Missing until the author changes them in Share.
Show child attributesHide child attributes
Whether the web page shows the small 'Made with Reactive Resume' footer.
The author's Check choices for this resume. Not printed; missing until a choice is made.