Configure worksheet questions
Send the reviewed subject matter and learning standards for a worksheet, and start generating its question plan.
POST
/
worksheet
/
v1
/
question-config
/
{work_sheet_id}
Configure worksheet questions
curl --request POST \
--url https://api.crazygoldfish.com/worksheet/v1/question-config/{work_sheet_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subject_matter": {
"topics_to_be_covered": {
"topic": {
"ai_recommendations": [
"Magnetic field and field lines around a bar magnet",
"Magnetic field due to a current through a straight conductor",
"Right-hand thumb rule"
],
"additional_recommendations": [
"Activity: make an electromagnet with a solenoid and a steel rod"
]
}
},
"key_concepts_and_subconcepts": {
"concepts": {
"ai_recommendations": [
"Properties of magnetic field lines",
"Force on a current-carrying conductor"
],
"additional_recommendations": []
}
},
"prerequisite_knowledge": {
"prerequisite": {
"ai_recommendations": [
"Poles of a magnet and how like and unlike poles interact"
],
"additional_recommendations": []
}
}
},
"learning_standards": {
"learning_outcomes": {
"outcomes": {
"ai_recommendations": [
"Explains the pattern of magnetic field lines around a bar magnet"
],
"additional_recommendations": []
}
},
"smart_learning_objectives": {
"objects": {
"ai_recommendations": [
"By the end of the worksheet, students draw field lines around a bar magnet and state three of their properties"
],
"additional_recommendations": []
}
},
"competencies": {
"competency_list": [
{
"name": "C-10.3",
"description": "Explains phenomena using the concepts of electricity and magnetism"
}
]
}
}
}
'import requests
url = "https://api.crazygoldfish.com/worksheet/v1/question-config/{work_sheet_id}"
payload = {
"subject_matter": {
"topics_to_be_covered": { "topic": {
"ai_recommendations": ["Magnetic field and field lines around a bar magnet", "Magnetic field due to a current through a straight conductor", "Right-hand thumb rule"],
"additional_recommendations": ["Activity: make an electromagnet with a solenoid and a steel rod"]
} },
"key_concepts_and_subconcepts": { "concepts": {
"ai_recommendations": ["Properties of magnetic field lines", "Force on a current-carrying conductor"],
"additional_recommendations": []
} },
"prerequisite_knowledge": { "prerequisite": {
"ai_recommendations": ["Poles of a magnet and how like and unlike poles interact"],
"additional_recommendations": []
} }
},
"learning_standards": {
"learning_outcomes": { "outcomes": {
"ai_recommendations": ["Explains the pattern of magnetic field lines around a bar magnet"],
"additional_recommendations": []
} },
"smart_learning_objectives": { "objects": {
"ai_recommendations": ["By the end of the worksheet, students draw field lines around a bar magnet and state three of their properties"],
"additional_recommendations": []
} },
"competencies": { "competency_list": [
{
"name": "C-10.3",
"description": "Explains phenomena using the concepts of electricity and magnetism"
}
] }
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subject_matter: {
topics_to_be_covered: {
topic: {
ai_recommendations: [
'Magnetic field and field lines around a bar magnet',
'Magnetic field due to a current through a straight conductor',
'Right-hand thumb rule'
],
additional_recommendations: ['Activity: make an electromagnet with a solenoid and a steel rod']
}
},
key_concepts_and_subconcepts: {
concepts: {
ai_recommendations: ['Properties of magnetic field lines', 'Force on a current-carrying conductor'],
additional_recommendations: []
}
},
prerequisite_knowledge: {
prerequisite: {
ai_recommendations: ['Poles of a magnet and how like and unlike poles interact'],
additional_recommendations: []
}
}
},
learning_standards: {
learning_outcomes: {
outcomes: {
ai_recommendations: ['Explains the pattern of magnetic field lines around a bar magnet'],
additional_recommendations: []
}
},
smart_learning_objectives: {
objects: {
ai_recommendations: [
'By the end of the worksheet, students draw field lines around a bar magnet and state three of their properties'
],
additional_recommendations: []
}
},
competencies: {
competency_list: [
{
name: 'C-10.3',
description: 'Explains phenomena using the concepts of electricity and magnetism'
}
]
}
}
})
};
fetch('https://api.crazygoldfish.com/worksheet/v1/question-config/{work_sheet_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"detail": [
{
"id": "152764ca-1685-427c-aba7-4b92dcc0d60f",
"msg": "Worksheet question configuration initiated successfully."
}
]
}Step 2 of 4 in Generate a worksheet. This call starts an async job.
Rules
- Call this only after Get worksheet metadata returns
status: "Completed". The API doesn’t reliably reject an early call: while the metadata step is still running, this call is accepted and the job is queued against unfinished metadata. Waiting is your responsibility. - Send
subject_matterandlearning_standardsin the same shape you received them. To steer the worksheet, add items toadditional_recommendationsor remove items you don’t want. - This step runs once per worksheet. A second call returns
400unless the first one failed.
Next step
Get worksheet question configuration
Poll until
status is Completed, or wait for the worksheet_question_configuration webhook.Authorizations
Access token from Get an access token.
Path Parameters
The worksheet id returned by Start a worksheet.
Example:
"152764ca-1685-427c-aba7-4b92dcc0d60f"
Body
application/json
Response
The job was queued. Poll the matching GET endpoint or wait for the webhook.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Configure worksheet questions
curl --request POST \
--url https://api.crazygoldfish.com/worksheet/v1/question-config/{work_sheet_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subject_matter": {
"topics_to_be_covered": {
"topic": {
"ai_recommendations": [
"Magnetic field and field lines around a bar magnet",
"Magnetic field due to a current through a straight conductor",
"Right-hand thumb rule"
],
"additional_recommendations": [
"Activity: make an electromagnet with a solenoid and a steel rod"
]
}
},
"key_concepts_and_subconcepts": {
"concepts": {
"ai_recommendations": [
"Properties of magnetic field lines",
"Force on a current-carrying conductor"
],
"additional_recommendations": []
}
},
"prerequisite_knowledge": {
"prerequisite": {
"ai_recommendations": [
"Poles of a magnet and how like and unlike poles interact"
],
"additional_recommendations": []
}
}
},
"learning_standards": {
"learning_outcomes": {
"outcomes": {
"ai_recommendations": [
"Explains the pattern of magnetic field lines around a bar magnet"
],
"additional_recommendations": []
}
},
"smart_learning_objectives": {
"objects": {
"ai_recommendations": [
"By the end of the worksheet, students draw field lines around a bar magnet and state three of their properties"
],
"additional_recommendations": []
}
},
"competencies": {
"competency_list": [
{
"name": "C-10.3",
"description": "Explains phenomena using the concepts of electricity and magnetism"
}
]
}
}
}
'import requests
url = "https://api.crazygoldfish.com/worksheet/v1/question-config/{work_sheet_id}"
payload = {
"subject_matter": {
"topics_to_be_covered": { "topic": {
"ai_recommendations": ["Magnetic field and field lines around a bar magnet", "Magnetic field due to a current through a straight conductor", "Right-hand thumb rule"],
"additional_recommendations": ["Activity: make an electromagnet with a solenoid and a steel rod"]
} },
"key_concepts_and_subconcepts": { "concepts": {
"ai_recommendations": ["Properties of magnetic field lines", "Force on a current-carrying conductor"],
"additional_recommendations": []
} },
"prerequisite_knowledge": { "prerequisite": {
"ai_recommendations": ["Poles of a magnet and how like and unlike poles interact"],
"additional_recommendations": []
} }
},
"learning_standards": {
"learning_outcomes": { "outcomes": {
"ai_recommendations": ["Explains the pattern of magnetic field lines around a bar magnet"],
"additional_recommendations": []
} },
"smart_learning_objectives": { "objects": {
"ai_recommendations": ["By the end of the worksheet, students draw field lines around a bar magnet and state three of their properties"],
"additional_recommendations": []
} },
"competencies": { "competency_list": [
{
"name": "C-10.3",
"description": "Explains phenomena using the concepts of electricity and magnetism"
}
] }
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subject_matter: {
topics_to_be_covered: {
topic: {
ai_recommendations: [
'Magnetic field and field lines around a bar magnet',
'Magnetic field due to a current through a straight conductor',
'Right-hand thumb rule'
],
additional_recommendations: ['Activity: make an electromagnet with a solenoid and a steel rod']
}
},
key_concepts_and_subconcepts: {
concepts: {
ai_recommendations: ['Properties of magnetic field lines', 'Force on a current-carrying conductor'],
additional_recommendations: []
}
},
prerequisite_knowledge: {
prerequisite: {
ai_recommendations: ['Poles of a magnet and how like and unlike poles interact'],
additional_recommendations: []
}
}
},
learning_standards: {
learning_outcomes: {
outcomes: {
ai_recommendations: ['Explains the pattern of magnetic field lines around a bar magnet'],
additional_recommendations: []
}
},
smart_learning_objectives: {
objects: {
ai_recommendations: [
'By the end of the worksheet, students draw field lines around a bar magnet and state three of their properties'
],
additional_recommendations: []
}
},
competencies: {
competency_list: [
{
name: 'C-10.3',
description: 'Explains phenomena using the concepts of electricity and magnetism'
}
]
}
}
})
};
fetch('https://api.crazygoldfish.com/worksheet/v1/question-config/{work_sheet_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"detail": [
{
"id": "152764ca-1685-427c-aba7-4b92dcc0d60f",
"msg": "Worksheet question configuration initiated successfully."
}
]
}