ai-controller

Export refinement-layout AI request JSON

Changed on

Returns the OpenAI structured-response request body for note refinement layout generation (breakdown) without calling OpenAI. Optional MCQ question context uses the same question-aware instruction builder as generate-refinement-suggestions.

post/api/ai/export-refinement-layout-request/{note}

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/ai/export-refinement-layout-request/{note}
  • Auth
    none declared

Path parameters

noteinteger required

Request body

stemstring

MCQ question stem (markdown allowed)

choicesstring[]

MCQ response choices (markdown allowed)

correctAnswerIndexinteger

Zero-based index of the correct choice, when known

selectedChoiceIndexinteger

Zero-based index of the learner's selected choice, when known

clarificationstring

Optional clarification explicitly reviewed by the learner

testedFocusstring

Optional description of what the question was testing

Response

OK

object required

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property

    • warning

      removed the request property

    • warning

      removed the request property