Teacher Course Structure

Rewrite Unit With Ai

Changed on

Rewrite a unit's content using AI based on the provided prompt.

This endpoint allows teachers to provide instructions for how they want a unit to be rewritten, and the AI will generate new content accordingly.

put/teacher/courses/{course_id}/units/{unit_id}/rewrite

Request

  • Base URL: https://api.excellence-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.excellence-ai.com/teacher/courses/{course_id}/units/{unit_id}/rewrite
  • Auth: OAuth 2 (password, token URL api/login)

Path parameters

course_idstring required
unit_idstring required

Request body

promptstring required

Instructions for how to rewrite the unit

preserve_flashcardsboolean

Whether to preserve existing flashcards

preserve_qcmsboolean

Whether to preserve existing QCMs

Response

Successful Response

statusstring required
messagestring required

Changes

  • 7925dd21e4d0Revision changes
    • warning

      added the new excellence_course enum value to the // response property for the response status

    • warning

      added the new interactive enum value to the /////// response property for the response status

    • warning

      added the new video enum value to the /////// response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • c81ed506912fRevision changes
    • info

      added the optional property //// to the response with the status