POST
/
v1
/
k12
/
generate
/
mcqs
curl --request POST \
  --url https://api-staging.crazygoldfish.com/v1/k12/generate/mcqs \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: <content-type>' \
  --header 'accept: <accept>' \
  --data '{
  "institution_id": "inst789",
  "teacher_id": "teacher456",
  "board": "NCERT",
  "grade": 10,
  "subject": "Science",
  "topics": [
    "Photosynthesis",
    "Cell Structure"
  ],
  "number_of_questions": 20,
  "question_type_distribution_percentage": {
    "single_answer": 100,
    "multiple_answer": 0
  },
  "difficulty_distribution_percentage": {
    "easy": 33,
    "medium": 33,
    "hard": 34
  },
  "blooms_taxonomy_distribution_percentage": {
    "Remember": 20,
    "Understand": 20,
    "Apply": 20,
    "Analyze": 20,
    "Evaluate": 10,
    "Create": 10
  },
  "learning_objectives": [
    "Understand photosynthesis process",
    "Identify cell structures"
  ],
  "extras": [
    "Include diagrams",
    "Focus on practical applications"
  ],
  "question_tagging_options": {
    "Hint": "No",
    "Curricular_Goal": "No",
    "Competency": "No",
    "LO": "No",
    "LOB": "No",
    "Difficulty_level": "No",
    "Bloom_Taxonomy": "No"
  },
  "solution_sheet": "yes"
}'
{
  "status_code": 202,
  "message": "MCQ generation request submitted successfully",
  "data": {
    "request_id": "unique-request-id"
  },
  "status": "Processing"
}

Authorizations

Authorization
string
header
required

Headers

accept
enum<string>
default:application/json
required

Specifies the format of the response.

Available options:
application/json
Content-Type
enum<string>
default:application/json
required

Specifies the content type of the request body.

Available options:
application/json

Body

application/json
board
string
required

Educational board for which the MCQs is required.

  • For class 6, 7, 8, use CBSE

  • For the rest of the classes, use NCERT

Example:

"NCERT"

grade
integer
required

Grade level for the MCQs.

Example:

10

subject
string
required

Subject for which MCQs are needed.

Example:

"Science"

topics
string[]
required

Topics for which MCQs need to be generated.

Example:
["Photosynthesis", "Cell Structure"]
number_of_questions
integer
required

Total number of MCQs to generate.

Required range: x <= 20
Example:

20

question_type_distribution_percentage
object
required

Distribution of question types in percentage.

difficulty_distribution_percentage
object
required

Distribution of difficulty levels in percentage.

blooms_taxonomy_distribution_percentage
object
required

Distribution of Bloom's taxonomy levels in percentage.

question_tagging_options
object
required
institution_id
string

Unique identifier of the institution.

Example:

"inst789"

teacher_id
string

Unique identifier of the teacher.

Example:

"teacher456"

learning_objectives
string[]

Learning objectives to focus on.

Example:
[
  "Understand photosynthesis process",
  "Identify cell structures"
]
extras
string[]

Additional parameters for MCQ generation.

Example:
[
  "Include diagrams",
  "Focus on practical applications"
]
solution_sheet
enum<string>

Whether to include solution sheet.

Available options:
yes,
no
Example:

"yes"

Response

200
application/json
Request accepted for processing.
status_code
integer
Example:

202

message
string
Example:

"MCQ generation request submitted successfully"

data
object
status
string
Example:

"Processing"