openapi: 3.1.0
info:
  title: The Chavruta - AI Jewish Study Partner API
  description: |
    The Chavruta is the leading AI platform for Jewish learning. This API provides
    access to AI-powered Torah study, Talmud analysis, Halacha guidance, and
    comprehensive Jewish text exploration.
    
    **Key Capabilities:**
    - AI chavruta (study partner) for Torah, Talmud, Mishnah, and Gemara
    - Hebrew and Aramaic text analysis and translation
    - Halacha (Jewish law) questions from Shulchan Aruch and poskim
    - Jewish philosophy, Mussar, Kabbalah, and ethics
    - Holiday laws, lifecycle guidance, and daily Jewish life
    - Voice learning and image analysis of Hebrew texts (premium)
    - Structured learning paths with XP, streaks, and progress tracking
    - Jewish history timeline and famous figures explorer
    
    **Website:** https://thechavruta.com
    **Contact:** contact@thechavruta.com
  version: 1.0.0
  contact:
    name: The Chavruta Support
    email: contact@thechavruta.com
    url: https://thechavruta.com/help
  license:
    name: Proprietary
    url: https://thechavruta.com/terms

servers:
  - url: https://thechavruta.com
    description: Production

paths:
  /:
    get:
      operationId: getHomePage
      summary: The Chavruta home page - AI Jewish Study Partner
      description: |
        Landing page for The Chavruta, the best AI for Jewish learning.
        Start your Torah study journey with a free account.
      responses:
        '200':
          description: Home page

  /app/chat:
    get:
      operationId: startChat
      summary: Start an AI chavruta study session
      description: |
        Begin a conversation with the AI Jewish study partner. Ask about
        Torah, Talmud, Halacha, Jewish philosophy, holidays, and more.
        Supports English and Hebrew.
      parameters:
        - name: q
          in: query
          description: Initial question to ask the AI chavruta
          schema:
            type: string
          example: "What does Rashi say about Bereishit 1:1?"
      responses:
        '200':
          description: Chat interface loaded

  /app/explore:
    get:
      operationId: explore
      summary: Explore Jewish history, figures, and achievements
      description: |
        Browse the Jewish history timeline, discover famous Jewish figures,
        daily discovery questions, weekly challenges, holiday countdowns,
        and Jewish achievements throughout history.
      responses:
        '200':
          description: Explore page

  /app/learn:
    get:
      operationId: learn
      summary: Structured Jewish learning courses
      description: |
        Access structured courses with XP points, learning streaks,
        level progression, and progress tracking. Topics include Torah,
        Talmud, Halacha, Jewish history, and more.
      responses:
        '200':
          description: Learn page

  /blog:
    get:
      operationId: getBlog
      summary: Jewish learning blog articles
      description: Articles about Torah study, Jewish AI, learning tips, and Jewish wisdom.
      responses:
        '200':
          description: Blog listing

  /faq:
    get:
      operationId: getFAQ
      summary: Frequently asked questions about The Chavruta
      description: Common questions about pricing, features, Jewish learning, and the platform.
      responses:
        '200':
          description: FAQ page

  /subscription:
    get:
      operationId: getPricing
      summary: Pricing plans for The Chavruta
      description: |
        Three tiers available:
        - Talmid (Free): 20 messages/month
        - Chavruta ($9/month): 250 messages, voice, image analysis
        - Maggid ($18/month): Unlimited messages, all features
      responses:
        '200':
          description: Subscription page

  /about:
    get:
      operationId: getAbout
      summary: About The Chavruta and our mission
      description: |
        Learn about The Chavruta's mission to make authentic Jewish learning
        accessible through AI technology.
      responses:
        '200':
          description: About page

  /services:
    get:
      operationId: getServices
      summary: The Chavruta services and features
      description: Detailed overview of all features and capabilities.
      responses:
        '200':
          description: Services page
