Skip to main content
POST
Generate Worksheet Metadata

Authorizations

Authorization
string
header
required

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

Body

multipart/form-data
board
string<uuid>
required
Example:

"087c80b0-ac25-40ee-8657-28b694882ba8"

grade
string<uuid>
required
Example:

"65955148-e106-461b-a9a6-e0c3294f6734"

subject
string<uuid>
required
Example:

"5dcc9bab-e2ac-4c65-a3d0-e272ac4bc5ea"

number_of_questions
integer
required
Example:

10

question_distribution
string
required

JSON string representing question type distribution

Example:

"{\"mcq_single_answer\": 2, \"mcq_multiple_answer\": 3, \"true_false\": 1, \"fill_in_the_blanks\": 0, \"very_short_answer\": 1, \"short_answer\": 1, \"long_answer\": 2, \"match_the_column\": 0}"

difficulty_level_distribution
string
required

JSON string representing difficulty distribution

Example:

"{\"easy\": 30, \"medium\": 50, \"hard\": 20}"

bloom_taxonomy_distribution
string
required

JSON string representing Bloom taxonomy distribution

Example:

"{\"remember\": 30, \"understand\": 30, \"apply\": 30, \"analyze\": 10, \"evaluate\": 0, \"create\": 0}"

section
string | null
Example:

"A"

topic
string | null
Example:

"Magnet"

documents
file | null

Array of document files

audio
file | null

Audio file for question generation

meta_data
string

JSON string representing the metadata of the worksheet

Example:

"{\"teacher_id\": 199}"

Response

Worksheet metadata processing started successfully.

id
string

Unique identifier for the worksheet metadata request.

Example:

"84dad129-76dc-44b6-84ad-4f55fd451891"

msg
string

Confirmation msg indicating successful processing start.

Example:

"Worksheet metadata processing started successfully."