Per Artifact Note

curl --request POST \
  --url https://api.example.com/api/v1/courses/{course_id}/review/note \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "<string>",
  "artifact_type": "<string>",
  "asset_id": 123,
  "module_index": 123,
  "scene_index": 123
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

B2B Courses v2

Per Artifact Note

POST /courses/{id}/review/note (S2.1) Record a reviewer note against a single artifact. Before recording: runs check_regen_allowed (S2.3 regen-cap pre-check). - If the course regen cap is exhausted: returns 429 WITH code='regen_cap_reached' BUT the note IS still recorded (design 14.5: cap withholds the regen job, not the note). In Wave 1 there is no regen job to withhold anyway; the 429 surfaces the cap to the caller for UX purposes. After passing the cap check: calls course_reviews.record_note which upserts status='note', appends the curated feedback entry, and returns the ledger row. Edits-flag write for outline/notes (S2.3 / design section 7): When artifact_type IN ('outline', 'notes'), the ledger row itself (status='note', iteration counts as edits signal) IS the edits-flag that Wave 2's narration needs_refine predicate reads. No separate flag file is written. This replaces the run_dir outline_edited.flag approach for per-stage courses (punchlist P3-4). Phase 2 / Wave 1: returns {noted, iteration, regen_cap_reached?}. NO regen job is enqueued (Wave 2 wires that).

POST

api

courses

{course_id}

review

note

Per Artifact Note

curl --request POST \
  --url https://api.example.com/api/v1/courses/{course_id}/review/note \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "<string>",
  "artifact_type": "<string>",
  "asset_id": 123,
  "module_index": 123,
  "scene_index": 123
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Path Parameters

course_id

string

required

Body

application/json

Per-artifact note request. note is the reviewer's text.

note

string

required

artifact_type

string | null

asset_id

integer | null

module_index

integer | null

scene_index

integer | null

Response

Successful Response

Per Artifact Approve Slides Read

⌘I