Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
multipart/form-data
Response
Worksheet metadata processing started successfully.
The response is of type object
.
Generates metadata for a worksheet based on provided inputs such as board, grade, subject, section, number of questions, and optional resources (documents or audio). The request also accepts distributions for question types, difficulty levels, and Bloom’s taxonomy levels.
How to Use:
POST /worksheet/v1/metadata
with required fields (board
, grade
, subject
, number_of_questions
, and distributions) and optionally provide topic
, section
, documents
, or audio
.id
and confirmation message in the response.400
error is returned.200
response is returned with the request ID.500
error is returned.Question Type Distribution:
{
"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
}
The sum of question_type_distribution must equal number_of_questions.
Difficulty Level Distribution (%)
{
"easy": 30,
"medium": 50,
"hard": 20
}
Bloom’s Taxonomy Distribution (%)
{
"remember": 30,
"understand": 30,
"apply": 30,
"analyze": 10,
"evaluate": 0,
"create": 0
}
The sum of difficulty_level_distribution and bloom_taxonomy_distribution must each equal 100.
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Worksheet metadata processing started successfully.
The response is of type object
.