Get lesson plan alignment
Get the materials, teaching strategies, and six-stage timeline generated for a lesson plan, with minutes for each stage.
GET
/
lesson-plan
/
v1
/
finalize-metadata
/
{lesson_plan_id}
Get lesson plan alignment
curl --request GET \
--url https://api.crazygoldfish.com/lesson-plan/v1/finalize-metadata/{lesson_plan_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.crazygoldfish.com/lesson-plan/v1/finalize-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/finalize-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"
}
]
}
},
"alignment": {
"materials_options": [
{
"ai_recommendations": [
{
"name": "Bar magnets",
"description": "Two bar magnets per group of four students"
},
{
"name": "Iron filings and a sheet of paper",
"description": "To make the field pattern visible"
}
],
"additional_recommendations": [
{
"name": "Plotting compass",
"description": "To trace the direction of the field line by line"
}
]
}
],
"instructional_strategies_options": [
{
"ai_recommendations": [
{
"name": "Hands-on inquiry",
"description": "Students build the field pattern before it is named"
},
{
"name": "Think-pair-share",
"description": "Students compare their field sketches in pairs"
}
],
"additional_recommendations": []
}
],
"instructional_blocks": {
"introduction": {
"component_options": [
{
"name": "Magnet hook",
"description": "Ask why a compass needle moves near a wire"
}
],
"formative_questions": [
"What do you already know about magnets?"
],
"duration": 5
},
"development": {
"component_options": [
{
"name": "Iron filings demonstration",
"description": "Build the field pattern of a bar magnet"
},
{
"name": "Right-hand thumb rule",
"description": "Derive the field direction around a straight wire"
}
],
"formative_questions": [
"Where are the field lines closest together?"
],
"duration": 15
},
"guided_practice": {
"component_options": [
{
"name": "Guided sketching",
"description": "Draw field lines for two magnet arrangements together"
}
],
"formative_questions": [
"Why can two field lines never cross?"
],
"duration": 10
},
"independent_practice": {
"component_options": [
{
"name": "Worksheet task",
"description": "Students predict the field of a solenoid on their own"
}
],
"formative_questions": [
"Which end of the solenoid behaves like a north pole?"
],
"duration": 5
},
"closure": {
"component_options": [
{
"name": "Exit ticket",
"description": "Each student states one property of field lines"
}
],
"formative_questions": [
"What is one thing you would explain to a friend?"
],
"duration": 5
},
"summative_assessment": {
"component_options": [
{
"name": "Short quiz",
"description": "Three questions on field direction and strength"
}
],
"formative_questions": [
"Can you justify your answer with a rule?"
],
"duration": 5
}
}
}
}
}Step 2 of 4 in Build a lesson plan. Poll every 5 seconds until
status is Completed.Reading the response
alignment has three parts:
| Field | What it holds |
|---|---|
materials_options | A list holding one option group of materials. Read materials_options[0]. |
instructional_strategies_options | A list holding one option group of teaching strategies. |
instructional_blocks | The six stages of the lesson, each with component_options, formative_questions, and duration in minutes. |
introduction, development, guided_practice, independent_practice, closure, and summative_assessment. The API adjusts the AI’s duration values after generation so they add up to the lesson’s duration_minutes, and while it does that it aims to keep every stage at 5 minutes or more.
The 5 minute floor is what the API aims for, not a rule it enforces. On a short lesson there may not be enough time to give every stage 5 minutes, and the stages are returned as they are. Read the
duration values rather than assuming a minimum.404 saying Finalize metadata step not found for this lesson plan. right after the previous call means no worker has picked the job up yet. Keep polling. A failed step returns 400 with status: "Failed".
While the job runs,
alignment is {}. Check status before reading it.Next step
Build lesson plan content
Send
alignment back, with the teacher’s choices and stage durations.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. alignment is {} until the timeline exists.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Get lesson plan alignment
curl --request GET \
--url https://api.crazygoldfish.com/lesson-plan/v1/finalize-metadata/{lesson_plan_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.crazygoldfish.com/lesson-plan/v1/finalize-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/finalize-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"
}
]
}
},
"alignment": {
"materials_options": [
{
"ai_recommendations": [
{
"name": "Bar magnets",
"description": "Two bar magnets per group of four students"
},
{
"name": "Iron filings and a sheet of paper",
"description": "To make the field pattern visible"
}
],
"additional_recommendations": [
{
"name": "Plotting compass",
"description": "To trace the direction of the field line by line"
}
]
}
],
"instructional_strategies_options": [
{
"ai_recommendations": [
{
"name": "Hands-on inquiry",
"description": "Students build the field pattern before it is named"
},
{
"name": "Think-pair-share",
"description": "Students compare their field sketches in pairs"
}
],
"additional_recommendations": []
}
],
"instructional_blocks": {
"introduction": {
"component_options": [
{
"name": "Magnet hook",
"description": "Ask why a compass needle moves near a wire"
}
],
"formative_questions": [
"What do you already know about magnets?"
],
"duration": 5
},
"development": {
"component_options": [
{
"name": "Iron filings demonstration",
"description": "Build the field pattern of a bar magnet"
},
{
"name": "Right-hand thumb rule",
"description": "Derive the field direction around a straight wire"
}
],
"formative_questions": [
"Where are the field lines closest together?"
],
"duration": 15
},
"guided_practice": {
"component_options": [
{
"name": "Guided sketching",
"description": "Draw field lines for two magnet arrangements together"
}
],
"formative_questions": [
"Why can two field lines never cross?"
],
"duration": 10
},
"independent_practice": {
"component_options": [
{
"name": "Worksheet task",
"description": "Students predict the field of a solenoid on their own"
}
],
"formative_questions": [
"Which end of the solenoid behaves like a north pole?"
],
"duration": 5
},
"closure": {
"component_options": [
{
"name": "Exit ticket",
"description": "Each student states one property of field lines"
}
],
"formative_questions": [
"What is one thing you would explain to a friend?"
],
"duration": 5
},
"summative_assessment": {
"component_options": [
{
"name": "Short quiz",
"description": "Three questions on field direction and strength"
}
],
"formative_questions": [
"Can you justify your answer with a rule?"
],
"duration": 5
}
}
}
}
}