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:

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.
The API validates IDs, uploads files if present or retrieves them from RAG, stores the lesson plan, and triggers background processing.
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.

POST

lesson-plan

metadata

Create and process lesson plan metadata

curl --request POST \
  --url https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form board=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form grade=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form subject=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form duration_minutes=123 \
  --form 'topic=<string>' \
  --form 'section=<string>' \
  --form 'documents=<string>' \
  --form audio='@example-file' \
  --form 'meta_data={"teacher_id": 199}' \
  --form documents.items='@example-file'

{
  "detail": [
    {
      "id": "e2b7c8a2-7c2e-4e8a-9b1e-2c3d4e5f6a7b",
      "message": "Lesson plan metadata processing started successfully."
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

multipart/form-data

board

string<uuid>

required

Board ID (UUID)

grade

string<uuid>

required

Grade ID (UUID)

subject

string<uuid>

required

Subject ID (UUID)

duration_minutes

integer

required

Duration in minutes

topic

string

required

Topic

section

string

Section (optional)

documents

file[]

Optional file uploads

audio

file

Optional audio URL should be mp3 format

meta_data

string

JSON string representing the metadata of the worksheet

Example:

"{\"teacher_id\": 199}"

Response

Lesson plan metadata processing started successfully.

detail

object[]

Show child attributes

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:** 1. Call `GET /lesson-plan/v1/metadata/{lessonPlanId}` with the lesson plan ID. 2. On success, you receive lesson plan metadata in the response. 3. If the lesson plan is not found, a 404 error is returned. If processing failed, a 400 error with the failure message is returned.

Create and process lesson plan metadata

curl --request POST \
  --url https://api-staging.crazygoldfish.com/lesson-plan/v1/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form board=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form grade=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form subject=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form duration_minutes=123 \
  --form 'topic=<string>' \
  --form 'section=<string>' \
  --form 'documents=<string>' \
  --form audio='@example-file' \
  --form 'meta_data={"teacher_id": 199}' \
  --form documents.items='@example-file'

{
  "detail": [
    {
      "id": "e2b7c8a2-7c2e-4e8a-9b1e-2c3d4e5f6a7b",
      "message": "Lesson plan metadata processing started successfully."
    }
  ]
}

Documentation Index

Authorizations

Body

Response