GET - Get Worksheet Explanations
Retrieves all questions with their explanations for a given worksheet.
The response includes worksheet metadata along with questions that have an explanation key added to each question object.
Prerequisites:
- The worksheet must exist.
- The question generation step must be completed.
- The explanation generation step must be completed.
How to Use:
- Call
GET /worksheet/v1/generate-explanations/{work_sheet_id}with the worksheet ID. - On success, you will receive worksheet metadata along with questions and their explanations.
- If the worksheet or any required step is missing, a
404error is returned. - If the generation steps are not yet completed, a
400error is returned with the current status. - If explanation generation failed, a
400error is returned with the failure message.
Path Parameters:
work_sheet_id(UUID, required): The unique ID of the worksheet.
Response Data:
id: Worksheet ID.board: Board details (id and name).grade: Grade details (id and name).section: Worksheet section.subject: Subject details (id and name).status: Current status of the explanation generation step.number_of_questions: Total number of questions in the worksheet.topic: Topic of the worksheet.documents: List of document URLs associated with the worksheet.audio: Audio URL if available.questions: Array of questions with explanations merged.
Response Codes:
200 OK: Questions with explanations returned successfully.400 Bad Request: Questions or explanations not yet generated, or generation failed.404 Not Found: Worksheet, questions, or explanations not found.500 Internal Server Error: Unexpected error occurred.
GET
Get Worksheet Questions with Explanations
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.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier of the worksheet
Response
Worksheet questions with explanations retrieved successfully.
Previous
POST - Worksheet Feedback This API allows authenticated users to create feedback entries for a worksheet.
**How to Use:**
- Call `POST /worksheet/v1/feedback/{work_sheet_id}` with the feedback details including rating, comment, feedback type, and optional fields.
- The API validates that the worksheet exists and creates a new feedback entry.
**Request Body Parameters:**
- **rating** (optional): Integer between 1 and 5, representing the rating for the worksheet.
- **comment** (required): Text feedback or comment about the worksheet.
- **feedback_type** (required): Type of feedback ( May be one of them: `general`, `content`, `quality`, `suggestion`).
- **feedback_data** (optional): Structured feedback data as a JSON object for additional context.
- **step_name** (optional): Specific step name if the feedback is for a particular step in the worksheet.
- **component_name** (optional): Specific component name if the feedback is for a particular component.
Next
Get Worksheet Questions with Explanations