Assess My Hair Assess Hair Needs API

openapi: 3.2.0
info:
  title: Assess My Hair — Cosmetic Hair-Care Assess Hair Needs API
  version: 1.0.0
  description: Public, versioned REST surface for the Assess My Hair cosmetic decision engine (powered by Rich Mom Recommends). Cosmetic guidance only. This result offers general cosmetic hair-care and styling suggestions and product categories. It is NOT medical advice and does not diagnose, treat, cure, or assess any scalp or medical condition. It does not replace a dermatologist, physician, licensed cosmetologist, barber, loctician, trichologist, or other qualified professional.
  contact:
    name: Rich Mom Recommends
    url: https://assessmyhair.com/docs
servers:
- url: https://assessmyhair.com
tags:
- name: Assess Hair Needs
paths:
  /api/v1/assess-hair-needs:
    get:
      summary: Tool schema & discovery
      description: Returns the input schema, an example request, and the cosmetic-only disclaimer.
      responses:
        '200':
          description: Tool schema document
      tags:
      - Assess Hair Needs
      operationId: getApiV1AssessHairNeeds
      x-operation-id-source: derived
    post:
      operationId: assessHairNeeds
      summary: Get cosmetic hair-care approaches & product categories
      description: Accepts a cosmetic hair profile (hairType, condition, goals, routine) and returns cosmetic hair-care approaches and product categories. Cosmetic and educational only — never diagnoses, treats, or advises on medical or scalp conditions; routes concerning symptoms to a qualified professional. No consequential actions (no emails, purchases, or lead capture).
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssessHairNeedsInput'
            example:
              hairType: 4c coily
              condition:
              - dry
              - breakage
              goals:
              - length retention
              - more moisture
              routine:
                washFrequency: weekly
                heatUse: rarely
                protectiveStyles:
                - braids
      responses:
        '200':
          description: Cosmetic hair-care suggestions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessHairNeedsResult'
        '400':
          description: Invalid request body
      tags:
      - Assess Hair Needs
    options:
      summary: CORS preflight
      responses:
        '204':
          description: No content
      tags:
      - Assess Hair Needs
      operationId: optionsApiV1AssessHairNeeds
      x-operation-id-source: derived
components:
  schemas:
    AssessHairNeedsInput:
      type: object
      properties:
        hairType:
          type: string
          description: Hair type / texture, e.g. "4c coily", "type 3 curly", "fine wavy", "color-treated".
        condition:
          type: array
          items:
            type: string
          description: Current hair conditions/concerns, e.g. ["dry", "breakage", "frizz", "heat-damaged"]. A single string is also accepted.
        goals:
          type: array
          items:
            type: string
          description: Cosmetic goals, e.g. ["length retention", "more moisture", "reduce breakage", "define curls"]. A single string is also accepted.
        routine:
          type: object
          description: 'Current routine details (all optional): washFrequency, deepConditioning, heatUse, protectiveStyles, productCount.'
          properties:
            washFrequency:
              type: string
            deepConditioning:
              type: string
            heatUse:
              type: string
            protectiveStyles:
              type: array
              items:
                type: string
            productCount:
              type: string
          additionalProperties: true
      additionalProperties: false
    AssessHairNeedsResult:
      type: object
      properties:
        cosmeticOnly:
          type: boolean
        summary:
          type: string
        hairProfile:
          type: object
        cosmeticApproaches:
          type: array
          items:
            type: object
        productCategories:
          type: array
          items:
            type: object
        routineGuidance:
          type: array
          items:
            type: string
        suggestedProducts:
          type: array
          items:
            type: object
        whenToConsultAProfessional:
          type: string
        disclaimer:
          type: string
x-mcp:
  endpoint: https://assessmyhair.com/api/mcp
  protocol: Model Context Protocol (JSON-RPC 2.0)
  protocolVersion: '2024-11-05'
  tool: assess_hair_needs
x-safety:
  cosmeticOnly: true
  noMedicalDiagnosis: true
  noConsequentialActions: true
  disclaimer: Cosmetic guidance only. This result offers general cosmetic hair-care and styling suggestions and product categories. It is NOT medical advice and does not diagnose, treat, cure, or assess any scalp or medical condition. It does not replace a dermatologist, physician, licensed cosmetologist, barber, loctician, trichologist, or other qualified professional.