Worksheet Generation
GET generated Worksheet
Authentication
K12
- Handwritten Gen Evaluation
- Handwritten Exam Evaluation
- Content Generation
- Lesson Plan Generation
- Content Generation
- MCQ Generation
- Worksheet Generation
- Assignment Evaluation
Assessment Rubrics
- Rubrics
Standardized Language Exams
- Embeddable UI
- TOEFL Evaluation
- IELTS Evaluation
Worksheet Generation
GET generated Worksheet
This endpoint allows clients to retrieve a specific generated worksheet using its unique identifier called request_id (ID).
GET
/
v1
/
k12
/
generate
/
worksheet
/
{request_id}
curl --request GET \
--url https://api-staging.crazygoldfish.com/v1/k12/generate/worksheet/{request_id} \
--header 'Authorization: <api-key>' \
--header 'accept: <accept>'
{
"status_code": 200,
"message": "Worksheet request :completed",
"status": "completed",
"data": {
"request_id": "unique-request-id",
"client_id": "client123",
"created_at": "2025-01-07T17:43:13.595406",
"worksheet": [
{
"subject": "Science",
"topic": "Photosynthesis",
"questions": [
{
"question_id": 1,
"question_type": "MCQ_single_answer",
"question": "What is the main pigment involved in photosynthesis?",
"options": [
"A-Chlorophyll",
"B-Hemoglobin",
"C-Keratin",
"D-Melanin"
],
"tags": {
"Difficulty_level": "easy",
"Bloom's_Taxonomy": "Remember",
"Competency": "Understand the role of chlorophyll in photosynthesis",
"Curricular_Goal": "Identify the pigment responsible for photosynthesis",
"LO": "Understand the process of photosynthesis",
"Hints": "The pigment is green in color and is found in plant cells."
}
}
],
"solution_sheet": [
{
"question_id": 1,
"answer": "The field consists of concentric circles centred on the wire."
}
],
"topics": [
"Photosynthesis",
"Cell Structure"
]
}
]
}
}
Authorizations
Headers
Specifies the format of the response.
Available options:
application/json
Path Parameters
Unique identifier of the worksheet generation request.
Response
200
application/json
Successfully retrieved worksheet. This checks if the request with respect to the user id is processing or completed if completed it will fetch the results else it returns processing.
Example:
200
Example:
"Worksheet request :completed"
Available options:
processing
, completed
Example:
"completed"
Example:
"unique-request-id"
Example:
"client123"
Example:
"2025-01-07T17:43:13.595406"
Example:
"Science"
Example:
"Photosynthesis"
Example:
1
Available options:
MCQ_single_answer
, MCQ_Multiple_answer
, True_False
, Fill_in_the_blanks
, Match_the_column
, Very_Short_answer
, Short_answer
, Long_answer
Example:
"MCQ_single_answer"
Example:
"What is the main pigment involved in photosynthesis?"
Example:
"easy"
Example:
"Remember"
Example:
"Understand the role of chlorophyll in photosynthesis"
Example:
"Identify the pigment responsible for photosynthesis"
Example:
"Understand the process of photosynthesis"
Example:
"The pigment is green in color and is found in plant cells."
Example:
[
"A-Chlorophyll",
"B-Hemoglobin",
"C-Keratin",
"D-Melanin"
]
Example:
[
{
"question_id": 1,
"answer": "The field consists of concentric circles centred on the wire."
}
]
Example:
["Photosynthesis", "Cell Structure"]
curl --request GET \
--url https://api-staging.crazygoldfish.com/v1/k12/generate/worksheet/{request_id} \
--header 'Authorization: <api-key>' \
--header 'accept: <accept>'
{
"status_code": 200,
"message": "Worksheet request :completed",
"status": "completed",
"data": {
"request_id": "unique-request-id",
"client_id": "client123",
"created_at": "2025-01-07T17:43:13.595406",
"worksheet": [
{
"subject": "Science",
"topic": "Photosynthesis",
"questions": [
{
"question_id": 1,
"question_type": "MCQ_single_answer",
"question": "What is the main pigment involved in photosynthesis?",
"options": [
"A-Chlorophyll",
"B-Hemoglobin",
"C-Keratin",
"D-Melanin"
],
"tags": {
"Difficulty_level": "easy",
"Bloom's_Taxonomy": "Remember",
"Competency": "Understand the role of chlorophyll in photosynthesis",
"Curricular_Goal": "Identify the pigment responsible for photosynthesis",
"LO": "Understand the process of photosynthesis",
"Hints": "The pigment is green in color and is found in plant cells."
}
}
],
"solution_sheet": [
{
"question_id": 1,
"answer": "The field consists of concentric circles centred on the wire."
}
],
"topics": [
"Photosynthesis",
"Cell Structure"
]
}
]
}
}