POST - Lesson Plan Instructional Framework Builder
This API allows authenticated users to trigger the content generation process for a lesson plan.
How to Use:
- Call
POST /lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}with the finalized finalize meta data. - The API validates the lesson plan ID, checks that the finalize meta data step is completed, and ensures content generation is not already in progress or completed.
- On success, the system updates the finalize meta data, triggers the content generation process asynchronously, and returns a success message.
Example Scenario:
A teacher wants to generate content for a lesson plan:
- They submit the finalized meta data using this API.
- The system validates the lesson plan and finalize meta step status.
- If valid, the system updates the finalize meta and starts the content generation process.
- The teacher receives a message confirming the content generation process has been initiated.
POST
/
lesson-plan
/
v1
/
instructional-framework-builder
/
{lesson_plan_id}
Trigger content generation for a lesson plan.
curl --request POST \
--url https://api-staging.crazygoldfish.com/lesson-plan/v1/instructional-framework-builder/{lesson_plan_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"alignment": {
"materials_options": [
{
"ai_recommendations": [
{
"name": "Community Role Cards",
"description": "Visual cards depicting various community roles help clarify roles and responsibilities."
},
{
"name": "Environmental Care Kits",
"description": "Hands-on kits with composting and waste management tools facilitate practical learning."
},
{
"name": "Festival Storybooks",
"description": "Books illustrating community celebrations support understanding of shared traditions."
}
],
"additional_recommendations": [
{
"name": "Storytelling Props",
"description": "Props for role-play enhance engagement in community role activities."
},
{
"name": "Local Institution Photos",
"description": "Images of schools, hospitals, and markets provide real-life context for community institutions."
}
]
}
],
"instructional_strategies_options": [
{
"ai_recommendations": [
{
"name": "Role-Play Activities",
"description": "Engages students actively to understand community roles and teamwork."
},
{
"name": "Group Discussions",
"description": "Facilitates strategic questioning and sharing of perspectives."
},
{
"name": "Hands-on Environmental Projects",
"description": "Applies learning through practical composting or clean-up tasks."
}
],
"additional_recommendations": [
{
"name": "Storytelling Sessions",
"description": "Promotes empathy and social understanding through narrative."
},
{
"name": "Interactive Q&A",
"description": "Encourages student participation and formative assessment through questioning."
}
]
}
],
"instructional_blocks": {
"introduction": {
"component_options": [
{
"name": "Storytelling on Community Roles",
"description": "Introduces community members and roles using relatable stories."
},
{
"name": "Visual Presentation of Community",
"description": "Shows images and videos illustrating community settings."
}
],
"formative_questions": [
"What community roles do you see in your family?",
"Can you name someone who helps in your school?"
],
"duration": 10
},
"development": {
"component_options": [
{
"name": "Role-Play of Community Helpers",
"description": "Students act out roles to understand responsibilities."
},
{
"name": "Discussion on Cooperation",
"description": "Guided talk about working together during festivals and community events."
}
],
"formative_questions": [
"How do people help each other during festivals?",
"Why is teamwork important in our community?"
],
"duration": 15
},
"guided_practice": {
"component_options": [
{
"name": "Group Composting Activity",
"description": "Students participate in composting to learn environmental care."
},
{
"name": "Waste Sorting Exercise",
"description": "Hands-on sorting of recyclable and non-recyclable materials."
}
],
"formative_questions": [
"What materials can we compost?",
"How does composting help the soil?"
],
"duration": 15
},
"independent_practice": {
"component_options": [
{
"name": "Community Institution Mapping",
"description": "Students create maps highlighting local institutions and their functions."
},
{
"name": "Celebration Sharing Session",
"description": "Students share stories about festivals and traditions."
}
],
"formative_questions": [
"Which community institutions do you visit often?",
"How do festivals make you feel part of the community?"
],
"duration": 10
},
"closure": {
"component_options": [
{
"name": "Group Reflection",
"description": "Students discuss what they learned about community roles and care."
},
{
"name": "Question and Answer Review",
"description": "Teacher-led Q&A to summarize key concepts."
}
],
"formative_questions": [
"What is one important role in your community?",
"How can you help keep your neighborhood clean?"
],
"duration": 5
},
"summative_assessment": {
"component_options": [
{
"name": "Matching Roles to Responsibilities",
"description": "Students match community members to their roles."
},
{
"name": "Explain Importance of Cooperation",
"description": "Oral or written explanation of teamwork in community events."
},
{
"name": "Demonstrate Composting Benefits",
"description": "Students describe or show composting process and its impact."
},
{
"name": "List Community Institutions and Functions",
"description": "Students list institutions and explain their roles."
},
{
"name": "Discuss Shared Traditions",
"description": "Students talk about how celebrations foster belonging."
}
],
"formative_questions": [],
"duration": 5
}
}
}
}
'import requests
url = "https://api-staging.crazygoldfish.com/lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}"
payload = { "alignment": {
"materials_options": [
{
"ai_recommendations": [
{
"name": "Community Role Cards",
"description": "Visual cards depicting various community roles help clarify roles and responsibilities."
},
{
"name": "Environmental Care Kits",
"description": "Hands-on kits with composting and waste management tools facilitate practical learning."
},
{
"name": "Festival Storybooks",
"description": "Books illustrating community celebrations support understanding of shared traditions."
}
],
"additional_recommendations": [
{
"name": "Storytelling Props",
"description": "Props for role-play enhance engagement in community role activities."
},
{
"name": "Local Institution Photos",
"description": "Images of schools, hospitals, and markets provide real-life context for community institutions."
}
]
}
],
"instructional_strategies_options": [
{
"ai_recommendations": [
{
"name": "Role-Play Activities",
"description": "Engages students actively to understand community roles and teamwork."
},
{
"name": "Group Discussions",
"description": "Facilitates strategic questioning and sharing of perspectives."
},
{
"name": "Hands-on Environmental Projects",
"description": "Applies learning through practical composting or clean-up tasks."
}
],
"additional_recommendations": [
{
"name": "Storytelling Sessions",
"description": "Promotes empathy and social understanding through narrative."
},
{
"name": "Interactive Q&A",
"description": "Encourages student participation and formative assessment through questioning."
}
]
}
],
"instructional_blocks": {
"introduction": {
"component_options": [
{
"name": "Storytelling on Community Roles",
"description": "Introduces community members and roles using relatable stories."
},
{
"name": "Visual Presentation of Community",
"description": "Shows images and videos illustrating community settings."
}
],
"formative_questions": ["What community roles do you see in your family?", "Can you name someone who helps in your school?"],
"duration": 10
},
"development": {
"component_options": [
{
"name": "Role-Play of Community Helpers",
"description": "Students act out roles to understand responsibilities."
},
{
"name": "Discussion on Cooperation",
"description": "Guided talk about working together during festivals and community events."
}
],
"formative_questions": ["How do people help each other during festivals?", "Why is teamwork important in our community?"],
"duration": 15
},
"guided_practice": {
"component_options": [
{
"name": "Group Composting Activity",
"description": "Students participate in composting to learn environmental care."
},
{
"name": "Waste Sorting Exercise",
"description": "Hands-on sorting of recyclable and non-recyclable materials."
}
],
"formative_questions": ["What materials can we compost?", "How does composting help the soil?"],
"duration": 15
},
"independent_practice": {
"component_options": [
{
"name": "Community Institution Mapping",
"description": "Students create maps highlighting local institutions and their functions."
},
{
"name": "Celebration Sharing Session",
"description": "Students share stories about festivals and traditions."
}
],
"formative_questions": ["Which community institutions do you visit often?", "How do festivals make you feel part of the community?"],
"duration": 10
},
"closure": {
"component_options": [
{
"name": "Group Reflection",
"description": "Students discuss what they learned about community roles and care."
},
{
"name": "Question and Answer Review",
"description": "Teacher-led Q&A to summarize key concepts."
}
],
"formative_questions": ["What is one important role in your community?", "How can you help keep your neighborhood clean?"],
"duration": 5
},
"summative_assessment": {
"component_options": [
{
"name": "Matching Roles to Responsibilities",
"description": "Students match community members to their roles."
},
{
"name": "Explain Importance of Cooperation",
"description": "Oral or written explanation of teamwork in community events."
},
{
"name": "Demonstrate Composting Benefits",
"description": "Students describe or show composting process and its impact."
},
{
"name": "List Community Institutions and Functions",
"description": "Students list institutions and explain their roles."
},
{
"name": "Discuss Shared Traditions",
"description": "Students talk about how celebrations foster belonging."
}
],
"formative_questions": [],
"duration": 5
}
}
} }
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({
alignment: {
materials_options: [
{
ai_recommendations: [
{
name: 'Community Role Cards',
description: 'Visual cards depicting various community roles help clarify roles and responsibilities.'
},
{
name: 'Environmental Care Kits',
description: 'Hands-on kits with composting and waste management tools facilitate practical learning.'
},
{
name: 'Festival Storybooks',
description: 'Books illustrating community celebrations support understanding of shared traditions.'
}
],
additional_recommendations: [
{
name: 'Storytelling Props',
description: 'Props for role-play enhance engagement in community role activities.'
},
{
name: 'Local Institution Photos',
description: 'Images of schools, hospitals, and markets provide real-life context for community institutions.'
}
]
}
],
instructional_strategies_options: [
{
ai_recommendations: [
{
name: 'Role-Play Activities',
description: 'Engages students actively to understand community roles and teamwork.'
},
{
name: 'Group Discussions',
description: 'Facilitates strategic questioning and sharing of perspectives.'
},
{
name: 'Hands-on Environmental Projects',
description: 'Applies learning through practical composting or clean-up tasks.'
}
],
additional_recommendations: [
{
name: 'Storytelling Sessions',
description: 'Promotes empathy and social understanding through narrative.'
},
{
name: 'Interactive Q&A',
description: 'Encourages student participation and formative assessment through questioning.'
}
]
}
],
instructional_blocks: {
introduction: {
component_options: [
{
name: 'Storytelling on Community Roles',
description: 'Introduces community members and roles using relatable stories.'
},
{
name: 'Visual Presentation of Community',
description: 'Shows images and videos illustrating community settings.'
}
],
formative_questions: [
'What community roles do you see in your family?',
'Can you name someone who helps in your school?'
],
duration: 10
},
development: {
component_options: [
{
name: 'Role-Play of Community Helpers',
description: 'Students act out roles to understand responsibilities.'
},
{
name: 'Discussion on Cooperation',
description: 'Guided talk about working together during festivals and community events.'
}
],
formative_questions: [
'How do people help each other during festivals?',
'Why is teamwork important in our community?'
],
duration: 15
},
guided_practice: {
component_options: [
{
name: 'Group Composting Activity',
description: 'Students participate in composting to learn environmental care.'
},
{
name: 'Waste Sorting Exercise',
description: 'Hands-on sorting of recyclable and non-recyclable materials.'
}
],
formative_questions: ['What materials can we compost?', 'How does composting help the soil?'],
duration: 15
},
independent_practice: {
component_options: [
{
name: 'Community Institution Mapping',
description: 'Students create maps highlighting local institutions and their functions.'
},
{
name: 'Celebration Sharing Session',
description: 'Students share stories about festivals and traditions.'
}
],
formative_questions: [
'Which community institutions do you visit often?',
'How do festivals make you feel part of the community?'
],
duration: 10
},
closure: {
component_options: [
{
name: 'Group Reflection',
description: 'Students discuss what they learned about community roles and care.'
},
{
name: 'Question and Answer Review',
description: 'Teacher-led Q&A to summarize key concepts.'
}
],
formative_questions: [
'What is one important role in your community?',
'How can you help keep your neighborhood clean?'
],
duration: 5
},
summative_assessment: {
component_options: [
{
name: 'Matching Roles to Responsibilities',
description: 'Students match community members to their roles.'
},
{
name: 'Explain Importance of Cooperation',
description: 'Oral or written explanation of teamwork in community events.'
},
{
name: 'Demonstrate Composting Benefits',
description: 'Students describe or show composting process and its impact.'
},
{
name: 'List Community Institutions and Functions',
description: 'Students list institutions and explain their roles.'
},
{
name: 'Discuss Shared Traditions',
description: 'Students talk about how celebrations foster belonging.'
}
],
formative_questions: [],
duration: 5
}
}
}
})
};
fetch('https://api-staging.crazygoldfish.com/lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.crazygoldfish.com/lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'alignment' => [
'materials_options' => [
[
'ai_recommendations' => [
[
'name' => 'Community Role Cards',
'description' => 'Visual cards depicting various community roles help clarify roles and responsibilities.'
],
[
'name' => 'Environmental Care Kits',
'description' => 'Hands-on kits with composting and waste management tools facilitate practical learning.'
],
[
'name' => 'Festival Storybooks',
'description' => 'Books illustrating community celebrations support understanding of shared traditions.'
]
],
'additional_recommendations' => [
[
'name' => 'Storytelling Props',
'description' => 'Props for role-play enhance engagement in community role activities.'
],
[
'name' => 'Local Institution Photos',
'description' => 'Images of schools, hospitals, and markets provide real-life context for community institutions.'
]
]
]
],
'instructional_strategies_options' => [
[
'ai_recommendations' => [
[
'name' => 'Role-Play Activities',
'description' => 'Engages students actively to understand community roles and teamwork.'
],
[
'name' => 'Group Discussions',
'description' => 'Facilitates strategic questioning and sharing of perspectives.'
],
[
'name' => 'Hands-on Environmental Projects',
'description' => 'Applies learning through practical composting or clean-up tasks.'
]
],
'additional_recommendations' => [
[
'name' => 'Storytelling Sessions',
'description' => 'Promotes empathy and social understanding through narrative.'
],
[
'name' => 'Interactive Q&A',
'description' => 'Encourages student participation and formative assessment through questioning.'
]
]
]
],
'instructional_blocks' => [
'introduction' => [
'component_options' => [
[
'name' => 'Storytelling on Community Roles',
'description' => 'Introduces community members and roles using relatable stories.'
],
[
'name' => 'Visual Presentation of Community',
'description' => 'Shows images and videos illustrating community settings.'
]
],
'formative_questions' => [
'What community roles do you see in your family?',
'Can you name someone who helps in your school?'
],
'duration' => 10
],
'development' => [
'component_options' => [
[
'name' => 'Role-Play of Community Helpers',
'description' => 'Students act out roles to understand responsibilities.'
],
[
'name' => 'Discussion on Cooperation',
'description' => 'Guided talk about working together during festivals and community events.'
]
],
'formative_questions' => [
'How do people help each other during festivals?',
'Why is teamwork important in our community?'
],
'duration' => 15
],
'guided_practice' => [
'component_options' => [
[
'name' => 'Group Composting Activity',
'description' => 'Students participate in composting to learn environmental care.'
],
[
'name' => 'Waste Sorting Exercise',
'description' => 'Hands-on sorting of recyclable and non-recyclable materials.'
]
],
'formative_questions' => [
'What materials can we compost?',
'How does composting help the soil?'
],
'duration' => 15
],
'independent_practice' => [
'component_options' => [
[
'name' => 'Community Institution Mapping',
'description' => 'Students create maps highlighting local institutions and their functions.'
],
[
'name' => 'Celebration Sharing Session',
'description' => 'Students share stories about festivals and traditions.'
]
],
'formative_questions' => [
'Which community institutions do you visit often?',
'How do festivals make you feel part of the community?'
],
'duration' => 10
],
'closure' => [
'component_options' => [
[
'name' => 'Group Reflection',
'description' => 'Students discuss what they learned about community roles and care.'
],
[
'name' => 'Question and Answer Review',
'description' => 'Teacher-led Q&A to summarize key concepts.'
]
],
'formative_questions' => [
'What is one important role in your community?',
'How can you help keep your neighborhood clean?'
],
'duration' => 5
],
'summative_assessment' => [
'component_options' => [
[
'name' => 'Matching Roles to Responsibilities',
'description' => 'Students match community members to their roles.'
],
[
'name' => 'Explain Importance of Cooperation',
'description' => 'Oral or written explanation of teamwork in community events.'
],
[
'name' => 'Demonstrate Composting Benefits',
'description' => 'Students describe or show composting process and its impact.'
],
[
'name' => 'List Community Institutions and Functions',
'description' => 'Students list institutions and explain their roles.'
],
[
'name' => 'Discuss Shared Traditions',
'description' => 'Students talk about how celebrations foster belonging.'
]
],
'formative_questions' => [
],
'duration' => 5
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-staging.crazygoldfish.com/lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}"
payload := strings.NewReader("{\n \"alignment\": {\n \"materials_options\": [\n {\n \"ai_recommendations\": [\n {\n \"name\": \"Community Role Cards\",\n \"description\": \"Visual cards depicting various community roles help clarify roles and responsibilities.\"\n },\n {\n \"name\": \"Environmental Care Kits\",\n \"description\": \"Hands-on kits with composting and waste management tools facilitate practical learning.\"\n },\n {\n \"name\": \"Festival Storybooks\",\n \"description\": \"Books illustrating community celebrations support understanding of shared traditions.\"\n }\n ],\n \"additional_recommendations\": [\n {\n \"name\": \"Storytelling Props\",\n \"description\": \"Props for role-play enhance engagement in community role activities.\"\n },\n {\n \"name\": \"Local Institution Photos\",\n \"description\": \"Images of schools, hospitals, and markets provide real-life context for community institutions.\"\n }\n ]\n }\n ],\n \"instructional_strategies_options\": [\n {\n \"ai_recommendations\": [\n {\n \"name\": \"Role-Play Activities\",\n \"description\": \"Engages students actively to understand community roles and teamwork.\"\n },\n {\n \"name\": \"Group Discussions\",\n \"description\": \"Facilitates strategic questioning and sharing of perspectives.\"\n },\n {\n \"name\": \"Hands-on Environmental Projects\",\n \"description\": \"Applies learning through practical composting or clean-up tasks.\"\n }\n ],\n \"additional_recommendations\": [\n {\n \"name\": \"Storytelling Sessions\",\n \"description\": \"Promotes empathy and social understanding through narrative.\"\n },\n {\n \"name\": \"Interactive Q&A\",\n \"description\": \"Encourages student participation and formative assessment through questioning.\"\n }\n ]\n }\n ],\n \"instructional_blocks\": {\n \"introduction\": {\n \"component_options\": [\n {\n \"name\": \"Storytelling on Community Roles\",\n \"description\": \"Introduces community members and roles using relatable stories.\"\n },\n {\n \"name\": \"Visual Presentation of Community\",\n \"description\": \"Shows images and videos illustrating community settings.\"\n }\n ],\n \"formative_questions\": [\n \"What community roles do you see in your family?\",\n \"Can you name someone who helps in your school?\"\n ],\n \"duration\": 10\n },\n \"development\": {\n \"component_options\": [\n {\n \"name\": \"Role-Play of Community Helpers\",\n \"description\": \"Students act out roles to understand responsibilities.\"\n },\n {\n \"name\": \"Discussion on Cooperation\",\n \"description\": \"Guided talk about working together during festivals and community events.\"\n }\n ],\n \"formative_questions\": [\n \"How do people help each other during festivals?\",\n \"Why is teamwork important in our community?\"\n ],\n \"duration\": 15\n },\n \"guided_practice\": {\n \"component_options\": [\n {\n \"name\": \"Group Composting Activity\",\n \"description\": \"Students participate in composting to learn environmental care.\"\n },\n {\n \"name\": \"Waste Sorting Exercise\",\n \"description\": \"Hands-on sorting of recyclable and non-recyclable materials.\"\n }\n ],\n \"formative_questions\": [\n \"What materials can we compost?\",\n \"How does composting help the soil?\"\n ],\n \"duration\": 15\n },\n \"independent_practice\": {\n \"component_options\": [\n {\n \"name\": \"Community Institution Mapping\",\n \"description\": \"Students create maps highlighting local institutions and their functions.\"\n },\n {\n \"name\": \"Celebration Sharing Session\",\n \"description\": \"Students share stories about festivals and traditions.\"\n }\n ],\n \"formative_questions\": [\n \"Which community institutions do you visit often?\",\n \"How do festivals make you feel part of the community?\"\n ],\n \"duration\": 10\n },\n \"closure\": {\n \"component_options\": [\n {\n \"name\": \"Group Reflection\",\n \"description\": \"Students discuss what they learned about community roles and care.\"\n },\n {\n \"name\": \"Question and Answer Review\",\n \"description\": \"Teacher-led Q&A to summarize key concepts.\"\n }\n ],\n \"formative_questions\": [\n \"What is one important role in your community?\",\n \"How can you help keep your neighborhood clean?\"\n ],\n \"duration\": 5\n },\n \"summative_assessment\": {\n \"component_options\": [\n {\n \"name\": \"Matching Roles to Responsibilities\",\n \"description\": \"Students match community members to their roles.\"\n },\n {\n \"name\": \"Explain Importance of Cooperation\",\n \"description\": \"Oral or written explanation of teamwork in community events.\"\n },\n {\n \"name\": \"Demonstrate Composting Benefits\",\n \"description\": \"Students describe or show composting process and its impact.\"\n },\n {\n \"name\": \"List Community Institutions and Functions\",\n \"description\": \"Students list institutions and explain their roles.\"\n },\n {\n \"name\": \"Discuss Shared Traditions\",\n \"description\": \"Students talk about how celebrations foster belonging.\"\n }\n ],\n \"formative_questions\": [],\n \"duration\": 5\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-staging.crazygoldfish.com/lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"alignment\": {\n \"materials_options\": [\n {\n \"ai_recommendations\": [\n {\n \"name\": \"Community Role Cards\",\n \"description\": \"Visual cards depicting various community roles help clarify roles and responsibilities.\"\n },\n {\n \"name\": \"Environmental Care Kits\",\n \"description\": \"Hands-on kits with composting and waste management tools facilitate practical learning.\"\n },\n {\n \"name\": \"Festival Storybooks\",\n \"description\": \"Books illustrating community celebrations support understanding of shared traditions.\"\n }\n ],\n \"additional_recommendations\": [\n {\n \"name\": \"Storytelling Props\",\n \"description\": \"Props for role-play enhance engagement in community role activities.\"\n },\n {\n \"name\": \"Local Institution Photos\",\n \"description\": \"Images of schools, hospitals, and markets provide real-life context for community institutions.\"\n }\n ]\n }\n ],\n \"instructional_strategies_options\": [\n {\n \"ai_recommendations\": [\n {\n \"name\": \"Role-Play Activities\",\n \"description\": \"Engages students actively to understand community roles and teamwork.\"\n },\n {\n \"name\": \"Group Discussions\",\n \"description\": \"Facilitates strategic questioning and sharing of perspectives.\"\n },\n {\n \"name\": \"Hands-on Environmental Projects\",\n \"description\": \"Applies learning through practical composting or clean-up tasks.\"\n }\n ],\n \"additional_recommendations\": [\n {\n \"name\": \"Storytelling Sessions\",\n \"description\": \"Promotes empathy and social understanding through narrative.\"\n },\n {\n \"name\": \"Interactive Q&A\",\n \"description\": \"Encourages student participation and formative assessment through questioning.\"\n }\n ]\n }\n ],\n \"instructional_blocks\": {\n \"introduction\": {\n \"component_options\": [\n {\n \"name\": \"Storytelling on Community Roles\",\n \"description\": \"Introduces community members and roles using relatable stories.\"\n },\n {\n \"name\": \"Visual Presentation of Community\",\n \"description\": \"Shows images and videos illustrating community settings.\"\n }\n ],\n \"formative_questions\": [\n \"What community roles do you see in your family?\",\n \"Can you name someone who helps in your school?\"\n ],\n \"duration\": 10\n },\n \"development\": {\n \"component_options\": [\n {\n \"name\": \"Role-Play of Community Helpers\",\n \"description\": \"Students act out roles to understand responsibilities.\"\n },\n {\n \"name\": \"Discussion on Cooperation\",\n \"description\": \"Guided talk about working together during festivals and community events.\"\n }\n ],\n \"formative_questions\": [\n \"How do people help each other during festivals?\",\n \"Why is teamwork important in our community?\"\n ],\n \"duration\": 15\n },\n \"guided_practice\": {\n \"component_options\": [\n {\n \"name\": \"Group Composting Activity\",\n \"description\": \"Students participate in composting to learn environmental care.\"\n },\n {\n \"name\": \"Waste Sorting Exercise\",\n \"description\": \"Hands-on sorting of recyclable and non-recyclable materials.\"\n }\n ],\n \"formative_questions\": [\n \"What materials can we compost?\",\n \"How does composting help the soil?\"\n ],\n \"duration\": 15\n },\n \"independent_practice\": {\n \"component_options\": [\n {\n \"name\": \"Community Institution Mapping\",\n \"description\": \"Students create maps highlighting local institutions and their functions.\"\n },\n {\n \"name\": \"Celebration Sharing Session\",\n \"description\": \"Students share stories about festivals and traditions.\"\n }\n ],\n \"formative_questions\": [\n \"Which community institutions do you visit often?\",\n \"How do festivals make you feel part of the community?\"\n ],\n \"duration\": 10\n },\n \"closure\": {\n \"component_options\": [\n {\n \"name\": \"Group Reflection\",\n \"description\": \"Students discuss what they learned about community roles and care.\"\n },\n {\n \"name\": \"Question and Answer Review\",\n \"description\": \"Teacher-led Q&A to summarize key concepts.\"\n }\n ],\n \"formative_questions\": [\n \"What is one important role in your community?\",\n \"How can you help keep your neighborhood clean?\"\n ],\n \"duration\": 5\n },\n \"summative_assessment\": {\n \"component_options\": [\n {\n \"name\": \"Matching Roles to Responsibilities\",\n \"description\": \"Students match community members to their roles.\"\n },\n {\n \"name\": \"Explain Importance of Cooperation\",\n \"description\": \"Oral or written explanation of teamwork in community events.\"\n },\n {\n \"name\": \"Demonstrate Composting Benefits\",\n \"description\": \"Students describe or show composting process and its impact.\"\n },\n {\n \"name\": \"List Community Institutions and Functions\",\n \"description\": \"Students list institutions and explain their roles.\"\n },\n {\n \"name\": \"Discuss Shared Traditions\",\n \"description\": \"Students talk about how celebrations foster belonging.\"\n }\n ],\n \"formative_questions\": [],\n \"duration\": 5\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.crazygoldfish.com/lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"alignment\": {\n \"materials_options\": [\n {\n \"ai_recommendations\": [\n {\n \"name\": \"Community Role Cards\",\n \"description\": \"Visual cards depicting various community roles help clarify roles and responsibilities.\"\n },\n {\n \"name\": \"Environmental Care Kits\",\n \"description\": \"Hands-on kits with composting and waste management tools facilitate practical learning.\"\n },\n {\n \"name\": \"Festival Storybooks\",\n \"description\": \"Books illustrating community celebrations support understanding of shared traditions.\"\n }\n ],\n \"additional_recommendations\": [\n {\n \"name\": \"Storytelling Props\",\n \"description\": \"Props for role-play enhance engagement in community role activities.\"\n },\n {\n \"name\": \"Local Institution Photos\",\n \"description\": \"Images of schools, hospitals, and markets provide real-life context for community institutions.\"\n }\n ]\n }\n ],\n \"instructional_strategies_options\": [\n {\n \"ai_recommendations\": [\n {\n \"name\": \"Role-Play Activities\",\n \"description\": \"Engages students actively to understand community roles and teamwork.\"\n },\n {\n \"name\": \"Group Discussions\",\n \"description\": \"Facilitates strategic questioning and sharing of perspectives.\"\n },\n {\n \"name\": \"Hands-on Environmental Projects\",\n \"description\": \"Applies learning through practical composting or clean-up tasks.\"\n }\n ],\n \"additional_recommendations\": [\n {\n \"name\": \"Storytelling Sessions\",\n \"description\": \"Promotes empathy and social understanding through narrative.\"\n },\n {\n \"name\": \"Interactive Q&A\",\n \"description\": \"Encourages student participation and formative assessment through questioning.\"\n }\n ]\n }\n ],\n \"instructional_blocks\": {\n \"introduction\": {\n \"component_options\": [\n {\n \"name\": \"Storytelling on Community Roles\",\n \"description\": \"Introduces community members and roles using relatable stories.\"\n },\n {\n \"name\": \"Visual Presentation of Community\",\n \"description\": \"Shows images and videos illustrating community settings.\"\n }\n ],\n \"formative_questions\": [\n \"What community roles do you see in your family?\",\n \"Can you name someone who helps in your school?\"\n ],\n \"duration\": 10\n },\n \"development\": {\n \"component_options\": [\n {\n \"name\": \"Role-Play of Community Helpers\",\n \"description\": \"Students act out roles to understand responsibilities.\"\n },\n {\n \"name\": \"Discussion on Cooperation\",\n \"description\": \"Guided talk about working together during festivals and community events.\"\n }\n ],\n \"formative_questions\": [\n \"How do people help each other during festivals?\",\n \"Why is teamwork important in our community?\"\n ],\n \"duration\": 15\n },\n \"guided_practice\": {\n \"component_options\": [\n {\n \"name\": \"Group Composting Activity\",\n \"description\": \"Students participate in composting to learn environmental care.\"\n },\n {\n \"name\": \"Waste Sorting Exercise\",\n \"description\": \"Hands-on sorting of recyclable and non-recyclable materials.\"\n }\n ],\n \"formative_questions\": [\n \"What materials can we compost?\",\n \"How does composting help the soil?\"\n ],\n \"duration\": 15\n },\n \"independent_practice\": {\n \"component_options\": [\n {\n \"name\": \"Community Institution Mapping\",\n \"description\": \"Students create maps highlighting local institutions and their functions.\"\n },\n {\n \"name\": \"Celebration Sharing Session\",\n \"description\": \"Students share stories about festivals and traditions.\"\n }\n ],\n \"formative_questions\": [\n \"Which community institutions do you visit often?\",\n \"How do festivals make you feel part of the community?\"\n ],\n \"duration\": 10\n },\n \"closure\": {\n \"component_options\": [\n {\n \"name\": \"Group Reflection\",\n \"description\": \"Students discuss what they learned about community roles and care.\"\n },\n {\n \"name\": \"Question and Answer Review\",\n \"description\": \"Teacher-led Q&A to summarize key concepts.\"\n }\n ],\n \"formative_questions\": [\n \"What is one important role in your community?\",\n \"How can you help keep your neighborhood clean?\"\n ],\n \"duration\": 5\n },\n \"summative_assessment\": {\n \"component_options\": [\n {\n \"name\": \"Matching Roles to Responsibilities\",\n \"description\": \"Students match community members to their roles.\"\n },\n {\n \"name\": \"Explain Importance of Cooperation\",\n \"description\": \"Oral or written explanation of teamwork in community events.\"\n },\n {\n \"name\": \"Demonstrate Composting Benefits\",\n \"description\": \"Students describe or show composting process and its impact.\"\n },\n {\n \"name\": \"List Community Institutions and Functions\",\n \"description\": \"Students list institutions and explain their roles.\"\n },\n {\n \"name\": \"Discuss Shared Traditions\",\n \"description\": \"Students talk about how celebrations foster belonging.\"\n }\n ],\n \"formative_questions\": [],\n \"duration\": 5\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"id": "78f0974d-d2df-42f4-8c06-073ed43482f5",
"message": "Content generation initiated successfully."
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
UUID of the lesson plan to generate content for.
Body
application/json
Community-focused alignment data required to drive content generation. Includes recommended materials, instructional strategies, and detailed instructional blocks.
Alignment details that specify materials, strategies, and instructional blocks.
Show child attributes
Show child attributes
Response
Content generation job enqueued successfully.
Show child attributes
Show child attributes
Was this page helpful?
Previous
GET - Lesson Plan Instructional Framework Builder This API allows authenticated users to retrieve the generated instructional framework for a lesson plan.
**How to Use:**
1. Call `GET /lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}` with the lesson plan ID.
2. The API validates the lesson plan ID and checks if instructional framework generation is completed.
3. On success, the system returns the generated instructional framework.
**Example Scenario:**
A teacher wants to view the generated instructional framework for a lesson plan:
- They call this API with the lesson plan ID.
- The system validates the lesson plan and instructional framework generation status.
- If valid and completed, the system returns the generated instructional framework.
- The teacher receives the lesson plan instructional framework for review and use.
Next
⌘I
Trigger content generation for a lesson plan.
curl --request POST \
--url https://api-staging.crazygoldfish.com/lesson-plan/v1/instructional-framework-builder/{lesson_plan_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"alignment": {
"materials_options": [
{
"ai_recommendations": [
{
"name": "Community Role Cards",
"description": "Visual cards depicting various community roles help clarify roles and responsibilities."
},
{
"name": "Environmental Care Kits",
"description": "Hands-on kits with composting and waste management tools facilitate practical learning."
},
{
"name": "Festival Storybooks",
"description": "Books illustrating community celebrations support understanding of shared traditions."
}
],
"additional_recommendations": [
{
"name": "Storytelling Props",
"description": "Props for role-play enhance engagement in community role activities."
},
{
"name": "Local Institution Photos",
"description": "Images of schools, hospitals, and markets provide real-life context for community institutions."
}
]
}
],
"instructional_strategies_options": [
{
"ai_recommendations": [
{
"name": "Role-Play Activities",
"description": "Engages students actively to understand community roles and teamwork."
},
{
"name": "Group Discussions",
"description": "Facilitates strategic questioning and sharing of perspectives."
},
{
"name": "Hands-on Environmental Projects",
"description": "Applies learning through practical composting or clean-up tasks."
}
],
"additional_recommendations": [
{
"name": "Storytelling Sessions",
"description": "Promotes empathy and social understanding through narrative."
},
{
"name": "Interactive Q&A",
"description": "Encourages student participation and formative assessment through questioning."
}
]
}
],
"instructional_blocks": {
"introduction": {
"component_options": [
{
"name": "Storytelling on Community Roles",
"description": "Introduces community members and roles using relatable stories."
},
{
"name": "Visual Presentation of Community",
"description": "Shows images and videos illustrating community settings."
}
],
"formative_questions": [
"What community roles do you see in your family?",
"Can you name someone who helps in your school?"
],
"duration": 10
},
"development": {
"component_options": [
{
"name": "Role-Play of Community Helpers",
"description": "Students act out roles to understand responsibilities."
},
{
"name": "Discussion on Cooperation",
"description": "Guided talk about working together during festivals and community events."
}
],
"formative_questions": [
"How do people help each other during festivals?",
"Why is teamwork important in our community?"
],
"duration": 15
},
"guided_practice": {
"component_options": [
{
"name": "Group Composting Activity",
"description": "Students participate in composting to learn environmental care."
},
{
"name": "Waste Sorting Exercise",
"description": "Hands-on sorting of recyclable and non-recyclable materials."
}
],
"formative_questions": [
"What materials can we compost?",
"How does composting help the soil?"
],
"duration": 15
},
"independent_practice": {
"component_options": [
{
"name": "Community Institution Mapping",
"description": "Students create maps highlighting local institutions and their functions."
},
{
"name": "Celebration Sharing Session",
"description": "Students share stories about festivals and traditions."
}
],
"formative_questions": [
"Which community institutions do you visit often?",
"How do festivals make you feel part of the community?"
],
"duration": 10
},
"closure": {
"component_options": [
{
"name": "Group Reflection",
"description": "Students discuss what they learned about community roles and care."
},
{
"name": "Question and Answer Review",
"description": "Teacher-led Q&A to summarize key concepts."
}
],
"formative_questions": [
"What is one important role in your community?",
"How can you help keep your neighborhood clean?"
],
"duration": 5
},
"summative_assessment": {
"component_options": [
{
"name": "Matching Roles to Responsibilities",
"description": "Students match community members to their roles."
},
{
"name": "Explain Importance of Cooperation",
"description": "Oral or written explanation of teamwork in community events."
},
{
"name": "Demonstrate Composting Benefits",
"description": "Students describe or show composting process and its impact."
},
{
"name": "List Community Institutions and Functions",
"description": "Students list institutions and explain their roles."
},
{
"name": "Discuss Shared Traditions",
"description": "Students talk about how celebrations foster belonging."
}
],
"formative_questions": [],
"duration": 5
}
}
}
}
'import requests
url = "https://api-staging.crazygoldfish.com/lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}"
payload = { "alignment": {
"materials_options": [
{
"ai_recommendations": [
{
"name": "Community Role Cards",
"description": "Visual cards depicting various community roles help clarify roles and responsibilities."
},
{
"name": "Environmental Care Kits",
"description": "Hands-on kits with composting and waste management tools facilitate practical learning."
},
{
"name": "Festival Storybooks",
"description": "Books illustrating community celebrations support understanding of shared traditions."
}
],
"additional_recommendations": [
{
"name": "Storytelling Props",
"description": "Props for role-play enhance engagement in community role activities."
},
{
"name": "Local Institution Photos",
"description": "Images of schools, hospitals, and markets provide real-life context for community institutions."
}
]
}
],
"instructional_strategies_options": [
{
"ai_recommendations": [
{
"name": "Role-Play Activities",
"description": "Engages students actively to understand community roles and teamwork."
},
{
"name": "Group Discussions",
"description": "Facilitates strategic questioning and sharing of perspectives."
},
{
"name": "Hands-on Environmental Projects",
"description": "Applies learning through practical composting or clean-up tasks."
}
],
"additional_recommendations": [
{
"name": "Storytelling Sessions",
"description": "Promotes empathy and social understanding through narrative."
},
{
"name": "Interactive Q&A",
"description": "Encourages student participation and formative assessment through questioning."
}
]
}
],
"instructional_blocks": {
"introduction": {
"component_options": [
{
"name": "Storytelling on Community Roles",
"description": "Introduces community members and roles using relatable stories."
},
{
"name": "Visual Presentation of Community",
"description": "Shows images and videos illustrating community settings."
}
],
"formative_questions": ["What community roles do you see in your family?", "Can you name someone who helps in your school?"],
"duration": 10
},
"development": {
"component_options": [
{
"name": "Role-Play of Community Helpers",
"description": "Students act out roles to understand responsibilities."
},
{
"name": "Discussion on Cooperation",
"description": "Guided talk about working together during festivals and community events."
}
],
"formative_questions": ["How do people help each other during festivals?", "Why is teamwork important in our community?"],
"duration": 15
},
"guided_practice": {
"component_options": [
{
"name": "Group Composting Activity",
"description": "Students participate in composting to learn environmental care."
},
{
"name": "Waste Sorting Exercise",
"description": "Hands-on sorting of recyclable and non-recyclable materials."
}
],
"formative_questions": ["What materials can we compost?", "How does composting help the soil?"],
"duration": 15
},
"independent_practice": {
"component_options": [
{
"name": "Community Institution Mapping",
"description": "Students create maps highlighting local institutions and their functions."
},
{
"name": "Celebration Sharing Session",
"description": "Students share stories about festivals and traditions."
}
],
"formative_questions": ["Which community institutions do you visit often?", "How do festivals make you feel part of the community?"],
"duration": 10
},
"closure": {
"component_options": [
{
"name": "Group Reflection",
"description": "Students discuss what they learned about community roles and care."
},
{
"name": "Question and Answer Review",
"description": "Teacher-led Q&A to summarize key concepts."
}
],
"formative_questions": ["What is one important role in your community?", "How can you help keep your neighborhood clean?"],
"duration": 5
},
"summative_assessment": {
"component_options": [
{
"name": "Matching Roles to Responsibilities",
"description": "Students match community members to their roles."
},
{
"name": "Explain Importance of Cooperation",
"description": "Oral or written explanation of teamwork in community events."
},
{
"name": "Demonstrate Composting Benefits",
"description": "Students describe or show composting process and its impact."
},
{
"name": "List Community Institutions and Functions",
"description": "Students list institutions and explain their roles."
},
{
"name": "Discuss Shared Traditions",
"description": "Students talk about how celebrations foster belonging."
}
],
"formative_questions": [],
"duration": 5
}
}
} }
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({
alignment: {
materials_options: [
{
ai_recommendations: [
{
name: 'Community Role Cards',
description: 'Visual cards depicting various community roles help clarify roles and responsibilities.'
},
{
name: 'Environmental Care Kits',
description: 'Hands-on kits with composting and waste management tools facilitate practical learning.'
},
{
name: 'Festival Storybooks',
description: 'Books illustrating community celebrations support understanding of shared traditions.'
}
],
additional_recommendations: [
{
name: 'Storytelling Props',
description: 'Props for role-play enhance engagement in community role activities.'
},
{
name: 'Local Institution Photos',
description: 'Images of schools, hospitals, and markets provide real-life context for community institutions.'
}
]
}
],
instructional_strategies_options: [
{
ai_recommendations: [
{
name: 'Role-Play Activities',
description: 'Engages students actively to understand community roles and teamwork.'
},
{
name: 'Group Discussions',
description: 'Facilitates strategic questioning and sharing of perspectives.'
},
{
name: 'Hands-on Environmental Projects',
description: 'Applies learning through practical composting or clean-up tasks.'
}
],
additional_recommendations: [
{
name: 'Storytelling Sessions',
description: 'Promotes empathy and social understanding through narrative.'
},
{
name: 'Interactive Q&A',
description: 'Encourages student participation and formative assessment through questioning.'
}
]
}
],
instructional_blocks: {
introduction: {
component_options: [
{
name: 'Storytelling on Community Roles',
description: 'Introduces community members and roles using relatable stories.'
},
{
name: 'Visual Presentation of Community',
description: 'Shows images and videos illustrating community settings.'
}
],
formative_questions: [
'What community roles do you see in your family?',
'Can you name someone who helps in your school?'
],
duration: 10
},
development: {
component_options: [
{
name: 'Role-Play of Community Helpers',
description: 'Students act out roles to understand responsibilities.'
},
{
name: 'Discussion on Cooperation',
description: 'Guided talk about working together during festivals and community events.'
}
],
formative_questions: [
'How do people help each other during festivals?',
'Why is teamwork important in our community?'
],
duration: 15
},
guided_practice: {
component_options: [
{
name: 'Group Composting Activity',
description: 'Students participate in composting to learn environmental care.'
},
{
name: 'Waste Sorting Exercise',
description: 'Hands-on sorting of recyclable and non-recyclable materials.'
}
],
formative_questions: ['What materials can we compost?', 'How does composting help the soil?'],
duration: 15
},
independent_practice: {
component_options: [
{
name: 'Community Institution Mapping',
description: 'Students create maps highlighting local institutions and their functions.'
},
{
name: 'Celebration Sharing Session',
description: 'Students share stories about festivals and traditions.'
}
],
formative_questions: [
'Which community institutions do you visit often?',
'How do festivals make you feel part of the community?'
],
duration: 10
},
closure: {
component_options: [
{
name: 'Group Reflection',
description: 'Students discuss what they learned about community roles and care.'
},
{
name: 'Question and Answer Review',
description: 'Teacher-led Q&A to summarize key concepts.'
}
],
formative_questions: [
'What is one important role in your community?',
'How can you help keep your neighborhood clean?'
],
duration: 5
},
summative_assessment: {
component_options: [
{
name: 'Matching Roles to Responsibilities',
description: 'Students match community members to their roles.'
},
{
name: 'Explain Importance of Cooperation',
description: 'Oral or written explanation of teamwork in community events.'
},
{
name: 'Demonstrate Composting Benefits',
description: 'Students describe or show composting process and its impact.'
},
{
name: 'List Community Institutions and Functions',
description: 'Students list institutions and explain their roles.'
},
{
name: 'Discuss Shared Traditions',
description: 'Students talk about how celebrations foster belonging.'
}
],
formative_questions: [],
duration: 5
}
}
}
})
};
fetch('https://api-staging.crazygoldfish.com/lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.crazygoldfish.com/lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'alignment' => [
'materials_options' => [
[
'ai_recommendations' => [
[
'name' => 'Community Role Cards',
'description' => 'Visual cards depicting various community roles help clarify roles and responsibilities.'
],
[
'name' => 'Environmental Care Kits',
'description' => 'Hands-on kits with composting and waste management tools facilitate practical learning.'
],
[
'name' => 'Festival Storybooks',
'description' => 'Books illustrating community celebrations support understanding of shared traditions.'
]
],
'additional_recommendations' => [
[
'name' => 'Storytelling Props',
'description' => 'Props for role-play enhance engagement in community role activities.'
],
[
'name' => 'Local Institution Photos',
'description' => 'Images of schools, hospitals, and markets provide real-life context for community institutions.'
]
]
]
],
'instructional_strategies_options' => [
[
'ai_recommendations' => [
[
'name' => 'Role-Play Activities',
'description' => 'Engages students actively to understand community roles and teamwork.'
],
[
'name' => 'Group Discussions',
'description' => 'Facilitates strategic questioning and sharing of perspectives.'
],
[
'name' => 'Hands-on Environmental Projects',
'description' => 'Applies learning through practical composting or clean-up tasks.'
]
],
'additional_recommendations' => [
[
'name' => 'Storytelling Sessions',
'description' => 'Promotes empathy and social understanding through narrative.'
],
[
'name' => 'Interactive Q&A',
'description' => 'Encourages student participation and formative assessment through questioning.'
]
]
]
],
'instructional_blocks' => [
'introduction' => [
'component_options' => [
[
'name' => 'Storytelling on Community Roles',
'description' => 'Introduces community members and roles using relatable stories.'
],
[
'name' => 'Visual Presentation of Community',
'description' => 'Shows images and videos illustrating community settings.'
]
],
'formative_questions' => [
'What community roles do you see in your family?',
'Can you name someone who helps in your school?'
],
'duration' => 10
],
'development' => [
'component_options' => [
[
'name' => 'Role-Play of Community Helpers',
'description' => 'Students act out roles to understand responsibilities.'
],
[
'name' => 'Discussion on Cooperation',
'description' => 'Guided talk about working together during festivals and community events.'
]
],
'formative_questions' => [
'How do people help each other during festivals?',
'Why is teamwork important in our community?'
],
'duration' => 15
],
'guided_practice' => [
'component_options' => [
[
'name' => 'Group Composting Activity',
'description' => 'Students participate in composting to learn environmental care.'
],
[
'name' => 'Waste Sorting Exercise',
'description' => 'Hands-on sorting of recyclable and non-recyclable materials.'
]
],
'formative_questions' => [
'What materials can we compost?',
'How does composting help the soil?'
],
'duration' => 15
],
'independent_practice' => [
'component_options' => [
[
'name' => 'Community Institution Mapping',
'description' => 'Students create maps highlighting local institutions and their functions.'
],
[
'name' => 'Celebration Sharing Session',
'description' => 'Students share stories about festivals and traditions.'
]
],
'formative_questions' => [
'Which community institutions do you visit often?',
'How do festivals make you feel part of the community?'
],
'duration' => 10
],
'closure' => [
'component_options' => [
[
'name' => 'Group Reflection',
'description' => 'Students discuss what they learned about community roles and care.'
],
[
'name' => 'Question and Answer Review',
'description' => 'Teacher-led Q&A to summarize key concepts.'
]
],
'formative_questions' => [
'What is one important role in your community?',
'How can you help keep your neighborhood clean?'
],
'duration' => 5
],
'summative_assessment' => [
'component_options' => [
[
'name' => 'Matching Roles to Responsibilities',
'description' => 'Students match community members to their roles.'
],
[
'name' => 'Explain Importance of Cooperation',
'description' => 'Oral or written explanation of teamwork in community events.'
],
[
'name' => 'Demonstrate Composting Benefits',
'description' => 'Students describe or show composting process and its impact.'
],
[
'name' => 'List Community Institutions and Functions',
'description' => 'Students list institutions and explain their roles.'
],
[
'name' => 'Discuss Shared Traditions',
'description' => 'Students talk about how celebrations foster belonging.'
]
],
'formative_questions' => [
],
'duration' => 5
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-staging.crazygoldfish.com/lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}"
payload := strings.NewReader("{\n \"alignment\": {\n \"materials_options\": [\n {\n \"ai_recommendations\": [\n {\n \"name\": \"Community Role Cards\",\n \"description\": \"Visual cards depicting various community roles help clarify roles and responsibilities.\"\n },\n {\n \"name\": \"Environmental Care Kits\",\n \"description\": \"Hands-on kits with composting and waste management tools facilitate practical learning.\"\n },\n {\n \"name\": \"Festival Storybooks\",\n \"description\": \"Books illustrating community celebrations support understanding of shared traditions.\"\n }\n ],\n \"additional_recommendations\": [\n {\n \"name\": \"Storytelling Props\",\n \"description\": \"Props for role-play enhance engagement in community role activities.\"\n },\n {\n \"name\": \"Local Institution Photos\",\n \"description\": \"Images of schools, hospitals, and markets provide real-life context for community institutions.\"\n }\n ]\n }\n ],\n \"instructional_strategies_options\": [\n {\n \"ai_recommendations\": [\n {\n \"name\": \"Role-Play Activities\",\n \"description\": \"Engages students actively to understand community roles and teamwork.\"\n },\n {\n \"name\": \"Group Discussions\",\n \"description\": \"Facilitates strategic questioning and sharing of perspectives.\"\n },\n {\n \"name\": \"Hands-on Environmental Projects\",\n \"description\": \"Applies learning through practical composting or clean-up tasks.\"\n }\n ],\n \"additional_recommendations\": [\n {\n \"name\": \"Storytelling Sessions\",\n \"description\": \"Promotes empathy and social understanding through narrative.\"\n },\n {\n \"name\": \"Interactive Q&A\",\n \"description\": \"Encourages student participation and formative assessment through questioning.\"\n }\n ]\n }\n ],\n \"instructional_blocks\": {\n \"introduction\": {\n \"component_options\": [\n {\n \"name\": \"Storytelling on Community Roles\",\n \"description\": \"Introduces community members and roles using relatable stories.\"\n },\n {\n \"name\": \"Visual Presentation of Community\",\n \"description\": \"Shows images and videos illustrating community settings.\"\n }\n ],\n \"formative_questions\": [\n \"What community roles do you see in your family?\",\n \"Can you name someone who helps in your school?\"\n ],\n \"duration\": 10\n },\n \"development\": {\n \"component_options\": [\n {\n \"name\": \"Role-Play of Community Helpers\",\n \"description\": \"Students act out roles to understand responsibilities.\"\n },\n {\n \"name\": \"Discussion on Cooperation\",\n \"description\": \"Guided talk about working together during festivals and community events.\"\n }\n ],\n \"formative_questions\": [\n \"How do people help each other during festivals?\",\n \"Why is teamwork important in our community?\"\n ],\n \"duration\": 15\n },\n \"guided_practice\": {\n \"component_options\": [\n {\n \"name\": \"Group Composting Activity\",\n \"description\": \"Students participate in composting to learn environmental care.\"\n },\n {\n \"name\": \"Waste Sorting Exercise\",\n \"description\": \"Hands-on sorting of recyclable and non-recyclable materials.\"\n }\n ],\n \"formative_questions\": [\n \"What materials can we compost?\",\n \"How does composting help the soil?\"\n ],\n \"duration\": 15\n },\n \"independent_practice\": {\n \"component_options\": [\n {\n \"name\": \"Community Institution Mapping\",\n \"description\": \"Students create maps highlighting local institutions and their functions.\"\n },\n {\n \"name\": \"Celebration Sharing Session\",\n \"description\": \"Students share stories about festivals and traditions.\"\n }\n ],\n \"formative_questions\": [\n \"Which community institutions do you visit often?\",\n \"How do festivals make you feel part of the community?\"\n ],\n \"duration\": 10\n },\n \"closure\": {\n \"component_options\": [\n {\n \"name\": \"Group Reflection\",\n \"description\": \"Students discuss what they learned about community roles and care.\"\n },\n {\n \"name\": \"Question and Answer Review\",\n \"description\": \"Teacher-led Q&A to summarize key concepts.\"\n }\n ],\n \"formative_questions\": [\n \"What is one important role in your community?\",\n \"How can you help keep your neighborhood clean?\"\n ],\n \"duration\": 5\n },\n \"summative_assessment\": {\n \"component_options\": [\n {\n \"name\": \"Matching Roles to Responsibilities\",\n \"description\": \"Students match community members to their roles.\"\n },\n {\n \"name\": \"Explain Importance of Cooperation\",\n \"description\": \"Oral or written explanation of teamwork in community events.\"\n },\n {\n \"name\": \"Demonstrate Composting Benefits\",\n \"description\": \"Students describe or show composting process and its impact.\"\n },\n {\n \"name\": \"List Community Institutions and Functions\",\n \"description\": \"Students list institutions and explain their roles.\"\n },\n {\n \"name\": \"Discuss Shared Traditions\",\n \"description\": \"Students talk about how celebrations foster belonging.\"\n }\n ],\n \"formative_questions\": [],\n \"duration\": 5\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-staging.crazygoldfish.com/lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"alignment\": {\n \"materials_options\": [\n {\n \"ai_recommendations\": [\n {\n \"name\": \"Community Role Cards\",\n \"description\": \"Visual cards depicting various community roles help clarify roles and responsibilities.\"\n },\n {\n \"name\": \"Environmental Care Kits\",\n \"description\": \"Hands-on kits with composting and waste management tools facilitate practical learning.\"\n },\n {\n \"name\": \"Festival Storybooks\",\n \"description\": \"Books illustrating community celebrations support understanding of shared traditions.\"\n }\n ],\n \"additional_recommendations\": [\n {\n \"name\": \"Storytelling Props\",\n \"description\": \"Props for role-play enhance engagement in community role activities.\"\n },\n {\n \"name\": \"Local Institution Photos\",\n \"description\": \"Images of schools, hospitals, and markets provide real-life context for community institutions.\"\n }\n ]\n }\n ],\n \"instructional_strategies_options\": [\n {\n \"ai_recommendations\": [\n {\n \"name\": \"Role-Play Activities\",\n \"description\": \"Engages students actively to understand community roles and teamwork.\"\n },\n {\n \"name\": \"Group Discussions\",\n \"description\": \"Facilitates strategic questioning and sharing of perspectives.\"\n },\n {\n \"name\": \"Hands-on Environmental Projects\",\n \"description\": \"Applies learning through practical composting or clean-up tasks.\"\n }\n ],\n \"additional_recommendations\": [\n {\n \"name\": \"Storytelling Sessions\",\n \"description\": \"Promotes empathy and social understanding through narrative.\"\n },\n {\n \"name\": \"Interactive Q&A\",\n \"description\": \"Encourages student participation and formative assessment through questioning.\"\n }\n ]\n }\n ],\n \"instructional_blocks\": {\n \"introduction\": {\n \"component_options\": [\n {\n \"name\": \"Storytelling on Community Roles\",\n \"description\": \"Introduces community members and roles using relatable stories.\"\n },\n {\n \"name\": \"Visual Presentation of Community\",\n \"description\": \"Shows images and videos illustrating community settings.\"\n }\n ],\n \"formative_questions\": [\n \"What community roles do you see in your family?\",\n \"Can you name someone who helps in your school?\"\n ],\n \"duration\": 10\n },\n \"development\": {\n \"component_options\": [\n {\n \"name\": \"Role-Play of Community Helpers\",\n \"description\": \"Students act out roles to understand responsibilities.\"\n },\n {\n \"name\": \"Discussion on Cooperation\",\n \"description\": \"Guided talk about working together during festivals and community events.\"\n }\n ],\n \"formative_questions\": [\n \"How do people help each other during festivals?\",\n \"Why is teamwork important in our community?\"\n ],\n \"duration\": 15\n },\n \"guided_practice\": {\n \"component_options\": [\n {\n \"name\": \"Group Composting Activity\",\n \"description\": \"Students participate in composting to learn environmental care.\"\n },\n {\n \"name\": \"Waste Sorting Exercise\",\n \"description\": \"Hands-on sorting of recyclable and non-recyclable materials.\"\n }\n ],\n \"formative_questions\": [\n \"What materials can we compost?\",\n \"How does composting help the soil?\"\n ],\n \"duration\": 15\n },\n \"independent_practice\": {\n \"component_options\": [\n {\n \"name\": \"Community Institution Mapping\",\n \"description\": \"Students create maps highlighting local institutions and their functions.\"\n },\n {\n \"name\": \"Celebration Sharing Session\",\n \"description\": \"Students share stories about festivals and traditions.\"\n }\n ],\n \"formative_questions\": [\n \"Which community institutions do you visit often?\",\n \"How do festivals make you feel part of the community?\"\n ],\n \"duration\": 10\n },\n \"closure\": {\n \"component_options\": [\n {\n \"name\": \"Group Reflection\",\n \"description\": \"Students discuss what they learned about community roles and care.\"\n },\n {\n \"name\": \"Question and Answer Review\",\n \"description\": \"Teacher-led Q&A to summarize key concepts.\"\n }\n ],\n \"formative_questions\": [\n \"What is one important role in your community?\",\n \"How can you help keep your neighborhood clean?\"\n ],\n \"duration\": 5\n },\n \"summative_assessment\": {\n \"component_options\": [\n {\n \"name\": \"Matching Roles to Responsibilities\",\n \"description\": \"Students match community members to their roles.\"\n },\n {\n \"name\": \"Explain Importance of Cooperation\",\n \"description\": \"Oral or written explanation of teamwork in community events.\"\n },\n {\n \"name\": \"Demonstrate Composting Benefits\",\n \"description\": \"Students describe or show composting process and its impact.\"\n },\n {\n \"name\": \"List Community Institutions and Functions\",\n \"description\": \"Students list institutions and explain their roles.\"\n },\n {\n \"name\": \"Discuss Shared Traditions\",\n \"description\": \"Students talk about how celebrations foster belonging.\"\n }\n ],\n \"formative_questions\": [],\n \"duration\": 5\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.crazygoldfish.com/lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"alignment\": {\n \"materials_options\": [\n {\n \"ai_recommendations\": [\n {\n \"name\": \"Community Role Cards\",\n \"description\": \"Visual cards depicting various community roles help clarify roles and responsibilities.\"\n },\n {\n \"name\": \"Environmental Care Kits\",\n \"description\": \"Hands-on kits with composting and waste management tools facilitate practical learning.\"\n },\n {\n \"name\": \"Festival Storybooks\",\n \"description\": \"Books illustrating community celebrations support understanding of shared traditions.\"\n }\n ],\n \"additional_recommendations\": [\n {\n \"name\": \"Storytelling Props\",\n \"description\": \"Props for role-play enhance engagement in community role activities.\"\n },\n {\n \"name\": \"Local Institution Photos\",\n \"description\": \"Images of schools, hospitals, and markets provide real-life context for community institutions.\"\n }\n ]\n }\n ],\n \"instructional_strategies_options\": [\n {\n \"ai_recommendations\": [\n {\n \"name\": \"Role-Play Activities\",\n \"description\": \"Engages students actively to understand community roles and teamwork.\"\n },\n {\n \"name\": \"Group Discussions\",\n \"description\": \"Facilitates strategic questioning and sharing of perspectives.\"\n },\n {\n \"name\": \"Hands-on Environmental Projects\",\n \"description\": \"Applies learning through practical composting or clean-up tasks.\"\n }\n ],\n \"additional_recommendations\": [\n {\n \"name\": \"Storytelling Sessions\",\n \"description\": \"Promotes empathy and social understanding through narrative.\"\n },\n {\n \"name\": \"Interactive Q&A\",\n \"description\": \"Encourages student participation and formative assessment through questioning.\"\n }\n ]\n }\n ],\n \"instructional_blocks\": {\n \"introduction\": {\n \"component_options\": [\n {\n \"name\": \"Storytelling on Community Roles\",\n \"description\": \"Introduces community members and roles using relatable stories.\"\n },\n {\n \"name\": \"Visual Presentation of Community\",\n \"description\": \"Shows images and videos illustrating community settings.\"\n }\n ],\n \"formative_questions\": [\n \"What community roles do you see in your family?\",\n \"Can you name someone who helps in your school?\"\n ],\n \"duration\": 10\n },\n \"development\": {\n \"component_options\": [\n {\n \"name\": \"Role-Play of Community Helpers\",\n \"description\": \"Students act out roles to understand responsibilities.\"\n },\n {\n \"name\": \"Discussion on Cooperation\",\n \"description\": \"Guided talk about working together during festivals and community events.\"\n }\n ],\n \"formative_questions\": [\n \"How do people help each other during festivals?\",\n \"Why is teamwork important in our community?\"\n ],\n \"duration\": 15\n },\n \"guided_practice\": {\n \"component_options\": [\n {\n \"name\": \"Group Composting Activity\",\n \"description\": \"Students participate in composting to learn environmental care.\"\n },\n {\n \"name\": \"Waste Sorting Exercise\",\n \"description\": \"Hands-on sorting of recyclable and non-recyclable materials.\"\n }\n ],\n \"formative_questions\": [\n \"What materials can we compost?\",\n \"How does composting help the soil?\"\n ],\n \"duration\": 15\n },\n \"independent_practice\": {\n \"component_options\": [\n {\n \"name\": \"Community Institution Mapping\",\n \"description\": \"Students create maps highlighting local institutions and their functions.\"\n },\n {\n \"name\": \"Celebration Sharing Session\",\n \"description\": \"Students share stories about festivals and traditions.\"\n }\n ],\n \"formative_questions\": [\n \"Which community institutions do you visit often?\",\n \"How do festivals make you feel part of the community?\"\n ],\n \"duration\": 10\n },\n \"closure\": {\n \"component_options\": [\n {\n \"name\": \"Group Reflection\",\n \"description\": \"Students discuss what they learned about community roles and care.\"\n },\n {\n \"name\": \"Question and Answer Review\",\n \"description\": \"Teacher-led Q&A to summarize key concepts.\"\n }\n ],\n \"formative_questions\": [\n \"What is one important role in your community?\",\n \"How can you help keep your neighborhood clean?\"\n ],\n \"duration\": 5\n },\n \"summative_assessment\": {\n \"component_options\": [\n {\n \"name\": \"Matching Roles to Responsibilities\",\n \"description\": \"Students match community members to their roles.\"\n },\n {\n \"name\": \"Explain Importance of Cooperation\",\n \"description\": \"Oral or written explanation of teamwork in community events.\"\n },\n {\n \"name\": \"Demonstrate Composting Benefits\",\n \"description\": \"Students describe or show composting process and its impact.\"\n },\n {\n \"name\": \"List Community Institutions and Functions\",\n \"description\": \"Students list institutions and explain their roles.\"\n },\n {\n \"name\": \"Discuss Shared Traditions\",\n \"description\": \"Students talk about how celebrations foster belonging.\"\n }\n ],\n \"formative_questions\": [],\n \"duration\": 5\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"id": "78f0974d-d2df-42f4-8c06-073ed43482f5",
"message": "Content generation initiated successfully."
}
]
}