> ## 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 - Get Generated Worksheet

> Retrieves the generated worksheet (questions and metadata) for a given worksheet ID.  
The response includes worksheet details such as board, grade, subject, topic, number of questions, and the full set of generated questions (if available).

**How to Use:**
 1. Call `GET /worksheet/v1/generate-worksheet/{work_sheet_id}` with the worksheet ID.
 2. On success, you will receive worksheet metadata along with the generated questions.
 3. If the worksheet or step is missing, a `404` error is returned.
 4. If the generation step failed, a `400` error is returned with the failure message.
 5. If no questions have been generated yet, the `questions` field will return a placeholder message.

**Path Parameters:**
- `work_sheet_id` (UUID, required): The unique ID of the worksheet.




## OpenAPI

````yaml GET /worksheet/v1/generate-worksheet/{work_sheet_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:
  /worksheet/v1/generate-worksheet/{work_sheet_id}:
    get:
      summary: Get Generated Worksheet
      description: >-
        Fetches the generated worksheet, including metadata (board, grade,
        subject, etc.) and the generated questions grouped by type. Returns
        validation errors if generation failed, or placeholders if no questions
        are available.
      operationId: getGeneratedWorksheet
      parameters:
        - name: work_sheet_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Unique identifier of the worksheet
      responses:
        '200':
          description: Generated worksheet retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneratedWorksheetResponse'
              example:
                data:
                  id: 152764ca-1685-427c-aba7-4b92dcc0d60f
                  board:
                    id: baf36573-d049-4636-9c4b-bc9cda6270fe
                    name: CBSE
                  grade:
                    id: 28820b1a-34e1-4003-b5bd-96455ca2c6d8
                    name: Grade 10
                  section: ''
                  subject:
                    id: 6dd7ebda-1bc5-4c01-8649-372579189073
                    name: Science
                  status: Completed
                  number_of_questions: 10
                  topic: Magnet
                  documents: []
                  audio: ''
                  questions:
                    true_false:
                      - question: >-
                          A compass needle, being a small magnet, has two poles:
                          the north-seeking pole and the south-seeking pole.
                        answer: 'True'
                        tags:
                          bloom: Remember
                          difficulty: Easy
                          learning_objectives: >-
                            Students will explain the characteristics that
                            differentiate various materials and organisms,
                            supporting their conclusions with evidence.
                    long_answer:
                      - question: >-
                          Explain in detail how you would differentiate between
                          autotrophic and heterotrophic nutrition in organisms.
                          In your answer, include: (a) definitions of both types
                          of nutrition, (b) examples of organisms exhibiting
                          each type, and (c) how energy is obtained and utilized
                          in both cases. Your response should be structured in
                          at least three paragraphs and comprise 150-200 words.
                        answer: >-
                          (a) Autotrophic nutrition is the process by which
                          organisms produce their own food from simple inorganic
                          substances like carbon dioxide and water, typically
                          through photosynthesis. Heterotrophic nutrition refers
                          to organisms obtaining food by consuming other
                          organisms or organic matter. (b) Examples of
                          autotrophs include green plants, algae, and some
                          bacteria; heterotrophs include animals, fungi, and
                          many bacteria. (c) Autotrophs trap energy from
                          sunlight to synthesize organic molecules, which serve
                          as food and energy sources. Heterotrophs obtain energy
                          by digesting organic molecules consumed from
                          autotrophs or other heterotrophs, using respiration to
                          release energy stored in these molecules.
                        tags:
                          bloom: Apply
                          difficulty: Medium
                          learning_objectives: >-
                            Differentiate materials, objects, organisms,
                            phenomena, and processes based on properties and
                            characteristics, such as identifying autotrophic and
                            heterotrophic nutrition.
                      - question: >-
                          Explain the differences between autotrophic and
                          heterotrophic nutrition, classify materials as
                          biodegradable or non-biodegradable with examples, and
                          distinguish between exothermic and endothermic
                          chemical reactions. Your answer should be structured
                          in three parts: (a) Define autotrophic and
                          heterotrophic nutrition with examples (5 marks), (b)
                          Classify the following substances as biodegradable or
                          non-biodegradable and justify your classification:
                          paper, plastic, and food waste (5 marks), and (c)
                          Compare exothermic and endothermic reactions by
                          defining each and providing one example with
                          explanation (10 marks). Write your answer in 150-200
                          words.
                        answer: >-
                          (a) Autotrophic nutrition is the process by which
                          organisms prepare their own food from simple
                          substances like carbon dioxide and water using
                          sunlight (e.g., green plants). Heterotrophic nutrition
                          is when organisms obtain food by consuming other
                          organisms (e.g., animals). (b) Paper and food waste
                          are biodegradable because they decompose naturally by
                          microorganisms; plastic is non-biodegradable as it
                          does not decompose easily. (c) Exothermic reactions
                          release heat to the surroundings (e.g., combustion),
                          causing temperature rise. Endothermic reactions absorb
                          heat (e.g., photosynthesis), resulting in temperature
                          drop or heat absorption.
                        tags:
                          bloom: Remember
                          difficulty: Hard
                          learning_objectives: >-
                            Differentiate materials, organisms, and chemical
                            reactions based on properties; identify autotrophic
                            and heterotrophic nutrition; classify biodegradable
                            and non-biodegradable substances; distinguish types
                            of chemical reactions.
                    short_answer:
                      - question: >-
                          Explain briefly how you can use indicators to identify
                          whether a salt solution is acidic, basic, or neutral.
                          Write your answer in 2-3 sentences.
                        answer: >-
                          By adding a suitable indicator to the salt solution,
                          the color change indicates its nature: if the
                          indicator shows acidic color, the salt solution is
                          acidic; if it shows basic color, the solution is
                          basic; and if there is no significant color change,
                          the salt solution is neutral.
                        tags:
                          bloom: Apply
                          difficulty: Medium
                          learning_objectives: >-
                            Use indicators to classify substances as acidic,
                            basic, or neutral salts.
                    mcq_single_answer:
                      - question: >-
                          Why does a compass needle get deflected when it is
                          brought near a bar magnet?
                        options:
                          - >-
                            A. Because the compass needle is affected by the
                            magnetic field of the bar magnet
                          - >-
                            B. Because the compass needle is a normal iron piece
                            that attracts the magnet
                          - >-
                            C. Because the compass needle heats up near the
                            magnet
                          - >-
                            D. Because the compass needle loses its magnetic
                            properties near the magnet
                        answer: A
                        tags:
                          bloom: Understand
                          difficulty: Easy
                          learning_objectives: >-
                            Explain characteristics that differentiate materials
                            and organisms with evidence; understand magnetic
                            interaction
                      - question: >-
                          Which of the following indicators correctly classifies
                          a salt solution as acidic?
                        options:
                          - >-
                            A. Blue litmus paper turns red when dipped in the
                            solution.
                          - >-
                            B. Red litmus paper remains red when dipped in the
                            solution.
                          - C. Phenolphthalein turns pink in the solution.
                          - D. Methyl orange remains yellow in the solution.
                        answer: A
                        tags:
                          bloom: Apply
                          difficulty: Medium
                          learning_objectives: >-
                            Use indicators to classify substances as strong or
                            weak acids and bases, and acidic, basic, or neutral
                            salts.
                    very_short_answer:
                      - question: >-
                          Write ONE WORD only: What is the end of a compass
                          needle that points towards the north direction called?
                        answer: North pole
                        tags:
                          bloom: Remember
                          difficulty: Easy
                          learning_objectives: >-
                            Students will explain the characteristics that
                            differentiate various materials and organisms,
                            supporting their conclusions with evidence.
                    mcq_multiple_answer:
                      - question: >-
                          Select ALL correct statements about the properties and
                          behavior of a compass needle and magnetic field based
                          on the given content. (Select TWO options)
                        options:
                          - >-
                            A. The north pole of the compass needle points
                            towards the south pole of a nearby bar magnet due to
                            magnetic attraction.
                          - >-
                            B. A compass needle is a small bar magnet with its
                            north pole pointing towards geographic north.
                          - >-
                            C. Magnetic field lines represent the path along
                            which a hypothetical free south pole would move.
                          - >-
                            D. Like poles of magnets attract each other, while
                            unlike poles repel.
                        answer: A, B
                        tags:
                          bloom: Analyze
                          difficulty: Hard
                          learning_objectives: >-
                            Differentiate materials, objects, organisms,
                            phenomena, and processes based on properties and
                            characteristics related to magnetism and magnetic
                            field.
                      - question: >-
                          Select ALL the correct ways to classify substances
                          using indicators:
                        options:
                          - >-
                            A. Use indicators to determine if an acid is strong
                            or weak
                          - >-
                            B. Use indicators to classify salts as acidic,
                            basic, or neutral
                          - C. Use indicators to measure magnetic field strength
                          - >-
                            D. Use indicators to classify bases as strong or
                            weak
                          - >-
                            E. Use indicators to identify the north and south
                            poles of a magnet
                        answer: A, B, D
                        tags:
                          bloom: Apply
                          difficulty: Medium
                          learning_objectives: >-
                            Using indicators to classify strong/weak acids and
                            bases, and acidic/basic/neutral salts
                      - question: >-
                          Select TWO correct statements about the
                          characteristics of a compass needle and its
                          interaction with a bar magnet. (Tick TWO options)
                        options:
                          - >-
                            A. The compass needle has two poles: north seeking
                            and south seeking.
                          - >-
                            B. The north pole of the compass needle is attracted
                            towards the north pole of a bar magnet.
                          - >-
                            C. The south pole of the compass needle points
                            towards the north pole of a bar magnet.
                          - >-
                            D. The compass needle gets deflected because it is a
                            small bar magnet.
                          - >-
                            E. Iron filings repel and never align along the
                            magnetic field lines around the bar magnet.
                        answer: A, C, D
                        tags:
                          bloom: Understand
                          difficulty: Easy
                          learning_objectives: >-
                            Students will explain the characteristics that
                            differentiate various materials and organisms,
                            supporting their conclusions with evidence.
        '400':
          description: Worksheet generation failed or invalid state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                detail:
                  - msg: Failed to generate worksheet due to invalid configuration.
        '404':
          description: Worksheet or generation step not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                detail:
                  - msg: Worksheet not found.
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                detail:
                  - msg: Unexpected server error.
      security:
        - bearerAuth: []
components:
  schemas:
    GeneratedWorksheetResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
              description: Unique identifier of the worksheet
              example: 152764ca-1685-427c-aba7-4b92dcc0d60f
            board:
              $ref: '#/components/schemas/IdName'
              description: Educational board information
            grade:
              $ref: '#/components/schemas/IdName'
              description: Grade information
            section:
              type: string
              description: Section of the grade (if applicable)
            subject:
              $ref: '#/components/schemas/IdName'
              description: Subject information
            status:
              type: string
              description: Current status of the worksheet generation
              example: Completed
            number_of_questions:
              type: integer
              description: Total number of questions in the worksheet
            topic:
              type: string
              description: Topic of the worksheet
            documents:
              type: array
              items:
                type: string
                format: uri
            audio:
              type: string
              format: uri
            questions:
              type: object
              additionalProperties:
                type: array
                items:
                  $ref: '#/components/schemas/Question'
    ErrorResponse:
      type: object
      properties:
        detail:
          type: array
          items:
            type: object
            properties:
              msg:
                type: string
                example: Worksheet question configuration is not finalized!
    IdName:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: baf36573-d049-4636-9c4b-bc9cda6270fe
          description: Unique identifier
        name:
          type: string
          example: CBSE
          description: Name corresponding to the ID
    Question:
      type: object
      description: A question in the generated worksheet
      properties:
        question:
          type: string
          description: The text of the question
        options:
          type: array
          items:
            type: string
            description: An option for multiple-choice questions
        answer:
          type: string
          description: The correct answer to the question
        tags:
          type: object
          description: Metadata tags for the question
          properties:
            bloom:
              type: string
              description: Bloom's taxonomy level
            difficulty:
              type: string
              description: Difficulty level of the question
            learning_objectives:
              type: string
              description: Learning objectives associated with the question
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````