Get generated worksheet questions

GET

worksheet

generate-worksheet

{work_sheet_id}

curl --request GET \
  --url https://api.crazygoldfish.com/worksheet/v1/generate-worksheet/{work_sheet_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.crazygoldfish.com/worksheet/v1/generate-worksheet/{work_sheet_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.crazygoldfish.com/worksheet/v1/generate-worksheet/{work_sheet_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "152764ca-1685-427c-aba7-4b92dcc0d60f",
    "board": {
      "id": "baf36573-d049-4636-9c4b-bc9cda6270fe",
      "name": "CBSE"
    },
    "grade": {
      "id": "28820b1a-34e1-4003-b5bd-96455ca2c6d8",
      "name": "Grade 10"
    },
    "section": null,
    "subject": {
      "id": "6dd7ebda-1bc5-4c01-8649-372579189073",
      "name": "Science"
    },
    "status": "Completed",
    "number_of_questions": 5,
    "topic": "Magnetic Effects of Electric Current",
    "documents": [],
    "audio": null,
    "questions": {
      "mcq_single_answer": [
        {
          "question": "Which statement about magnetic field lines is correct?",
          "options": [
            "A. They cross each other near the poles",
            "B. They start at the south pole and end at the north pole outside the magnet",
            "C. They are closer together where the field is stronger",
            "D. They are straight lines around a bar magnet"
          ],
          "answer": "C",
          "tags": {
            "learning_objectives": "Recall the properties of magnetic field lines",
            "bloom": "Remember",
            "difficulty": "Easy"
          }
        }
      ],
      "short_answer": [
        {
          "question": "Why do two magnetic field lines never intersect?",
          "answer": "If they crossed, a compass needle at that point would point in two directions at once, which is impossible.",
          "tags": {
            "learning_objectives": "Explain why magnetic field lines never cross",
            "bloom": "Understand",
            "difficulty": "Medium"
          }
        }
      ]
    }
  }
}

Step 3 of 4 in Generate a worksheet. Poll every 5 seconds until status is Completed.

questions is an object keyed by question type, such as mcq_single_answer or short_answer. Each question has question, answer, and tags. Only the two MCQ types include options. While the job is running, status is In Progress and questions is {"msg": "No questions generated."}. Check status before reading questions.

Next step

Generate worksheet explanations

Optional: add a step-by-step explanation to every question.

Send worksheet feedback

Optional: record what the teacher thought of the worksheet.

Authorizations

Authorization

string

header

required

Access token from Get an access token.

Path Parameters

work_sheet_id

string<uuid>

required

The worksheet id returned by Start a worksheet.

Example:

"152764ca-1685-427c-aba7-4b92dcc0d60f"

Response

The step is In Progress or Completed.

data

object

Show child attributes

Get generated worksheet questions

curl --request GET \
  --url https://api.crazygoldfish.com/worksheet/v1/generate-worksheet/{work_sheet_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.crazygoldfish.com/worksheet/v1/generate-worksheet/{work_sheet_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.crazygoldfish.com/worksheet/v1/generate-worksheet/{work_sheet_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "152764ca-1685-427c-aba7-4b92dcc0d60f",
    "board": {
      "id": "baf36573-d049-4636-9c4b-bc9cda6270fe",
      "name": "CBSE"
    },
    "grade": {
      "id": "28820b1a-34e1-4003-b5bd-96455ca2c6d8",
      "name": "Grade 10"
    },
    "section": null,
    "subject": {
      "id": "6dd7ebda-1bc5-4c01-8649-372579189073",
      "name": "Science"
    },
    "status": "Completed",
    "number_of_questions": 5,
    "topic": "Magnetic Effects of Electric Current",
    "documents": [],
    "audio": null,
    "questions": {
      "mcq_single_answer": [
        {
          "question": "Which statement about magnetic field lines is correct?",
          "options": [
            "A. They cross each other near the poles",
            "B. They start at the south pole and end at the north pole outside the magnet",
            "C. They are closer together where the field is stronger",
            "D. They are straight lines around a bar magnet"
          ],
          "answer": "C",
          "tags": {
            "learning_objectives": "Recall the properties of magnetic field lines",
            "bloom": "Remember",
            "difficulty": "Easy"
          }
        }
      ],
      "short_answer": [
        {
          "question": "Why do two magnetic field lines never intersect?",
          "answer": "If they crossed, a compass needle at that point would point in two directions at once, which is impossible.",
          "tags": {
            "learning_objectives": "Explain why magnetic field lines never cross",
            "bloom": "Understand",
            "difficulty": "Medium"
          }
        }
      ]
    }
  }
}

Get started

Guides

Exam Evaluation

Assignment Evaluation

Rubrics

Action Plans

Lesson Plan Builder

Worksheet Builder

ClassTrack

Metadata

Webhooks

Get generated worksheet questions

Next step

Generate worksheet explanations

Send worksheet feedback

Authorizations

Path Parameters

Response

​Next step

Generate worksheet explanations

Send worksheet feedback

Authorizations

Path Parameters

Response

Next step