Endometriosis AI
Overview
The Helfie Endometriosis Risk Prediction model algorithm estimates the likelihood of a user having endometriosis based on responses to symptom questions and demographic information.
Base URL
- PROD:
https://api.prod.helfie.ai
- DEV:
https://api-dev.helfie.ai
API Endpoints
Endometriosis Prediction Endpoint
- Endpoint:
/vitals/api/predict-endometriosis
- Method:
POST
- Description: Returns probability and risk classification (low, medium, high) of endometriosis based on user input.
Authentication:
- Requires Bearer token (
Authorization
header) - Requires API key (
api-key
header)
Request Parameters
age
(float): User’s age (must be between 18–45).- All other fields: "yes" or "no" string responses to questions.
- If an entire section is skipped, those fields are defaulted to "no".
Example Request
curl --location 'https://fcvitals.azurewebsites.net/vitals/api/predict-endometriosis' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...' \
--header 'api-key: 025d17da-724f-4f5b-9da3-e14fbdf0f31a' \
--header 'Content-Type: application/json' \
--data '{
"age": 32,
"dysmenorrhoea": "yes",
"non_menstrual_pelvic_pain": "yes",
"intense_pain": "yes",
"worsening_pain": "yes",
"pain_before_period": "no",
"stabbing_pain": "no",
"lower_back_pain": "yes",
"leg_or_hip_pain": "no",
"disabling_pain": "yes",
"pain_affects_mobility": "yes",
"dyspareunia": "no",
"positional_dyspareunia": "no",
"intercourse_interruption": "yes",
"painful_bowel_movements": "yes",
"bowel_spasms": "no",
"diarrhea_or_constipation": "yes",
"pain_when_urinating": "no",
"bladder_pain": "yes",
"sciatica": "no",
"right_shoulder_pain": "no",
"infertility": "yes"
}'
Response Format
{
"probability": 0.8723,
"risk": "High"
}
Response Fields:
probability
(float): Probability (between 0 and 1) of endometriosis.risk
(string): One of "Low", "Medium", or "High".