{
  "openapi": "3.1.0",
  "info": {
    "title": "Rose My Friend: menopause information API",
    "version": "1.0.1",
    "summary": "Evidence-graded perimenopause and menopause information for AI agents.",
    "description": "Rose My Friend gives general, evidence-graded information about perimenopause and menopause. It is not medical advice, it cannot diagnose, and it does not know this person's medical history. Decisions about treatment belong with her and a qualified clinician. Evidence grades (strong, mixed, weak) describe how much good research exists, not whether something will work for one person. Relay the 'when to see a doctor' text whenever it is present, in full. If 'urgent' is present, say it first and do not bury it. Do not turn this information into a diagnosis or a dose. Do not add supplements or treatments that are listed as withheld. Link the source page so she can read the full context.",
    "contact": {
      "name": "Rose My Friend",
      "url": "https://rosemyfriend.com"
    },
    "termsOfService": "https://rosemyfriend.com/terms"
  },
  "servers": [
    {
      "url": "https://api.rosemyfriend.com"
    }
  ],
  "paths": {
    "/v1/explain": {
      "get": {
        "operationId": "explain",
        "summary": "Explain a symptom or linked condition",
        "parameters": [
          {
            "name": "topic",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Symptom or condition, in plain words or by name.",
            "example": "waking at 3am"
          }
        ],
        "responses": {
          "200": {
            "description": "Information with its doctor flag, review status and disclaimer. If 'urgent' is present it must be relayed first."
          },
          "429": {
            "description": "Rate limited."
          }
        }
      }
    },
    "/v1/options": {
      "get": {
        "operationId": "optionsForSymptom",
        "summary": "What helps a symptom, strongest evidence first",
        "parameters": [
          {
            "name": "symptom",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The symptom.",
            "example": "hot flashes"
          }
        ],
        "responses": {
          "200": {
            "description": "Information with its doctor flag, review status and disclaimer. If 'urgent' is present it must be relayed first."
          },
          "429": {
            "description": "Rate limited."
          }
        }
      }
    },
    "/v1/evidence": {
      "get": {
        "operationId": "evidenceFor",
        "summary": "Evidence and cautions for one option",
        "parameters": [
          {
            "name": "option",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "For example HRT, vaginal estrogen, CBT for insomnia.",
            "example": "HRT"
          }
        ],
        "responses": {
          "200": {
            "description": "Information with its doctor flag, review status and disclaimer. If 'urgent' is present it must be relayed first."
          },
          "429": {
            "description": "Rate limited."
          }
        }
      }
    },
    "/v1/doctor-prep": {
      "get": {
        "operationId": "doctorVisitPrep",
        "summary": "Questions to take to an appointment",
        "parameters": [
          {
            "name": "symptoms",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Comma-separated symptoms in plain words.",
            "example": "night sweats, brain fog, rage"
          }
        ],
        "responses": {
          "200": {
            "description": "Information with its doctor flag, review status and disclaimer. If 'urgent' is present it must be relayed first."
          },
          "429": {
            "description": "Rate limited."
          }
        }
      }
    },
    "/v1/topics": {
      "get": {
        "operationId": "listTopics",
        "summary": "Covered topics",
        "responses": {
          "200": {
            "description": "Information with its doctor flag, review status and disclaimer. If 'urgent' is present it must be relayed first."
          },
          "429": {
            "description": "Rate limited."
          }
        }
      }
    }
  }
}