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

# Premium Solar Return PDF report



## OpenAPI

````yaml /openapi.public.json post /api/v3/reports/solar-return/pdf
openapi: 3.1.0
info:
  title: AstroM8 Public API
  version: 1.1.0
  description: >-
    Astrology calculations, reports, customer delivery, and enterprise
    workflows. Each operation declares whether it uses an API key or a customer
    session bearer token.
servers:
  - url: https://api.astrom8.com
    description: Production
security: []
tags:
  - name: Western
    description: Natal, relationship, return, progression, and transit calculations.
  - name: Vedic
    description: Lahiri sidereal Vedic calculations, matching, timing, and remedies.
  - name: Thai Astrology
    description: Thai calendar, auspicious timing, lunar, festival, and wheel tools.
  - name: Chinese & Korean
    description: BaZi, Qi Men Dun Jia, and Saju calculations.
  - name: Horoscopes
    description: Published daily and range horoscope content.
  - name: Reports
    description: Branded report generation and asynchronous job polling.
  - name: Tarot & Numerology
    description: Tarot spreads and Pythagorean numerology.
  - name: Uranian
    description: Uranian charts, midpoints, and planetary pictures.
  - name: Developer workflow
    description: Preflight capability eligibility and credit estimates.
  - name: Customer reports
    description: Session-authenticated report jobs and reusable brand profiles.
  - name: Customer delivery
    description: Session-authenticated webhooks and scheduled horoscope delivery.
  - name: Cultural Intelligence
    description: >-
      Enterprise API-key workflows for encrypted profiles, teams, and campaign
      content.
paths:
  /api/v3/reports/solar-return/pdf:
    post:
      tags:
        - Reports
      summary: Premium Solar Return PDF report
      operationId: createSolarReturnPremiumPdfJob
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/WesternSolarReturnRequest'
                - type: object
                  properties:
                    name:
                      type: string
                      maxLength: 120
                    branding:
                      $ref: '#/components/schemas/PdfBranding'
                    brand_profile_id:
                      type: string
      responses:
        '202':
          description: Queued report job.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncReportJobAccepted'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          description: Pro tier required.
      security:
        - ApiKeyAuth: []
components:
  schemas:
    WesternSolarReturnRequest:
      type: object
      required:
        - birth_subject
        - target_year
      properties:
        birth_subject:
          $ref: '#/components/schemas/WesternBirthSubject'
        target_year:
          type: integer
          minimum: 1900
          maximum: 2200
        house_system:
          type: string
          enum:
            - P
            - W
            - K
            - E
          default: P
        locale:
          type: string
          enum:
            - th
            - en
          default: en
    PdfBranding:
      allOf:
        - $ref: '#/components/schemas/WhiteLabelBrandFields'
        - type: object
          description: >-
            Visual white-label branding rendered into the PDF (logo, color) in
            addition to the LLM voice controls.
          properties:
            logo_url:
              type: string
              format: uri
              maxLength: 500
              description: Must be an https URL.
            primary_color:
              type: string
              pattern: ^#[0-9a-fA-F]{6}$
              examples:
                - '#7c3aed'
            contact_email:
              type: string
              format: email
              maxLength: 200
              description: Shown in the report footer, e.g. "hello@moonpath.app".
            contact_phone:
              type: string
              maxLength: 40
              description: >-
                Shown in the report footer. Free-form — international phone
                formats vary.
              examples:
                - +66 2 123 4567
            contact_url:
              type: string
              format: uri
              maxLength: 300
              description: >-
                Must be an https URL. Shown in the footer in place of the
                default astrom8.com link.
              examples:
                - https://moonpath.app
    AsyncReportJobAccepted:
      type: object
      required:
        - job_id
        - status
        - poll
      properties:
        job_id:
          type: string
          example: job_a1b2c3d4e5f60718293a4b5c
        status:
          type: string
          enum:
            - queued
        poll:
          type: string
          example: /api/v3/jobs/job_a1b2c3d4e5f60718293a4b5c
    WesternBirthSubject:
      type: object
      required:
        - date
        - time
        - latitude
        - longitude
        - timezoneOffsetMinutes
      properties:
        date:
          type: string
          format: date
        time:
          type: string
          pattern: ^\d{2}:\d{2}(:\d{2})?$
        latitude:
          type: number
          minimum: -90
          maximum: 90
        longitude:
          type: number
          minimum: -180
          maximum: 180
        timezoneOffsetMinutes:
          type: integer
          minimum: -840
          maximum: 840
    WhiteLabelBrandFields:
      type: object
      description: >-
        Optional white-label AI voice controls for endpoints that generate LLM
        interpretation text.
      properties:
        brand_name:
          type: string
          minLength: 1
          maxLength: 60
          examples:
            - Moon & Co
        tone:
          type: string
          enum:
            - professional
            - casual
            - mystical
            - playful
            - formal
        audience:
          type: string
          enum:
            - consumer
            - employee
            - manager
            - customer
            - community
        safety_mode:
          type: string
          enum:
            - default
            - workplace
            - financial_wellness
            - entertainment
    JsonError:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          description: >-
            Stable slug (e.g. unauthorized, payment_required,
            internal_server_error).
        message:
          type: string
          description: Human-readable message safe for clients.
        code:
          type: string
          description: Optional provider-specific code.
        request_id:
          type: string
          description: Correlation id when middleware sets it.
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/JsonError'
          example:
            error: unauthorized
            message: Invalid API key
            code: '401'
            request_id: 01HQXYZ...
    PaymentRequired:
      description: >-
        Insufficient credits (checked before work where applicable; deduction is
        atomic)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/JsonError'
          example:
            error: payment_required
            message: Insufficient credits for this request
            code: '402'
            request_id: 01HQXYZ...
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: Use the raw API key as the Bearer token, or send X-API-Key instead.

````