POST - Lesson Plan Instructional Framework Builder
This API allows authenticated users to trigger the content generation process for a lesson plan.
How to Use:
- Call
POST /lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}with the finalized finalize meta data. - The API validates the lesson plan ID, checks that the finalize meta data step is completed, and ensures content generation is not already in progress or completed.
- On success, the system updates the finalize meta data, triggers the content generation process asynchronously, and returns a success message.
Example Scenario:
A teacher wants to generate content for a lesson plan:
- They submit the finalized meta data using this API.
- The system validates the lesson plan and finalize meta step status.
- If valid, the system updates the finalize meta and starts the content generation process.
- The teacher receives a message confirming the content generation process has been initiated.
POST
Trigger content generation for a lesson plan.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
UUID of the lesson plan to generate content for.
Body
application/json
Community-focused alignment data required to drive content generation. Includes recommended materials, instructional strategies, and detailed instructional blocks.
Alignment details that specify materials, strategies, and instructional blocks.
Response
Content generation job enqueued successfully.
Previous
GET - Lesson Plan Instructional Framework Builder This API allows authenticated users to retrieve the generated instructional framework for a lesson plan.
**How to Use:**
1. Call `GET /lesson-plan/v1/instructional-framework-builder/{lesson_plan_id}` with the lesson plan ID.
2. The API validates the lesson plan ID and checks if instructional framework generation is completed.
3. On success, the system returns the generated instructional framework.
**Example Scenario:**
A teacher wants to view the generated instructional framework for a lesson plan:
- They call this API with the lesson plan ID.
- The system validates the lesson plan and instructional framework generation status.
- If valid and completed, the system returns the generated instructional framework.
- The teacher receives the lesson plan instructional framework for review and use.
Next
Trigger content generation for a lesson plan.