Sync My Cycle

Today's cycle phase, with workout and food ideas. For when the user asks what phase they are in, what workout or food suits them today, or why their energy is up or down, for example "what phase am I in, my last period started September 12th" or "what should I train today?". Needs the first day of their last period. Not for getting pregnant, fertile days, ovulation timing, contraception or pregnancy: this is general wellbeing only, not for pregnancy planning or contraception, and a doctor or pharmacist is the right person for those. When `period_may_be_late` is true the say line says the period may be late and suggests checking with a doctor.

{
  "type": "object",
  "properties": {
    "last_period": {
      "type": "string",
      "format": "date",
      "description": "First day of the user's most recent period, YYYY-MM-DD. Must be within the last 120 days."
    },
    "cycle_length": {
      "type": "integer",
      "minimum": 20,
      "maximum": 45,
      "description": "Usual days from one period start to the next, 20 to 45. Default 28."
    },
    "period_length": {
      "type": "integer",
      "minimum": 2,
      "maximum": 10,
      "description": "Usual days of bleeding, 2 to 10. Default 5."
    },
    "date": {
      "type": "string",
      "format": "date",
      "description": "Day to ask about, YYYY-MM-DD, a real calendar day. Default today where the user is: from tz, else country, else the request, else UTC."
    },
    "diet": {
      "type": "string",
      "description": "Comma separated: vegetarian, vegan, pescatarian, halal. Food ideas are filtered to suit."
    },
    "country": {
      "type": "string",
      "description": "Two-letter country code (UK is read as GB). Sets the kit links (US, GB and IE get local Amazon links) and the time zone for today. Default from the request."
    },
    "tz": {
      "type": "string",
      "description": "The user's IANA time zone, for example Europe/London or America/Chicago, so today is the user's today. Optional: country is enough in most places."
    },
    "last_period_start": {
      "type": "string",
      "format": "date",
      "description": "Older name for last_period, kept for existing callers; last_period is the current name."
    }
  },
  "required": [
    "last_period"
  ],
  "additionalProperties": false
}

The days ahead by phase. For when the user wants to plan training or meals for the week, for example "plan my training this week around my cycle". Returns each day's likely phase, workout focus, intensity and food focus. Not for getting pregnant, fertile days, ovulation timing, contraception or pregnancy: this is general wellbeing only, not for pregnancy planning or contraception, and it is not a fertility calendar. When `period_may_be_late` is true, `days` is empty and the say line suggests checking with a doctor.

{
  "type": "object",
  "properties": {
    "last_period": {
      "type": "string",
      "format": "date",
      "description": "First day of the user's most recent period, YYYY-MM-DD. Must be within the last 120 days."
    },
    "cycle_length": {
      "type": "integer",
      "minimum": 20,
      "maximum": 45,
      "description": "Usual cycle length, 20 to 45. Default 28."
    },
    "period_length": {
      "type": "integer",
      "minimum": 2,
      "maximum": 10,
      "description": "Usual days of bleeding, 2 to 10. Default 5."
    },
    "date": {
      "type": "string",
      "format": "date",
      "description": "First day of the plan, YYYY-MM-DD, a real calendar day. Default today where the user is: from tz, else country, else the request, else UTC."
    },
    "days": {
      "type": "integer",
      "minimum": 1,
      "maximum": 35,
      "description": "How many days, a whole number from 1 to 35. Default 7."
    },
    "diet": {
      "type": "string",
      "description": "Accepted for symmetry with get_todays_phase; the week view has no food list, so it has no effect here."
    },
    "country": {
      "type": "string",
      "description": "Two-letter country code (UK is read as GB), used for the time zone of today."
    },
    "tz": {
      "type": "string",
      "description": "The user's IANA time zone, for example Europe/London or America/Chicago, so today is the user's today. Optional: country is enough in most places."
    },
    "last_period_start": {
      "type": "string",
      "format": "date",
      "description": "Older name for last_period, kept for existing callers; last_period is the current name."
    }
  },
  "required": [
    "last_period"
  ],
  "additionalProperties": false
}

What each phase usually feels like, with workout and food ideas. For general questions about cycle syncing that need no dates, for example "what should I eat in my luteal phase?". Not for conception, fertile days, contraception or pregnancy: general wellbeing only, not for pregnancy planning or contraception.

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}