> ## Documentation Index
> Fetch the complete documentation index at: https://solarium-1f74f072.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Assessment



## OpenAPI

````yaml /openapi.json post /api/assessments
openapi: 3.1.0
info:
  title: Solar Money API
  version: 0.1.0
  description: >-
    Rooftop solar assessment API — buildings, shadows, climate, assessments, and
    vendor matching.
servers:
  - url: https://solarmoney.up.railway.app
    description: Production
security: []
tags:
  - name: Admin
    description: Admin-only operations (JWT or X-Admin-Secret)
  - name: Assessments
    description: Anonymous and authenticated assessment records
  - name: Authentication
    description: User registration and login
  - name: Buildings
    description: Building footprint queries (GBA DB → fallback → OSM)
  - name: Health
    description: Service health checks
  - name: Places
    description: Address autocomplete and geocoding proxies
  - name: Shadows
    description: Shadow geometry and usable roof area
  - name: Terrain & Climate
    description: DEM tiles, township climate, and tilt optimization
  - name: User Account
    description: Endpoints for logged-in users (JWT required)
  - name: Vendors
    description: Vendor listings, applications, and inquiries
paths:
  /api/assessments:
    post:
      tags:
        - Assessments
      summary: Create Assessment
      operationId: create_assessment_api_assessments_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssessmentRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AssessmentRequest:
      properties:
        user_id:
          type: string
          title: User Id
        address:
          anyOf:
            - type: string
            - type: 'null'
          title: Address
        lat:
          anyOf:
            - type: number
            - type: 'null'
          title: Lat
        lng:
          anyOf:
            - type: number
            - type: 'null'
          title: Lng
        county:
          anyOf:
            - type: string
            - type: 'null'
          title: County
        roof_area_ping:
          anyOf:
            - type: number
            - type: 'null'
          title: Roof Area Ping
        monthly_kwh:
          anyOf:
            - type: number
            - type: 'null'
          title: Monthly Kwh
        goal:
          anyOf:
            - type: string
            - type: 'null'
          title: Goal
        capacity_kw:
          anyOf:
            - type: number
            - type: 'null'
          title: Capacity Kw
        total_cost:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total Cost
        subsidy_amount:
          anyOf:
            - type: integer
            - type: 'null'
          title: Subsidy Amount
        out_of_pocket:
          anyOf:
            - type: integer
            - type: 'null'
          title: Out Of Pocket
        annual_kwh:
          anyOf:
            - type: number
            - type: 'null'
          title: Annual Kwh
        self_sufficiency:
          anyOf:
            - type: number
            - type: 'null'
          title: Self Sufficiency
        payback_years:
          anyOf:
            - type: number
            - type: 'null'
          title: Payback Years
        total_20yr:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total 20Yr
        annual_revenue:
          anyOf:
            - type: integer
            - type: 'null'
          title: Annual Revenue
        best_angle:
          anyOf:
            - type: integer
            - type: 'null'
          title: Best Angle
        result:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Result
      type: object
      required:
        - user_id
      title: AssessmentRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````