Get worksheet explanations
Get every question in a worksheet with its explanation, key concepts, common mistakes, and real-world application.
GET
/
worksheet
/
v1
/
generate-explanations
/
{work_sheet_id}
Get worksheet explanations
curl --request GET \
--url https://api.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.crazygoldfish.com/worksheet/v1/generate-explanations/{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-explanations/{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"
},
"explanations": [
{
"learning_objective": "Recall the properties of magnetic field lines",
"explanation": "Field lines are drawn closer together where the magnetic field is stronger, so option C is correct. Field lines never cross (A), run from north to south outside the magnet (B), and curve around a bar magnet (D).",
"key_concepts": [
"Magnetic field lines",
"Field strength"
],
"common_mistakes": "Assuming field lines run from the south pole to the north pole outside the magnet.",
"real_world_application": "Iron filings on paper show the field pattern around magnets used in motors and speakers."
}
]
}
],
"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"
},
"explanations": [
{
"learning_objective": "Explain why magnetic field lines never cross",
"explanation": "A field line shows the direction a compass needle points. At a crossing point the needle would have two directions, so lines cannot cross.",
"key_concepts": [
"Direction of magnetic field"
],
"common_mistakes": "Describing what happens at a crossing instead of why a crossing is impossible.",
"real_world_application": ""
}
]
}
]
}
}
}Step 4 of 4 (optional) in Generate a worksheet.
Unlike the other worksheet GET endpoints, this one returns HTTP 400 while explanations are still running. Check
detail[0].status: keep polling while it’s In Progress, and stop if it’s Failed.explanations array. It usually contains one object with learning_objective, explanation, key_concepts, common_mistakes, and real_world_application.
Rarely, the explanation step finishes with nothing stored. Generate the explanations again, and read the questions from Get generated worksheet in the meantime.
Authorizations
Access token from Get an access token.
Path Parameters
The worksheet id returned by Start a worksheet.
Example:
"152764ca-1685-427c-aba7-4b92dcc0d60f"
Response
Explanations are Completed.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Get worksheet explanations
curl --request GET \
--url https://api.crazygoldfish.com/worksheet/v1/generate-explanations/{work_sheet_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.crazygoldfish.com/worksheet/v1/generate-explanations/{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-explanations/{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"
},
"explanations": [
{
"learning_objective": "Recall the properties of magnetic field lines",
"explanation": "Field lines are drawn closer together where the magnetic field is stronger, so option C is correct. Field lines never cross (A), run from north to south outside the magnet (B), and curve around a bar magnet (D).",
"key_concepts": [
"Magnetic field lines",
"Field strength"
],
"common_mistakes": "Assuming field lines run from the south pole to the north pole outside the magnet.",
"real_world_application": "Iron filings on paper show the field pattern around magnets used in motors and speakers."
}
]
}
],
"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"
},
"explanations": [
{
"learning_objective": "Explain why magnetic field lines never cross",
"explanation": "A field line shows the direction a compass needle points. At a crossing point the needle would have two directions, so lines cannot cross.",
"key_concepts": [
"Direction of magnetic field"
],
"common_mistakes": "Describing what happens at a crossing instead of why a crossing is impossible.",
"real_world_application": ""
}
]
}
]
}
}
}