> ## Documentation Index
> Fetch the complete documentation index at: https://spotzee.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Assess email domain health

> Assesses an email domain using MX, SPF, DMARC, DKIM selector, and blacklist checks. The full DKIM option checks the same seven common selectors as quick. If none is found, the DKIM subscore can receive full points despite no DKIM record being confirmed. Treat the score as an assessment, not proof of DKIM configuration.



## OpenAPI

````yaml https://apix.spotzee.com/api/ext/openapi.json post /generic/email/email-health-check
openapi: 3.1.0
info:
  title: Spotzee API
  version: '2026-04-28'
  description: >-
    Comprehensive API for email services, DNS management, AI tools, and
    marketing features.
servers:
  - url: https://apix.spotzee.com/api/ext
    description: >-
      Extended API surface — sender-side utilities (DNS, AI, deliverability,
      generators).
security:
  - BearerAuth: []
tags:
  - name: AI
    description: >-
      Sender-side AI utilities — generate copy, score subject lines, and draft
      message variants tailored to a contact or campaign brief.
  - name: Data
    description: >-
      Realistic-looking sample data for development and load testing — contacts,
      events, and segments shaped like production records without exposing real
      customer data.
  - name: DNS
    description: >-
      Inspect a domain’s sender posture — SPF, DKIM, DMARC, MX, and reverse-DNS
      records — and surface the gaps that put deliverability at risk.
  - name: Email
    description: >-
      Send-side validation and inspection — verify addresses, fingerprint MTAs,
      decode bounces, and check inbox-placement signals before a campaign goes
      out.
  - name: SMS
    description: Mobile-number validation and carrier lookup for SMS campaigns.
  - name: Text
    description: >-
      Text-quality utilities — spam-score grading, readability metrics, and
      subject-line scoring against deliverability heuristics.
paths:
  /generic/email/email-health-check:
    post:
      tags:
        - Email
      summary: Assess email domain health
      description: >-
        Assesses an email domain using MX, SPF, DMARC, DKIM selector, and
        blacklist checks. The full DKIM option checks the same seven common
        selectors as quick. If none is found, the DKIM subscore can receive full
        points despite no DKIM record being confirmed. Treat the score as an
        assessment, not proof of DKIM configuration.
      operationId: performEmailHealthCheck
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                email_domain:
                  anyOf:
                    - type: string
                      description: Email address
                    - type: string
                      description: Domain name
                      example: example.com
                dkim_test_type:
                  type: string
                  description: >-
                    DKIM test option. Both quick and full check the same seven
                    common selectors; full does not expand the scan.
                  enum:
                    - quick
                    - full
                  example: quick
              required:
                - email_domain
      responses:
        '200':
          description: Successfully completed health check
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                  data:
                    type: object
                    properties:
                      totalCritereaScore:
                        type: number
                        description: Total maximum possible score
                        example: 290
                      obtainedScore:
                        type: number
                        description: Actual score obtained
                        example: 220
                      finalScorePercentage:
                        type: number
                        description: Final score as percentage (0-100)
                        example: 76
                      dataCompleteness:
                        type: object
                        properties:
                          percentage:
                            type: number
                            description: Percentage of checks completed
                            example: 100
                          missingChecks:
                            type: array
                            items:
                              type: string
                            description: List of checks that could not be performed
                            example:
                              - TLS-RPT
                          failureReason:
                            type: string
                            description: Reason for incomplete checks
                            example: technical
                        required:
                          - percentage
                          - missingChecks
                          - failureReason
                      mx:
                        type: object
                        properties:
                          score:
                            type: number
                          maxScore:
                            type: number
                          value:
                            type: array
                            items:
                              type: object
                              properties:
                                priority:
                                  type: string
                                hostname:
                                  type: string
                              required:
                                - priority
                                - hostname
                          isExists:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - points
                          emailServiceProvider:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    hostname:
                                      type: string
                                    provider:
                                      type: string
                                  required:
                                    - hostname
                                    - provider
                            required:
                              - result
                              - points
                              - value
                          hasMultipleProviders:
                            type: object
                            properties:
                              result:
                                type: boolean
                              isProblematic:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - isProblematic
                              - points
                          backupServers:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: array
                                items: {}
                            required:
                              - result
                              - points
                              - value
                          isAnyBackUpServerDown:
                            type: object
                            properties:
                              result:
                                type: boolean
                              isProblematic:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - isProblematic
                              - points
                          isAnyIpBlacklisted:
                            type: object
                            properties:
                              result:
                                type: boolean
                              isProblematic:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: object
                                additionalProperties:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      ip:
                                        type: string
                                      isBlacklisted:
                                        type: boolean
                                    required:
                                      - ip
                                      - isBlacklisted
                            required:
                              - result
                              - isProblematic
                              - points
                              - value
                          isReverseDNSMatches:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: object
                                additionalProperties:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      ip:
                                        type: string
                                      ptrValue:
                                        type: array
                                        items:
                                          type: string
                                    required:
                                      - ip
                                      - ptrValue
                            required:
                              - result
                              - points
                              - value
                          isAnyHostnameBlacklisted:
                            type: object
                            properties:
                              result:
                                type: boolean
                              isProblematic:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: array
                                items: {}
                            required:
                              - result
                              - isProblematic
                              - points
                              - value
                          info:
                            type: array
                            items:
                              type: string
                          warnings:
                            type: array
                            items:
                              type: string
                        required:
                          - score
                          - maxScore
                          - value
                          - isExists
                          - emailServiceProvider
                          - hasMultipleProviders
                          - backupServers
                          - isAnyBackUpServerDown
                          - isAnyIpBlacklisted
                          - isReverseDNSMatches
                          - isAnyHostnameBlacklisted
                          - info
                      spf:
                        type: object
                        properties:
                          score:
                            type: number
                          maxScore:
                            type: number
                          isExists:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - points
                          isDuplicate:
                            type: object
                            properties:
                              result:
                                type: boolean
                              isProblematic:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - isProblematic
                              - points
                          isValid:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - points
                          isMechanismUsed:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: object
                                additionalProperties:
                                  type: number
                            required:
                              - result
                              - points
                              - value
                          isModifiersUsed:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: object
                                additionalProperties: true
                            required:
                              - result
                              - points
                              - value
                          isRecursiveIncluded:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: array
                                items:
                                  type: string
                            required:
                              - result
                              - points
                              - value
                          isTooManyVoidLookup:
                            type: object
                            properties:
                              result:
                                type: boolean
                              isProblematic:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: number
                            required:
                              - result
                              - isProblematic
                              - points
                              - value
                          hasStrictAll:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - points
                          dnsLookupCount:
                            type: object
                            properties:
                              value:
                                type: number
                              points:
                                type: number
                            required:
                              - value
                              - points
                          value:
                            type: array
                            items:
                              type: string
                        required:
                          - score
                          - maxScore
                          - isExists
                          - isDuplicate
                          - isValid
                          - isMechanismUsed
                          - isModifiersUsed
                          - isRecursiveIncluded
                          - isTooManyVoidLookup
                          - hasStrictAll
                          - value
                      dmarc:
                        type: object
                        properties:
                          score:
                            type: number
                          maxScore:
                            type: number
                          isExists:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - points
                          isValid:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - points
                          policy:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: string
                            required:
                              - result
                              - points
                              - value
                          subDomainPolicy:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: string
                            required:
                              - result
                              - points
                              - value
                          isRuaExists:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: array
                                items:
                                  type: string
                            required:
                              - result
                              - points
                              - value
                          ruaEmails:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    email:
                                      type: string
                                    result:
                                      type: string
                                  required:
                                    - email
                                    - result
                            required:
                              - result
                              - points
                              - value
                          isRufExists:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: array
                                items: {}
                            required:
                              - result
                              - points
                              - value
                          rufEmails:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: array
                                items: {}
                            required:
                              - result
                              - points
                              - value
                          isPctExists:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: string
                            required:
                              - result
                              - points
                              - value
                          isAspfExists:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: string
                            required:
                              - result
                              - points
                              - value
                          isAdkimExists:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: string
                            required:
                              - result
                              - points
                              - value
                          value:
                            type: array
                            items:
                              type: string
                        required:
                          - score
                          - maxScore
                          - isExists
                          - isValid
                          - policy
                          - subDomainPolicy
                          - isRuaExists
                          - ruaEmails
                          - isRufExists
                          - rufEmails
                          - isPctExists
                          - isAspfExists
                          - isAdkimExists
                          - value
                      domain:
                        type: object
                        properties:
                          score:
                            type: number
                          maxScore:
                            type: number
                          isBlackListed:
                            type: object
                            properties:
                              result:
                                type: boolean
                              isProblematic:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - isProblematic
                              - points
                          ageInMonths:
                            type: object
                            properties:
                              points:
                                type: number
                              value:
                                type: number
                            required:
                              - points
                              - value
                          expiryDate:
                            type: object
                            properties:
                              points:
                                type: number
                              value:
                                type: string
                            required:
                              - points
                              - value
                          isDomainAgeMoreThan3Months:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: number
                            required:
                              - result
                              - points
                              - value
                          dnsProvider:
                            type: object
                            properties:
                              points:
                                type: number
                              value:
                                type: array
                                items:
                                  type: string
                            required:
                              - points
                              - value
                          isTrustworthy:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: string
                            required:
                              - result
                              - points
                              - value
                          isCommon:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: string
                            required:
                              - result
                              - points
                              - value
                          isMXRecordExists:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    priority:
                                      type: string
                                    hostname:
                                      type: string
                                  required:
                                    - priority
                                    - hostname
                            required:
                              - result
                              - points
                              - value
                          isUsingTLSA:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: array
                                items: {}
                            required:
                              - result
                              - points
                              - value
                          isUsingDNSKEY:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: array
                                items: {}
                            required:
                              - result
                              - points
                              - value
                          isDomainUrlBroken:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: string
                            required:
                              - result
                              - points
                              - value
                          isSafeUrl:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: string
                            required:
                              - result
                              - points
                              - value
                          isParkedDomain:
                            type: object
                            properties:
                              result:
                                type: boolean
                              isProblematic:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - isProblematic
                              - points
                          value:
                            type: string
                          info:
                            type: array
                            items:
                              type: string
                        required:
                          - score
                          - maxScore
                          - isBlackListed
                          - ageInMonths
                          - expiryDate
                          - isDomainAgeMoreThan3Months
                          - dnsProvider
                          - isTrustworthy
                          - isCommon
                          - isMXRecordExists
                          - isUsingTLSA
                          - isUsingDNSKEY
                          - isDomainUrlBroken
                          - isSafeUrl
                          - isParkedDomain
                          - value
                          - info
                      bimi:
                        type: object
                        properties:
                          score:
                            type: number
                          maxScore:
                            type: number
                          value:
                            type: string
                          isExists:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - points
                          isValid:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - points
                          isAllImageUrlWorks:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: array
                                items: {}
                            required:
                              - result
                              - points
                              - value
                        required:
                          - score
                          - maxScore
                          - value
                          - isExists
                          - isValid
                          - isAllImageUrlWorks
                      mtaSts:
                        type: object
                        properties:
                          score:
                            type: number
                          maxScore:
                            type: number
                          isExists:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: string
                            required:
                              - result
                              - points
                              - value
                          policy:
                            type: object
                            properties:
                              mode:
                                type: object
                                properties:
                                  result:
                                    type: boolean
                                  points:
                                    type: number
                                  value:
                                    type: string
                                required:
                                  - result
                                  - points
                                  - value
                              maxAge:
                                type: object
                                properties:
                                  result:
                                    type: boolean
                                  points:
                                    type: number
                                  value:
                                    type: number
                                required:
                                  - result
                                  - points
                                  - value
                              mxHosts:
                                type: object
                                properties:
                                  value:
                                    type: array
                                    items:
                                      type: string
                                  result:
                                    type: boolean
                                required:
                                  - value
                                  - result
                            required:
                              - mode
                              - maxAge
                              - mxHosts
                          isPolicyFileValid:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - points
                          policyFileUrl:
                            type: object
                            properties:
                              value:
                                type: string
                            required:
                              - value
                          policyFileContent:
                            type: object
                            properties:
                              value:
                                type: string
                            required:
                              - value
                          errors:
                            type: array
                            items: {}
                        required:
                          - score
                          - maxScore
                          - isExists
                          - policy
                          - isPolicyFileValid
                          - policyFileUrl
                          - policyFileContent
                          - errors
                      tlsRpt:
                        type: object
                        properties:
                          score:
                            type: number
                          maxScore:
                            type: number
                          isExists:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - points
                          rua:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                              value:
                                type: array
                                items: {}
                            required:
                              - result
                              - points
                              - value
                          record:
                            type: object
                            properties:
                              value:
                                type: string
                            required:
                              - value
                          errors:
                            type: array
                            items: {}
                        required:
                          - score
                          - maxScore
                          - isExists
                          - rua
                          - record
                          - errors
                      dkim:
                        type: object
                        properties:
                          score:
                            type: number
                          maxScore:
                            type: number
                          records:
                            type: array
                            items: {}
                          info:
                            type: array
                            items:
                              type: string
                        required:
                          - score
                          - maxScore
                          - records
                          - info
                      caa:
                        type: object
                        properties:
                          score:
                            type: number
                          maxScore:
                            type: number
                          isExists:
                            type: object
                            properties:
                              result:
                                type: boolean
                              points:
                                type: number
                            required:
                              - result
                              - points
                          records:
                            type: array
                            items:
                              type: object
                              properties:
                                raw:
                                  type: string
                                flags:
                                  type: number
                                tag:
                                  type: string
                                value:
                                  type: string
                                isCritical:
                                  type: boolean
                                type:
                                  type: string
                                description:
                                  type: string
                                isRestrictive:
                                  type: boolean
                                isCustomTag:
                                  type: boolean
                                contactMethod:
                                  type: string
                                contactValue:
                                  type: string
                                reportingMethod:
                                  type: string
                                reportingAddress:
                                  type: string
                                reportingUrl:
                                  type: string
                                parsingConfidence:
                                  type: string
                                parsingError:
                                  type: boolean
                              required:
                                - raw
                                - tag
                                - value
                                - type
                                - description
                          analysis:
                            type: object
                            properties:
                              hasIssueTag:
                                type: boolean
                              hasIssuewildTag:
                                type: boolean
                              hasIncidentReporting:
                                type: boolean
                              isRestrictive:
                                type: boolean
                              authorizedCAs:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    ca:
                                      type: string
                                    type:
                                      type: string
                                    provider:
                                      type: string
                                  required:
                                    - ca
                                    - type
                              hasContactInfo:
                                type: boolean
                              contactRecords:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                    value:
                                      type: string
                                    method:
                                      type: string
                                  required:
                                    - type
                                    - value
                              hasCriticalRecords:
                                type: boolean
                              hasMultipleCAs:
                                type: boolean
                              hasWildcardRestriction:
                                type: boolean
                              totalRecords:
                                type: number
                              unparsedRecords:
                                type: number
                            required:
                              - hasIssueTag
                              - hasIssuewildTag
                              - hasIncidentReporting
                              - isRestrictive
                              - authorizedCAs
                        required:
                          - score
                          - maxScore
                          - isExists
                          - records
                          - analysis
                        example:
                          score: 10
                          maxScore: 10
                          isExists:
                            result: true
                            points: 10
                          records:
                            - raw: 0 issue "letsencrypt.org"
                              flags: 0
                              tag: issue
                              value: letsencrypt.org
                              isCritical: false
                              type: issue
                              description: Authorizes letsencrypt.org to issue certificates
                            - raw: 0 iodef "mailto:security@example.com"
                              flags: 0
                              tag: iodef
                              value: mailto:security@example.com
                              isCritical: false
                              type: iodef
                              description: Incident reporting configured
                              reportingMethod: email
                              reportingAddress: security@example.com
                            - raw: 0 contactemail "caa-notifications@example.com"
                              flags: 0
                              tag: contactemail
                              value: caa-notifications@example.com
                              isCritical: false
                              type: contactemail
                              description: 'CAA contact email: caa-notifications@example.com'
                              contactMethod: email
                              contactValue: caa-notifications@example.com
                          analysis:
                            hasIssueTag: true
                            hasIssuewildTag: false
                            hasIncidentReporting: true
                            isRestrictive: false
                            authorizedCAs:
                              - ca: letsencrypt.org
                                type: issue
                                provider: Let's Encrypt
                            hasContactInfo: true
                            contactRecords:
                              - type: contactemail
                                value: caa-notifications@example.com
                                method: email
                            hasCriticalRecords: false
                            hasMultipleCAs: false
                            hasWildcardRestriction: false
                            totalRecords: 3
                            unparsedRecords: 0
                    required:
                      - totalCritereaScore
                      - obtainedScore
                      - finalScorePercentage
                      - dataCompleteness
                      - mx
                      - spf
                      - dmarc
                      - domain
                      - bimi
                      - mtaSts
                      - tlsRpt
                      - dkim
                      - caa
                required:
                  - status
                  - data
        '400':
          description: Bad request - Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
        '401':
          description: Unauthorized - Invalid API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
        '402':
          description: Payment Required - Quota exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
        '503':
          description: Service temporarily unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
        '504':
          description: Gateway timeout - Request took too long
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Bearer token authentication. Use format: Bearer YOUR_API_KEY'

````