POST
/
v1
/
k12
/
generate
/
worksheet
curl --request POST \
  --url https://api-staging.crazygoldfish.com/v1/k12/generate/worksheet \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: <content-type>' \
  --header 'accept: <accept>' \
  --data '{
  "institution_id": "inst789",
  "teacher_id": "teacher456",
  "grade": "10",
  "subject": "Science",
  "board": "NCERT",
  "topics": [
    "Photosynthesis",
    "Cell Structure"
  ],
  "learning_objectives": [
    "Understanding photosynthesis process"
  ],
  "question_tagging_options": {
    "Hint": "No",
    "Curricular_Goal": "No",
    "Competency": "No",
    "LO": "No",
    "LOB": "No",
    "Difficulty_level": "No",
    "Bloom_Taxonomy": "No"
  },
  "number_of_questions": 10,
  "difficulty_distribution_percentage": {
    "easy": 33,
    "medium": 33,
    "hard": 34
  },
  "blooms_taxonomy_distribution_percentage": {
    "Remember": 10,
    "Understand": 10,
    "Apply": 10,
    "Analyze": 10,
    "Evaluate": 10,
    "Create": 50
  },
  "question_type_distribution_absolute": {
    "MCQ_single_answer": 3,
    "MCQ_Multiple_answer": 2,
    "True_False": 2,
    "Fill_in_the_blanks": 1,
    "Match_the_column": 6,
    "Very_Short_answer": 1,
    "Short_answer": 4,
    "Long_answer": 5
  },
  "solution_sheet": "Yes",
  "format": "JSON",
  "extra": [
    "string"
  ]
}'
{
  "status_code": 202,
  "message": "Worksheet 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
​
grade
string
required

Grade level for the worksheet.

Example:

"10"

​
subject
string
required

Subject for the worksheet.

Example:

"Science"

​
board
string
required

Educational board for which the lesson plan is required.

  • For class 6, 7, 8, use CBSE

  • For the rest of the classes, use NCERT

Example:

"NCERT"

​
topics
string[]
required

Topics to be covered in the worksheet.

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

Total number of questions.

Required range: x <= 20
Example:

10

​
difficulty_distribution_percentage
object
required
​
blooms_taxonomy_distribution_percentage
object
required
​
question_type_distribution_absolute
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 for the worksheet.

Example:
["Understanding photosynthesis process"]
​
solution_sheet
enum<string>
Available options:
Yes,
No
Example:

"Yes"

​
format
string
Example:

"JSON"

​
extra
string[]
Example:
["string"]

Response

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

202

​
message
string
Example:

"Worksheet generation request submitted successfully"

​
data
object
​
status
string
Example:

"Processing"