Skip to main content
POST
Generate Worksheet

When to use this endpoint

Call this endpoint after you have:
  1. Created a worksheet shell and initialized its metadata.
  2. Finalized the question configuration using the configuration APIs.
  3. Validated that the totals across question_summary, bloom_summary, difficulty_summary, and question_type_summary match number_of_questions.
Typical scenarios:
  • 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.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

work_sheet_id
string<uuid>
required

Unique identifier of the worksheet

Body

application/json
question_type_summary
object[]
required

Summary of question types and their counts.

bloom_summary
object[]
required
difficulty_summary
object[]
required
question_summary
object[]
required

Response

Worksheet generation initiated successfully.

detail
object[]