Get lesson plan metadata
Get the topics, concepts, prerequisites, outcomes, and objectives generated for a lesson plan, and check whether generation is complete.
GET
/
lesson-plan
/
v1
/
metadata
/
{lesson_plan_id}
Get lesson plan metadata
curl --request GET \
--url https://api.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_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/lesson-plan/v1/metadata/{lesson_plan_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "7d2f1b90-4c6a-4f3e-b1d7-9a5e2c8f0b34",
"board": {
"id": "baf36573-d049-4636-9c4b-bc9cda6270fe",
"name": "CBSE"
},
"grade": {
"id": "28820b1a-34e1-4003-b5bd-96455ca2c6d8",
"name": "Grade 10"
},
"section": "A",
"subject": {
"id": "6dd7ebda-1bc5-4c01-8649-372579189073",
"name": "Science"
},
"status": "Completed",
"duration_minutes": 45,
"topic": "Magnetic Effects of Electric Current",
"documents": [],
"audio": null,
"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 in a magnetic field"
],
"additional_recommendations": []
}
},
"prerequisite_knowledge": {
"prerequisite": {
"ai_recommendations": [
"Poles of a magnet and how like and unlike poles interact",
"Electric current and a simple circuit"
],
"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 lesson, students draw the field lines around a bar magnet and state three of their properties"
],
"additional_recommendations": []
}
},
"competencies": {
"competency_list": [
{
"name": "Scientific inquiry",
"description": "Observes a magnetic field pattern and describes it in her own words"
}
]
}
}
}
}Step 1 of 4 in Build a lesson plan. Poll every 5 seconds until
status is Completed.Reading the response
| Response | Meaning | What to do |
|---|---|---|
200 with status: "In Progress" | Still generating | Poll again |
200 with status: "Completed" | Ready | Show subject_matter and learning_standards to the teacher |
404 Lesson plan metadata step not found. | No worker has picked the job up yet | Poll again. This is normal for a few seconds, and for longer if you sent audio. |
404 Lesson plan not found. | The ID doesn’t exist | Check the id you saved from step 1 |
400 with status: "Failed" | Generation failed | Read msg and start a new lesson plan |
subject_matter and learning_standards are the two objects you send back in step 2. Each part holds an ai_recommendations list and an additional_recommendations list under a fixed key, such as topics_to_be_covered.topic.
Instead of polling, register a webhook for
lesson_plan_initialize_metadata. See Async jobs and webhooks.Next step
Finalize lesson plan metadata
Send
subject_matter and learning_standards back, with any edits.Authorizations
Access token from Get an access token.
Path Parameters
The lesson plan id returned by Start a lesson plan.
Example:
"7d2f1b90-4c6a-4f3e-b1d7-9a5e2c8f0b34"
Response
The step is In Progress or Completed. Fields fill in as generation progresses.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Get lesson plan metadata
curl --request GET \
--url https://api.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_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/lesson-plan/v1/metadata/{lesson_plan_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "7d2f1b90-4c6a-4f3e-b1d7-9a5e2c8f0b34",
"board": {
"id": "baf36573-d049-4636-9c4b-bc9cda6270fe",
"name": "CBSE"
},
"grade": {
"id": "28820b1a-34e1-4003-b5bd-96455ca2c6d8",
"name": "Grade 10"
},
"section": "A",
"subject": {
"id": "6dd7ebda-1bc5-4c01-8649-372579189073",
"name": "Science"
},
"status": "Completed",
"duration_minutes": 45,
"topic": "Magnetic Effects of Electric Current",
"documents": [],
"audio": null,
"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 in a magnetic field"
],
"additional_recommendations": []
}
},
"prerequisite_knowledge": {
"prerequisite": {
"ai_recommendations": [
"Poles of a magnet and how like and unlike poles interact",
"Electric current and a simple circuit"
],
"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 lesson, students draw the field lines around a bar magnet and state three of their properties"
],
"additional_recommendations": []
}
},
"competencies": {
"competency_list": [
{
"name": "Scientific inquiry",
"description": "Observes a magnetic field pattern and describes it in her own words"
}
]
}
}
}
}