GET - Lesson Plan Metadata by ID

Retrieves metadata for a specific lesson plan by its ID. This endpoint returns details such as board, grade, section, subject, status, duration, topic, subject matter, and learning standards.

How to Use:

Call GET /lesson-plan/v1/metadata/{lessonPlanId} with the lesson plan ID.
On success, you receive lesson plan metadata in the response.
If the lesson plan is not found, a 404 error is returned. If processing failed, a 400 error with the failure message is returned.

GET

lesson-plan

metadata

{lesson_plan_id}

Retrieve the metadata of a lesson plan by its ID.

curl --request GET \
  --url https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "board": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "grade": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "section": "<string>",
    "subject": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "status": "<string>",
    "duration_minutes": 123,
    "topic": "<string>",
    "documents": [
      {
        "url": "<string>",
        "file_type": "<string>"
      }
    ],
    "audio": "<string>",
    "subject_matter": {
      "topics_to_be_covered": {
        "topic": {
          "ai_recommendations": [
            "<string>"
          ],
          "additional_recommendations": [
            "<string>"
          ]
        }
      },
      "key_concepts_and_subconcepts": {
        "concepts": {
          "ai_recommendations": [
            "<string>"
          ],
          "additional_recommendations": [
            "<string>"
          ]
        }
      },
      "prerequisite_knowledge": {
        "prerequisite": {
          "ai_recommendations": [
            "<string>"
          ],
          "additional_recommendations": [
            "<string>"
          ]
        }
      }
    },
    "learning_standards": {
      "learning_outcomes": {
        "outcomes": {
          "ai_recommendations": [
            "<string>"
          ],
          "additional_recommendations": [
            "<string>"
          ]
        }
      },
      "smart_learning_objectives": {
        "objects": {
          "ai_recommendations": [
            "<string>"
          ],
          "additional_recommendations": [
            "<string>"
          ]
        }
      },
      "competencies": {
        "competency_list": [
          {
            "name": "<string>",
            "description": "<string>"
          }
        ]
      }
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

lesson_plan_id

string<uuid>

required

Unique identifier of the lesson plan.

Response

Lesson plan metadata retrieved successfully.

data

object

Show child attributes

POST - Lesson Plan Finalize Metadata This API allows authenticated users to trigger the finalization metadata process for a lesson plan. **How to Use:** 1. Call this endpoint with the finalized metadata payload, including subject matter and learning standards. 2. The API validates the lesson plan ID, checks metadata step status, and ensures alignment is not already in progress or completed. 3. On success, the system updates metadata, triggers the alignment process asynchronously, and returns a success message. **Example Scenario:** A teacher submits finalized metadata for a lesson plan. - The system validates the request and workflow state. - If valid, metadata is saved and alignment starts. - The teacher receives confirmation that alignment has been initiated.

Retrieve the metadata of a lesson plan by its ID.

curl --request GET \
  --url https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata/{lesson_plan_id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "board": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "grade": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "section": "<string>",
    "subject": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "status": "<string>",
    "duration_minutes": 123,
    "topic": "<string>",
    "documents": [
      {
        "url": "<string>",
        "file_type": "<string>"
      }
    ],
    "audio": "<string>",
    "subject_matter": {
      "topics_to_be_covered": {
        "topic": {
          "ai_recommendations": [
            "<string>"
          ],
          "additional_recommendations": [
            "<string>"
          ]
        }
      },
      "key_concepts_and_subconcepts": {
        "concepts": {
          "ai_recommendations": [
            "<string>"
          ],
          "additional_recommendations": [
            "<string>"
          ]
        }
      },
      "prerequisite_knowledge": {
        "prerequisite": {
          "ai_recommendations": [
            "<string>"
          ],
          "additional_recommendations": [
            "<string>"
          ]
        }
      }
    },
    "learning_standards": {
      "learning_outcomes": {
        "outcomes": {
          "ai_recommendations": [
            "<string>"
          ],
          "additional_recommendations": [
            "<string>"
          ]
        }
      },
      "smart_learning_objectives": {
        "objects": {
          "ai_recommendations": [
            "<string>"
          ],
          "additional_recommendations": [
            "<string>"
          ]
        }
      },
      "competencies": {
        "competency_list": [
          {
            "name": "<string>",
            "description": "<string>"
          }
        ]
      }
    }
  }
}

Documentation Index

Authorizations

Path Parameters

Response