GET - Worksheet Question Configuration
Retrieves the finalized question configuration of a worksheet by its ID.
The response includes worksheet details such as board, grade, subject, status, topic, number of questions, documents, audio, subject matter, learning standards, and the actual question configuration.
How to Use:
- Call
GET /worksheet/v1/question-config/{work_sheet_id}with the worksheet ID. - On success, you will receive all worksheet metadata along with question configuration.
- If the worksheet or configuration step does not exist, a
404error is returned. - If the configuration step failed, a
400error with the failure message is returned.
Path Parameters:
work_sheet_id(UUID, required): The unique ID of the worksheet.
GET
Get Worksheet Question Configuration
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 question configuration retrieved successfully.
The response is of type object.
Previous
POST - Generate WorksheetInitiates the worksheet question generation process for a given worksheet after validation of its configuration.
This step ensures that the worksheet is generated based on the finalized **question configuration** (Bloom’s taxonomy, difficulty levels, and question types).
**How to Use:**
1. Call `POST /worksheet/v1/generate-worksheet/{work_sheet_id}` with a valid worksheet ID.
2. Provide the complete **question configuration** in the request body, including:
- `question_summary`
- `bloom_summary`
- `difficulty_summary`
- `question_type_summary`
3. All counts must add up to the worksheet’s total `number_of_questions`.
4. If validation passes, the generation job is queued and you receive confirmation.
**Path Parameters:**
- `work_sheet_id` (UUID, required): The unique ID of the worksheet.
Next
Get Worksheet Question Configuration