Create a cover letter - Reactive Resume

post/cover-letters

Request example

curl --request POST "https://rxresu.me/api/openapi/cover-letters" --header "x-api-key: <api-key>" --header "Content-Type: application/json" --data '{
  "name": "<string>"
}'

Response

{
  "name": "<string>",
  "recipient": "<string>",
  "content": "<string>",
  "greeting": null,
  "signOff": null,
  "style": {
    "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>"
        }
      ]
    },
    "picture": {
      "hidden": true,
      "fit": "cover",
      "url": "<string>",
      "size": 32,
      "rotation": 0,
      "aspectRatio": 0.5,
      "borderRadius": 0,
      "borderColor": "<string>",
      "borderWidth": 0,
      "shadowColor": "<string>",
      "shadowWidth": 0
    },
    "metadata": {
      "template": "azurill",
      "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
      },
      "styleRules": null,
      "stylesheet": {
        "mode": "legacy",
        "source": {
          "languageVersion": -9007199254740991,
          "text": "<string>"
        }
      },
      "web": {
        "showCredit": true
      },
      "check": {
        "ignored": [
          "<string>"
        ],
        "hiddenTerms": [
          "<string>"
        ]
      }
    },
    "sectionId": "<string>",
    "itemId": "<string>"
  },
  "layout": "freeform",
  "recipientName": "",
  "recipientCompany": "",
  "letterDate": null,
  "id": "<string>",
  "sourceResumeId": "<string>",
  "sourceApplicationId": "<string>",
  "senderLinked": true,
  "designLinked": true,
  "isLocked": true,
  "revision": 1,
  "createdAt": "2026-08-10T12:00:00Z",
  "updatedAt": "2026-08-10T12:00:00Z"
}

{
  "defined": true,
  "code": "<string>",
  "status": 1,
  "message": "<string>",
  "data": null
}

post/cover-letters

Authorization

x-api-keystringheaderrequired#

The API key to authenticate requests.

2 alternative authorization methods available — see the spec for details.

Body

application/json

namestringrequired#

Length: 1–100

recipientstring#

Default: ""

Length: max 20000

contentstring#

Default: ""

Length: max 100000

greetingstring · null#

signOffstring · null#

resumeIdstring#

The resume it goes with; its details and design are linked.

Length: min 1

applicationIdstring#

The job it's for; it fills the recipient.

Length: min 1

templateenum<string>#

Options:azurillbronzorchikoritaditgardittogengarglaliekakunalaprasleafishmeowthonyxpersianpikachuporygonrhyhornscizorsmeargle

layoutenum<string>#

Defaults to structured, or freeform when a recipient block is given.

Options:structuredfreeform

recipientNamestring#

Length: max 200

recipientCompanystring#

Length: max 200

letterDatestring · null#

YYYY-MM-DD; defaults to today.

Responses

application/json

The newly created cover letter.

namestringrequired#

Length: 1–100

recipientstringrequired#

Length: max 20000

contentstringrequired#

Length: max 100000

greetingstring · null#

Custom greeting; null uses the document language default, empty omits it.

Default: null

signOffstring · null#

Custom signature including name and optional contact details; null uses the document language default with the sender's name, empty omits it.

Default: null

styleobjectrequired#

Show child attributes

basicsobjectrequired#

Show child attributes

namestringrequired#

The full name of the author of the resume.

headlinestringrequired#

The headline of the author of the resume.

emailstringrequired#

The email address of the author of the resume.

phonestringrequired#

The phone number of the author of the resume.

locationstringrequired#

The location of the author of the resume.

websiteobjectrequired#

The website of the author of the resume.

Show child attributes

urlstringrequired#

The URL to show as a link. Must be a valid URL with a protocol (http:// or https://).

labelstringrequired#

The label to display for the URL. Leave blank to display the URL as-is.

customFieldsobject[]required#

The custom fields to display on the resume.

Show child attributes

idstringrequired#

The unique identifier for the custom field. Usually generated as a UUID.

iconstringrequired#

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.

textstringrequired#

The text to display for the custom field.

linkstringrequired#

If the custom field should be a link, the URL to link to.

pictureobjectrequired#

Show child attributes

hiddenbooleanrequired#

Whether to hide the picture from the resume.

fitenum<string>required#

How the picture fits its frame: cover crops overflow, while contain preserves the whole image.

Options:covercontain

urlstringrequired#

The URL to the picture to display on the resume. Prefer local app-served paths (for example /uploads/...) populated via upload.

sizenumberrequired#

The size of the picture to display on the resume, defined in points (pt).

Range: 32–512

rotationnumberrequired#

The rotation of the picture to display on the resume, defined in degrees (°).

Range: 0–360

aspectRationumberrequired#

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

borderRadiusnumberrequired#

The border radius of the picture to display on the resume, defined in points (pt).

Range: 0–100

borderColorstringrequired#

The color of the border of the picture to display on the resume, defined as rgba(r, g, b, a).

borderWidthnumberrequired#

The width of the border of the picture to display on the resume, defined in points (pt).

Range: >= 0

shadowColorstringrequired#

The color of the shadow of the picture to display on the resume, defined as rgba(r, g, b, a).

shadowWidthnumberrequired#

The width of the shadow of the picture to display on the resume, defined in points (pt).

Range: >= 0

metadataobjectrequired#

Show child attributes

templateenum<string>required#

The template to use for the resume. Determines the overall design and appearance of the resume.

Options:azurillbronzorchikoritaditgardittogengarglaliekakunalaprasleafishmeowthonyxpersianpikachuporygonrhyhornscizorsmeargle

pageobjectrequired#

The page settings of the resume. Determines the margins, format, and locale of the resume.

Show child attributes

gapXnumberrequired#

The horizontal gap between the sections of the page, defined in points (pt).

Range: >= 0

gapYnumberrequired#

The vertical gap between the sections of the page, defined in points (pt).

Range: >= 0

marginXnumberrequired#

The horizontal margin of the page, defined in points (pt).

Range: 0–100

marginYnumberrequired#

The vertical margin of the page, defined in points (pt).

Range: 0–100

formatenum<string>required#

The format of the page. Can be 'a4', 'letter', or 'free-form'.

Options:a4letterfree-form

localestringrequired#

The locale of the page. Used for displaying pre-translated section headings, if not overridden.

dateFormatenum<string>#

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:shortlongnumericiso

hideLinkUnderlinebooleanrequired#

Whether to hide the underlines of the links.

hideIconsbooleanrequired#

Whether to hide the item-level icons (skills, profiles, interests).

hideSectionIconsbooleanrequired#

Whether to hide the section heading icons displayed before section titles.

designobjectrequired#

The design settings of the resume. Determines the colors, level designs, and typography of the resume.

Show child attributes

levelobjectrequired#

Show child attributes

iconstringrequired#

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.

typeenum<string>required#

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-baricon

colorsobjectrequired#

Show child attributes

primarystringrequired#

The primary color of the design, defined as rgba(r, g, b, a).

textstringrequired#

The text color of the design, defined as rgba(r, g, b, a). Usually set to black: rgba(0, 0, 0, 1).

backgroundstringrequired#

The background color of the design, defined as rgba(r, g, b, a). Usually set to white: rgba(255, 255, 255, 1).

entryobject#

How entry headers are arranged and decorated. When missing, entries use the stacked layout.

Show child attributes

layoutenum<string>required#

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-columneyebrow

leadenum<string>required#

Which comes first in Experience and Education entries: the organization (company, school) or the role (position, field of study).

Options:organizationrole

accentenum<string>required#

Decoration 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:nonerulebarband

typographyobjectrequired#

The typography settings of the resume. Determines the fonts and sizes of the body and headings of the resume.

Show child attributes

bodyobjectrequired#

The typography for the body of the resume.

Show child attributes

fontFamilystringrequired#

The family of the font to use. Must be a supported resume font.

fontWeightsenum<string>[]required#

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.

fontSizenumberrequired#

The size of the font to use, defined in points (pt).

Range: 6–24

lineHeightnumberrequired#

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

headingobjectrequired#

The typography for the headings of the resume.

Show child attributes

fontFamilystringrequired#

The family of the font to use. Must be a supported resume font.

fontWeightsenum<string>[]required#

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.

fontSizenumberrequired#

The size of the font to use, defined in points (pt).

Range: 6–24

lineHeightnumberrequired#

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

hyphenationboolean#

Enable automatic PDF hyphenation using the resume language. Defaults to false.

styleRulesany#

Structured style rules that target semantic resume sections and slots for PDF rendering.

stylesheetobject#

Show child attributes

modeenum<string>required#

Options:legacysemantic

sourceobjectrequired#

Show child attributes

languageVersionintegerrequired#

Range: -9007199254740991 < x <= 9007199254740991

textstringrequired#

webobject#

Settings for the resume's public web page, which uses the resume's template. Missing until the author changes them in Share.

Show child attributes

showCreditbooleanrequired#

Whether the web page shows the small 'Made with Reactive Resume' footer.

checkobject#

The author's Check choices for this resume. Not printed; missing until a choice is made.

Show child attributes

ignoredstring[]required#

Check issues the author chose to ignore, by issue key (the rule code and where it applies).

hiddenTermsstring[]required#

Job-posting terms the author hid from Job match as not true for them.

sectionIdstringrequired#

Length: min 1

itemIdstringrequired#

Length: min 1

layoutenum<string>#

structured: recipient name, company and date fields, a greeting from the name, the body and a sign-off. freeform: the recipient block and body as written (letters from before structured letters).

Default: "freeform"

Options:structuredfreeform

recipientNamestring#

Who the letter is to: a person, or a team.

Default: ""

Length: max 200

recipientCompanystring#

Default: ""

Length: max 200

letterDatestring · null#

The letter's date, as YYYY-MM-DD.

Default: null

idstringrequired#

sourceResumeIdstring · nullrequired#

sourceApplicationIdstring · nullrequired#

senderLinkedbooleanrequired#

The sender's details come live from the source resume, instead of the copy in style.

designLinkedbooleanrequired#

The design comes live from the source resume, instead of the copy in style.

isLockedbooleanrequired#

Locked letters can't be edited or moved to Trash until they're unlocked.

revisionintegerrequired#

Range: 1–9007199254740991

createdAtstringrequired#

updatedAtstringrequired#

List cover letters Get cover letter by ID