> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crazygoldfish.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET - Lesson Plan Instructional Framework Builder

>  This API allows authenticated users to retrieve the generated instructional framework for a lesson plan. 

 **How to Use:**

 
 1. Call `GET /lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}` with the lesson plan ID. 
 2. The API validates the lesson plan ID and checks if instructional framework generation is completed. 
 3. On success, the system returns the generated instructional framework. 

 **Example Scenario:** 

 A teacher wants to view the generated instructional framework for a lesson plan: 
 - They call this API with the lesson plan ID. 
 - The system validates the lesson plan and instructional framework generation status. 
 - If valid and completed, the system returns the generated instructional framework. 
 - The teacher receives the lesson plan instructional framework for review and use. 



## OpenAPI

````yaml GET /lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}
openapi: 3.0.1
info:
  title: Evaluation Report API
  description: An API for retrieving evaluation reports.
  version: 1.0.0
servers:
  - url: https://api-staging.crazygoldfish.com
    description: SandBox endpoint
  - url: https://api.crazygoldfish.com
    description: Prod End Point
security: []
paths:
  /lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}:
    get:
      summary: Retrieve the generated content for a lesson plan.
      operationId: getLessonPlanContent
      parameters:
        - name: lesson_plan_id
          in: path
          required: true
          description: UUID of the lesson plan whose generated content is being requested.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Lesson plan content retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    description: The full lesson plan record including generated content.
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: Unique identifier of the lesson plan.
                      board:
                        type: object
                        description: Educational board details for this lesson plan.
                        properties:
                          id:
                            type: string
                            format: uuid
                            description: UUID of the board.
                          name:
                            type: string
                            description: Name of the board (e.g., CBSE).
                      grade:
                        type: object
                        description: Grade level for which this lesson plan is intended.
                        properties:
                          id:
                            type: string
                            format: uuid
                            description: UUID of the grade.
                          name:
                            type: string
                            description: Grade name (e.g., Grade 10).
                      section:
                        type: string
                        description: Section or class division (if applicable).
                      subject:
                        type: object
                        description: Subject details for this lesson plan.
                        properties:
                          id:
                            type: string
                            format: uuid
                            description: UUID of the subject.
                          name:
                            type: string
                            description: Name of the subject (e.g., Mathematics).
                      status:
                        type: string
                        description: >-
                          Current status of content generation (e.g.,
                          InProgress, Completed, Failed).
                      duration_minutes:
                        type: integer
                        description: Planned duration of the lesson in minutes.
                      topic:
                        type: string
                        description: Specific topic or title of the lesson.
                      documents:
                        type: array
                        description: List of document URLs associated with the lesson plan.
                        items:
                          type: string
                          format: uri
                      audio_url:
                        type: string
                        format: uri
                        description: >-
                          Optional URL of an audio resource generated for the
                          lesson.
                      subject_matter:
                        type: object
                        description: >-
                          Detailed subject matter chunks generated for the
                          lesson, including topics to be covered, key concepts,
                          and prerequisites.
                      learning_standards:
                        type: object
                        description: >-
                          Learning standards and objectives covered by the
                          lesson.
                      alignment:
                        type: object
                        description: >-
                          Alignment information (materials, instructional
                          strategies, and instructional blocks) generated before
                          content creation.
                      content_generation:
                        type: object
                        description: >-
                          Generated instructional content for each phase of the
                          lesson plan.
                        properties:
                          introduction_block:
                            type: object
                            description: >-
                              Generated introduction activities including
                              teacher notes, materials, implementation script,
                              formative questions, expected responses, and
                              duration.
                          development_block:
                            type: object
                            description: >-
                              Generated development segment with step-by-step
                              teaching instructions, scripts, formative
                              checkpoints, and teacher guidance.
                          guided_practice_block:
                            type: object
                            description: >-
                              Guided practice activities for collaborative or
                              teacher-assisted work, with questions and expected
                              responses.
                          independent_practice_block:
                            type: object
                            description: >-
                              Independent practice tasks for students to apply
                              learning, including detailed scripts and
                              assessment cues.
                          closure_block:
                            type: object
                            description: >-
                              Lesson closure activities with reflection
                              questions, key takeaways, and teacher notes.
                          assessment_block:
                            type: object
                            description: >-
                              Summative assessment tasks aligned with lesson
                              objectives, including formative questions,
                              expected responses, and scoring guidance.
              example:
                data:
                  id: 658fcb13-0304-46cd-8c3d-0776ec4506f8
                  board:
                    id: 087c80b0-ac25-40ee-8657-28b694882ba8
                    name: CBSE
                  grade:
                    id: 65955148-e106-461b-a9a6-e0c3294f6734
                    name: Grade 10
                  section: null
                  subject:
                    id: abf49127-253c-4dc9-9bf5-eb66360e5592
                    name: Mathematics
                  status: Completed
                  duration_minutes: 50
                  topic: Real Numbers
                  documents: []
                  audio_url: null
                  subject_matter:
                    ...: >-
                      Full subject matter as in the provided JSON
                      (topics_to_be_covered, key_concepts_and_subconcepts,
                      prerequisite_knowledge)
                  learning_standards:
                    ...: >-
                      Learning outcomes, SMART objectives, competencies as in
                      your JSON
                  alignment:
                    ...: >-
                      Materials options, instructional strategies, and
                      instructional blocks as previously generated
                  content_generation:
                    introduction_block:
                      components:
                        - component_name: Warm-up Discussion on Number Properties
                          duration_minutes: 7
                          materials_used:
                            - Whiteboard
                            - Markers
                            - Number line chart or projection
                          implementation_script: >-
                            Begin the class by greeting students and stating the
                            objective ...
                          formative_questions:
                            - >-
                              Can you explain what divisibility means with an
                              example?
                            - >-
                              How would you describe an irrational number on a
                              number line?
                          expected_responses:
                            - >-
                              Divisibility means one number can be divided by
                              another without remainder, e.g., 10 is divisible
                              by 2.
                            - >-
                              An irrational number cannot be expressed as a
                              fraction; e.g., √2 lies between 1 and 2.
                          teacher_notes: >-
                            Observe students' ability to recall key definitions
                            and address misconceptions.
                    development_block:
                      components:
                        - component_name: Explain Euclid's Division Algorithm with Examples
                          duration_minutes: 12
                          materials_used:
                            - Whiteboard
                            - Markers
                            - Number line chart
                            - Handouts
                          implementation_script: >-
                            Explain Euclid's Division Algorithm: For any two
                            positive integers a and b...
                          formative_questions:
                            - >-
                              What are the quotient and remainder when 22 is
                              divided by 6?
                            - >-
                              Why must the remainder always be less than the
                              divisor?
                          expected_responses:
                            - Quotient 3, remainder 4
                            - >-
                              Because the remainder represents what is left
                              after dividing fully.
                          teacher_notes: >-
                            Use visual aids and real-life analogies; check
                            student work and adjust pacing.
                    guided_practice_block:
                      components:
                        - component_name: Guided Proof Exploration of Irrationality
                          duration_minutes: 10
                          materials_used:
                            - Worksheet
                            - Whiteboard
                          implementation_script: >-
                            Model proof of √2's irrationality step-by-step and
                            guide students through proofs of √3 and 3 + 2√5.
                          formative_questions:
                            - >-
                              Why do we assume the integers in the proof are
                              coprime?
                            - >-
                              What contradiction arises when assuming √3 is
                              rational?
                          expected_responses:
                            - To ensure the fraction is in lowest terms.
                            - >-
                              That both integers share a factor, contradicting
                              coprimality.
                          teacher_notes: >-
                            Circulate to support reasoning and correct
                            misunderstandings.
                    independent_practice_block:
                      components:
                        - component_name: >-
                            Individual Exercises on Divisibility and
                            Factorization
                          duration_minutes: 12
                          materials_used:
                            - Worksheet
                            - Notebook
                          implementation_script: >-
                            Students apply Euclid's algorithm and perform prime
                            factorization on given integers.
                          formative_questions:
                            - >-
                              Can you explain each step of Euclid's algorithm
                              you performed?
                            - How does your prime factorization show uniqueness?
                          expected_responses:
                            - >-
                              Describe quotient and remainder steps until
                              remainder zero.
                            - Integer expressed as unique product of primes.
                          teacher_notes: >-
                            Observe and guide students, ensuring clear steps and
                            explanations.
                    closure_block:
                      components:
                        - component_name: Summarize Key Concepts
                          duration_minutes: 5
                          materials_used:
                            - Whiteboard
                            - Checklist
                          implementation_script: >-
                            Review Euclid's algorithm, Fundamental Theorem of
                            Arithmetic, and irrationality proofs...
                          formative_questions:
                            - >-
                              How does Euclid's algorithm help in understanding
                              divisibility?
                            - Why is prime factorization unique?
                          expected_responses:
                            - >-
                              Expresses integer division with quotient and
                              remainder.
                            - Every integer >1 has a unique prime factorization.
                          teacher_notes: >-
                            Ensure active participation and correct
                            misconceptions quickly.
                    assessment_block:
                      components:
                        - component_name: >-
                            Multiple Choice Questions on Euclid's Division
                            Algorithm
                          duration_minutes: 4
                          materials_used:
                            - Printed MCQ sheets
                          implementation_script: >-
                            Provide students with MCQs testing Euclid's
                            algorithm, divisibility, and prime factorization.
                          formative_questions:
                            - What is the dividend in 17 ÷ 5?
                            - Find the remainder when 101 is divided by 7.
                          expected_responses:
                            - '17'
                            - '3'
                          teacher_notes: Monitor and provide hints where needed.
        '400':
          description: Content generation failed or is in an invalid state.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: array
                    items:
                      type: object
                      properties:
                        msg:
                          type: string
                          description: Error message explaining why the request is invalid.
        '404':
          description: Lesson plan not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: array
                    items:
                      type: object
                      properties:
                        msg:
                          type: string
                          description: >-
                            Error message indicating the lesson plan does not
                            exist.
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: array
                    items:
                      type: object
                      properties:
                        msg:
                          type: string
                          description: Detailed server error message.
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````