GET - Worksheet Metadata by ID
Retrieves metadata for a specific worksheet by its ID.
The response includes board, grade, subject, status, number of questions, topic, subject matter (topics, prerequisites, concepts), and learning standards.
How to Use:
- Call
GET /worksheet/v1/metadata/{work_sheet_id}with the worksheet ID. - On success, you receive full worksheet metadata in the response.
- If the worksheet is not found, a
404error is returned.
GET
/
worksheet
/
v1
/
metadata
/
{work_sheet_id}
Get Worksheet Metadata by ID
curl --request GET \
--url https://api-staging.crazygoldfish.com/worksheet/v1/metadata/{work_sheet_id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "152764ca-1685-427c-aba7-4b92dcc0d60f",
"board": {
"id": "baf36573-d049-4636-9c4b-bc9cda6270fe",
"name": "CBSE"
},
"grade": {
"id": "28820b1a-34e1-4003-b5bd-96455ca2c6d8",
"name": "Grade 10"
},
"section": null,
"subject": {
"id": "6dd7ebda-1bc5-4c01-8649-372579189073",
"name": "Science"
},
"status": "Completed",
"number_of_questions": 10,
"topic": "Magnet",
"documents": [],
"audio": null,
"subject_matter": {
"topics_to_be_covered": {
"topic": {
"ai_recommendations": [
"Explain the concept of magnetic poles and their properties with examples.",
"Describe the behavior of a compass needle near a bar magnet and explain why it gets deflected.",
"Illustrate the method to visualize magnetic field lines around a bar magnet using iron filings and represent these field lines through diagrams."
],
"additional_recommendations": [
"Include an activity-based question related to creating an electromagnet using a solenoid and steel rod.",
"Add conceptual questions comparing attraction and repulsion between like and unlike magnetic poles."
]
}
},
"prerequisite_knowledge": {
"prerequisite": {
"ai_recommendations": [
"Understand the concept of magnetism including magnetic poles and their properties from previous science grades.",
"Familiarity with the behavior of magnets, particularly attraction and repulsion between poles.",
"Basic knowledge of compass usage and directional properties (north and south poles)."
],
"additional_recommendations": [
"Review the concept of magnetic fields and field lines learned in previous lessons.",
"Include practical activities to connect theoretical concepts, such as creating electromagnets and observing magnetic effects.",
"Discuss conceptual questions comparing magnetic attraction and repulsion to reinforce understanding."
]
}
},
"key_concepts_and_subconcepts": {
"concepts": {
"ai_recommendations": [
"Magnetic Poles and Their Properties",
"Behavior of Compass Needle Near a Bar Magnet",
"Visualization and Representation of Magnetic Field Lines Around a Bar Magnet"
],
"additional_recommendations": [
"Activity on Creating an Electromagnet Using a Solenoid and Steel Rod",
"Conceptual Questions on Attraction and Repulsion Between Like and Unlike Magnetic Poles"
]
}
}
},
"learning_standards": {
"competencies": {
"competency_list": [
{
"name": "C-8.1",
"description": "Develops accurate and appropriate models (including geometric, mathematical, graphical) to represent real-life events and phenomena using scientific principles and use these models to manipulate variables and predict results"
},
{
"name": "C-8.2",
"description": "Designs and implements a plan for scientific inquiry (formulates hypotheses, makes predictions, identifies variables, accurately uses scientific instruments, represents data — primary and secondary — in multiple modes, draws inferences based on data and understanding of scientific concepts, theories, laws, and principles, communicates findings using scientific terminology)"
}
]
},
"learning_outcomes": {
"outcomes": {
"ai_recommendations": [
"relates processes and phenomena with causes and effects, such as, hormones with their functions, tooth decay with pH of saliva, growth of plants with pH of the soil, survival of aquatic life with pH of water, blue colour of sky with scattering of light, deflection of compass needle due to magnetic effect of electric current, etc."
],
"additional_recommendations": [
"draws labelled diagrams, flow charts, concept maps, and graphs, such as, digestive, respiratory, circulatory, excretory, and reproductive systems, electrolysis of water, electron dot structure of atoms and molecules, flow chart for extraction of metals from ores, ray diagrams, magnetic field lines, etc.",
"plans and conducts investigations and experiments to arrive at and verify the facts, principles, phenomena, or to seek answers to queries on their own, such as, investigates conditions necessary for rusting, tests the conductivity of various solutions, compares the foaming capacity of different types of soap samples, verifies laws of reflection and refraction of light, Ohm’s law, etc."
]
}
},
"smart_learning_objectives": {
"objects": {
"ai_recommendations": [
"Students will explain the relationship between hormones and their functions by identifying hormonal effects in the human body (Understand).",
"Students will analyze the causes of tooth decay by relating it to the pH level of saliva and propose preventive measures (Analyze).",
"Students will evaluate the impact of soil pH on plant growth by conducting experiments or interpreting given data (Evaluate).",
"Students will describe how the survival of aquatic life depends on the pH level of water by summarizing relevant environmental factors (Understand).",
"Students will explain the phenomenon of blue color of the sky through the concept of light scattering (Understand).",
"Students will analyze the deflection of a compass needle due to the magnetic effect of electric current by demonstrating or simulating the effect (Analyze)."
],
"additional_recommendations": [
"Students will draw accurately labelled diagrams of human systems such as digestive, respiratory, circulatory, excretory, and reproductive systems (Apply).",
"Students will construct flow charts and concept maps to represent processes like electrolysis of water and extraction of metals from ores (Apply).",
"Students will sketch electron dot structures of atoms and molecules and explain their significance (Understand).",
"Students will depict ray diagrams and magnetic field lines for various physical phenomena, explaining their characteristics (Apply)."
]
}
}
}
}
}Documentation Index
Fetch the complete documentation index at: https://docs.crazygoldfish.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier of the worksheet
Response
Worksheet metadata retrieved successfully.
The response is of type object.
Was this page helpful?
Previous
POST - Create Worksheet Question ConfigurationFinalizes the worksheet metadata by submitting **subject matter** and **learning standards** for a given worksheet.
This step ensures that the worksheet proceeds to the **question configuration phase**.
**How to Use:**
1. Call `POST /worksheet/v1/question-config/{work_sheet_id}` with a valid worksheet ID.
2. Provide the finalized metadata in the request body (`subject_matter` and `learning_standards`).
3. If successful, the worksheet question configuration process will be initiated asynchronously.
4. If the worksheet is not found, or if its steps are invalid, a corresponding error is returned.
**Path Parameters:**
- `work_sheet_id` (UUID, required): The unique ID of the worksheet.
Next
⌘I
Get Worksheet Metadata by ID
curl --request GET \
--url https://api-staging.crazygoldfish.com/worksheet/v1/metadata/{work_sheet_id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "152764ca-1685-427c-aba7-4b92dcc0d60f",
"board": {
"id": "baf36573-d049-4636-9c4b-bc9cda6270fe",
"name": "CBSE"
},
"grade": {
"id": "28820b1a-34e1-4003-b5bd-96455ca2c6d8",
"name": "Grade 10"
},
"section": null,
"subject": {
"id": "6dd7ebda-1bc5-4c01-8649-372579189073",
"name": "Science"
},
"status": "Completed",
"number_of_questions": 10,
"topic": "Magnet",
"documents": [],
"audio": null,
"subject_matter": {
"topics_to_be_covered": {
"topic": {
"ai_recommendations": [
"Explain the concept of magnetic poles and their properties with examples.",
"Describe the behavior of a compass needle near a bar magnet and explain why it gets deflected.",
"Illustrate the method to visualize magnetic field lines around a bar magnet using iron filings and represent these field lines through diagrams."
],
"additional_recommendations": [
"Include an activity-based question related to creating an electromagnet using a solenoid and steel rod.",
"Add conceptual questions comparing attraction and repulsion between like and unlike magnetic poles."
]
}
},
"prerequisite_knowledge": {
"prerequisite": {
"ai_recommendations": [
"Understand the concept of magnetism including magnetic poles and their properties from previous science grades.",
"Familiarity with the behavior of magnets, particularly attraction and repulsion between poles.",
"Basic knowledge of compass usage and directional properties (north and south poles)."
],
"additional_recommendations": [
"Review the concept of magnetic fields and field lines learned in previous lessons.",
"Include practical activities to connect theoretical concepts, such as creating electromagnets and observing magnetic effects.",
"Discuss conceptual questions comparing magnetic attraction and repulsion to reinforce understanding."
]
}
},
"key_concepts_and_subconcepts": {
"concepts": {
"ai_recommendations": [
"Magnetic Poles and Their Properties",
"Behavior of Compass Needle Near a Bar Magnet",
"Visualization and Representation of Magnetic Field Lines Around a Bar Magnet"
],
"additional_recommendations": [
"Activity on Creating an Electromagnet Using a Solenoid and Steel Rod",
"Conceptual Questions on Attraction and Repulsion Between Like and Unlike Magnetic Poles"
]
}
}
},
"learning_standards": {
"competencies": {
"competency_list": [
{
"name": "C-8.1",
"description": "Develops accurate and appropriate models (including geometric, mathematical, graphical) to represent real-life events and phenomena using scientific principles and use these models to manipulate variables and predict results"
},
{
"name": "C-8.2",
"description": "Designs and implements a plan for scientific inquiry (formulates hypotheses, makes predictions, identifies variables, accurately uses scientific instruments, represents data — primary and secondary — in multiple modes, draws inferences based on data and understanding of scientific concepts, theories, laws, and principles, communicates findings using scientific terminology)"
}
]
},
"learning_outcomes": {
"outcomes": {
"ai_recommendations": [
"relates processes and phenomena with causes and effects, such as, hormones with their functions, tooth decay with pH of saliva, growth of plants with pH of the soil, survival of aquatic life with pH of water, blue colour of sky with scattering of light, deflection of compass needle due to magnetic effect of electric current, etc."
],
"additional_recommendations": [
"draws labelled diagrams, flow charts, concept maps, and graphs, such as, digestive, respiratory, circulatory, excretory, and reproductive systems, electrolysis of water, electron dot structure of atoms and molecules, flow chart for extraction of metals from ores, ray diagrams, magnetic field lines, etc.",
"plans and conducts investigations and experiments to arrive at and verify the facts, principles, phenomena, or to seek answers to queries on their own, such as, investigates conditions necessary for rusting, tests the conductivity of various solutions, compares the foaming capacity of different types of soap samples, verifies laws of reflection and refraction of light, Ohm’s law, etc."
]
}
},
"smart_learning_objectives": {
"objects": {
"ai_recommendations": [
"Students will explain the relationship between hormones and their functions by identifying hormonal effects in the human body (Understand).",
"Students will analyze the causes of tooth decay by relating it to the pH level of saliva and propose preventive measures (Analyze).",
"Students will evaluate the impact of soil pH on plant growth by conducting experiments or interpreting given data (Evaluate).",
"Students will describe how the survival of aquatic life depends on the pH level of water by summarizing relevant environmental factors (Understand).",
"Students will explain the phenomenon of blue color of the sky through the concept of light scattering (Understand).",
"Students will analyze the deflection of a compass needle due to the magnetic effect of electric current by demonstrating or simulating the effect (Analyze)."
],
"additional_recommendations": [
"Students will draw accurately labelled diagrams of human systems such as digestive, respiratory, circulatory, excretory, and reproductive systems (Apply).",
"Students will construct flow charts and concept maps to represent processes like electrolysis of water and extraction of metals from ores (Apply).",
"Students will sketch electron dot structures of atoms and molecules and explain their significance (Understand).",
"Students will depict ray diagrams and magnetic field lines for various physical phenomena, explaining their characteristics (Apply)."
]
}
}
}
}
}