> ## 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.

# Check a PDF for ATS readability

> Multipart PDF upload, up to 25 MB. Processes at most 30 pages, reports truncation and skipped checks, and stores nothing. Rate limited per client address. No authentication required.



## OpenAPI

````yaml /spec.json post /pdf-checks
openapi: 3.1.1
info:
  title: Reactive Resume
  version: 6.0.0
  description: >-
    Reactive Resume API. Mutations do not support Idempotency-Key. Do not
    automatically retry POST, PUT, PATCH or DELETE requests after a timeout:
    first read the resource to determine whether the operation succeeded.
    Existing enum values and response shapes are retained for compatibility.
  license:
    name: MIT
    url: https://github.com/reactive-resume/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: []
  - bearerAuth: []
  - cookieAuth: []
externalDocs:
  url: https://docs.rxresu.me
  description: Reactive Resume Documentation
paths:
  /pdf-checks:
    post:
      tags:
        - Checks
      summary: Check a PDF for ATS readability
      description: >-
        Multipart PDF upload, up to 25 MB. Processes at most 30 pages, reports
        truncation and skipped checks, and stores nothing. Rate limited per
        client address. No authentication required.
      operationId: createPdfCheck
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  contentMediaType: '*/*'
                jobDescription:
                  type: string
                  maxLength: 20000
              required:
                - file
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  version:
                    const: 1
                  score:
                    type: number
                  cappedBy:
                    type: array
                    items:
                      enum:
                        - NO_TEXT_LAYER
                        - IMAGE_ONLY_DOCUMENT
                        - GARBLED_TEXT
                        - TYPE3_FONT
                        - INVALID_EMBEDDED_FONT
                        - FILE_TOO_LARGE
                        - ENCRYPTED_PDF
                        - XFA_FORM
                        - PDF_PORTFOLIO
                        - REPLACEMENT_CHARACTERS
                        - PRIVATE_USE_CHARACTERS
                        - LIGATURE_CHARACTERS
                        - NON_EMBEDDED_FONTS
                        - INVISIBLE_TEXT
                        - WHITE_TEXT
                        - LOW_TEXT_DENSITY
                        - HIGH_IMAGE_COVERAGE
                        - LOST_WORD_SPACING
                        - SPLIT_CHARACTER_SPACING
                        - VERTICAL_TEXT
                        - ROTATED_PAGES
                        - ACROFORM_FIELDS
                        - NON_STANDARD_PAGE_SIZE
                        - UNTAGGED_PDF
                        - MISSING_DOCUMENT_LANGUAGE
                        - LARGE_FILE_SIZE
                        - TRUNCATED_ANALYSIS
                        - MULTI_COLUMN_LAYOUT
                        - READING_ORDER_INVERSION
                        - READING_ORDER_RISK
                        - COLUMN_GUTTER
                        - TABLE_LIKE_LAYOUT
                        - TEXT_IN_MARGIN_ZONE
                        - TIGHT_LINE_SPACING
                        - SMALL_BODY_TEXT
                        - MANY_DISTINCT_FONTS
                        - NARROW_PAGE_MARGINS
                        - TEXT_OUTSIDE_PAGE
                        - NON_STANDARD_BULLET_GLYPHS
                        - REPEATED_HEADER_FOOTER
                        - DENSE_PAGE
                        - NO_EXPERIENCE_SECTION
                        - NO_RECOGNIZED_HEADINGS
                        - FEW_SECTION_HEADINGS
                        - NO_EDUCATION_SECTION
                        - NO_SKILLS_SECTION
                        - HEADINGS_NOT_DISTINGUISHED
                        - VERY_SHORT_DOCUMENT
                        - NO_BULLET_POINTS
                        - NO_ROLE_LINES
                        - NO_SUMMARY_SECTION
                        - NO_EMAIL
                        - NO_PHONE
                        - NO_NAME_LINE
                        - CONTACT_NOT_ON_FIRST_PAGE
                        - EMAIL_SPLIT_ACROSS_ITEMS
                        - LINK_TEXT_URL_MISMATCH
                        - MULTIPLE_EMAILS
                        - NO_PROFESSIONAL_LINK
                        - BARE_URL_WITHOUT_PROTOCOL
                        - PHONE_FORMAT_UNUSUAL
                        - NO_DATES_FOUND
                        - FEW_DATES
                        - UNPARSEABLE_DATE_RANGE
                        - REVERSED_DATE_RANGE
                        - FUTURE_DATED_ENTRY
                        - MIXED_DATE_FORMATS
                        - NO_CURRENT_ROLE_MARKER
                        - AMBIGUOUS_NUMERIC_DATE
                        - NO_QUANTIFIED_IMPACT
                        - WEAK_ACTION_VERBS
                        - FIRST_PERSON_PRONOUNS
                        - LONG_BULLETS
                        - HIGH_PAGE_COUNT
                        - EMPLOYMENT_GAP
                        - ALL_CAPS_RUNS
                        - REPEATED_PHRASES
                      type: string
                    readOnly: true
                  categories:
                    type: array
                    items:
                      type: object
                      properties:
                        category:
                          enum:
                            - parseability
                            - layout
                            - sections
                            - contact
                            - dates
                          type: string
                        score:
                          type: number
                        weight:
                          type: number
                        applicableChecks:
                          type: number
                        passedChecks:
                          type: number
                        skippedChecks:
                          type: number
                      required:
                        - category
                        - score
                        - weight
                        - applicableChecks
                        - passedChecks
                        - skippedChecks
                    readOnly: true
                  checks:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          enum:
                            - NO_TEXT_LAYER
                            - IMAGE_ONLY_DOCUMENT
                            - GARBLED_TEXT
                            - TYPE3_FONT
                            - INVALID_EMBEDDED_FONT
                            - FILE_TOO_LARGE
                            - ENCRYPTED_PDF
                            - XFA_FORM
                            - PDF_PORTFOLIO
                            - REPLACEMENT_CHARACTERS
                            - PRIVATE_USE_CHARACTERS
                            - LIGATURE_CHARACTERS
                            - NON_EMBEDDED_FONTS
                            - INVISIBLE_TEXT
                            - WHITE_TEXT
                            - LOW_TEXT_DENSITY
                            - HIGH_IMAGE_COVERAGE
                            - LOST_WORD_SPACING
                            - SPLIT_CHARACTER_SPACING
                            - VERTICAL_TEXT
                            - ROTATED_PAGES
                            - ACROFORM_FIELDS
                            - NON_STANDARD_PAGE_SIZE
                            - UNTAGGED_PDF
                            - MISSING_DOCUMENT_LANGUAGE
                            - LARGE_FILE_SIZE
                            - TRUNCATED_ANALYSIS
                            - MULTI_COLUMN_LAYOUT
                            - READING_ORDER_INVERSION
                            - READING_ORDER_RISK
                            - COLUMN_GUTTER
                            - TABLE_LIKE_LAYOUT
                            - TEXT_IN_MARGIN_ZONE
                            - TIGHT_LINE_SPACING
                            - SMALL_BODY_TEXT
                            - MANY_DISTINCT_FONTS
                            - NARROW_PAGE_MARGINS
                            - TEXT_OUTSIDE_PAGE
                            - NON_STANDARD_BULLET_GLYPHS
                            - REPEATED_HEADER_FOOTER
                            - DENSE_PAGE
                            - NO_EXPERIENCE_SECTION
                            - NO_RECOGNIZED_HEADINGS
                            - FEW_SECTION_HEADINGS
                            - NO_EDUCATION_SECTION
                            - NO_SKILLS_SECTION
                            - HEADINGS_NOT_DISTINGUISHED
                            - VERY_SHORT_DOCUMENT
                            - NO_BULLET_POINTS
                            - NO_ROLE_LINES
                            - NO_SUMMARY_SECTION
                            - NO_EMAIL
                            - NO_PHONE
                            - NO_NAME_LINE
                            - CONTACT_NOT_ON_FIRST_PAGE
                            - EMAIL_SPLIT_ACROSS_ITEMS
                            - LINK_TEXT_URL_MISMATCH
                            - MULTIPLE_EMAILS
                            - NO_PROFESSIONAL_LINK
                            - BARE_URL_WITHOUT_PROTOCOL
                            - PHONE_FORMAT_UNUSUAL
                            - NO_DATES_FOUND
                            - FEW_DATES
                            - UNPARSEABLE_DATE_RANGE
                            - REVERSED_DATE_RANGE
                            - FUTURE_DATED_ENTRY
                            - MIXED_DATE_FORMATS
                            - NO_CURRENT_ROLE_MARKER
                            - AMBIGUOUS_NUMERIC_DATE
                            - NO_QUANTIFIED_IMPACT
                            - WEAK_ACTION_VERBS
                            - FIRST_PERSON_PRONOUNS
                            - LONG_BULLETS
                            - HIGH_PAGE_COUNT
                            - EMPLOYMENT_GAP
                            - ALL_CAPS_RUNS
                            - REPEATED_PHRASES
                          type: string
                        category:
                          enum:
                            - parseability
                            - layout
                            - sections
                            - contact
                            - dates
                            - content
                          type: string
                        severity:
                          enum:
                            - blocker
                            - warning
                            - tip
                          type: string
                        status:
                          enum:
                            - pass
                            - skip
                            - fail
                          type: string
                        skipReason:
                          enum:
                            - no-text
                            - no-operators
                            - not-english
                            - not-applicable
                            - encrypted
                            - insufficient-data
                          type: string
                        findings:
                          type: array
                          items:
                            type: object
                            properties:
                              code:
                                enum:
                                  - NO_TEXT_LAYER
                                  - IMAGE_ONLY_DOCUMENT
                                  - GARBLED_TEXT
                                  - TYPE3_FONT
                                  - INVALID_EMBEDDED_FONT
                                  - FILE_TOO_LARGE
                                  - ENCRYPTED_PDF
                                  - XFA_FORM
                                  - PDF_PORTFOLIO
                                  - REPLACEMENT_CHARACTERS
                                  - PRIVATE_USE_CHARACTERS
                                  - LIGATURE_CHARACTERS
                                  - NON_EMBEDDED_FONTS
                                  - INVISIBLE_TEXT
                                  - WHITE_TEXT
                                  - LOW_TEXT_DENSITY
                                  - HIGH_IMAGE_COVERAGE
                                  - LOST_WORD_SPACING
                                  - SPLIT_CHARACTER_SPACING
                                  - VERTICAL_TEXT
                                  - ROTATED_PAGES
                                  - ACROFORM_FIELDS
                                  - NON_STANDARD_PAGE_SIZE
                                  - UNTAGGED_PDF
                                  - MISSING_DOCUMENT_LANGUAGE
                                  - LARGE_FILE_SIZE
                                  - TRUNCATED_ANALYSIS
                                  - MULTI_COLUMN_LAYOUT
                                  - READING_ORDER_INVERSION
                                  - READING_ORDER_RISK
                                  - COLUMN_GUTTER
                                  - TABLE_LIKE_LAYOUT
                                  - TEXT_IN_MARGIN_ZONE
                                  - TIGHT_LINE_SPACING
                                  - SMALL_BODY_TEXT
                                  - MANY_DISTINCT_FONTS
                                  - NARROW_PAGE_MARGINS
                                  - TEXT_OUTSIDE_PAGE
                                  - NON_STANDARD_BULLET_GLYPHS
                                  - REPEATED_HEADER_FOOTER
                                  - DENSE_PAGE
                                  - NO_EXPERIENCE_SECTION
                                  - NO_RECOGNIZED_HEADINGS
                                  - FEW_SECTION_HEADINGS
                                  - NO_EDUCATION_SECTION
                                  - NO_SKILLS_SECTION
                                  - HEADINGS_NOT_DISTINGUISHED
                                  - VERY_SHORT_DOCUMENT
                                  - NO_BULLET_POINTS
                                  - NO_ROLE_LINES
                                  - NO_SUMMARY_SECTION
                                  - NO_EMAIL
                                  - NO_PHONE
                                  - NO_NAME_LINE
                                  - CONTACT_NOT_ON_FIRST_PAGE
                                  - EMAIL_SPLIT_ACROSS_ITEMS
                                  - LINK_TEXT_URL_MISMATCH
                                  - MULTIPLE_EMAILS
                                  - NO_PROFESSIONAL_LINK
                                  - BARE_URL_WITHOUT_PROTOCOL
                                  - PHONE_FORMAT_UNUSUAL
                                  - NO_DATES_FOUND
                                  - FEW_DATES
                                  - UNPARSEABLE_DATE_RANGE
                                  - REVERSED_DATE_RANGE
                                  - FUTURE_DATED_ENTRY
                                  - MIXED_DATE_FORMATS
                                  - NO_CURRENT_ROLE_MARKER
                                  - AMBIGUOUS_NUMERIC_DATE
                                  - NO_QUANTIFIED_IMPACT
                                  - WEAK_ACTION_VERBS
                                  - FIRST_PERSON_PRONOUNS
                                  - LONG_BULLETS
                                  - HIGH_PAGE_COUNT
                                  - EMPLOYMENT_GAP
                                  - ALL_CAPS_RUNS
                                  - REPEATED_PHRASES
                                type: string
                              severity:
                                enum:
                                  - blocker
                                  - warning
                                  - tip
                                type: string
                              category:
                                enum:
                                  - parseability
                                  - layout
                                  - sections
                                  - contact
                                  - dates
                                  - content
                                type: string
                              params:
                                type: object
                                propertyNames:
                                  type: string
                                additionalProperties:
                                  anyOf:
                                    - type: string
                                    - type: number
                              evidence:
                                type: object
                                properties:
                                  snippet:
                                    type: string
                                  page:
                                    type: number
                                  box:
                                    type: object
                                    properties:
                                      x:
                                        type: number
                                      'y':
                                        type: number
                                      width:
                                        type: number
                                      height:
                                        type: number
                                    required:
                                      - x
                                      - 'y'
                                      - width
                                      - height
                            required:
                              - code
                              - severity
                              - category
                          readOnly: true
                      required:
                        - code
                        - category
                        - severity
                        - status
                        - findings
                    readOnly: true
                  findings:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          enum:
                            - NO_TEXT_LAYER
                            - IMAGE_ONLY_DOCUMENT
                            - GARBLED_TEXT
                            - TYPE3_FONT
                            - INVALID_EMBEDDED_FONT
                            - FILE_TOO_LARGE
                            - ENCRYPTED_PDF
                            - XFA_FORM
                            - PDF_PORTFOLIO
                            - REPLACEMENT_CHARACTERS
                            - PRIVATE_USE_CHARACTERS
                            - LIGATURE_CHARACTERS
                            - NON_EMBEDDED_FONTS
                            - INVISIBLE_TEXT
                            - WHITE_TEXT
                            - LOW_TEXT_DENSITY
                            - HIGH_IMAGE_COVERAGE
                            - LOST_WORD_SPACING
                            - SPLIT_CHARACTER_SPACING
                            - VERTICAL_TEXT
                            - ROTATED_PAGES
                            - ACROFORM_FIELDS
                            - NON_STANDARD_PAGE_SIZE
                            - UNTAGGED_PDF
                            - MISSING_DOCUMENT_LANGUAGE
                            - LARGE_FILE_SIZE
                            - TRUNCATED_ANALYSIS
                            - MULTI_COLUMN_LAYOUT
                            - READING_ORDER_INVERSION
                            - READING_ORDER_RISK
                            - COLUMN_GUTTER
                            - TABLE_LIKE_LAYOUT
                            - TEXT_IN_MARGIN_ZONE
                            - TIGHT_LINE_SPACING
                            - SMALL_BODY_TEXT
                            - MANY_DISTINCT_FONTS
                            - NARROW_PAGE_MARGINS
                            - TEXT_OUTSIDE_PAGE
                            - NON_STANDARD_BULLET_GLYPHS
                            - REPEATED_HEADER_FOOTER
                            - DENSE_PAGE
                            - NO_EXPERIENCE_SECTION
                            - NO_RECOGNIZED_HEADINGS
                            - FEW_SECTION_HEADINGS
                            - NO_EDUCATION_SECTION
                            - NO_SKILLS_SECTION
                            - HEADINGS_NOT_DISTINGUISHED
                            - VERY_SHORT_DOCUMENT
                            - NO_BULLET_POINTS
                            - NO_ROLE_LINES
                            - NO_SUMMARY_SECTION
                            - NO_EMAIL
                            - NO_PHONE
                            - NO_NAME_LINE
                            - CONTACT_NOT_ON_FIRST_PAGE
                            - EMAIL_SPLIT_ACROSS_ITEMS
                            - LINK_TEXT_URL_MISMATCH
                            - MULTIPLE_EMAILS
                            - NO_PROFESSIONAL_LINK
                            - BARE_URL_WITHOUT_PROTOCOL
                            - PHONE_FORMAT_UNUSUAL
                            - NO_DATES_FOUND
                            - FEW_DATES
                            - UNPARSEABLE_DATE_RANGE
                            - REVERSED_DATE_RANGE
                            - FUTURE_DATED_ENTRY
                            - MIXED_DATE_FORMATS
                            - NO_CURRENT_ROLE_MARKER
                            - AMBIGUOUS_NUMERIC_DATE
                            - NO_QUANTIFIED_IMPACT
                            - WEAK_ACTION_VERBS
                            - FIRST_PERSON_PRONOUNS
                            - LONG_BULLETS
                            - HIGH_PAGE_COUNT
                            - EMPLOYMENT_GAP
                            - ALL_CAPS_RUNS
                            - REPEATED_PHRASES
                          type: string
                        severity:
                          enum:
                            - blocker
                            - warning
                            - tip
                          type: string
                        category:
                          enum:
                            - parseability
                            - layout
                            - sections
                            - contact
                            - dates
                            - content
                          type: string
                        params:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            anyOf:
                              - type: string
                              - type: number
                        evidence:
                          type: object
                          properties:
                            snippet:
                              type: string
                            page:
                              type: number
                            box:
                              type: object
                              properties:
                                x:
                                  type: number
                                'y':
                                  type: number
                                width:
                                  type: number
                                height:
                                  type: number
                              required:
                                - x
                                - 'y'
                                - width
                                - height
                      required:
                        - code
                        - severity
                        - category
                    readOnly: true
                  tips:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          enum:
                            - NO_TEXT_LAYER
                            - IMAGE_ONLY_DOCUMENT
                            - GARBLED_TEXT
                            - TYPE3_FONT
                            - INVALID_EMBEDDED_FONT
                            - FILE_TOO_LARGE
                            - ENCRYPTED_PDF
                            - XFA_FORM
                            - PDF_PORTFOLIO
                            - REPLACEMENT_CHARACTERS
                            - PRIVATE_USE_CHARACTERS
                            - LIGATURE_CHARACTERS
                            - NON_EMBEDDED_FONTS
                            - INVISIBLE_TEXT
                            - WHITE_TEXT
                            - LOW_TEXT_DENSITY
                            - HIGH_IMAGE_COVERAGE
                            - LOST_WORD_SPACING
                            - SPLIT_CHARACTER_SPACING
                            - VERTICAL_TEXT
                            - ROTATED_PAGES
                            - ACROFORM_FIELDS
                            - NON_STANDARD_PAGE_SIZE
                            - UNTAGGED_PDF
                            - MISSING_DOCUMENT_LANGUAGE
                            - LARGE_FILE_SIZE
                            - TRUNCATED_ANALYSIS
                            - MULTI_COLUMN_LAYOUT
                            - READING_ORDER_INVERSION
                            - READING_ORDER_RISK
                            - COLUMN_GUTTER
                            - TABLE_LIKE_LAYOUT
                            - TEXT_IN_MARGIN_ZONE
                            - TIGHT_LINE_SPACING
                            - SMALL_BODY_TEXT
                            - MANY_DISTINCT_FONTS
                            - NARROW_PAGE_MARGINS
                            - TEXT_OUTSIDE_PAGE
                            - NON_STANDARD_BULLET_GLYPHS
                            - REPEATED_HEADER_FOOTER
                            - DENSE_PAGE
                            - NO_EXPERIENCE_SECTION
                            - NO_RECOGNIZED_HEADINGS
                            - FEW_SECTION_HEADINGS
                            - NO_EDUCATION_SECTION
                            - NO_SKILLS_SECTION
                            - HEADINGS_NOT_DISTINGUISHED
                            - VERY_SHORT_DOCUMENT
                            - NO_BULLET_POINTS
                            - NO_ROLE_LINES
                            - NO_SUMMARY_SECTION
                            - NO_EMAIL
                            - NO_PHONE
                            - NO_NAME_LINE
                            - CONTACT_NOT_ON_FIRST_PAGE
                            - EMAIL_SPLIT_ACROSS_ITEMS
                            - LINK_TEXT_URL_MISMATCH
                            - MULTIPLE_EMAILS
                            - NO_PROFESSIONAL_LINK
                            - BARE_URL_WITHOUT_PROTOCOL
                            - PHONE_FORMAT_UNUSUAL
                            - NO_DATES_FOUND
                            - FEW_DATES
                            - UNPARSEABLE_DATE_RANGE
                            - REVERSED_DATE_RANGE
                            - FUTURE_DATED_ENTRY
                            - MIXED_DATE_FORMATS
                            - NO_CURRENT_ROLE_MARKER
                            - AMBIGUOUS_NUMERIC_DATE
                            - NO_QUANTIFIED_IMPACT
                            - WEAK_ACTION_VERBS
                            - FIRST_PERSON_PRONOUNS
                            - LONG_BULLETS
                            - HIGH_PAGE_COUNT
                            - EMPLOYMENT_GAP
                            - ALL_CAPS_RUNS
                            - REPEATED_PHRASES
                          type: string
                        severity:
                          enum:
                            - blocker
                            - warning
                            - tip
                          type: string
                        category:
                          enum:
                            - parseability
                            - layout
                            - sections
                            - contact
                            - dates
                            - content
                          type: string
                        params:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            anyOf:
                              - type: string
                              - type: number
                        evidence:
                          type: object
                          properties:
                            snippet:
                              type: string
                            page:
                              type: number
                            box:
                              type: object
                              properties:
                                x:
                                  type: number
                                'y':
                                  type: number
                                width:
                                  type: number
                                height:
                                  type: number
                              required:
                                - x
                                - 'y'
                                - width
                                - height
                      required:
                        - code
                        - severity
                        - category
                    readOnly: true
                  counts:
                    type: object
                    properties:
                      blocker:
                        type: number
                      warning:
                        type: number
                      tip:
                        type: number
                    required:
                      - blocker
                      - warning
                      - tip
                  applicableChecks:
                    type: number
                  passedChecks:
                    type: number
                  skippedChecks:
                    type: number
                  jd:
                    anyOf:
                      - type: object
                        properties:
                          terms:
                            type: array
                            items:
                              type: object
                              properties:
                                term:
                                  type: string
                                jdCount:
                                  type: number
                                resumeCount:
                                  type: number
                                weight:
                                  type: number
                              required:
                                - term
                                - jdCount
                                - resumeCount
                                - weight
                            readOnly: true
                          matchedTerms:
                            type: array
                            items:
                              type: string
                            readOnly: true
                          missingTerms:
                            type: array
                            items:
                              type: string
                            readOnly: true
                          totalTerms:
                            type: number
                          matchedCount:
                            type: number
                          weightedCoverage:
                            type: number
                          stuffedTerms:
                            type: array
                            items:
                              type: string
                            readOnly: true
                          documentHasHiddenText:
                            type: boolean
                        required:
                          - terms
                          - matchedTerms
                          - missingTerms
                          - totalTerms
                          - matchedCount
                          - weightedCoverage
                          - stuffedTerms
                          - documentHasHiddenText
                      - type: 'null'
                  file:
                    type: object
                    properties:
                      name:
                        type: string
                      sizeBytes:
                        type: number
                      magicBytesOk:
                        type: boolean
                    required:
                      - name
                      - sizeBytes
                      - magicBytesOk
                  document:
                    type: object
                    properties:
                      pageCount:
                        type: number
                      truncated:
                        type: boolean
                      wordCount:
                        type: number
                      operatorsAvailable:
                        type: boolean
                    required:
                      - pageCount
                      - truncated
                      - wordCount
                      - operatorsAvailable
                  fullText:
                    type: string
                    description: >-
                      Extracted text in reading order, for the optional AI
                      review.
                required:
                  - version
                  - score
                  - cappedBy
                  - categories
                  - checks
                  - findings
                  - tips
                  - counts
                  - applicableChecks
                  - passedChecks
                  - skippedChecks
                  - jd
                  - file
                  - document
                  - fullText
        default:
          description: >-
            Structured API error. See status and code; do not branch on message
            text.
          content:
            application/json:
              schema:
                type: object
                required:
                  - defined
                  - code
                  - status
                  - message
                properties:
                  defined:
                    type: boolean
                  code:
                    type: string
                  status:
                    type: integer
                  message:
                    type: string
                  data: {}
      security: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: x-api-key
      in: header
      description: The API key to authenticate requests.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: An OAuth access token issued by this instance for its API/MCP resource.
    cookieAuth:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: >-
        Browser session (secure deployments use the __Secure- prefix). Cookie
        requests must originate from this instance.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.