Start a worksheet
Create a worksheet from a topic, images, or an audio recording, and start generating its subject matter and learning standards.
id. Save it: every later call uses it.Rules
- Send exactly one source:
topic,documents, oraudio. number_of_questionscan be at most 10.- The counts in
question_distributionmust add up tonumber_of_questions. - The percentages in
difficulty_level_distributionandbloom_taxonomy_distributionmust each add up to 100. documents: up to 4 images,.jpg,.jpeg, or.png, 5 MB each.audio: one.mp3, 5 MB.- Send the three distribution fields as JSON strings inside the form.
- The form also accepts a
sectionfield, but the API never stores it, sosectioncomes back asnullin every worksheet response. Leave it out and keep your own record of the class section. The lesson plan API does store the section it is sent.
topic, questions are grounded in CrazyGoldFish’s indexed textbook content for the board, grade, and subject. If none exists, the step fails with No content found. Use documents for your own material.Next step
Get worksheet metadata
status is Completed, or wait for the worksheet_initialize_metadata webhook.Authorizations
Access token from Get an access token.
Body
Board ID from List boards.
"baf36573-d049-4636-9c4b-bc9cda6270fe"
Grade ID from List grades.
"28820b1a-34e1-4003-b5bd-96455ca2c6d8"
Subject ID from List subjects.
"6dd7ebda-1bc5-4c01-8649-372579189073"
JSON object mapping question type to count. The counts must add up to number_of_questions. Question types: mcq_single_answer, mcq_multiple_answer, true_false, fill_in_the_blanks, very_short_answer, short_answer, long_answer, match_the_column.
"{\"mcq_single_answer\": 3, \"short_answer\": 2}"
Optional JSON object with your own reference fields, such as a teacher ID. Returned by List worksheets and usable as a listing filter.
"{\"teacher_id\": \"T-1042\"}"