POST - Lesson Plan Metadata
This API allows authenticated users to create and process lesson plan metadata.
How to Use:
- Call
POST /lesson-plan/metadatawith 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
Create and process lesson plan metadata
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
multipart/form-data
Board ID (UUID)
Grade ID (UUID)
Subject ID (UUID)
Duration in minutes
Topic
Section (optional)
Optional file uploads
Optional audio URL should be mp3 format
Response
Lesson plan metadata processing started successfully.
Previous
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.
Next
Create and process lesson plan metadata