GET - Subjects for Grade

This API allows authenticated users to retrieve all subjects for a specific grade within a board.

How to Use:

Call GET /metadata/v1/board/{board_id}/grades/{grade_id}/subjects with the required board’s id and grade’s id to get the list of all subjects for that grade.
Use the id of the required subject in lesson plans or any other feature that needs a subject reference.

Example Scenario: A teacher wants to create or view a lesson plan for a specific subject within a grade and board: - First, they call the boards API to list all boards and find the required board’s id. - Then, they call the grades API to list all grades for that board and find the required grade’s id. - Next, they call this API to list all subjects for that grade and find the required subject’s id. - Finally, they use that subject id in the lesson plan API or anywhere else in the system where a subject reference is needed.

GET

metadata

board

{board_id}

grades

{grade_id}

subjects

List Subjects for Grade

curl --request GET \
  --url https://api-staging.crazygoldfish.com/metadata/v1/board/{board_id}/grades/{grade_id}/subjects \
  --header 'Authorization: Bearer <token>'

[
  {
    "name": "English",
    "id": "99f5312d-48f6-4c5c-8141-2eeb88f16290"
  },
  {
    "name": "Mathematics",
    "id": "e3edf414-eb46-4fa3-b8fc-b2cd0c39266e"
  },
  {
    "name": "Hindi",
    "id": "e20dec7b-0577-4f13-a54b-8cbbddec126c"
  },
  {
    "name": "Science",
    "id": "6dd7ebda-1bc5-4c01-8649-372579189073"
  },
  {
    "name": "Social Science",
    "id": "5aeb9455-7058-4f07-a532-b72db708edb6"
  },
  {
    "name": "Health and Physical Education",
    "id": "1f3afbed-c93c-42cf-9228-733bd88fdcc0"
  }
]

Authorizations

Authorization

string

header

required

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

Path Parameters

board_id

string

required

Unique identifier of the board.

grade_id

string

required

Unique identifier of the grade.

Response

A list of subjects for the specified grade.

string

Unique identifier for the subject.

name

string

Name of the subject.

POST - Lesson Plan Metadata This API allows authenticated users to create and process lesson plan metadata. **Duration Constraint:** - Minimum duration: 30 minutes - Maximum duration: 90 minutes **How to Use:** 1. Call `POST /lesson-plan/metadata` with board, grade, subject, section, duration, topic, and optional file uploads. If no file is provided, the system will search for relevant files from the RAG (Retrieval-Augmented Generation) system. 2. The API validates IDs, uploads files if present or retrieves them from RAG, stores the lesson plan, and triggers background processing. 3. On success, you receive a request ID and a message confirming processing has started. **Example Scenario:** A teacher wants to create a new lesson plan: - They submit board, grade, subject, section, duration, topic, and files using this API. - If no files are uploaded, the system will automatically search for them using RAG. - The system validates the data, uploads or retrieves files, and starts processing the lesson plan metadata. - The teacher receives a request ID to track processing status.

List Subjects for Grade

curl --request GET \
  --url https://api-staging.crazygoldfish.com/metadata/v1/board/{board_id}/grades/{grade_id}/subjects \
  --header 'Authorization: Bearer <token>'

[
  {
    "name": "English",
    "id": "99f5312d-48f6-4c5c-8141-2eeb88f16290"
  },
  {
    "name": "Mathematics",
    "id": "e3edf414-eb46-4fa3-b8fc-b2cd0c39266e"
  },
  {
    "name": "Hindi",
    "id": "e20dec7b-0577-4f13-a54b-8cbbddec126c"
  },
  {
    "name": "Science",
    "id": "6dd7ebda-1bc5-4c01-8649-372579189073"
  },
  {
    "name": "Social Science",
    "id": "5aeb9455-7058-4f07-a532-b72db708edb6"
  },
  {
    "name": "Health and Physical Education",
    "id": "1f3afbed-c93c-42cf-9228-733bd88fdcc0"
  }
]

Documentation Index

Authorizations

Path Parameters

Response