POST - Generate Worksheet
Initiates 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:
- Call
POST /worksheet/v1/generate-worksheet/{work_sheet_id}with a valid worksheet ID. - Provide the complete question configuration in the request body, including:
question_summarybloom_summarydifficulty_summaryquestion_type_summary
- All counts must add up to the worksheet’s total
number_of_questions. - 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.
POST
Generate Worksheet
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.
When to use this endpoint
Call this endpoint after you have:- Created a worksheet shell and initialized its metadata.
- Finalized the question configuration using the configuration APIs.
- Validated that the totals across
question_summary,bloom_summary,difficulty_summary, andquestion_type_summarymatchnumber_of_questions.
- LMS or homework platforms that queue auto‑generated practice sheets once teachers approve the configuration.
- Admin dashboards that generate board‑aligned worksheets in bulk for multiple classes.
- Programmatic integrations that run nightly worksheet jobs based on student performance data.
Related endpoints
- POST - Initialize Worksheet Metadata
- POST - Worksheet Question Configuration
- GET - Worksheet Generation Status
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier of the worksheet
Body
application/json
Response
Worksheet generation initiated successfully.
Previous
GET - Get Generated WorksheetRetrieves 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.
Next
Generate Worksheet