> ## Documentation Index > Fetch the complete documentation index at: https://docs.rxresu.me/llms.txt > Use this file to discover all available pages before exploring further. # Post coverlettersimport ## OpenAPI ````yaml /spec.json post /coverLetters/import openapi: 3.1.1 info: title: Reactive Resume version: 5.2.8 description: Reactive Resume API license: name: MIT url: https://github.com/amruthpillai/reactive-resume/blob/main/LICENSE contact: name: Amruth Pillai email: hello@amruthpillai.com url: https://amruthpillai.com servers: - url: https://rxresu.me/api/openapi security: - apiKey: [] externalDocs: url: https://docs.rxresu.me description: Reactive Resume Documentation paths: /coverLetters/import: post: operationId: coverLetters.import requestBody: required: true content: application/json: schema: type: object properties: document: type: object properties: name: type: string minLength: 1 maxLength: 100 recipient: type: string maxLength: 20000 content: type: string maxLength: 100000 style: type: object properties: basics: type: object properties: name: type: string description: The full name of the author of the resume. headline: type: string description: The headline of the author of the resume. email: type: string description: The email address of the author of the resume. phone: type: string description: The phone number of the author of the resume. location: type: string description: The location of the author of the resume. website: type: object properties: url: type: string description: >- The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). label: type: string description: >- The label to display for the URL. Leave blank to display the URL as-is. required: - url - label description: The website of the author of the resume. customFields: type: array items: type: object properties: id: type: string description: >- The unique identifier for the custom field. Usually generated as a UUID. icon: type: string description: >- 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. text: type: string description: The text to display for the custom field. link: type: string description: >- If the custom field should be a link, the URL to link to. required: - id - icon - text - link description: The custom fields to display on the resume. required: - name - headline - email - phone - location - website - customFields picture: type: object properties: hidden: type: boolean description: Whether to hide the picture from the resume. url: type: string description: >- The URL to the picture to display on the resume. Prefer local app-served paths (for example /uploads/...) populated via upload. size: type: number minimum: 32 maximum: 512 description: >- The size of the picture to display on the resume, defined in points (pt). rotation: type: number minimum: 0 maximum: 360 description: >- The rotation of the picture to display on the resume, defined in degrees (°). aspectRatio: type: number minimum: 0.5 maximum: 2.5 description: >- 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). borderRadius: type: number minimum: 0 maximum: 100 description: >- The border radius of the picture to display on the resume, defined in points (pt). borderColor: type: string description: >- The color of the border of the picture to display on the resume, defined as rgba(r, g, b, a). borderWidth: type: number minimum: 0 description: >- The width of the border of the picture to display on the resume, defined in points (pt). shadowColor: type: string description: >- The color of the shadow of the picture to display on the resume, defined as rgba(r, g, b, a). shadowWidth: type: number minimum: 0 description: >- The width of the shadow of the picture to display on the resume, defined in points (pt). required: - hidden - url - size - rotation - aspectRatio - borderRadius - borderColor - borderWidth - shadowColor - shadowWidth metadata: type: object properties: template: enum: - azurill - bronzor - chikorita - ditgar - ditto - gengar - glalie - kakuna - lapras - leafish - meowth - onyx - pikachu - rhyhorn - scizor type: string description: >- The template to use for the resume. Determines the overall design and appearance of the resume. page: type: object properties: gapX: type: number minimum: 0 description: >- The horizontal gap between the sections of the page, defined in points (pt). gapY: type: number minimum: 0 description: >- The vertical gap between the sections of the page, defined in points (pt). marginX: type: number minimum: 0 maximum: 100 description: >- The horizontal margin of the page, defined in points (pt). marginY: type: number minimum: 0 maximum: 100 description: >- The vertical margin of the page, defined in points (pt). format: enum: - a4 - letter - free-form type: string description: >- The format of the page. Can be 'a4', 'letter', or 'free-form'. locale: type: string description: >- The locale of the page. Used for displaying pre-translated section headings, if not overridden. hideLinkUnderline: type: boolean description: Whether to hide the underlines of the links. hideIcons: type: boolean description: >- Whether to hide the item-level icons (skills, profiles, interests). hideSectionIcons: type: boolean description: >- Whether to hide the section heading icons displayed before section titles. required: - gapX - gapY - marginX - marginY - format - locale - hideLinkUnderline - hideIcons - hideSectionIcons description: >- The page settings of the resume. Determines the margins, format, and locale of the resume. design: type: object properties: level: type: object properties: icon: type: string description: >- 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. type: type: string enum: - hidden - circle - square - rectangle - rectangle-full - progress-bar - icon description: >- 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. required: - icon - type colors: type: object properties: primary: type: string description: >- The primary color of the design, defined as rgba(r, g, b, a). text: type: string description: >- The text color of the design, defined as rgba(r, g, b, a). Usually set to black: rgba(0, 0, 0, 1). background: type: string description: >- The background color of the design, defined as rgba(r, g, b, a). Usually set to white: rgba(255, 255, 255, 1). required: - primary - text - background required: - level - colors description: >- The design settings of the resume. Determines the colors, level designs, and typography of the resume. typography: type: object properties: body: type: object properties: fontFamily: type: string description: >- The family of the font to use. Must be a supported resume font. fontWeights: type: array items: type: string enum: - '100' - '200' - '300' - '400' - '500' - '600' - '700' - '800' - '900' description: >- 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. fontSize: type: number minimum: 6 maximum: 24 description: >- The size of the font to use, defined in points (pt). lineHeight: type: number minimum: 0.5 maximum: 4 description: >- The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x). required: - fontFamily - fontWeights - fontSize - lineHeight description: The typography for the body of the resume. heading: type: object properties: fontFamily: type: string description: >- The family of the font to use. Must be a supported resume font. fontWeights: type: array items: type: string enum: - '100' - '200' - '300' - '400' - '500' - '600' - '700' - '800' - '900' description: >- 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. fontSize: type: number minimum: 6 maximum: 24 description: >- The size of the font to use, defined in points (pt). lineHeight: type: number minimum: 0.5 maximum: 4 description: >- The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x). required: - fontFamily - fontWeights - fontSize - lineHeight description: >- The typography for the headings of the resume. required: - body - heading description: >- The typography settings of the resume. Determines the fonts and sizes of the body and headings of the resume. styleRules: type: array items: {} description: >- Structured style rules that target semantic resume sections and slots for React PDF rendering. stylesheet: type: object properties: mode: type: string enum: - legacy - semantic source: type: object properties: languageVersion: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 text: type: string required: - languageVersion - text additionalProperties: false required: - mode - source additionalProperties: false required: - template - page - design - typography - styleRules sectionId: type: string minLength: 1 itemId: type: string minLength: 1 required: - basics - picture - metadata - sectionId - itemId format: const: reactive-resume-cover-letter version: const: 1 required: - name - recipient - content - style - format - version required: - document responses: '200': description: OK content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 100 recipient: type: string maxLength: 20000 content: type: string maxLength: 100000 style: type: object properties: basics: type: object properties: name: type: string description: The full name of the author of the resume. headline: type: string description: The headline of the author of the resume. email: type: string description: The email address of the author of the resume. phone: type: string description: The phone number of the author of the resume. location: type: string description: The location of the author of the resume. website: type: object properties: url: type: string description: >- The URL to show as a link. Must be a valid URL with a protocol (http:// or https://). label: type: string description: >- The label to display for the URL. Leave blank to display the URL as-is. required: - url - label description: The website of the author of the resume. customFields: type: array items: type: object properties: id: type: string description: >- The unique identifier for the custom field. Usually generated as a UUID. icon: type: string description: >- 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. text: type: string description: The text to display for the custom field. link: type: string description: >- If the custom field should be a link, the URL to link to. required: - id - icon - text - link description: The custom fields to display on the resume. required: - name - headline - email - phone - location - website - customFields picture: type: object properties: hidden: type: boolean description: Whether to hide the picture from the resume. url: type: string description: >- The URL to the picture to display on the resume. Prefer local app-served paths (for example /uploads/...) populated via upload. size: type: number minimum: 32 maximum: 512 description: >- The size of the picture to display on the resume, defined in points (pt). rotation: type: number minimum: 0 maximum: 360 description: >- The rotation of the picture to display on the resume, defined in degrees (°). aspectRatio: type: number minimum: 0.5 maximum: 2.5 description: >- 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). borderRadius: type: number minimum: 0 maximum: 100 description: >- The border radius of the picture to display on the resume, defined in points (pt). borderColor: type: string description: >- The color of the border of the picture to display on the resume, defined as rgba(r, g, b, a). borderWidth: type: number minimum: 0 description: >- The width of the border of the picture to display on the resume, defined in points (pt). shadowColor: type: string description: >- The color of the shadow of the picture to display on the resume, defined as rgba(r, g, b, a). shadowWidth: type: number minimum: 0 description: >- The width of the shadow of the picture to display on the resume, defined in points (pt). required: - hidden - url - size - rotation - aspectRatio - borderRadius - borderColor - borderWidth - shadowColor - shadowWidth metadata: type: object properties: template: enum: - azurill - bronzor - chikorita - ditgar - ditto - gengar - glalie - kakuna - lapras - leafish - meowth - onyx - pikachu - rhyhorn - scizor type: string description: >- The template to use for the resume. Determines the overall design and appearance of the resume. page: type: object properties: gapX: type: number minimum: 0 description: >- The horizontal gap between the sections of the page, defined in points (pt). gapY: type: number minimum: 0 description: >- The vertical gap between the sections of the page, defined in points (pt). marginX: type: number minimum: 0 maximum: 100 description: >- The horizontal margin of the page, defined in points (pt). marginY: type: number minimum: 0 maximum: 100 description: >- The vertical margin of the page, defined in points (pt). format: enum: - a4 - letter - free-form type: string description: >- The format of the page. Can be 'a4', 'letter', or 'free-form'. locale: type: string description: >- The locale of the page. Used for displaying pre-translated section headings, if not overridden. hideLinkUnderline: type: boolean description: Whether to hide the underlines of the links. hideIcons: type: boolean description: >- Whether to hide the item-level icons (skills, profiles, interests). hideSectionIcons: type: boolean description: >- Whether to hide the section heading icons displayed before section titles. required: - gapX - gapY - marginX - marginY - format - locale - hideLinkUnderline - hideIcons - hideSectionIcons description: >- The page settings of the resume. Determines the margins, format, and locale of the resume. design: type: object properties: level: type: object properties: icon: type: string description: >- 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. type: type: string enum: - hidden - circle - square - rectangle - rectangle-full - progress-bar - icon description: >- 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. required: - icon - type colors: type: object properties: primary: type: string description: >- The primary color of the design, defined as rgba(r, g, b, a). text: type: string description: >- The text color of the design, defined as rgba(r, g, b, a). Usually set to black: rgba(0, 0, 0, 1). background: type: string description: >- The background color of the design, defined as rgba(r, g, b, a). Usually set to white: rgba(255, 255, 255, 1). required: - primary - text - background required: - level - colors description: >- The design settings of the resume. Determines the colors, level designs, and typography of the resume. typography: type: object properties: body: type: object properties: fontFamily: type: string description: >- The family of the font to use. Must be a supported resume font. fontWeights: type: array items: type: string enum: - '100' - '200' - '300' - '400' - '500' - '600' - '700' - '800' - '900' description: >- 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. fontSize: type: number minimum: 6 maximum: 24 description: >- The size of the font to use, defined in points (pt). lineHeight: type: number minimum: 0.5 maximum: 4 description: >- The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x). required: - fontFamily - fontWeights - fontSize - lineHeight description: The typography for the body of the resume. heading: type: object properties: fontFamily: type: string description: >- The family of the font to use. Must be a supported resume font. fontWeights: type: array items: type: string enum: - '100' - '200' - '300' - '400' - '500' - '600' - '700' - '800' - '900' description: >- 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. fontSize: type: number minimum: 6 maximum: 24 description: >- The size of the font to use, defined in points (pt). lineHeight: type: number minimum: 0.5 maximum: 4 description: >- The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x). required: - fontFamily - fontWeights - fontSize - lineHeight description: The typography for the headings of the resume. required: - body - heading description: >- The typography settings of the resume. Determines the fonts and sizes of the body and headings of the resume. styleRules: description: >- Structured style rules that target semantic resume sections and slots for React PDF rendering. stylesheet: type: object properties: mode: type: string enum: - legacy - semantic source: type: object properties: languageVersion: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 text: type: string required: - languageVersion - text additionalProperties: false required: - mode - source additionalProperties: false required: - template - page - design - typography sectionId: type: string minLength: 1 itemId: type: string minLength: 1 required: - basics - picture - metadata - sectionId - itemId id: type: string sourceResumeId: anyOf: - type: string - type: 'null' sourceApplicationId: anyOf: - type: string - type: 'null' revision: type: integer minimum: 1 maximum: 9007199254740991 createdAt: type: string format: date-time x-native-type: date updatedAt: type: string format: date-time x-native-type: date required: - name - recipient - content - style - id - sourceResumeId - sourceApplicationId - revision - createdAt - updatedAt components: securitySchemes: apiKey: type: apiKey name: x-api-key in: header description: The API key to authenticate requests. ````